Create and Map New Enumerated List Entries 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 New Enumerated List Entry in the Authoring Tool

  • Use the appropriate authoring tool software to add the new enumerated list entry to an existing enumerated list in the authoring tool metadata database.

    For example, for Smart P&ID or Smart Electrical, add a new select list entry to the appropriate select list in Data Dictionary Manager.

    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 the Map Enumerated List

  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 enumerated list entry that you added in the authoring tool appears in the Synchronization dialog box to be added to the tool map schema file.

    Mapping_EnumEntryfromTool_Synch

  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.

  4. Expand the Map Enumerated List node and double-click the map enumerated list to which you added the new list entry.

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.

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

  2. Above Unmapped SmartPlant enumerations on the right side of the dialog box, click New SmartPlant Enumeration on the toolbar.

  3. In the New Enumerated Entry dialog box, type the name and long description for the new enumerated list entry, and click OK.

    Mapping_NewSPEnumEntryProperties

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

Map Tool List Entries to SmartPlant Schema List Entries

  1. In the Unmapped application enumerations table, select the tool enumerated list entry that you want to map.

  2. In the Unmapped SmartPlant enumerations table, select the SmartPlant enumerated list entry 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 Enumerated List Definition dialog box.

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.

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.