IST Configuration Syntax

This is the configuration for IST/Switch environments which are monitored by the Payments product suite.

SUBSYS IST

TRANSACTION SOURCE (<source-name>, <location>, <source-type>, <exe-name>[, <custom-key-definition>][, SCHEMA=<schema-name>])
TCPIP PORT (<port-number>[, <server-proc-name>])
MAP RECORD (<source-name>, <record-name>[, <filter>])
ENABLE KEY (<record-name>, <key>, [<where-clause>], [<logical-key-name>])
AMOUNT RANGE (<record-name>, <range-type>, <range-delimiter>, [<range delimiter>], [<range-delimiter>...] )
BIN LENGTH (<record-name>, <bin-length>)
MAP FIELD (<source-name>, <dest-record-name>, <key-field>, <record-field>)
RESPONSE FIELD (<source-name>, <response-code-field>)
RESPONSE CODES (<source-name>, <response-type>, <response-code>[, <response-code> ...])

Syntax Elements

TRANSACTION SOURCE

The Transaction Source statement specifies a Transaction Log Readers (TLR). Multiple Transaction Source statements are permitted, representing each TLR, with each identified by a unique <source-name>. If no Transaction Source entries are specified in the configuration then no data will be provided by the collector.

The commas in this statement must be retained as placeholders if any intermediate optional parameters are excluded, e.g. Transaction Source (name, location, type, exe-name , , params). However, if optional parameters starting from the end of the string are excluded then the preceding comma may be omitted, e.g. Transaction Source (name, location, type, exe-name).

<source-name>

Unique user-defined name for this TLR.

<location>

Location of the transaction log. For IST/Switch this is specified in the format <database-instance>, for more information see the IST/Switch Configuration Locations.

<source-type>

Type of transaction source. For IST/Switch specify 'Other'. When set to 'Other', the TLR can actually deliver any type of transaction data.

<exe-name>

Executable name of the TLR. Must be specified if <source-type> is Other. For IST/Switch specify iristtlr as the <exe-name>.

<custom-key-definition>

(Optional) Name of the record definition used for the custom keys for this TLR. For IST/Switch this is 'IstTransactionCustomKey'.

If omitted, the collector will expect no custom fields to be passed from the TLR

SCHEMA=<schema-name>

(Optional) Name of the Oracle schema where the SHCLOG table is located.

TCPIP

<port-number>

Port number on which the Transaction Manager collector should listen for incoming connections from log readers. The collector requires exclusive use of this port. This is a required parameter.

If the specified <port-number> is in use, the collector will attempt to use the next available port number, starting from the one specified. It will keep trying for up to 20 port numbers until it finds one available. A warning will be logged to wvlog if the collector eventually uses a port number other than the one specified.

MAP RECORD

The Map Record statement specifies a particular Transaction Source that will populate a given record. Multiple Transaction Sources can populate a single record and/or a single Transaction Source can populate multiple records. Multiple Map Record statements are allowed within a configuration and there must be at least one Map Record statement for every Transaction Source statement.

<source-name>

Name of the Transaction Source to be mapped.

<record-name>

Identifies the record to which the TLR transactions should be mapped. It is possible to define multiple record mappings for the same TLR.

<filter>

One of ATM, POS, Other or *. When specified as ATM, POS or Other, only those transaction types will be mapped to the destination record. When specified as *, all transactions from <source-name> will be mapped to the <record-name> record.

Example:

MAP RECORD (Logger1, IstAtmTransactionSummary, ATM)

ENABLE KEY

The Enable Key statement specifies that a new Key be enabled for a given record. Multiple Enable Key statements are allowed (and expected) for a given record. Multiple Enable Key statements are even allowed for the same <key>, provided that a unique <logical-key-name> is provided. At least one Enable Key statement must be specified for each record mentioned in a MAP RECORD.

<record-name>

Name of the Prognosis record for which the key is to be enabled, e.g. ConnexAtmTransactionSummary.

<key>

Key or Keys to enable. This is a combination of Key fields for which a separate set of statistics is to be maintained.

The Keys are entered in the form, <key-field>[+<key-field> [+<key-field> …]].

For example:

TERMID+TYPE+RESPCODE.

For a list of applicable Key fields, see the Standard Transaction Key Fields.

