specs/models/M_APP_VER_STEP_HIST_WIDGET

Record History Widget

The Record History widget allows you to view the history of any table record that has been loaded into a Record Placeholder in an app that is running in the Tulip Player.

It is commonly used to view the history of batches, materials and subassemblies.

You can view one record at a time within the widget.

A Tulip user will typically build an app called "Review and Approval" that is meant for another Tulip user from the quality department.

The member of the quality team will view the history record for a recently completed batch, and then sign their approval. This will complete the app and log their official approval.

So, this widget is commonly used in combination with these other features:

Since records can be modified in both the Player and the Tables admin interface, the Record History Widget includes events from both sources. For easier reviewability and compareability, all datetime values in the record history widget are shown using the same time zone and the datetime format of the account. This can be changed in the account settings. The time zone used for the datetime values will be inferred from the device that is running the Tulip player.

Fields

These fields are used to customize the widget within the App Builder

NameDescription
Linked PlaceholderThe record placeholder that will populate the widget when used in the Player
Enable Printing (optional)A boolean option that determines whether the record history can be printed within the Player
Footer (optional and only when printing is enabled)Text field for showing a custom footer on each page of Record History when printed
Sorting DefaultThe default sorting direction (oldest to newest vs. newest to oldest)
Enable SortingA boolean option to allow or prevent sorting of the widget from within the Player
From Date (optional)The earliest date to show updates to record history in Player
To Date (optional)The latest date to show updates to record history in Player
App Name (optional)Choose to only show updates to a record that came from a specific app
Step Name (optional)Filter data by the name of the Step in which it was recorded
Table Field Name (optional)Choose to only show updates to a specific record field
Table Field Value (optional)Choose to filter updates by the value within a Table field. Only fields of the selected Placeholder can be selected
User (optional)Choose to only show updates by a specific user
Hide "Old" Values in Record UpdatesChoose to hide the "Old" column that compares an old value of a data point to the new one
Hide Process DataChoose to hide data from completion records in which the table record is included
Signed Completions OnlyOnly show process data and Table records that occur during a completion that also contains a signature.

Data Recorded

The following sections decribe the data that are recorded and shown in the record history widget for a specific table record.

Creating, changing or deleting a table record

NameDescription
User Name or API Token NameThe user that opened the app in the Player or interacted with the Table admin interfaced, or API token that updated the record
Type of ChangeWhether the user created, updated or deleted the record
Changed FieldsThe fields that were modified
Changed Values (Old)The values in the record before the change
Changed Values (New)The values in the record after the change
TimestampThe datetime when the user modified the record

Note: In the Table admin interface, records and associated fields are modified after clicking 'Save' (when editing) or 'Create' (when creating a new record). Note: Writing the identical value it currently has to a record field is not counted as an updated as the actual value does not change and therefore is not reflected in the record history.

Completion data

If a completion record includes a table record loaded into a record placeholder, the completion data is included in the record history of that table record.

Note: To create a completion record, the user must complete the app or run the "save all app data" trigger action. Note: Only variables that are marked as "Save for Analysis" in the Variables dialog in the App Builder will be included in the completion record.

NameDescription
User NameThe user who ran the App
App NameThe app where the record was modified
VersionThe version number of the app that was being run
Station NameThe name of the station where the app was run
Step NameThe name of the step where the record was modified
Step Open TimestampThe datetime when the step was opened
Record Change TimestampThe datetime when the trigger was run that modified the record
Variable Name ListThe list of variables with values at the time that app data was captured
Variable ValuesThe value of each variable at the time that app data was captured
Variable Update TimestampThe timestamp that the step was changed after variables were modified
Signature NameThe text label of the Signature Widget or Signature Form
Signature DataThe Variable and Table Record Field values at the time of signing
Signature MeaningThe association between the user signing and the data being signed for
Signature CommentThe text comment associated with a signature from the Signature Widget
Signature SignerThe username and ID of the user that signed the Signature Form or Signature Widget
Signature TimestampThe timestamp when the user successfully submitted the Signature Form Step or signed the Signature Widget

Viewing History of Deleted Records

If a user deletes a record, the history can be restored and viewed in the Record History Widget.

Example: If the record with ID "123" was deleted, a user must create a new record with ID "123" in the same Table.

When viewing the record history for this record, it will include any history from before the record deletion.

Tests

IDName
QA-T596Widgets - Record History Widget

Requirements

IDRequirement
PLAT-8871 (855)For records supporting batch release it should be possible to generate printouts indicating if any of the data has been changed since the original entry.
PLAT-8874 (848)The ability to discern invalid or altered records. Ability to annotate data is changed. For GMP or critical data changes annotation can be configured as required.
PLAT-8883 (814)Ability to view, display and and print accurate and complete records, including any attachments, electronic signatures and their associated audit trails.