Headers in the CSV import file for OPC Client - OPC Client 3.1

OPC Client Plugin Guide 3.1

series
OPC Client 3.1
revised_modified
2019-03-25

The CSV file contains the information used to create entities and their properties in Security Center.

In the CSV file, you specify the location of an OPC tag on the OPC server, choose which entity properties to import, and map those properties to an entity type that is defined in the XML type definition file.

The CSV headers listed as required in the following table must be included in the first line of the CSV file. Headers listed as optional can be omitted if they are not used by entities in the file.

CSV header Include in file Description
ENTITY_NAME Required Name for the new custom entity in Security Center.
NOTE: Properties imported for the same entity must share the same entity name.
TYPE_NAME Required Name of an entity type that is defined in TypeName field of the XML file.
PROPERTY_ID Required ID of the property in the external system that is defined in the PropertyID field of the XML file.
DISPLAY_NAME Optional Name for the property that is displayed in Security Center.
NOTE: If you do not include this parameter in the CSV file, the DisplayName defined in the XML file is used.
NODE_ID Required ID of the node for the OPC tag to read on the OPC server.
NOTE: Use the following format: nsu=<namespaceUri>;<identifier_type_flag>=<identifier>
UNIT Optional The unit of measurement for the property.
NOTE: If you do not include this parameter, the Unit that is defined in the XML file is used.
UNITSYMBOL Optional The symbol for the unit of measurement for the property.
NOTE: If you do not include this parameter, the UnitSymbol that is defined in the XML file is used.
In the following example, the entity type FireDetector is defined in the XML type definition file.
<EntityTypes>
  <EntityType>
    <Manufacturer>Genetec</Manufacturer>
    <TypeName>FireDetector3</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>
      <Property>
        <PropertyId>Property2</PropertyId>
        <DisplayName>Temperature</DisplayName>
        <Type>System.Int32</Type>
        <Unit>Celsius</Unit>
        <UnitSymbol>°C</UnitSymbol>
      </Property>
    </Properties>
  </EntityType>
</EntityTypes>

The following image shows the corresponding CSV file, which imports three Security Center entities of the type FireDetector: EntityA, EntityB, and EntityC, each with two properties.

  • Entities EntityA, EntityB, and EntityC are mapped to the entity type FireDetector.
  • The properties of EntityA and EntityB will be displayed in Security Center as Temperature, as defined in the XML type definition file.
  • The properties of EntityC will be displayed in Security Center as Temperature 1 and Temperature 2, even though Temperature is configured as the DisplayName in the XML file. The DISPLAY_NAME value in the CSV file overrides the DisplayName value in the XML file.
  • No UNIT or UNITSYMBOL values are included in the CSV file, so they are taken from the XML file.