<where-clause>

Optional Where Clause which is used to filter the collected data. Only transactions matching this Where Clause will be accumulated for this Key, e.g. ATM=DEPOSITS. See Where Clauses for details about Where Clause functionality.

The Where Clause statement must be enclosed in single quotes if it contains any quoted strings, e.g. 'RESPCODE = "400"'

<logical-key-name>

Optional unique name for the Enabled Key. When added, this is used as the associate name in the Data View Definition dialog box when creating a Display, Database etc. By adding a logical key name, it allows easier input into the Data View Definition, i.e. it is only necessary to enter the logical key name instead of the full set of key and/or where clause parameters. Normally this is only used in combination with a <where-clause> parameter, however it can be used with any Enable Key statement. Where <key> is specified for the same record more than once, a logical key name has to be used to make the entry unique.

Refer to Adding Transaction Key Fields for additional tips when adding Key fields.

Example:

Enable Key (IstAtmTransactionSummary, BIN+TERMID+TERMNAME+TERMCITY, 'RESPCODE IN {"00","08"} and ACQRNETC = "<INPUT>"', BIN_TERMID_TERMSTAT_Approvals)

AMOUNT RANGE

This statement defines a set of amount ranges that can be used to categorize transaction data. Amount Range is optional. If not specified, the associated Amount Range fields will not be populated.

<record-name>

Record for which the range is to be set.

<range-type>

Amount field that this range will apply to; Total, Cash or NonCash.

<range-delimiter>

Defines a specific amount range for which separate statistics will be kept. Successive <range-delimiter> fields must increase in number.

Example:
In this example, 5 distinct amount ranges will be created (0-100, 100-200, 200-300, 300-400, 400+) for which separate statistics will be maintained when the associated key is enabled.

AMOUNT RANGE (IstPosTransactionSummary,Total, 100, 200, 300, 400)

BIN LENGTH

Specifies the BIN (Bank Institution Number) length to be used for the specified record. Defaults to 6 if not specified.

<record-name>

Record for which the BIN length is to be set.

<bin-length>

Number of leading characters from the Primary Account Number (PAN) to treat as the BIN.

Example:

BIN LENGTH (IstAtmTransactionSummary, 4)

MAP FIELD

Specifies the mapping of a field from a standard or custom Key field passed up by the TLR to a Key field in the record. Map Field statements can only be specified for <source-name>, <record-name> combinations already referenced in the Map Record statements. By default, fields in the standard or custom Key will be automatically mapped to fields of the same name in the record.

<source-name>

Name of the Transaction Source from which the field is to be mapped.

<record-name>

Name of the Transaction Summary record to which the field is to be mapped.

<key-field>

Name of the field in the TLR message that is to be mapped. <key-field> can be either a field in the standard transaction Key or a custom Key field for the TLR. For a list of Key fields, refer to Key Fields.

<record-field>

Field within the specified <record-name> to be filled with the contents of <key-field>.

RESPONSE FIELD

This statement is used to specify the name of the field that collects the transaction response codes, normally this will be 'RespCode'. However, this can vary for different ATM/POS transaction log solutions. The purpose of this statement is related to the following Response Codes statement and a Response Field statement must be specified for each record referenced in a Response Codes statement.

<source-name>

Name of the Transaction Source containing the response code.

<response-code-field>

Name of the field to be used for response codes.

Example:

See the following Response Codes statement description.

RESPONSE CODES

Overrides the default treatment of the 'Approved', 'Denied' and 'TimedOut' response codes from a Transaction Source. This allows for an otherwise failed response code to be treated as a success. If not specified for a Transaction Source the <response-type> will be as provided by the Transaction Log reader.

<source-name>

Name of the Transaction Source for which this Response Code is to be defined.

<response-type>

One of: Approved, Denied, TimedOut.

<response-code>

Response code that will now be treated as the specified <response-type>. This overrides the default definition for this <response-code>.

Example:

RESPONSE FIELD (<Logger1>, <RESPCODE>)
RESPONSE CODES (<Logger1>, Approved, 150, 151)

The use of both the Response Field and Response Codes statements in the above example will cause response codes 150 and 151 to be treated as 'Approved', whereas normally they would be treated as 'Denied'.

Provide feedback on this article