Custom Production Tracking Data Store

The Custom Production Tracking Data Store object allows the user to create and configure multiple Production Tracking data stores in addition to the already existing System Production Tracking Data Store. The object can be created in the I/O Model beneath the Core or a Data Store Group object.

Quick Configuration

  1. Right click on the Core or a Data Store Group object and select Admin  New  Data Stores  Custom Production Tracking Data Store from the context menu to open the Create Object wizard.

  2. Give the object a unique name and enter a description if necessary. Leave the Processing Mode set to "Configuration"

  3. Click on the Custom Production Tracking Data Store options from the wizard sidebar to view the data store settings.

  4. The default database name can be changed here, along with data retention period and purge settings (what happens to the object data if the object is deleted). If the retention period is set to <null> then the event data will be retained permanently.

  5. If necessary, the MongoDB connection settings can also be changed (for example, if you wish to connect to a remote MongoDB instance or configure replication sets).

  6. Click Create to create the object in the I/O model tree.

  7. Select the newly created Custom Production Tracking Data Store in the I/O Model and look at the Object Properties panel. Open the Filter Options property compound to see all the options for filtering production events for storage in the Custom Store.

    The Custom Production Tracking Data Store will only store Production Tracking event data that has been proactively selected by the user through configuration of the event filters. The System Production Tracking Data Store will archive all event data from configured Batch Tracker objects.
  8. Open the S95 Owner Objects table property. Here, objects from the ISA-95 Equipment Model can be added to the table (the path to the object can be entered or added by drag and drop). The Batch Production Records from the selected objects will be archived in the Custom Production Tracking Data Store. Click OK to close the table.

  9. A custom Lua script can also be added to the Filter Script field to fully customize your filtering options.

  10. When all filtering options have been applied, return to the Common property compound and change the Processing Mode to "Operation" and click Apply to begin archiving.

  11. Production Tracking data can be retrieved selectively from a Custom Production Tracking Data Store using the Lua API Batch Production Records library functions and specifying the appropriate data store in the _options table argument for the function.

    This is also the case for the Web API endpoints used for querying, annotating and updating batch production records.

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 name overrides the description which has been supplied by the external system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Processing Mode

Configure the processing mode of the object.

  • Configuration: In this mode no data is processed.

  • Operation: In this mode the object is operational.

Production Tracking Data Store

Custom Production Tracking data store configuration.

Database

The user-defined database storing Batch Production Tracking data.

Retention Time

The maximum age of data in the archive.

Purge Size

The maximum number of BSON documents purged in a single batch operation.

Purge Mode

Controls what happens to an object’s data in the store after the object’s deletion.

  • Do not purge: Do not purge data of deleted objects from the store.

  • Purge when idle: Purge data of deleted objects from the store, only when it is idle.

  • Purge continuously: Purge data of deleted objects from the store, even if it is busy.

MongoDB Connection

This property compound combines the properties of the MongoDB Connection e.g. the connection strings to the mongoDB.

Connection String

The connection string for the external system; depending on the type of connection.

Replication Set Name

Configuration name for MongoDB Replica Set.

Replication Set 1

The connection string for the core service to replication set 1.

Replication Set 2

The connection string for the core service to replication set 2.

Authentication Mode

Authentication mode to be used connecting the MongoDB instance.

  • No Authentication: No Authentication is performed when the System connects to a certain instance of MongoDB.

  • Challenge-Response: MONGODB-CR is the default authentication mechanism supported by MongoDB. Username and Password needs to be provided.

  • SCRAM-SHA-1 Authentication: Salted Challenge Response Authentication Mechanism (SCRAM) means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows.

  • X.509 Certificate: MONGODB-X509 mechanism authenticates a username derived from the distinguished subject name of a X.509 certificate.

  • LDAP (Lightweight Directory Access Protocol): Lightweight Directory Access Protocol (LDAP) service is used for MongoDB authentication.

  • SCRAM-SHA-256 Authentication: SCRAM-SHA-256 authentication means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows (non-ASCII characters in passwords are not supported).

  • Auto: Detect the default authentication mechanism for users with stored SCRAM-SHA-1 and SCRAM-SHA-256 credentials (requires MongoDB 4.0 or newer).

User Name

User Name.

Password

Password.

Compression

Compress MongoDB data on the wire.

Secure connections

Enable TLS for MongoDB connections.

Allow Invalid Hostnames

Allow invalid hostnames in the server certificate for TLS connections.

Allow Invalid Certificates

Allow invalid server certificates for TLS connections.

MongoDB URI

If not empty, the MongoDB URI takes precedence, overriding all other MongoDB connection settings. The string needs to be URL-encoded.

Effective MongoDB URI

The actual MongoDB URI used for current connection.

Filter Options

Filter settings to select particular Batch Production Records to be assigned to this store.

S95 Owner Objects

A list of object paths (eg. '\\^/System/Core/obj1 \\^/obj2') from the S95 Equipment Model which shall store their respective BPR documents in this store.

Filter Script

A Lua script returning true or false when passed in a particular BPR document.

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.