Edit and check in a document - HxGN SDx - Update 64 - Help

HxGN SDx Help

Language
English
Product
HxGN SDx
Search by Category
Help
SmartPlant Foundation / SDx Version
10

When you edit a WORKING version document, it is checked out and set as reserved for edit, and then downloaded to your device for editing. After a document has been edited, you must check in the document as a new WORKING version.

How can I check in or replace a file along with content extraction?

By default, this feature is not enabled. However, your administrator can change the default behavior to enable content extraction for the Check in and Replace Files methods. For more information, see Configure content extraction on Replace Files and Check in methods.

To allow content extraction whenever you check in a document or replace a file related to a document, after attaching the file in the New Files page, you must:

  1. Set any replaced file or checked in file as the Master, by clicking Set as Master to mark the file for content extraction and display the Extract Content window.

  2. In the Extract Content window,

    1. Select a template group from the TemplateGroup/Template list to apply the processing rules using the corresponding Preprocessor Reader.

    2. Click Ok.

      By default, the file name is displayed in the Select File list.

      SHARED Tip You can use preprocessed content files for processing the file. For more information, see Extract data from a document.

  3. Click FINISH to successfully replace a file or check in a document along with content extraction.

To check the status of the content extraction, you can click Notifications.

  1. Select Actions > Edit Files.

  2. On the Select files to download page, select the file or files you want to edit, and select Save.

    SHARED Tip Depending on the browser used, you can either open the document directly or locate it saved in the download location on your device.

  3. Edit the files locally.

  4. To check in the updated files, select the document, and click Actions > Check In.

  5. On the Select Document(s) to Check In window, select a master document you want to check in from the list of documents displayed, you cannot select its reference documents as the software displays them in the view mode.

  6. Select Choose Files to locate and select the files to be checked in, and click FINISH.

    • You must select the files from the files displayed in the Files that are being edited section

    • To check in a document by attaching a file that references other files, including their nested reference files, you must ensure that the nested reference file level is less than or equal to the maximum number of nested reference files allowed. For more information, see Set the user options.

  • The modified document must be uploaded with its original name. You can see the check in details in Object Details > History tab, which lists the object's history details, such as the original name or creation date.

  • When checking in a document and a master file with its referenced files:

  • When you edit a document, a new WORKING version of the document is created based on the revision scheme. The previous document version is set to Superseded but is kept for history.

  • Edit Files allows you to download master files and copy files referenced by it, along with their nested reference files. As an administrator, you can prevent the copying of nested reference files by configuring methods of client API EditFiles. For more information, see Configure Edit Files action to filter nested reference files.