Event Data Template Fields

Event Data Template Fields
casp1032
The following table describes the fields in the Event Data Template. Each event must contain the required vardata items to be processed by the Southbound Gateway.
If the event received does not conform to the Event Data Template, an event with an ID 0x03dc0000 is generated against the EventAdmin model.
Variable ID
Name
Type
Description
Required/Optional
1
Unique ID 1
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
 
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
2
Unique ID 2
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
 
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
3
Unique ID 3
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
 
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
4
Unique ID 4
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
 
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
5
Unique ID 5
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
 
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
6
Unique ID 6
String/Integer
The Unique ID variables are used to identify a target EventModel by a Unique Identifier string. The Unique Identifier is a composite of up to six variable data items (one to six). The final unique identifier string is composed as follows:
<1>_<2>_<3>_<4>_ <5>_<6>
in that exact order. If one of the components is not provided, it is not included within the composite unique identifier. If an existing EventModel with the Unique Identifier string cannot be found one is created.
Either one unique identifier or a Target Name (field 7) or Target Address (field 8) is required.
 NA 
7
Target Name
String
This field lets you specify a target model by model name.
An EventModel is not created if a target model is not found using a Target Name event variable. However, if event variable 7 (Target Name) or event variable 16 (Target Name Case Insensitive) is used with the 'unique id' event variable (1-6), the unique id field is used to identify the model.
8
Target Address
Octet/Text String
This field lets you specify a target model by IP address. Use this field if you want to send the event to a model other than an EventModel.
9
Reserved for future CA use
10
EventModel Name
String/Integer
This field provides the ability to assign a model name that is different than the unique identifier. If this data is not provided, the composite unique identifier becomes the model name.
Optional
11
Model Class
Integer
Populates the Model Class attribute of the target EventModel with the value specified in this event variable.
Optional
12
Reserved for future CA use
13
Network Address
Octet/Text String
Populates the Network Address attribute of the target EventModel with the value specified in this event variable.
Optional
14
MAC Address
Octet/Text String
Populates the MAC Address attribute of the target EventModel with the value specified in this event variable.
Optional
15
Manufacturer
String
Populates the Manufacturer attribute of the target EventModel with the value specified in this event variable.
Optional
16
Target Name Case Insensitive
String
This field lets you specify a target model by model name.
An EventModel is not created if a target model is not found using a Target Name Case Insensitive event variable. However, if event variable 7 (Target Name) or event variable 16 (Target Name Case Insensitive) is used with the 'unique id' event variable (1-6), the unique id field is used to identify the model.
17-99
Reserved for future CA use
Any other variable ID greater than or equal to 100.
Any Data
Any Type
This data is forwarded to the EventModel model unchanged. The data type and data are preserved. This data can be viewed within an event message.
Optional