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
| Name | Description |
|---|---|
| Linked Placeholder | The 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 Default | The default sorting direction (oldest to newest vs. newest to oldest) |
| Enable Sorting | A 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 Updates | Choose to hide the "Old" column that compares an old value of a data point to the new one |
| Hide Process Data | Choose to hide data from completion records in which the table record is included |
| Signed Completions Only | Only 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
| Name | Description |
|---|---|
| User Name or API Token Name | The user that opened the app in the Player or interacted with the Table admin interfaced, or API token that updated the record |
| Type of Change | Whether the user created, updated or deleted the record |
| Changed Fields | The 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 |
| Timestamp | The 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.
| Name | Description |
|---|---|
| User Name | The user who ran the App |
| App Name | The app where the record was modified |
| Version | The version number of the app that was being run |
| Station Name | The name of the station where the app was run |
| Step Name | The name of the step where the record was modified |
| Step Open Timestamp | The datetime when the step was opened |
| Record Change Timestamp | The datetime when the trigger was run that modified the record |
| Variable Name List | The list of variables with values at the time that app data was captured |
| Variable Values | The value of each variable at the time that app data was captured |
| Variable Update Timestamp | The timestamp that the step was changed after variables were modified |
| Signature Name | The text label of the Signature Widget or Signature Form |
| Signature Data | The Variable and Table Record Field values at the time of signing |
| Signature Meaning | The association between the user signing and the data being signed for |
| Signature Comment | The text comment associated with a signature from the Signature Widget |
| Signature Signer | The username and ID of the user that signed the Signature Form or Signature Widget |
| Signature Timestamp | The 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.
Requirements
| ID | Requirement |
|---|---|
| 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. |