Implementation Guide › Adapter Configuration Specifications › TranslatorCollection Section

TranslatorCollection Section

The Translator Collection section describes how to translate the parsed and manipulated data source record extracted in previous section to an CA Business Service Insight event.

When the interface mode is "online" the CA Business Service Insight event has a unified structure that contains the following fields:

• Timestamp: The time of event occurrence.
• ResourceId: CA Business Service Insight's Resource Id associated with the event (the resource that was measured , etc.).
• EventTypeId: CA Business Service Insight's Event type associated with the event and describes the type of the event (type of measurement on the resource , type of ticket action , etc.).
• DataSourceId: (optional) the name of the input data source (file name / table name…).
• Value: The value of the event (measurement result, ticket number, etc.). This field can appear more than one time.

When the interface mode is "offline" there are not any limitations on the number of the fields or on their name.

XML Structure:

<TranslatorCollection>
   <Translator TranslatorName="events" OnDuplication = "ignore">
	<TranslatorFields>
		<TranslatorField Name="ResourceId" SourceType="table"
		    SourceName="ResourcesTranslateTable" Iskey="yes"/>
		<TranslatorField Name="EventTypeId"	SourceType="constant"
		    ConstantValue="1002" Iskey="yes"/>
		<TranslatorField Name="Timestamp"  	SourceType="field"
                SourceName="timestamp" Iskey="yes"/>
		<TranslatorField Name="Value" 	SourceType="table"
                SourceName="valueUpDownTranslateTable" Iskey="yes"/>
		< TranslatorField Name="Value"  SourceType ="field"
                SourceName ="nodeName" Iskey="yes"/>
		< TranslatorField Name="Value"  SourceType ="constant"
                Type="integer" ConstantValue="1000" Iskey="yes"/>
		< TranslatorField Name="Value"  SourceType ="field"
                SourceName ="timestamp" TimeShift="-3600"
                TimeShiftFieldName="createDate"	Iskey="yes"/>
		< TranslatorField Name="Value"  SourceType ="lookup"
                SourceName ="ServiceTable" LookupValue="word"
                Iskey="yes"/>
      </TranslatorFields>
   </Translator>
</TranslatorCollection>

• Translator: Describes how to translate the set of fields it receives into the output event.
  • TranslatorName: Name that is used by the InputFormat to send field sets to this translator.
  • OnDuplication: Member that holds "ignore","add", "update", or "updateAlways" value for determining what to do with duplication event (see Event Singularity)
  • TranslatorFields: Contains list of TranslatorField elements, each one of them contains the following attributes:
  • Name: Field name. In online interface it must be Timestamp, ResourceId, EventTypeId,Value or DataSourceId.
  • SourceType:

    field: Value of this field is taken from field in the input format. The SourceName attribute contains the field name.

    table: Value of the field is taken from the translation table. The SourceName attribute contains the table name.

    lookup: Value of this field is taken from the translation table. The SourceName attribute contains the table name. The value to be translated is taken from the LookupValue attribute and not from the input format.

    constant: Value of the field is constant and its value is in the ConstantValue attribute.

  • SourceName: Contains the field name to translation table name.
  • Type: [integer/real/string/time] Required only when the field's type is not predefined (by field name or by SourceType). In online interface it required only for Value field with SourceType=constant. In offline interface it required for each field with SourceType=constant.
  • IsKey: Represents event's unique key. This key is assembled from fields, which were marked as TranslatorFields?IsKey = "yes".

    (See Event Singularity)

  • LookupValue: Contains the lookup value when SourceType="lookup".
  • ConstantValue: Contains the constant value when SourceType=constant. When the field's type is time the constant value is formatted string according to the TimeFormat or "Now" or "NowUtc", where "Now" is the current time in the Data source locale and "NowUtc" is the current time in UTC.
  • TimeFormat: Contains the TimeFormat, required only for fields with SourceType=constant and Type=time.
  • TimeShift: Defines shift time in seconds, only for time fields.
  • TimeShiftFieldName: (optional) Contains field name, from the input format, that contains time shift in seconds. The TimeShift and TimeShiftFieldName can be together.