Trackable item content

Several attributes are associated with a trackable item. Most of the attributes are user-supplied. A tracking ID for the tracked item is generated when it is added to the database.

The attributes are described in the following table.
Table 1. Trackable item attributes
Field name Field type Maximum length Direction
TRACKING_NAME String 254 INPUT
TRACKING_TYPE String 50 INPUT
SEND_FLAG Boolean   INPUT
SOURCE String 100 INPUT
TARGET String 100 INPUT
SITE Integer   INPUT
DATE String 20 INPUT
CATEGORY String 2 INPUT
AFFECTS_EOD Boolean   INPUT
EXPECTED_BY Timestamp   INPUT
ALERT_EMAIL String 100 INPUT
ALERT_EMAIL_LIST Boolean   INPUT
TRACKING_ID Long   OUTPUT
Note: All Boolean attributes are stored in the database as integers, with zero representing false and one representing true.
The attributes that are shown in the following table provide details about the tracked item.
Table 2. Tracked item details
Attribute name Description
TRACKING_NAME The name of the tracked item. The transmission name, for example.
TRACKING_TYPE The type of item that is being tracked.
SOURCE The source of the item that is being tracked.
TARGET The target of the item that is being tracked.
SEND_FLAG Indicates whether the item is being sent (true) or received (false).
Except for SEND_FLAG, each of these attributes is user-defined and can be anything that makes sense to the client application. However, they must all be specified because they are required fields. No NULL values are admissible. The field needs to be unique enough to make locating an item easier.
The attributes in the following table are used to associate the tracked item with a Transaction Server business day.
Table 3. Trackable business day attributes
Attribute name Description
SITE The Transaction Server site identifier. It is typically zero.
DATE The business date.
CATEGORY The business category.
AFFECTS_EOD Indicates whether end of day is inhibited if the item status is not complete.
Notes:
  1. Each of the fields is optional and can be set to NULL.
  2. If any of the fields except for AFFECTS_EOD are specified, all the fields must be specified.
  3. AFFECTS_EOD is optional and defaults to false if unspecified.
  4. If business day information is specified for the tracked item, the item is deleted from the database whenever the business day is later purged.

The fields in the following table enable the alert-posting features in the Transaction Server.

Table 4. Trackable alert attributes
Attribute name Description
EXPECTED_BY The time that this item is expected by.
ALERT_EMAIL The email address to receive the item overdue or late alert messages.
ALERT_EMAIL_LIST Indicates whether the Transaction Server sends the overdue or late item alert messages to a fixed email address list. This address list is specified in the emailAddressList configuration property of the Transaction Server.

Trackable items that are generated due to an expected transmission for an inbound transmission that is defined in the Participant Directory have this value set to 0 or false. To send emails for these trackable items, specify the alert email shift properties that are configured in the Transaction Server ConfigMap.
Notes:
  1. Each of the fields is optional and can be set to NULL.
  2. If EXPECTED_BY is not specified, the item overdue or late status is not detected and alerts are not posted.
  3. The ALERT_EMAIL attribute and the email addresses that are associated with ALERT_EMAIL_LIST are combined to create a single email list to which the alerts are posted. If ALERT_EMAIL is unspecified and ALERT_EMAIL_LIST is unspecified or false, no alert email messages are sent. When no messages are sent, it negates the detection of the item overdue or late status. This note does not apply for trackable items that are generated due to an expected transmission for an inbound transmission that is defined in the Participant Directory.

The field in the following table is created when the trackable item is inserted into the database. This field uniquely identifies the tracked item in the database.

Table 5. Tracked item inserted output attributes
Attribute name Description
TRACKING_ID A unique identifier for the item inserted. It is used to identify the specific tracked item in the database.
After a trackable item is inserted into the FTM database, its registration time is recorded and its completed timestamp is set to unspecified. It uses an internal flag to track whether the overdue or late alert messages were sent. One of the following things occurs after the trackable item is inserted into the database.
  • The trackable item is posted as complete.
  • The trackable item is posted with an expected by time. When the expected time is reached, an alert message or messages are sent.
    Note: After the expected by time expires, the item can still be posted as complete. No alerts are sent except for those alerts that were sent previously during the overdue or late detection.