General Section

Implementation Guide › Adapter Configuration Specifications › General Section

General Section

The General section consists of attributes and sub nodes as following:

XML Structure:

<General	
MajorVersion="2345"
MinorVersion="01245"
WorkingDirectoryName=" output"
DataSourceControlFileName="DatasourceControl.xml"
SendFileName="Send.txt"
SendControlFileName="SendControl.xml"
LogDebugMode="no"
ConsoleDebugMode="no"
RunOnce="yes"	
RepeatUntilDry="yes"
RuntimeErrorLimit="1"	
RetryRejectedEvents="yes"
RejectedEventsFileName="rejectedEvents.txt"
RejectedEventsUpperLimit="1000"
RegExUnlimitedSearch (V3.1 Patch)="no"
HoldRejectedEventsSpan="24"
GenerateStatistics="yes"
StatisticsFileName="MyStatistics.txt" >
KeepHistoricState="yes" >
DefaultTimeFormat="%Y/%m/%d-%H:%M:%S"
DefaultDecimalSymbol="."
DataSourceIdMaxLength="60"
DefaultDigitGroupingSymbol=","
SaveIllegalEvents ="no"
WriteEventErrorToLog ="yes"
IllegalEventsDirectoryName="xxxpath"
<DataSourceDifferenceFromUTC 
	DefaultOffset="2"
	TimeFormat="%Y/%m/%d-%H:%M:%S">
	<DayLightSaving 
		From="2001/04/09-12:00:00"
		To="2001/09/01-12:00:00"
		Shift="1"/>
</ DataSourceDifferenceFromUTC >
</General>

MajorVersion-Specifies the major version number.
MinorVersion-Specifies the minor version number.
WorkingDirectoryName-(optional)
Specifies the default path for Adapter output files (data source control, translation, sends).

Default Value-output directory (folder) in the directory where the configuration file exists.
DataSourceControlFileName-(optional)
Name of the file that the Adapter uses to keep track of last data records retrieved from data source.

Default Value-DataSourcecontrol.xml (If not otherwise specified, the default value is used.)
SendFileName-(optional)
Name of the file that holds the events before they are sent to CA Business Service Insight.

Default Value-Send.txt (If not otherwise specified, the default value is used.)
SendControlFileName-(optional)
Name of the file that the adapter uses to keep track of the sending process.

Default Value-SendControl.xml (If not otherwise specified, the default value is used.)
DataSourceIdMaxLength-
Maximum length for the DataSourceId field in t_raw_data table. If the user inserts a string greater than this length, they receive an error in the adapter.

This value must be less than or equal to the real size of the table.

Default Value-60
SaveIllegalEvents-If selected, this attribute indicates that the illegal events must be written to file.
Default Value-no
WriteEventErrorToLog-Guides if data errors are written in the T_Log table
Legal Values-[yes/no]

Default Value-yes
IllegalEventsDirectoryName-(no default value)
SendFileName-(optional)
Name of the file that holds the records before they are sent to CA Business Service Insight.

Default Value-Send.txt (If not otherwise specified, the default value is used.)
§SendControlFileName-(optional)
Name of the file that the adapter uses to keep track of the sending process.

Default Value-SendControl.xml (If not otherwise specified, the default value is used.)
LogDebugMode-(optional)
Legal Values-[yes/no]

When set to yes, the following is sent to log-original row from data source, parsing results, CA Business Service Insight Unified Event.
ConsoleDebugMode-(optional)
Legal Values-[yes/no]

When set to yes, debug messages appear on the consol.
- Indicators for reading and translating records:
  - .: For a record that was read and translated to one output event.
  - i: For a record that was ignored by the regular expression parser.
  - I: For a record that was read and ignored by the translation tables.
  - R: For a record that was read but rejected by the translation table (cannot translated by the translation tables).
  - X: For a record for which there was a problem when parsing it. It will be ignored and lost or it will be saved in the Illegal Events directory.
