Work with Batch Transfer message sets
- Last UpdatedApr 24, 2025
- 3 minute read
The Batch Transfer requires a 13 row message set. As with any RealTime database (RTDB) record, the message set is assigned to a Batch Transfer (batchXfer) record by referencing the Base Message field to the first row of the message set. The text below is the default message set for Batch Transfer. This is from the file (LMS.message.l) that is used to install the default AVEVA Pipeline Operations for Liquids message set.
Each row of the message set is applied to a particular condition for the batchXfer record. The following table details the Message Set Entries within the Batch Transfer Message Set.
|
Number |
Name |
Description |
|---|---|---|
|
0 |
Normal |
The Normal message set is used when all operations are functioning correctly and a ticket is currently being processed by the batchXfer record. Return-to-Normal (RTN) alarms will also be generated using this message set entry. |
|
1 |
Stopped |
The Stopped message set entry is used to indicate that there are no tickets currently active within the batchXfer record. This state’s message set entry is used when a batchXfer record is initially created or when an active ticket is stopped. There are no alarms generated for the Stopped message set entry. |
|
2 |
Inhibited |
The Inhibited message set entry is used when the parent batchXfer record is manually inhibited by a Controller or Administrator, or when the point that is configured in the Inhibit Path is changed to the state that is specified as the inhibited state, the batchXfer will be inhibited. There are no alarms generated for the Inhibited message set entry. |
|
3 |
Auto Track Complete |
The Auto-Track Complete message set entry is used to generate alarms when the Gross Standard Volume (GSV) of an active ticket reaches its configured scheduled volume. This message set entry is only used to provide alarming information upon successful ticket completion. It is never used for configuring the current state of a batchXfer record. |
|
4 |
Auto Track Warning Volume |
The Auto Track Warning Volume message set entry is used to generate alarms when the remaining GSV of an active ticket crosses the configured remaining volume alarm threshold. This message set entry is never used for configuring the current state of a batchXfer record. |
|
5 |
Auto Track Warning Time 1 |
The Auto Track Warning Volume Time 1 message set entry is used to generate alarms when the estimated time until completion crosses the configured remaining time warning 1. This message set entry is never used for configuring the current state of a batchXfer record. |
|
6 |
Auto Track Warning Time 2 |
The Auto Track Warning Volume Time 2 message set entry is used to generate alarms when the estimated time until completion crosses the configured remaining time warning 2. This message set entry is never used for configuring the current state of a batchXfer record. |
|
7 |
General Alarm |
The General Alarm message set entry is used to generate alarms when automatic ticket starts and splits are performed by the batch transfer application, as well as alarms when these actions fail. This message set entry is never used to configure the current state of the batchXfer record. |
|
8 |
Delivery Size Alarm |
The Delivery Size Alarm message set entry is used to generate alarms when the difference between a completed ticket’s GSV and scheduled GSV exceed the configured Volume Threshold Tolerance. This message set entry is never used to configure the current state of the batchXfer record. |
|
9 |
Low Pending Queue Alarm |
The Low Pending Queue Alarm message set entry is used to generate alarms when the number of pending tickets on a batchXfer record falls below the configured Pending Queue Low Limit. This message set entry is never used to configure the current state of the batchXfer record. |
|
10 |
General Failure |
The General Failure message set entry is used to configure the state of a batchXfer record when a failure has occurred when attempting to process the record. Typically, this state is observed when the RealTime database (RTDB) schema does not contain a field that the Batch Transfer Processing Engine expects to find. |
|
11 |
New Schedule |
The New Schedule message set indicates a new batch schedule is available. |
|
12 |
Configuration Error |
The configuration Error message set specifies that an action could not be performed due to a problem with configuration of a batch transfer or individual batch. For example, when an action sequence on a batch transfer is requested to start but the action sequence name is invalid (does not exist). |