RetrieveDocument - SmartPlant Foundation - IM Update 48 - Help - Hexagon

This function controls the retrieval of data from the data warehouse. The key points about the methods are:

1. A call is made to PreRetrieveData first (to allow for customization).

2. The domain of the document being retrieved is determined and subsequently stamped on any properties instantiated as a result of the retrieve.

3. Key elements of the map file are read into arrays to improve performance.

4. The view file is downloaded if the RetrieveViewFile parameter is set to True in the adapter header file.

5. The metadata file is read, and the document variables are stored away so that if a design basis document is created later, it can be created with the same information as it is stored in the data warehouse.

6. The data file is read, and if a mapping is found, a load file is generated in the authoring schema. While the data is being processed, and if the item is a class definition (and is also mapped), then a call is made to the function AutoExpandClassDef to allow for enhanced mapping.

7. The tombstone file is read, and any delete instructions found are extracted. The Same As objects are read and checked against the authoring database, and if any exist, a new delete instruction (with the UID of the authoring item) is created and added to the file.

8. A call is made to PostProcessRetrievedObjects to allow for further customization if needed.

9. The data is serialized.