Retrieve Process - 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)

Steps are similar to those for Document Selection of Publish except step 2e, which has the following steps for Retrieve.

For each document object in a document type,

  1. Creates document containers (Metadata, Document, Tombstones and Message).

  2. Creates an instance of the document object.

  3. Calls EFClient to retrieve the document. EFClient returns 3 XML files (document data, Metadata and tombstones).

  4. Loads the document data file into the Document container.

  5. Loads the Metadata file into the Metadata container.

  6. Loads the tombstones file into the tombstones container.

  7. Calls the RetrieveDocument method of the IEFAdapter interface. The arguments are DocumentIObj, document container, tombstones container, and metadata container. Tool Adapter retrieves the data in containers. The data container has data objects. The metadata container has File objects. There is one File object for each view file associated with the document. The File object has an interface called IFile, which has a property called FilePath, which points to the absolute path of the file. Tools should copy the file from this path to their local path. Adding of File objects happens only if the tool supports retrieval of view files. A tool will communicate whether it can retrieve view files or not by returning TRUE when the SupportsFeature method is called with RetrieveViewFile as an argument. See SupportsFeature As Boolean for details. Calls the RetrieveConfirm method of the IEFAdapter6 interface. The time of retrieval passed in this method needs to be persisted in the tool database, which can be used in resetting design basis after a tool restore. See Resetting Design Basis Methods for information about how the retrieval time is used for resetting design basis.

  8. Releases the contents of the container composition of the document.