SmartPlant Common UI Adapter DLLs - 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)

When the SmartPlant Test Tool executable issues commands to the SmartPlant Common UI, the Common UI needs to get various types of information from the tool. The Common UI does this using DLLs provided by the tool.

The SmartPlant Test Tool passes information about how the Common UI can connect to these DLLs when it connects to the Common UI. The Common UI can create objects and call methods from these DLLs because the DLLs were written to conform to interfaces provided by the SmartPlant Client. Every integrated tool must provide DLLs that conform to these two interfaces so that the Common UI can communicate with the tool. These interfaces may be combined in a single DLL.

IEFToolDocs

The tool documents DLL conforms to the IEFToolDocs.IEFToolDocs interface. For the SmartPlant Test Tool, it is EFTestToolToolDocs.dll. This DLL puts document information into objects needed during publishing. Among other things, this DLL tells the Common UI which documents to publish.

IEFAdapter

The adapter DLL conforms to the IEFAdapter.IEFAdapter interface. For the SmartPlant Test Tool, it is EFTestToolAdapter.dll. This DLL provides many different types of information to the Common UI through its many methods and properties. For example, the method PublishDocument fills an IContainer object with the objects that the tool publishes for a document. That is, PublishDocument takes tool-specific data and creates Schema-Component-style objects that are mapped to tool data types.

See Also

SmartPlant Test Tool as a Model for Integrated Tools