BLFailure_x

The
BLFailure_x
 item returns the failure message for the
x
th
batch in the batch list. This is the highest priority failure message for the steps running within the recipe.
This table shows the input and output formats for this item.
Input Format
Request:
BLFailure_
<RowNumber>
<RowNumber>
is
ASCII - Integer
An array index. When an unacknowledged prompt generates, it adds to an array. If the unacknowledged prompts list is not sorted, then
x
is the row number of the unacknowledged prompt appearing in the unacknowledged prompts list.
Output Format
The BLFailure_x item returns in this format:
<Failure>
Field Name
Format
Description
<Failure>
ASCII – String
Failure message for the batch appearing on
x
th
row of the batch list.
This table is an example of a typical batch list containing three batches with batch IDs BATCH_98, BATCH_99, and BATCH_100:
Batch ID
Recipe
Desc
Start Time
State
Failure
BATCH_98
Vanilla
Ice Cream 1
2/24/2022 1:22:02 pm
RUNNING
BATCH_99
Chocolate
Ice Cream 2
2/24/2022 1:24:12 pm
RUNNING
BATCH_100
Premium French Vanilla
Ice Cream 3
2/24/2022 1:32:30 pm
RUNNING
PHASE UNDER EXTERNAL CONTROL DETECTED
This table shows an example of the return on this request.
TIP:
A request on
object.GetItem(BLFailure_3)
 would return the failure field of the batch in the batch list’s third row:
PHASE UNDER EXTERNAL CONTROL DETECTED
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal