After you add new objects to the SmartPlant schema, you can compare the SmartPlant schema to authoring tool map schemas to determine whether equivalent objects in the tool map schema have been mapped. Comparing tool map schemas to the SmartPlant schema is especially useful when you add new objects in the process of defining mapping one tool and need to identify and copy those changes out to other authoring tools.
Load the Tool Map Schema and Compare
-
In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.
-
Right-click the CMF file, and then select Edit > Check Out to display the Check Out dialog.
-
Select OK.
-
In the New Items window, right-click the new version of the CMF file, and select Launch Schema Editor.
-
On the Set Active Configurations dialog, select the schema version that you want to view.For more options, select Advanced.
-
Select OK to set the configuration.
-
The CMF file must be checked in to SmartPlant Foundation before users can publish from an authoring tool.
-
By default, changes to the SmartPlant Schema are written to all versions managed by the CMF file. Although you can choose to write changes to only selected versions, we do not recommend doing so.
If you choose to view one version of the schema (Specify configurations to display window) but write changes to all versions (Set Configurations for new objects window), an information window appears when you select OK, indicating that you will be prompted with every change to the schema to confirm that you want to write the changes to all versions. Select OK to continue.
-
In the Schema Editor, synchronize the authoring tool map schema for which you want to define mapping. For more information, see Synchronize Tool Metadata with the Tool Map Schema.
-
Click File > SmartPlant > Compare (Active Tool Schema) With Schema.
Results of the comparison appear in a tree view in the View Comparison Results window.
-
The following colors have special meaning in the View Comparison Results window.
-
Green - Fully mapped
-
Red - Not mapped
-
Blue - Incomplete mapping
-
-
The Schema Editor does not take retrieve mapping into account during comparison. After you resolve all the outstanding issues for publish mapping for an object, the object name changes to green in the tree view even if the retrieve mapping is not defined.
-
-
To review differences, expand the nodes in the tree view.
-
Click an object to review its publish and retrieve mapping on the Publish and Retrieve tabs in the View Comparison Results window.
Mark Objects that You Do Not Want to Map
You can resolve differences between your tool map schema and the SmartPlant schema in a variety of ways. For example, you can mark properties or class definitions that you do not want to be mapped. These objects to not appear in the Map Environment or in the View Comparison Results tree.
-
Click Set "Not to be Mapped" and then click the type of object that you want to exclude from mapping.
-
In the Map <object type> to map list, select the objects that you want to exclude from mapping, and then click Remove.
-
Click OK to save the changes.
If you decide to map the objects later, you can make them available for mapping by
selecting the objects in the Map <objects> Not to be Mapped list and then clicking Add.
Map Tool Objects to SmartPlant Schema Objects
-
In the tree view, select the object that is unmapped or partially mapped.
Information for the selected object appears on the Edit Form tab.
-
On the Overview tab, make sure that the publish to and retrieve from objects are defined properly.
-
Map class definitions can be mapped using view definitions. View definitions allow you to see properties categorically. If a view definition does not exist for the interface definition that you want to map to, the Schema Editor generates a view definition automatically for mapping. The software does not save this view definition. In future releases, additional mapping view definitions will be delivered to make mapping easier.
-
If a map class definition or an enumerated list definition have objects defined for both publish and retrieve, then the inconsistency could be in the map property definitions for the map class definition or the enumerated entries for the map enumerated list definition. To continue resolving inconsistencies, see step 3.
-
-
On the Publish and Retrieve tabs, review publish and retrieve mapping for map property definitions if you selected a map class definition or map enumerated entries if you selected a map enumerated list.
-
If map property definitions or map enumerated list entries are missing on the authoring tool side, click New
on the toolbar and create the object.
-
If objects that need to be mapped are not mapped, select the objects that you want to map and click Map
.
Save the Tool Map Schema
-
Click File > Save > Tool Schema File to save the tool map schema. For some tools, saving the tool map schema also saves changes to the tool metadata database.