This topic describes objects and object relationships that are relevant to the Smart Electrical tool schema. Relationship descriptions reference names shown in a diagram that represents the data model of the Smart Electrical tool schema. For details, see Tool Schema Data Model Diagram.
MapClass
The MapClass object corresponds to the IMapClassDef interface in the Tool Schema Data Model diagram. In general, there is a MapClass object in the tool schema for each Smart Electrical class (ItemType) that needs to be published or retrieved. MapClass is referred to as SPMapClassDef in the Schema Editor user interface. The properties and relationships for a MapClass object can be viewed in the Edit Map Class Definition dialog.
General
Property |
Description |
UID |
The property value is required, must be unique, with all characters in upper case. UID of a map class must be SPEL_<CLASSNAME>, where CLASSNAME is the name of a corresponding item type in the Smart Electrical data model. For example, the UID of the Motor class must be SPEL_MOTOR. |
Name |
The property value is required. This property designates the internal name of the Smart Electrical item type, exactly as defined in the Data Dictionary. |
Tool Schema Relationships
Relationship |
Description |
Map Properties |
The map properties associated with the MapClass object must be defined and related to the MapClass object. The relationship name in the diagram is MapClassMapProperties |
Mapping Relationships
Relationship |
Description |
Publish to SmartPlant Class |
This relationship must be set to a class in the SmartPlant schema if this class is to be published. When this relationship is set, an instance of the target class is published for each instance of the source class in the document being published. The relationship name in the diagram is MapClassToClass. |
Retrieve from SmartPlant interface |
The list of interfaces from which properties are to be retrieved must be set if this class is to be used for retrieval. The relationship name in the diagram is ClassToMapClass. |
MapProperty
The MapProperty object corresponds to the IMapPropertyDef interface in the Tool Schema Data Model diagram. In general, there is a MapProperty object in the tool schema for each Smart Electrical property that needs to be published or retrieved. The properties and relationships for a MapProperty object can be viewed in the Edit Map Property Definition dialog.
General
Property |
Description |
UID |
The property value is required, must be unique, with all characters in upper case. UID of a map property must be SPEL_<CLASSNAME>_<PROPERTYNAME>. For example, UID of Motor.ItemTag property must be SPEL_MOTOR_ITEMTAG. |
Name |
The property value is required. This property designates the internal name of the Smart Electrical attribute, as defined in the Data Dictionary. |
Process Criteria |
Process criteria are used when retrieving properties of Smart Electrical objects in the following case:
A relationship is designated by a text string that corresponds to the process criteria setting of the SPEL_A_Property_B property in Smart Electrical. If there are intermediate objects between the mapped SmartPlant schema object and the object in the SmartPlant schema that has the required property, the process criteria of the property in Smart Electrical must contain all relationship definitions of SmartPlant schema objects, separated by a comma delimiter. |
Tool Schema Relationships
Relationship |
Description |
Exposed by Map Classes |
Every MapProperty object must be related to a MapClass object. The relationship name in the diagram is MapClassMapProperties. |
Scoped by Enumeration |
If the data type of the property is enumerated, the MapProperty object must be related to a MapEnumList object. If the data type of the property is UoM, the MapProperty must be related to a MapUoMList object. Otherwise, this relationship is not needed. The relationship name in the diagram is MapPropertyMapEnumList. |
Mapping Relationships
Relationship |
Description |
Map Property to Property |
This relationship defines the property in the SmartPlant schema to which this tool property is to be published. If this relationship is not defined, the property will not be published. The relationship name in the diagram is MapPropertyToProperty. |
Property to Map Property |
This relationship defines the property in the SmartPlant schema from which this tool property is to be retrieved. If this relationship is not defined, the property will not be retrieved. The relationship name in the diagram is PropertyToMapProperty. |
MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the Tool Schema Data Model diagram. In general, there is a MapEnumList object in the tool schema for each Smart Electrical enumerated list associated with a property that needs to be published or retrieved. The properties and relationships for a MapEnumList object can be viewed in the Edit Map Enumerated List Definition dialog.
General
Property |
Description |
UID |
The property value is required, must be unique, characters are not case-sensitive. UID of an enumerated list must be SPEL_<EnumListName>. For example, UID of the YesNo enum list must be SPEL_YesNo. |
Name |
The value of this property is the name of the Smart Electrical enum list. |
Tool Schema Relationships
Relationship |
Description |
Scoped Map Properties |
A MapEnumList object must be related to the MapProperty objects that it scopes. The relationship name in the diagram is MapPropertyMapEnumList. |
Contains |
A MapEnumList object can contain a variable number of MapEnum objects. The relationship name in the diagram is MapEnumListMapEnum. |
Mapping Relationships
Relationship |
Description |
Maps To |
To support the publish operation, a MapEnumList object should be related to the corresponding enum list in the SmartPlant schema by means of the Maps To relationship. The relationship name in the diagram is MapEnumListToEnumList. |
Maps From |
To support the retrieve operation, a MapEnumList object should be related to the corresponding enum list in the SmartPlant schema by means of the Mapped From relationship. The relationship name in the diagram is EnumListToMapEnumList. |
MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the Tool Schema Data Model diagram. In general, there is a MapEnum object in the tool schema for each Smart Electrical enumerated list entry that needs to be mapped. The properties and relationships for a MapEnum object can be viewed in the Edit Map Enumerated List Definition dialog (the same dialog is used for MapEnumList objects.)
General
Property |
Description |
UID |
The property value must be unique. UID of an enumerated list entry must be SPEL_<EnumListName>_<CodelistIndex>, where CodelistIndex is the value of the index of the corresponding select list entry in the Smart Electrical data model. Values of codelist index are stored in the Data Dictionary table CODELISTS. For example, UID of the Yes entry of the YesNo enum list must be SPEL_YesNo_1. |
Name |
The value of this property is a text setting of the Smart Electrical enum list entry. |
Tool Schema Relationships
Relationship |
Description |
Contained In |
Every MapEnum object must be related to a MapEnumList object. The relationship name in the diagram is MapEnumListMapEnum. |
Mapping Relationships
Relationship |
Description |
Maps To |
This relationship defines the SmartPlant schema enum value to which this Smart Electrical enum value is to be published. If this relationship is not defined, the enum value will not be published. The relationship name in the diagram is MapEnumToEnum. |
Maps From |
This relationship defines the Smart Electrical enum value to which the SmartPlant schema enum value is to be retrieved. If this relationship is not defined, the enum value will not be retrieved. The relationship name in the diagram is EnumToMapEnum. |