Create a Map Enumerated List Definition - 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)

When you create a map enumerated list definition, you must create the enumerated list definition and then define the enumerated list entries that the list contains.

  1. After you open the tool map schema that you want to edit in the Schema Editor, click View > Tool Schema.

  2. Click Options on the View Schema dialog box.

  3. On the View tab, click Editor, and then click OK.

    SHARED Tip If you do not see the View tab, the View dialog box is in Simple mode. Click Editor in the Form list instead.

  4. In the Tool Schema Editor UML window, double-click SPMapEnumListDef in the Create tree.

    SHARED Tip You can also create map enumerated list definitions by double-clicking the SPMapEnumListDef node in any tree view in any Schema Editor view.

  5. In the Short description box, type the name of the enumerated list.

  6. In the Select criteria box, define the criteria that the tool adapter uses to select or identify objects for this tool enumerated list definition and its entries. See the mapping rules for your authoring tool for how to set the value for this property.

  7. In the Process criteria box, define the criteria that the adapter uses to process objects that are instances of this tool enumerated list definition and its enumerations. See the mapping rules for your authoring tool for how to set the value for this property.

  8. To define the SmartPlant schema enumerated list type that the tool enumerated list definition maps to for publish, click beside the Maps to box, and select the SmartPlant enumerated list type.

  9. To define the SmartPlant schema enumerated list type that maps to the tool map enumerated list definition for retrieve, click beside the Mapped from box, and select the SmartPlant enumerated list type.

  10. To define the tool map properties that this list defines values for, click beside the Scoped map properties box, and select the map property definitions that are scoped by this map enumerated list.

  11. To create an enumerated list entry (MapEnum) for this map enumerated list, click New Child in the New Map Enumerated List Definition dialog box.

    SHARED Tip If you have a spreadsheet containing your list entries, you can copy them to the Clipboard and then add them to the list using the Import Clipboard Entries button. For more information, see Import Enumerated List Entries from a Spreadsheet.

  12. In the Short description box, type the name of the enumerated list entry.

    Mapping_EnumListEntry

    SHARED Tip When you move out of the Short description box, the new enumerated list entry is automatically added to the Map enumerated list definition tree.

    Mapping_EnumList_Tree

  13. If a secondary numeric key identified the enumerated list entry, type the key in the Number box.

  14. In the Select criteria box, define the criteria that the tool adapter uses to select or identify objects for this tool enumerated list entry. See the mapping rules for your authoring tool for how to set the value for this property.

  15. In the Process criteria box, define the criteria that the adapter uses to process objects that are instances of this tool enumerated list entry. See the mapping rules for your authoring tool for how to set the value for this property.

  16. To create additional list entries, click New Sibling, and repeat steps 12-15 for each entry that you want to add.

  17. To save your changes, click OK.

For some authoring tools, you must change the system-generated UID so that the adapter can correlate the enumerated list and its entries with the appropriate enumerated list and entries in the tool database. For example, for Smart P&ID, you must replace the system-generated UID for the map enumerated list and the list entries with UIDs from the Smart P&ID database. For more information, see the rules for your authoring tool in the tool documentation. To change the system-generated UID, click Change UID.

  • If the map enumerated list constrains other enumerated lists or list entries in the authoring tool map schema, you can select the effected tool enumerated lists by selected the enumerated list name in the tree view, and then clicking beside the Constrains box. Constrains relationships define tool enumerated list hierarchies much like the contains relationships define enumerated list hierarchies in the SmartPlant schema.

  • If the map enumerated list is constrained by another enumerated list, you can select the tool enumerated lists that constrains this one by selecting the enumerated list in the tree view, and then clicking beside the Constrained by box.

  • To view properties for the map enumerated list or enumerated list entries, click the list or entry in the tree view.

  • As you add enumerated list entries to the list, the software adds them to the Contains box for the map enumerated list definition.

  • When you define enumerated list entries, the ContainedIn box is automatically populated with the map enumerated list name. However, you can change the map enumerated list for an enumerated list entry by clicking beside the ContainedIn box and selecting another map enumerated list. The enumerated entry is automatically moved to the selected map enumerated list.