Check out a document - SmartPlant Foundation - IM Update 48 - 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 Check Out command allows you to check out documents for editing. This command is available when you right-click one or more documents.

  1. Right-click the document version or versions that you want to check out for modification then click Edit > Check Out.

    Documents created without a configuration value can be checked out, checked in, revised, updated, or signed off when your active configuration is set above the plant level to Scope Not Set.

    • To use the Check Out command, all the selected documents must be checked in (that is, the checked-out indicator must be set to False), the status must be working, you must be a member of the owning group, and the revise state must be blank. If any of the selected documents do not satisfy these conditions, the Check Out command does not appear on the shortcut menu.

    • To determine whether a file is checked out or not, select the document and review the information in the Properties window. If the Checked Out property is True, then the file is currently checked out. You can also view the document properties in the History dialog box.

  2. Click Browse to select the directory into which you want the software to copy the checked-out files.

  3. Select each document that you want to check out.

  4. Click OK.

    • When you check out files that have references, the software automatically places read-only copies of all the reference files, any nested reference files, and the master file to your local computer. These copies are for reference only. If you want to update the reference files, you must check out the document to which they are attached.

    • If the file you check out has duplicate copies of a reference file in the nested structure, the software displays a message warning you that files with the same name are attached to multiple files. If you receive this message, click Yes to continue the checkout process with a single level copied for reference, or click No to cancel the checkout process.

    • If the file you check out has reference files attached to different versions of a document in the nested structure, the latest version of the document is copied for reference.

    If the files you are checking out are already copied for reference to your local computer, the newly checked out files overwrite the local files.

  • When you check out a document version, the previous version is superseded. The software sets the following properties for the superseded document version: status to working, the revise state to superseded, the access flag to 9 (no update access), and the version to 1.

  • When you check out a document, the software creates a new document version. The software gives the new version the next version number. The access flag for that new document is set to 1 (user access only), and the checked-out indicator is set to True.

  • When you check out a document, the previous version of the document is replaced with the new version of the document in the current active window. If you do not want to replace the previous version of the document with the version, set the Parameter 11 to False on the CheckOut client API. In this scenario, the new version of the document is displayed in the New Items window.

  • When you check out a document, you can also replace the previous version of the reference documents linked to it to new document versions, by selecting the Check out all references check box in the Check Out dialog box. By default, the Check out all references option is not selected.

  • For paging queries, when you check out a document on a page and navigate back to the same page, the previous version of the document is displayed in the List View window.

  • When you check out a document, any existing markups to files attached to the document are automatically copied forward with the checked-out document.