Map Enumerated List and Map Unit of Measure List Mapping - 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)

Tool map enumerated lists and map unit of measure lists need to be mapped into (for publish) and out of (for retrieve) the SmartPlant schema. This is necessary for tool map properties that are scoped by an enumerated list or a unit of measure list to properly exchange their values with other applications.

Like map classes and their map properties, there are also two methods by which map enumerated lists and their map enumerations or map unit of measure lists and their map units of measure can be mapped. One method is to define the mapping using separate forms activated from the Overview tab, and the other method is to use the Publish and Retrieve tabs. Before you begin mapping map enumerated lists and map unit of measure lists, you need to understand the map schema model that is used for modeling map enumerated lists and map enumerations.

SHARED Tip The SmartPlant Foundation property AllowUoMValueAsText is set to False by default and allows the property to be published using the UoM set in the authoring tool. The mapped value will publish as a string if you set the property to True.

Defining Map Enumerations and Their Relationships

Using the Advanced tab of the Edit window for map enumerated lists (SPMapEnumListDef), you can view and modify the complete definition of the map enumerated list. The Advanced tab for the ConstructionStatuses enumerated list appears in the following graphic. The MapEnumListMapEnum relationships between the map enumerated list ConstructionStatuses and its map enumerations are depicted in the Contains box, and the MapEnumListMapEnumList relationship between ConstructionStatuses and ConstructionStatuses2 is shown in the Constrains box.

If you select a node from the tree view on the left, the options on the right update accordingly. For example, selecting the To be relocated node from the tree view looks like the following. The MapEnumMapEnum relationship between To be relocated and Existing appears in the Constrained by box.

Several buttons in this window can be used to create new map enumerations, including New Child, New Sibling, and Import Clipboard Entries. If you create a new second level entry, such as To be relocated, it should be related to the appropriate first level entry using the Constrained by field.

This same dialog box is used for map unit of measure lists. However, all map unit of measure lists are one level. Therefore, the Constrains and Constrained by options should never be used for map units of measure.

Mapping Using the Separate Mapping Forms

On the Advanced tab, there are several buttons that can be used to define the mapping between map enumerated lists or unit of measure lists and the corresponding SmartPlant enumerated lists or unit of measure lists.

You can use the New SmartPlant Enumerated List with Correlated Entries button to create a new SmartPlant enumerated list of the same name and with the same entries and structure as exists for the map enumerated list. At the same time, the map enumerated list is mapped to the new SmartPlant enumerated list, and each of the map enumerations gets mapped to the corresponding SmartPlant enumerations. While this command makes the whole mapping process very simple, you should use it only when there is no existing list in the SmartPlant schema that can be used instead. Creating a new SmartPlant enumerated list when a suitable one already exists introduces ambiguity into the SmartPlant schema.

The Publish Map, Retrieve Map, and Publish and Retrieve Maps buttons display separate windows that can be used to define the mapping. All of these windows work by dragging a node from a tree view on one side of the window and dropping it in the appropriate column of the table on the other side of the window.

To establish a map relationship using the Publish Map for Tool Enumerated List window, you can drag an enumeration from the SmartPlant schema tree control on the right and drop it in the Enum column in the table for the appropriate map enumeration.

To create a map relationship using the Retrieve Map for Tool Enumerated List window, drag a map enumeration from the tool schema tree on the right and drop it in the Map Enum column in the table for the appropriate enumeration.

To create a publish map relationship using the Publish and Retrieve Maps for Tool Enumerated List window, drag a map enumeration from the tool schema tree and drop it in the From Map Enum column in the table. To create a retrieve map relationship, drag a map enumeration from the tool schema tree and drop it in the To Map Enum column.

Mapping Using the Publish and Retrieve Tabs

The Publish and Retrieve tabs on the Edit window for map enumerated lists and map unit of measure lists can also be used to define the mapping between the map enumerated lists or map unit of measure lists and the corresponding SmartPlant enumerated lists or unit of measure lists. These tabs are similar to the corresponding tabs for defining the mapping for a map class and its map properties.

The tree views at the top of the window display the map enumerated list and the corresponding enumerated list. Clicking a node in one of the tree views either filters the content displayed in the lower tables or selects a row in one of these tables. The toolbars on the left and right sides control the display of the table beneath them.

Selecting a row from the Unmapped application enumerations table and a row from the Unmapped SmartPlant enumerations table, and then clicking Map establishes a map relationship between the selected enumerations.

Selecting one or more rows from the bottom table and then clicking Unmap results in the deletion of those map relationships.

Selecting one or more rows from the bottom table and then clicking Enable/Disable enable-disableicon disables map relationships that are enabled, or enables map relationships that are disabled.

MappingExample35

See Also

Tool Map Schemas