Revising documents - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The document revision process is separate from the publishing process, making it possible to revise a document locally and in SmartPlant Foundation and save the revision values to the tool database without re-publishing the document. You specify the revision using the Revise command. Revising a document creates a revision for the document with major and minor revision values set, depending on the revision schema selected. When revising a document, you can modify the major and minor revision data on the document.

You can change the revision scheme after a document has been published, skip revision numbers, and manually add a revision number, then have it validated against the revision scheme. It is not required to assign a minor revision number. Also, revision data from tools is supported even if the document has previously been revised in SmartPlant Foundation.

You can revise a document by using any previous revisions that are available from the last published revision.

Example

If you revise a new document using the revision scheme RevAlpha (A, B, C, D…) and revision C, then SmartPlant Foundation reserves revision number C for the document. Revising the same document with RevAlpha, you can now revise with any previous revision numbers, such as A or B. However, if the document is published to SmartPlant Foundation with revision number C, you are not allowed to go back to the previous revision numbers.

The following table contains the available revision numbers based on the document revision state in SmartPlant Foundation:

Document revision state

Next available revision number

Working (C)

C and up

Current (C)

D and up

Revise dialog box

Allows you to revise a document in the authoring tool without publishing it.

Boxes with a shaded background are read-only and cannot be edited.

Engineering Tool — Displays an authoring tool-specific dialog box that allows you to select documents to add to the Selected documents list.

Delete — Removes the selected document from the Selected Documents list.

Selected documents — Displays a list of the documents selected to be revised. You populate this list by selecting documents before activating the Revise command. You can click the Delete button to remove documents from this list.

Revision Scheme — If you have selected a new document or a document for which no revision scheme has been selected, choose the revision scheme to be applied from the list of available options. If you have selected a document with a defined revision scheme, that scheme is displayed here in a read-only format. Only revision schemes that are applicable to the configuration (plant) or classification (document type) are available in the drop-down menu. If none of the revision schemes are related to the configuration or classification, then all revision schemes are available. For more information on revision scheme configuration, see Configure different revision scheme strategies.

Current Revision in Tool > Major — For existing documents, this box displays the current major revision of the document, as defined in the authoring tool, in a read-only format. For new documents, this box is empty.

Current Revision in Tool > Minor — For existing documents, this box displays the current minor revision of the document, as defined in the authoring tool, in a read-only format. If the revision scheme does not use minor revision, or if the selected document has not yet been revised, this box is empty.

If you do not use the Minor box when revising a document for the first time, the minor revision option will never be available for that document for future revisions.

Revise in Tool > Major — From this list box, choose the next available major revision number for the document to revise it locally, without publishing the new information.

Revise in Tool > Minor — From this list box, choose the next available minor revision number for the document to revise it locally, without publishing the new information. If minor revisions are not supported for the document, no options are available in this list.

Administrator can disable skipping of revision numbers using the Integration options in the SmartPlant Foundation Desktop Client. For more information on configuring skipping of revisions, see Configure Allow skipping revisions.

Next Major — Selects the next available major revision number for the document to revise it locally, without publishing the new information.

Next Minor — Selects the next available minor revision number for the document to revise it locally without publishing the new information.

What do you want to do?