Document Search and Retrieve - Integration - Update 46 - Help - Hexagon

SmartPlant Integration .NET 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)

Allows you to search published documents and retrieve documents to a specified folder.

Document Search and Retrieve Dialog Box

Name - Search by the name of the document.

Signature - Indicates a unique identifier for the relationship between a plant in SmartPlant Foundation and a specific plant in an authoring tool database. The relationship is created when an authoring tool is registered with SmartPlant Foundation.

Last Retrieved Version - Indicates the last version of the retrieved documents on the connected signature.

Latest Version - Indicates the latest version of the published documents.

Master OBID - Indicates a unique document objects identifier across the SmartPlant data base.

Document UID - Indicates a unique document object identifiers across configurations.

Document Class - Indicates the class name of the document

Raw - Allows you to retrieve only tool data and meta data.

With Instructions - Allows you to retrieve tool data, and metadata along with instructions.

Latest from SPF with Instructions - Allows you retrieve objects with latest data from SmartPlant Foundation.

Retrieval Folder - Shows a default temporary location where your retrieved documents are stored. This is a read only option.

Metadata - Allows you to retrieve metadata XML files that contain documents revision and versions published by a SmartPlant authoring tool.

Data - Allows you to retrieve tool data XML files that contain data objects and their relationships with other objects that are published by a SmartPlant authoring tool.

Instructions - Allows you to retrieve the tombstone XML file that contains delete instructions for objects and their relationships that are terminated when published by a SmartPlant authoring tool.

Retrieve confirm - Allows you to update the connected signature as the last retrieved version of the document.

Search documents

  1. Click SmartPlant > Document Search and Retrieve.

  2. In the Get Document by section, select a document type to set your search criteria.

  3. Select a Document Class from the list.

  4. Click Find Documents to execute search.

Retrieve searched documents

  1. In Retrieval Options section, select type of retrieval, such as With Instructions.

    To retrieve a view file, select the Retrieve View File option.

  2. Click Retrieve Document.

    For each document you retrieve, the SmartPlant Client Utility creates at least three files, which are named as follows:

    • SPCLClientUtility_Data.xml

    • SPCLClientUtility_Tombstone.xml

    • SPCLClientUtility_Metadata.xml

    To update the design basis of the retrieved document, select the With Instruction option, and then click Retrieve Confirm.

See Also

Connect a Tool in SmartPlant Foundation
Revise and Publish
Bulk Publish