Document Tracking Updates

Before any tracking information is collected or updated, the service or adapter verifies whether tracking is enabled by checking the global system-level tracking parameter and the business process-level tracking parameter.

The global system level is a property that you set for the entire installation of Sterling B2B Integrator, which affects the ability of certain services and adapters to track document information, and this global method is used if there is no other way to determine if document tracking is enabled. The business process level is specific to each business process. Each business process stored in Sterling B2B Integrator has a document tracking flag that indicates whether you enabled tracking for the business process.

If business process tracking is enabled when Sterling B2B Integrator determines the tracking setting for a document, that setting is used and it overrides the global system tracking setting. For example, if global tracking is enabled but document tracking is disabled in a business process, then no tracking information is saved for documents from that business process.

When a new document is generated from an existing document, Sterling B2B Integrator verifies whether document tracking is enabled for the source (existing) document, and then configures the new child document to have the same tracking parameters as the parent (source) document. An example is the extraction of group or transaction level business documents from Electronic Data Interchange (EDI) batches. The services that extract the child (group and transaction level documents) check the tracking flag of the input (the parent interchange) and then set the tracking flag on the output documents (the group and transaction level documents) to be the same as the input document.

To add any new information to the document tracking record for a document, Sterling B2B Integrator creates correlations of required system information and associates them with the document.

Predefined Correlations

Predefined correlations provide required system information that is stored in the tracking record for each document, and are used by other parts of Sterling B2B Integrator. These correlations include possible search criteria and processing details. Some of the correlations have restrictions on values and others are limited by the number of correlations per tracking record.

This table lists the predefined document correlations:

Correlation

Definition

Status

Defines the document status and is always present in the document tracking record. This parameter is similar to the statuses used for business processes. By default it is set to SUCCESS and can only be updated to WARNING or ERROR.

Note: Once the status is set to ERROR, it can never be changed to a lower status level.

State

Defines the state of the document and is similar to the state of a business process. You define the document state during the creation of a business process and update the document state using the Document Tracking Service.

Examples of values for a document state correlation are COMPLETE and WAITING, though the value may be any user-defined state.

Action

Defines the action performed on a document. Examples of document action are CREATE, PARSE, and TRANSLATE.

Message ID

Stores the message identifier received from or sent to another instance of Sterling B2B Integrator.

Note: The Message ID correlation is used to correlate tracking records between instances of Sterling B2B Integrator (internodal document tracking). All adapters that support internodal tracking support use this correlation to do so.

Entity ID

Stores the partner identifier.

Note: Some adapters provide an identifier for the trading partner. If Entity ID is not specified for a partner then Profile ID or Contract ID is provided as the correlation value.

Tracking Type

Short description of the current document that is used for display purposes only on the Document Tracking search pages.

Direction

Determines if the document is being sent (outbound) or received (inbound). The correlation value is restricted to OUTBOUND and INBOUND.

Sender ID

Specifies the sender identifier. This is not a unique correlation because various Sterling B2B Integrator features handle the sender identifier differently, depending on the context. Therefore, this correlation differentiates between identically named sender identifiers by also storing the context or scope information with each Sender ID.

Receiver ID

Specifies the receiver identifier. This is not a unique correlation because various Sterling B2B Integrator features handle the receiver identifier differently, depending on the context. Therefore, this correlation differentiates between identically named receiver identifiers by also storing the context or scope information with each Receiver ID.