Implementation Guide › Implementation › Data Gathering (Data Source Expert) › How to Configure Adapters and Translations › File Adapter Case Study › Configuration File TranslatorCollection Section

Configuration File TranslatorCollection Section

The Translator Collection section defines how the parsed and manipulated data source record extracted in previous sections will be translated into an CA Business Service Insight Event.

This section also defines how to handle duplicate Events and how to use the Event singularity mechanism (for further details see Event Singularity).

When the interface mode is set to online, the CA Business Service Insight Event has a unified structure that contains the following fields:

• Timestamp: Time of event occurrence.
• ResourceId: Resource Id associated with the Event (the Resource that was measured within that event).
• EventTypeId: Event type associated with the Event and describes the type of the Event (type of measurement of the Resource, type of ticket action, and so on).
• DataSourceId (optional): Any value. Supplies additional filtering criteria for raw data events.
• Value (multiple): Value(s) of the Event (measurement result, ticket number, and so on). This field often appears more than once.

The structure of the Translator corresponds with the structure of the Event Type within CA Business Service Insight, and also the database table T_RAW_DATA that stores the event as shown in the following figure:

• Translator: Describes how to translate the set of fields it receives into the output Event.
• TranslatorName: Name used by the InputFormat to send field sets to this translator. This example uses the name 'Translator1'. Refer to the previous figure for values that could be used for this scenario.
• TranslatorFields: Contains a list of TranslatorField elements, each one of which contains the following attributes:
  • Name: Field name. In the online interface it must be Timestamp, ResourceId, EventTypeId, ResourceId, or Value.
  • SourceType: Specifies the source of the field value. Can be one of the following:
    • Field: Value of this field is taken from field in the input format. The SourceName attribute contains the InputFormat field name.
    • Table: Value of the field is taken from the Translation table. The SourceName attribute contains the Translation table name that refers to a name which is defined in the next section of TranslationTableCollection. This type is used for values which are chosen to be translated into Resources and Event types in the event.
    • Lookup: Value of this field is taken from the Translation table. The SourceName attribute contains the table name. The value to be translated from the LookupValue attribute and not from the input format. It is commonly used when a constant value is required for the purpose of Translations.
    • Constant: Value of the field is constant, and its value is in the ConstantValue attribute. When using a constant value, it is necessary to specify the field type by using the Type attribute.
  • SourceName: Contains the field name or translation table name.
  • 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 a formatted string according to the TimeFormat (Set in the General section of the Adapter) or "Now" or "NowUtc", where "Now" is the current time in the Data source locale and "NowUtc" is the current time in UTC.

This section also contains the mapping tables defining the mapping of data source values into CA Business Service Insight Event fields and holds the table definition with the referred data source value which is to be to be translated.

• LoadingMode: Default for online interface is "remote" and for offline interface is "standalone".

  Specified loading method of the translation tables as following:

  • Standalone: Adapter loads the Translation tables locally. There is no connection to the CA Business Service Insight server regarding the Translation. Changes in the Translation tables are stored only in the local file.
  • Remote: Adapter sends a request to load all the tables from the CA Business Service Insight server. Changes made in the Translation tables are also stored locally.
• TranslationTable: Links the event value to the mapping table.
  • Name: Name of Translation table used and referred to by the Translator.
  • DestinationType: [resource, event_type, contract_party, service, time_zone, value]. Holds the type of the Translation table. In this example, the Servers column in the data source file is translated into an CA Business Service Insight Resource. Therefore, the Translation table type is Resource, and it holds translations of values to Resource IDs in CA Business Service Insight.
  • TranslationField: Field name to translate from and which is taken from the input format fields. Can contain a maximum of five fields.

Each translation table defined in the configuration file must have a corresponding definition in the CA Business Service Insight user interface.

The XML representation of a sample configuration file is as follows:

<?xml version="1.0" encoding="utf-8"?>
<AdapterConfiguration>
     <General MajorVersion="4" MinorVersion="0" RunOnce="yes" LogDebugMode="yes"
ConsoleDebugMode="yes" WorkingDirectoryName="output" RejectedEventsUpperLimit="10000">
     <DataSourceDifferenceFromUTC DefaultOffset="0" TimeFormat="%d/%m/%Y %H:%M">
          <DaylightSaving From="20/04/2001 00:00" To="15/10/2001 00:00" Shift="1"/>
     </DataSourceDifferenceFromUTC>
</General>
     <OblicoreInterface Mode="online">
          <OnlineInterface Port="5555" SecurityLevel="none"/>
     </OblicoreInterface>
     <DataSourceInterface>
          <Files>
               <File DeleteFileAfterProcessing="no" InputFormat="InputFormat1" NamePattern="servers*.csv" Path=" C:\Program Files\Oblicore\Adapters\ServersAdapter\data\" TitleExists="yes" SleepTime="60" Delimiters=","/>
      </Files>
</DataSourceInterface>
<InputFormatCollection>
     <InputFormat InputFormatName="InputFormat1">
          <InputFormatFields>
               <InputFormatField Name="resource" Type="string"/>
                    <InputFormatField Name="timestamp" Type="time" TimeFormat="%d.%m.%Y %H:%M"/>
                        <InputFormatField Name="memory_util" Type="real"/>
                        <InputFormatField Name="cpu_util" Type="real"/>
                </InputFormatFields>
     <TranslatorSwitch DefaultTranslator="Translator1"/>
     </InputFormat>
</InputFormatCollection>
<TranslatorCollection>
<Translator TranslatorName="Translator">
         <TranslatorFields>
            <TranslatorField Name="ResourceId" SourceType="table" SourceName="ResourceTable"/>
            <TranslatorField Name="EventTypeId" SourceType="lookup" SourceName="EventTable" LookupValue="PerformanceEvent"/>
            <TranslatorField Name="Timestamp" SourceType="field" SourceName="timestamp"/>
            <TranslatorField Name="Value" SourceType="field" SourceName="memory_util"/>
            <TranslatorField Name="Value" SourceType="field" SourceName="cpu_util"/>
         </TranslatorFields>
      </Translator>
   </TranslatorCollection>
   <TranslationTableCollection LoadingMode="remote">
      <TranslationTable Name="ResourceTable" DestinationType="resource">
         <TranslationField>resource</TranslationField>
      </TranslationTable>
      <TranslationTable Name="EventTable" DestinationType="event_type">
         <TranslationField>resource</TranslationField>
      </TranslationTable>
   </TranslationTableCollection>
</AdapterConfiguration>