Retrieve - Integration - Update 46 - Help - Hexagon

Like publish, retrieve has two steps: document selection and the batch retrieve process.

Document Selection

Steps are similar to the Document Selection steps for the Publish operation, except that steps g and h do not apply to Retrieve.

Retrieve Process

1. Create and load the meta-schema, if not already done.

2. SPCLServiceManager performs the following steps:

   1. Creates a container composition for the GenericDocument component schema.

   2. Creates a container for schema objects.

   3. Loads the GenericDocument component schema.

   4. Creates a container composition for document.

   5. Creates document containers (Metadata, Documents, Tombstones, and Message).

   6. Loads saved XML containers (Document, Metadata).

   7. Sorts document objects by document type.

   8. Creates container composition for a component schema.

   9. For each document object in a document type:

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

      • Creates an instance of the document object.

      • Calls SPCLClient to retrieve the document. SPCLClient returns 3 XML files (Document data, Metadata and Tombstones).

      • Loads the document data file into the Document container.

      • Loads the Metadata file into the Metadata container.

      • Loads the tombstones file into the tombstones container.

      • Calls the RetrieveDocument method of the ISPAdapter interface. The arguments are DocumentIObj, document container, tombstones container, and metadata container. Calls the RetrieveConfirm method of the ISPAdapter interface. The time of retrieval passed in this method needs to be persisted in the tool database, which can be used in resetting the design basis after a tool restore. See ResetDesignBasis Methods in ISPClientApplicationUI Interface for information on using the retrieval time to reset the design basis.

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

   

   • The tool adapter retrieves data objects that are transferred in data containers.

   • Metadata containers include one file object for each view file associated with the document.

   • File objects instantiate the IFile interface, which exposes the FilePath property, which points to the absolute path of the file. Tools should copy the file from this path to their local path.

   • File objects can be added 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 in Methods (ISPAdapter) for details.