Create and Map New Properties with Enumerated Lists Starting in the Tool - Integration - Update 44 - Help - Hexagon

Integration Help

Language
English
Product
Integration
Search by Category
Help
Smart 3D Version
12.1 (2019)
Smart Construction Version
2019(7.0)
SmartPlant Foundation / SDx Version
10
Smart Electrical Version
2019 (9.0)
Smart Materials/Smart Reference Data Version
2020 (10.0)
Smart P&ID Version
9 (2019)
Smart Review Version
2020 (15.0)
Smart Engineering Manager Version
10 (2019)
Smart Interop Publisher Version
13.1 (2019 R1)
Smart Isometrics Version
7.0(2019)
Spoolgen Version
9.0(2019)

The following procedure applies to authoring tools that have metadata adapters. For more information, see Before You Begin Mapping for Tools with Metadata Adapters.

Create the Enumerated List, List Entries, and Property in the Authoring Tool

  • Use the appropriate authoring tool software to add new enumerated list, enumerated list entries, and property that uses the enumerated list to the authoring tool metadata database. Be sure to set the data type to string for a string property.

    For example, for Smart P&ID or Smart Electrical, create a new select list, add entries to the select list, and then create a property associated with the new select list in the appropriate database table in Data Dictionary Manager. The new property should have a data type of select list and a relationship to the select list that you created.

    SHARED Tip Terminology for enumerated lists differs from tool-to-tool. Some authoring tools call enumerated lists select lists, picklists, codelists, or lookup tables. For more information, see the documentation for the authoring tool for which you want to add metadata.

Load the Tool Map Schema and Open a Map Class Definition

  1. In the Desktop Client, set your scope for the applicable plant, and then find the CMF file.

  2. Right-click the CMF file, and then select Edit > Check Out to display the Check Out dialog.

  3. Select OK.

  4. In the New Items window, right-click the new version of the CMF file, and select Launch Schema Editor.

  5. On the Set Active Configurations dialog, select the schema version that you want to view.For more options, select Advanced.

  6. 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.

  1. 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.

    SHARED Tip The new property, enumerated list, and list entries that you added in the authoring tool appear in the Synchronization dialog box to be added to the tool map schema file. As you can see in the following graphic, if you add a property to the Plant Item table in Data Dictionary Manager for Smart P&ID, multiple map classes inherit that property, and therefore, multiple map classes are updated in the tool map schema during synchronize.

  2. In the Map Environment, expand the Tool node, and then expand the node for the appropriate authoring tool.

  3. 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.

Add the New Enumerated List to the SmartPlant Schema

Before you create the list in the SmartPlant schema, you need to verify that the enumerated list or a list that has an equivalent meaning does not already exist.

  1. To add a new enumerated list to the SmartPlant Schema, expand the Map Enumerated Lists node, and double-click the new map enumerated list in the tree view.

  2. In the Edit Map Enumerated List Definition dialog box, click the Advanced tab.

    The enumerated list and entries that you created in the authoring tool appear in the Map enumerated list definition tree on the Advanced tab.

  3. To create the equivalent list in the SmartPlant schema, click New SmartPlant Enumerated List with Correlated Entries.

    SHARED Tip Once you click this button, the Schema Editor will create a list with the same entries in the SmartPlant schema and automatically map them to the corresponding entries in the map file. It will also prompt you with the option to create the retrieve mapping relationships at the same time. Click Yes to create the retrieve mapping relationships. Click No to create mapping for publish only.

  4. Review the new SmartPlant schema enumerated list and entries in the Created Enumerated List and Entries dialog box, and then click OK to create the enumerated list.

    • You can right-click the list or list entries to make changes before you save the list and its entries in your schema extensions file.

    • The software creates the SmartPlant enumerated list definition and creates the publish map for the authoring tool map enumerated list definition and entries to the new enumerated list definition and entries in the SmartPlant schema.

  5. Click OK in the Edit Map Enumerated List Definition dialog box.

Add the New Property to the SmartPlant Schema

After you add the new enumerated list and its entries to the tool map schema and the SmartPlant schema, you can add the property that is scoped by the new enumerated list.

  1. In the Map Environment, expand the Tool node, and then expand the node for the appropriate authoring tool.

  2. 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.

  3. To add a new property, expand the Map Classes node, and double-click the tool map class to which you want to add the new property.

  4. If you want to start by defining publish mapping for the new property, click the Publish tab.

    If you only want to define retrieve mapping for the enumerated property, you can click the Retrieve tab instead. The procedure for adding properties and mapping is the same for both tabs.

  5. Above Unmapped SmartPlant properties on the right side of the dialog box, click New Property Definition on the toolbar.

  6. In the New Property Definition dialog box, define the new SmartPlant schema property, and click OK to create the property definition. For more information, see Create a Property Definition.

    • By default, the Schema Editor defines the interface definition that exposes the selected property definition based on the tool map class definition you selected. However, the default is only a suggestion based on context, and you can change the interface definitions that expose this property definition in the Exposed by interface definitions box.

    • In the Scoped by property type box, be sure to select the new enumerated list you created previously as the property type for the new property.

    • When you click OK, the new property appears in the Unmapped SmartPlant properties table in the Edit Map Class Definition dialog box.

Map Tool Property to the SmartPlant Schema Property

  1. In the Unmapped application properties table, select the tool map property definition that you want to map.

  2. In the Unmapped SmartPlant properties table, select the SmartPlant property definition that you want to map.

  3. On the toolbar, click Map .

    SHARED Tip The mapping you defined appears in the mapped objects table at the bottom of the dialog box.

  4. 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.

  5. Click OK in the Edit Map Class Definition dialog box.

Save the Tool Map Schema and Schema Extensions File

  1. Click File > Save > Tool Schema File. For some tools, saving the tool map schema also saves changes to the tool metadata database.

  2. To save the changes to your schema extensions file, click File > Save > Schema File.

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.

  • 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.

See Also

Before You Begin Mapping for Tools with Metadata Adapters
Mapping with Metadata Adapters