Modifying the SmartPlant schema for integration, including performing mapping for tools with metadata adapters, requires the following:
-
Check out the SmartPlant schema CMF file from the SmartPlant Foundation Desktop Client.
-
Make sure your scope is set to the plant, right-click the new revision of the CMF file in SmartPlant Foundation, and click Launch Schema Editor. This provides the Schema Editor with the appropriate plant and SmartPlant Foundation site for connection.
-
Select the schema version or versions that you want to view in the Specify configurations to display window of the Active Configurations dialog box.
-
Click the Advanced button on the Active Configurations dialog box to view the Set Configurations for new objects window, where you can specify what version or versions of the schema changes should be written to. For example, to modify the 2019 schema, select the 2019 configuration for new objects.
By default, all configurations are checked to allow forward and backward compatibility
between schema versions when creating new objects or modifying existing objects.
-
Click File > SmartPlant > Edit Engineering Tool Options to activate the authoring tool metadata adapters.
For every application registered against that plant, the software checks to see if a Tool object exists for that application in this schema file. If not, an information message indicates the need for the Tool object. If the software finds a Tool object, it attempts to launch the metadata adapter specified in that Tool object (if the metadata adapter doesn't get activated, then an information message indicates this failure).
For every ToolSchema object that traces back to a Tool object in the schema and for which the metadata adapter for that Tool was successfully activated, the software adds an entry for that authoring tool to the list on the Engineering Applications dialog box. Selecting an authoring tool entry in the list enables the check boxes under Startup options for that application/map schema combination.
Selecting the Load map schema check box indicates that the software should open and parse the map schema file. Selecting Connect to application schema indicates that software should extract the application's metadata, compare it with that for the loaded map schema, and perform the synchronization process. By default, this synchronization process displays a window that shows the differences resulting from the comparison of the application's metadata with the map schema file. Selecting the Automatically synchronize schemas check box bypasses this user interface and uses the default (software selected) choices for synchronizing the schema.
Although Load map schema and Connect to application schema are separate check boxes, the current tool metadata adapters require that either both or neither of these check boxes are selected. Therefore, selecting Load map schema also selects Connect to application schema. This is referred to as connected mode, which is currently required by all tool metadata adapters.
For more information about connecting to SmartPlant Foundation and synchronizing tool map schemas with tool metadata, see Synchronize Tool Metadata with the Tool Map Schema.