How entity types are defined in XML type definition files - OPC Client 3.1

OPC Client Plugin Guide 3.1

series
OPC Client 3.1
revised_modified
2019-03-25

The XML type definition file defines the entity types that the OPC Client plugin will be able to create in Security Center.

Each entity type in the XML file must include a name and property definitions.
The XML tags in the following table are listed as required or optional for each entity type:
XML tag Include in file Description
Manufacturer Optional Manufacturer of the device that will be mapped to the entity type.
TypeName Required Name for the custom entity type in Security Center.
NOTE: This value must be unique.
Description Optional Description for the entity type.
PropertyID Required Identifier for this property.
NOTE: This value must be unique for a given entity type.
DisplayName Optional Name for the property that is displayed in Security Center.
NOTE: If this field is left empty, the PropertyID value is used instead. The DisplayName field can also be overridden by the Display_Name column in the CSV file.
Type Required Data type of the property, which indicates how you can interact with the property value in Security Center. Use one of the following standard .NET data types:
  • System.Boolean
  • System.Double
  • System.Single
  • System.String
  • System.Int16
  • System.UInt16
  • System.Int32
  • System.UInt32
  • System.Int64
  • System.UInt64
  • System.Byte
  • System.SByte
Unit Optional The unit of measurement for the property.
NOTE: If this field is left empty, the UNIT value in the CSV file is used.
UnitSymbol Optional The symbol for the unit of measurement for the property.
NOTE: If this field is left empty, the UNITSYMBOL value in the CSV file is used.
The following section of code defines an entity type called FireDetector. When an entity of this type is imported in Security Center, its Property1 integer is displayed as Temperature.
<EntityTypes>
  <EntityType>
    <Manufacturer>Genetec</Manufacturer>
    <TypeName>FireDetector</TypeName>
    <Description>Example entity type</Description>
    <Properties>
      <Property>
        <PropertyId>Property1</PropertyId>
        <DisplayName>Temperature</DisplayName>
        <Type>System.Int32</Type>
        <Unit>Fahrenheit</Unit>
        <UnitSymbol>°F</UnitSymbol>
      </Property>
    </Properties>
  </EntityType>
</EntityTypes>