Register tool - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

Before any data can be published, the authoring environment must be registered with the data warehouse. A method and menu option has to be configured to do this. The FrameworkRegisterInt client API is used to configure interactive tool registration. For more information about the client API behind registration, see FrameworkRegisterInt client API .

Tool Adapter Program ID

This is the reference to the COM prog ID of the SmartPlant Foundation Adapter. An example of which is SPFAdapter.TEF.Adapters.SPFTEFAdapterGEN. This is the general adapter supplied with SmartPlant Foundation that can perform the basic publish and retrieve operations. Customers can create their own adapters that inherit from SPFTEFAdapterGEN to override some adapter behavior.

The reference given above is typically the name given to a .NET assembly that is compiled with the COM registration radio button selected.

Domain

This is the name of the authoring domain in which the data will be instantiated, for example, ProcessD. When the comparison is made, the UIDs contained in the file are checked against the authoring database in the domain specified.

Adapter Code

This is the code used to represent the SmartPlant Foundation tool and is used to find the relevant adapter document via its adapter code property value, for example PA.

Database Code

This enables SmartPlant Foundation to publish and retrieve from a different database, but it is not supported at this time, so this argument is left blank.

The register method should be exposed through the SmartPlant menu. It is recommended that a new sub-menu is created for each application as shown below.