For connecting to SmartPlant Foundation to work for a particular application, the following objects must exist in the SmartPlant schema or the tool map schema:
-
Tool (SmartPlant schema object) - Defines the existence of the application in the context of the SmartPlant schema. Sets certain properties, such as the metadata adapter progID, needed for proper functional behavior.
-
ToolSchema (SmartPlant schema object) - Defines the existence of a tool map schema in the context of the schema.
-
SPMapSoftware (tool map schema object) - Ties the tool map schema to the corresponding ToolSchema object in the SmartPlant schema.
The following UML diagram illustrates the relationships among these objects and the properties exposed by the interfaces for these objects:
If the Tool, ToolSchema, or SPMapSoftware objects or the corresponding relationships are missing for a particular application, then that application is not available via the Edit Engineering Tool Options command. If an application is not available due to one or more of these objects being missing, use the Add Application/Map Schema button on the Application Metadata tab of the Workflows dialog box to define the objects and relationships in the Define Tool/Map Schema dialog box.
Selecting a tool from the Registered tool list displays whatever information has been defined for that application.
Tool Object
If a Tool object exists for the application, then the Name for that Tool object appears under Tool object. If the Tool object does not exist, you can create one by clicking Create button under Tool object to display the Edit Tool Definition dialog box.
If the Tool object already exists for the specified application, the progID specified for the metadata adapter is used to activate the specified DLL/software class. Alternatively, if the user creates a Tool object for the specified application, the software attempts to activate the metadata adapter when the user clicks OK.
If the metadata adapter is successfully activated, the Status text under Metadata adapter in the Define Tool/Map Schema dialog box reflects that the metadata adapter has been activated. If the specified metadata adapter cannot be activated, then an error message appears, and the Status text reflects this failure.
ToolSchema Object
If the Tool object is related to one or more ToolSchema objects, then the Name list under ToolSchema in the Define Tool/Map Schema dialog box lists these ToolSchema objects. Selecting one of these objects activates the Edit button, and, if the map schema for that application has been loaded, the software attempts to locate the SPMapSoftware object that is related to the ToolSchema object.
If no ToolSchema object exists, then the Create button can be used to create the ToolSchema object in the Edit Tool Schema Definition dialog box.
SPMapSoftware Object
To determine if the SPMapSoftware object exists, you can use the File > SmartPlant > Edit Engineering Tool Options command and select the desired application. When you click Finish after synchronization is completed, Map Environment that appears should include the selected application in the tree view. If expanding this application in the tree view in the Map Environment fails to show the data for that application, then the SPMapSoftware object is missing and needs to be created.
To create the missing SPMapSoftware object, click Create under MapSoftware in the Define Tool/Map Schema dialog box. The dialog box for creating/editing the SPMapSoftware object is shown in the following graphic:
The Schema Editor, when working with application metadata adapters, relies on the version supported information in the SPMapSoftware object. If the SPMapSoftware object for a given application doesn't indicate support for the version of the schema being used, then a message will be displayed to the user warning him about proceeding.