Revisable and Locked Documents - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

The New Revision Required dialog box allows you to revise documents that require a revision before they can be published. This functionality is available from the Publish dialog box and appears after you attempt to publish a document that requires a revision or is currently locked. You can revise the appropriate documents without exiting the Publish dialog box.

The New Revision Required dialog box appears when you attempt to publish any documents that require a revision. Revisable documents, such as a new document that requires an initial revision, can be revised without exiting the Publish dialog box. Locked documents, such as a document that is currently in a workflow, cannot be revised and the software allows you to select alternative documents to publish. The Unable to Publish dialog box appears when you attempt to publish a locked document. In an integrated environment, you may encounter the following scenarios based on the documents you select to publish.

Revisable Documents

A revisable document is either a signed off document, superseded document, a new document that has not been previously revised, or a previously revised document. The following examples demonstrate the workflow for publishing different types of revisable documents.

Publish signed off or superseded documents

The following example demonstrates the workflow for publishing a signed off document.

  1. Click SmartPlant > Publish. For more information, see Publish Documents.

  2. Select documents to publish from the Publish dialog box, and click OK.

  3. On the New Revision Required dialog box, select the signed off or superseded documents that you want to revise.

  4. Click Yes to revise the signed off document.

  5. After the Revise dialog box appears, select a revision scheme with which to revise the signed off document. For more information on revising documents, see Revise a Document.

  6. Click OK.

    After the revision operation completes the Publish dialog box appears and allows you to publish the signed off document.

  7. Click OK to complete the publish process.

Publish new documents

The following example demonstrates the workflow for publishing a document that needs an initial revision.

  1. Click SmartPlant > Publish. For more information, see Publish Documents.

  2. Select documents to publish from the Publish dialog box, and click OK.

  3. On the New Revision Required dialog box, select the new documents that you want to revise.

  4. Click Yes to revise the new document.

  5. After the Revise dialog box appears, select a revision scheme with which to revise the new document. For more information on revising documents, see Revise a Document.

  6. Click OK.

    After the revision operation completes the Publish dialog box appears and allows you to publish the new document.

  7. Click OK to complete the publish process.

Locked Documents

In SmartPlant Foundation, a document is locked if any of the following statements are true:

  • Documents in a workflow.

  • Documents in an as-built plant.

  • Documents in a different project.

  • Documents in a different plant.

For example, documents currently in a workflow cannot be published because they are locked in SmartPlant Foundation. Locked documents cannot be published.

If you attempt to publish a locked document, such as documents in a change management workflow waiting for an approval, the Unable to Publish dialog box appears. This is because the document is currently being processed by a workflow.

Click Yes to return to the Publish dialog box and select other documents to publish by clicking Engineering Tool or File System. For more information on these commands, see the Publish Dialog Box.

Combination of revisable documents and locked documents

If you select a combination of revisable documents and locked documents to publish, the New Revision Required dialog box appears with a list of revisable documents, followed by the Unable to Publish dialog box with a list of locked documents that cannot be published.

  1. Click SmartPlant > Publish. For more information, see Publish Documents.

  2. Select documents to publish from the Publish dialog box, and click OK.

  3. On the New Revision Required dialog box, select the new documents that you want to revise.

  4. Click Yes to revise the new document.

  5. After the Revise dialog box appears, select a revision scheme with which to revise the new document. For more information on revising documents, see Revise a Document.

  6. Click OK.

    The Unable to Publish dialog box appears with a list of locked documents that cannot be published.