The following procedure applies to authoring tools that have metadata adapters. For more information, see Before You Begin Mapping for Tools with Metadata Adapters.
Load the Tool Map Schema and Open the Map Enumerated List
-
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.
-
In the Map Environment, expand the Tool node, and then expand the node for the appropriate authoring tool.
-
Under the authoring tool node in the tree view, expand Loaded Map Schemas and the <Authoring Tool> Tool Schema node to display contents of the authoring tool map schema.
-
To add new entries to an existing enumerated list, expand the Map Enumerated List node and double-click the map enumerated list that you want to modify.
Add the New List Entries to the SmartPlant Schema
Before you add new entries to the SmartPlant schema, you need to verify that the entries or entries that have equivalent meanings do not already exist.
-
If you want to start by defining publish mapping for the new list entry, click the Publish tab.
If you only want to define retrieve mapping for the enumerated entry, you can click the Retrieve tab instead. The procedure for adding enumerated entries and mapping is the same for both tabs.
-
Above Unmapped SmartPlant enumerations on the right side of the dialog box, click New SmartPlant Enumeration
on the toolbar.
-
In the New Enumerated Entry dialog box, type the name and long description for the new enumerated list entry, and click OK.
-
The Schema Editor automatically provides number for the enumerated list entry. This number may need to be modified to match the corresponding codelist value if the entry will be mapped with Smart 3D.
-
When you click OK, the new list entry appears in the Unmapped SmartPlant enumerations table in the Edit Map Enumerated List Definition dialog box.
-
Add the New List Entries to the Tool Map Schema and Metadata
-
Above Unmapped application enumerations on the left side of the dialog box, click New Application Enumeration
on the toolbar.
-
In the New SPMapEnumDef dialog box, type the name and long description for the new enumerated list entry, and click OK.
-
The metadata adapter automatically fills in the appropriate unique identifier for the enumerated list entry.
-
When you click OK, the new list entry appears in the Unmapped SmartPlant enumerations table in the Edit Map Enumerated List Definition dialog box.
-
For some authoring tools, such as Smart Instrumentation, changes to the metadata
in the tool database are made automatically when you add the object to the tool map
schema. For other authoring tools, changes are only saved when you click File > Save > Tool Schema File command in the Schema Editor to save the tool map schema. This allows you to cancel
your changes when you are adding new tool properties, enumerated lists, or enumerated
entries before you save the tool map schema. For more information, see Mapping with Metadata Adapters.
Map Tool List Entries to SmartPlant Schema List Entries
-
In the Unmapped application enumerations table, select the tool enumerated list entry that you want to map.
For Smart 3D, mapping for enumerated list entries is done using the index number
assigned to the enumerated list entry. Therefore, you are not required to do any mapping
in the Map Environment for Smart 3D enumerated list entries once the appropriate entries are added to the
SmartPlant schema and the tool map schema and metadata.
-
In the Unmapped SmartPlant enumerations table, select the SmartPlant enumerated list entry that you want to map.
-
On the toolbar, click Map
.
The mapping you defined appears in the mapped objects table at the bottom of the
dialog box.
-
If you want to define both publish and retrieve mapping for the enumerated list entry, click the Retrieve tab, and repeat steps 1-3 in this procedure.
-
Click OK in the Edit Map Enumerated List Definition dialog box.
Defining mapping for an object does not necessarily mean that you can publish and
retrieve that object. The authoring tool adapter determines the objects that you can
publish and retrieve. For more information, see rules for your authoring tool in the
tool documentation.
Save the Tool Map Schema and Schema Extensions File
-
Click File > Save > All Modified Files to save the SmartPlant schema extensions and the tool map schema. For some tools, saving the tool map schema also saves changes to the tool metadata database.
-
When you close the Schema Editor, the software prompts you to save your connection information, user interface options, and loaded tool map schemas to a session file. Select Yes in the message box to save the session file so that you can use it to return to this working environment. However, you should not open a session file after launching the CMF file from the Desktop Client.
-
If you save changes to the CMF file or a tool map schema but did not validate the changes before exiting, the software displays an information message to remind you that the file contains changes that have not been validated. Select OK to dismiss the message.
-
If you make changes to the SmartPlant schema, you must load the changes into the SmartPlant Foundation database.
Propagating the Enumerated List Entry to Other Authoring Tools Using Compare
-
After you add new objects to the SmartPlant schema, do a compare with other authoring tool map schemas to identify changes that need to be made in the other authoring tools and then add new objects and define mapping in the Map Environment. For more information, see Compare a Tool Map Schema to the SmartPlant Schema.