Format the Batch Tracking file

The Batch Tracking (BT) text file will be named: <pipeline name>.BT

Where:

• <pipeline name> is the name of the pipeline record to be created.

The following formatting information is needed if you are editing the file using standard editing tools.

The BT file uses the following formatting:

• Comments are signaled with a semi-colon (';').

• Table and attribute names are upper case and followed by a colon (':').

• Attribute names are case sensitive.

• One table or attribute name per line.

• Start of a record definition is noted by the table name and followed by the record name. All subsequent lines are field definitions for that record until a line defines a new table or record name.

  Example:

  NODE:noderec1; defines start of definition of a record named 'noderec1' in the Node table.

  ALMINH TRUE; alarm inhibited for 'noderec1'

  EVTINH FALSE; event inhibited for 'noderec1'

  NODE: noderec2; defines start of definition of a record named 'noderec2' in the Node table.

  ALMINH TRUE; alarm inhibited for 'noderec2'

  EVTINH FALSE event inhibited for 'noderec2'

• The attribute name usually refers to a single field in the table, but in some cases they may configure multiple fields.

• The first non-comment or non-blank line will be the start of the pipeline record definition. For more information, see Define Pipeline records.

  An example of a BT file is provided in the Appendix (see Example Batch Tracking (BT) file).

You can define custom fields in the BT file if a plugin is provided to process these fields. For more information, see "Batch Tracking Compiler (BTC) Application Programming Interface (API)" in the AVEVA Pipeline Operations for Liquids Developer documentation.

Define custom fields using the following syntax:

!Key: Value

Where:

• ! = An indicator that this is a custom field.

• Key = The label assigned to the custom field.

• Value = The value associated with the custom field for this particular entity.

Example:

!CUSTOMFIELDX: 1234 ;This is a comment

In this case:

Key = CUSTOMFIELDX

Value = 1234 ;This is a comment

When the BTC process runs, the system passes the key-value pair, and the record under which they are defined, to the plugin for processing. It is the responsibility of the plugin to parse and interpret the provided value.