Applying a Custom Workflow Status in a Workbook Session
Overview
Sometimes there is a need to provide more information as to why a sample scheme analyte's Workflow Status was achieved. To do this, a custom workflow status is applied.
Process
Defining Custom Workflow Statuses
Custom workflow statuses are entered as System Table Codes with a Table Type of C30—User Statuses, as configured in the MSETBL—Table Code Service application.
If a user workflow status has an associated value of LNR, IS, NA or NR, when the sample scheme analyte's User Workflow Status is set, then the related Workflow Status is set, and if any other workflow status is referenced, then it is ignored.
Note: Where a sample scheme analyte has a User Workflow Status set by the user, this status is linked to the sample scheme analyte's Workflow Status.
Examples of user workflow status configuration:
| Table Type |
Table File Code (System Short Form) |
Table file entry description |
Table File Associated values (Related core Workflow Status) |
|---|---|---|---|
|
CC30 |
BRK |
Sample Breakage |
IS |
|
CC30 |
CONT |
Contamination |
NA |
|
CC30 |
INS_WT |
Insufficient Weight |
IS |
|
CC30 |
LIL |
Lost in Lab |
IS |
|
CC30 |
LIP |
Lost in Prep |
NA |
|
CC30 |
LIT |
Lost in Transit |
LNR |
|
CC30 |
LNR |
Listed Not Received |
LNR |
|
CC30 |
NA |
Not Analysed |
NA |
|
CC30 |
NR |
No Result |
NR |
|
CC30 |
OVR |
Over Range |
NA |
|
CC30 |
RTC |
Result to Come |
NR |
|
CC30 |
UNSEALED |
Unsealed |
NA |
The Table Code can be set to any combination of letters, digit, and symbols. Maximum 18 characters.
The Entry description can be modified as appropriate for reporting purposes. Maximum 50 characters.
To tie the user workflow status to a core workflow status, the Associated Values must be set to the Table Code value of a core Workflow Status of Listed Not Received, Insufficient Sample, No Analysis or No Result. This field is optional. If this field is set, when a sample scheme analyte's User Workflow Status is set, then its Workflow Status is set to the associated core workflow status. Where this field is not set, when a sample scheme analyte's User Workflow Status is set, then its Workflow Status remains unchanged.
Note: The definition of a core Workflow Status is ONLY applicable for Listed Not Received, Insufficient Sample, No Analysis or No Result core statuses to indicate the actual reason as to why this core status was set.
Important: This mechanism cannot be used to set another core Workflow Status as the setting of workflow status is managed by system mechanisms. For example, this process cannot be used to set a sample scheme analyte to have a Workflow Status of Complete or Released. However, a User Workflow Status can be set on a sample scheme analyte that has a Workflow Status of Released or Validated, but this process is not the actual release or validation process.
By default, the drop-down list of user QC statuses that are built from the CC30—User Statuses Table Type, ordered by Table Code. For example, using the table above, the drop-down list presented when marking workbook cells with a user workflow status is ordered: BRK, CONT, INS_WT, LIL, LIP, LIT, LNR, NA, NR, OVR, RTC, UNSEALED. Refer to Appendix—Job Audit Event Codes.
To change this default order, where a pipe character (|) is included in the Table File Associated Values, then the portion before the pipe character contains the sequence for display, and the portion after the pipe character contains the actual user status. For example:
| Table type |
Table File Code (System Short Form) |
Table file entry description |
Table File Associated Values (Related core Workflow Status) |
|---|---|---|---|
|
CC30 |
BRK |
Sample Breakage |
3|IS |
|
CC30 |
CONT |
Contamination |
7|NA |
|
CC30 |
INS_WT |
Insufficient Weight |
4|IS |
|
CC30 |
LIL |
Lost in Lab |
5|IS |
|
CC30 |
LIP |
Lost in Prep |
10|NA |
|
CC30 |
LIT |
Lost in Transit |
2|LNR |
|
CC30 |
LNR |
Listed Not Received |
1|LNR |
|
CC30 |
NA |
Not Analysed |
6|NA |
|
CC30 |
NR |
No Result |
11|NR |
|
CC30 |
OVR |
Over Range |
8|NA |
|
CC30 |
RTC |
Result to Come |
12|NR |
|
CC30 |
UNSEALED |
Unsealed |
9|NA |
populates the drop-down list of available user QC statuses in the order: LNR, LIT, BRK, INS_WT, LIL, NA, CONT, OVR, UNSEALED, LIP, NR, RTC.
Where only some of the entries have the sort order defined, then the drop-down list is ordered first by those that have a sort order in the given sort order, and secondly by those that do not have a sort order in the given table order.
Setting a Custom Workflow Status on Workbook Cells
A custom workflow status can be set only via a workbook script (typically accessed via the right-click menu from workbook cells) for selected workbook cells.
Mark workbook cells with a user workflow status
Use wild-cards to apply filtering on the drop-down list.
Any update to a QC sample scheme analyte's User Workflow Status is persisted to the associated QC history observation.
Related processes...