Note: When the read record passes through more than one translator, the record's indication will be enclosed in parentheses. For example: […] or [RRI].
- Adapter's status indicators:
  - 0: The adapter is alive and does not read any records at the last second.
  - E: Error status.
  - P: Pause status.
  - S: Stop command received from CA Business Service Insight.
  - B: Blocked status, the rejected events table is full.
  - Translation tables indicators:
  - L: Waiting for translation tables.
  - T: Translation table sent by/received from CA Business Service Insight.
  - t: Changes in translation table sent by/received from CA Business Service Insight.
  - Connection indicators:
  - <Connecting CA Business Service Insight: Trying to connect CA Business Service Insight.
  - <Connecting CA Business Service Insight>: Connection established.
  - <Connecting DataSource: Trying to connect Data Source.
  - <Connecting DataSource>: Connection established.
RunOnce-(optional)
Legal Values-[yes/no]

When set to no, the adapter will run continuously.

When set to yes, the text file adapter runs, reads records, and stops automatically. The file adapter reads entire files, waits a few seconds, tries to read new records (depending on the SleepTime). If there are no such records, it stops.

An SQL adapter runs each of the queries only once. If RepeatUntilDry is set to no, it stops immediately. If RepeatUntilDry is set to yes, it waits (depending on the SleepTime), tries to run the queries again (depending on the query's SleepTime), and if there are no new records, it stops.
RepeatUntilDry-(optional)
Legal Values-[yes/no] Default value-yes

See the RunOnce attribute above.
RuntimeErrorsLimit-(optional)
Determines the errors limit (for example, for errors in the input events) before the adapter is blocked. When equal to 0, the adapter is not blocked.

Default Value-1 (Meaning that the adapter is blocked after the first error.)
RetryRejectedEvents-(optional)
Legal Values-[yes/no] Default value-yes

When set to yes, records that need translation are kept in the rejected events file, waiting for translation.

It is not recommended to set this attribute to no because there is a chance that you may lose important data.
RejectedEventsFileName-(optional)
Name of the file that the Adapter uses to keep track of data records that were retrieved from the data source and waiting for translation.

Default Value-rejected.txt (If not otherwise specified, the default value is used.)
RejectedEventsUpperLimit-(optional)
Determines the limit of rejected records that are kept in the rejected.txt file. When the adapter reaches this upper limit, it stops and change to block status until these records are translated.

Default Value-1000
RegExUnlimitedSearch-Guides the adapter to perform full search according to the regular expression.
Legal Values-[yes/no]

Default Value-no
HoldRejectedEventsSpan-(optional)
Determines number of hours for which to save the rejected events file. If this attribute is not mentioned, the adapter does not erase any events which must be handled before the adapter can start again.

It is not recommended to use this attribute because there is a chance that you may loose important data.
GenerateStatistics-(optional)
Legal Values-[yes/no] Default value-yes

When set to yes, the adapter creates a statistics file containing statistic information every minute.
StatisticsFileName-(optional)
Name of the statistics file.

Default Value-statistics.txt (If not otherwise specified, the default value is used.)
KeepHistoricState-(optional)
Legal Values-[yes/no] Default value-no

When set to yes, the adapter saves all files, except for the log file, to a new directory called Historic state yyyymmdd-hhmmss, where yyyymmdd and hhmmss are the creation date and time formats.
DefaultTimeFormat-(optional)
The default time format. If this attribute is specified it is used as the time format in any place where the TimeFormat attribute is omitted. If it is not specified, the TimeFormat attribute in the other elements is mandatory.
DefaultDecimalSymbol-(optional)
The default decimal symbol for real fields.

Default Value-(If not otherwise specified, the default value is used.)
DefaultDigitGroupingSymbol-(optional)
The default digit grouping symbol for integer and real fields.

Default Value-(If not otherwise specified, the default value is used.)
DataSourceDifferenceFromUTC-Indicates the time difference between UTC and the time zone of the data source carrying machine.
- DefaultOffset-The offset from UTC when not in daylight saving time.
- TimeFormat-Specifies the format by which the Daylight Saving details (described next) should be parsed.
- DayLlightSaving-Specifies one daylight saving period of the data source time zone. This element is optional (meaning, if not selected, there are no daylight saving times) and it can exist more than once. When some elements exist, they must be ordered by time and the periods must not be overlapped.
  - From-Begin date of the period.
  - To-End date of the period.
  - Shift-Time shift added to the DefaultOffset within daylight saving period.