Batch Tracker Backfill

The Batch Tracker Backfill object (also referred to as the Backfill Controller) is created below the Batch Tracker and used to configure a selective and on-demand reprocessing of historical data over a defined time period. Any missing data for that time period is backfilled by the Batch Tracker and added to the BPR (Batch Production Record). This Backfill Mode is turned on by changing the Mode from "Configuration" to "Running". The configuration of the time period is done via Starttime and Endtime properties and this time period can be updated at any point. A BatchID Filter can also be entered which will only retrieve records for a matching BatchID string. Multiple Batch Tracker Backfill objects can be configured below one Batch Tracker. The Backfill process can be followed.

The Batch Tracker Backfill object and Backfill Mode requires that all Tags configured in the parent Batch Tracker be set to historize data in a configured data store Archive Selector .

Use Cases

  • Backfill missing data from running Batch Trackers objects

  • Selectively backfill data for particular BatchIDs in advance or on the fly

  • Automate the backfill process by updating backfill time period and triggering the mode

Quick Configuration

  1. Select the parent BatchTracker object and right-click. Select Admin  New  Production Tracking  Backfill Controller from the context menu.

  2. In the Create Object wizard, enter an Object name and an optional Object Description.

  3. Open the Starttime time/date picker and select a start for the time period you wish to cover. Do the same with Endtime to select the end of the desired time period.

  4. If you wish to only backfill data for a particular BatchID, enter the BatchID as a string in the BatchID Filter property field (optional).

  5. Click Create to create the object in the I/O Model.

  6. To begin backfilling data, select the object in the I/O Model and change the Mode property in the Object Properties panel from "Configuration" to "Running" and click Apply.

  7. The progress of the backfill operation can be followed in the Diagnostics compound which details information on the state of the process, including information from the Batch Tracker. The Tracking Documents compound allows the actual backfilled BPR documents to be viewed in JSON format (the last completed and the currently processed BPRs).

  8. Once the backfill for the specified time period is completed then the Mode will change back to "Configuration". The backfill operation can be re-run at any time to fill in any extra missing information.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Starttime

Start time for the backfill operation.

Endtime

End time for the backfill operation.

BatchID Filter

If this field is set, only BPRs where the BatchID matches this filter will be (re-)calculated.

Mode

Mode of operation. Set to running in order to start the backfill operation.

  • Configuration: Use this setting to configure start time and end time.

  • Running: This setting will start the operation.

Progress

Progress indicator for the backfill operation.

Attachments

File attachments stored in MongoDB file store.

Tracking Documents

The persisting JSON documents for the active and recently completed batch.

Recently Completed

JSON document for the most recent completed batch.

Completed at

The time when the recent batch was completed.

Current

JSON document for the current batch.

Last Update

The time when the current batch recently was updated.

Last run

timestamp of the last run.

Diagnostics

Runtime Diagnostics.

Process State

Shows the current processing state of the object.

Heartbeat

Indicates the heartbeat of the object.

Recent Runtime

Shows the runtime of the most recent process.

Load

Load percentage in respect to the processing time hint, which was received by the object recently.

Current Equipment State

Current Equipment State.

Current Batch ID

Current Batch ID.

Current Active State

Current Active State.

Current Script Result

Current Script Result.

Current Operation (S88)

Displays the current S88 operation as detected by the batch tracker object.

Current Equipment Phase (S88)

Displays the current S88 equipment phase as detected by the batch tracker object.

Current Equipment Step (S88)

Displays the current S88 equipment step as detected by the batch tracker object.

Recent Error

The most recent error, which was raised by this object.

Recent Error Time

Timestamp of the most recent error raised by this object.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.