Using the Workbook Grid
Overview
Workbook consists of a grid of sample scheme analytes, and customised menus with commands and options to enable you to work quickly and accurately with the data entered for those tests.
Use the grids to enter, edit and delete data into unlocked cells. You can cut, copy, paste and clear data and formulae into the cells.
You can select multiple cells (contiguous or non-contiguous) and enter data to be applied to all selected cells or execute a command (right click) or script on all the selected cells.
Process
Opening a Workbook Session in normal mode displays the CCWKOP—Workbook Open Detail screen, and in transposed mode displays the CCWKOP—Workbook Open Transposed Detail screen.
Workbook Cell Content
The workbook cells can only display one attribute of a sample scheme analyte at a time. By default, this attribute pertains to the selected data mode, but the operator can elect to display another property instead.
The Workbook Cell Content Bar displays the content of the current selected workbook cell.
The Workbook Status Bar displays the various statuses of the current selected workbook cell.
Also, the lower panel, when shown, displays many properties of the active cell.
Cells where a Sample Scheme Analyte Does Not Exist
If a sample scheme analyte does not exist, the cell displays dark blue.
Locked Cells
Refer to Unlocking Workbook Cells for the reason as to why workbook cells are locked.
Formulas
Refer to Conditions for Auto-calculation of Cell Formulas on Workbook Load.
Cell Colours, Fonts and Non-existing Sample Scheme Analytes
The sample list and result grid content is configurable for font family and size, column width and visibility.
Cell colours indicate specification and QC warnings and failures, and workflow status.
Cell Backgrounds
|
Situation |
Colour or Font |
Comment |
|---|---|---|
|
The sample scheme analyte does not exist (the workbook cell is displayed as empty and locked). |
|
Solid blue. |
|
A sample scheme analyte exists and the cell is selected. |
|
Medium blue. |
|
A sample scheme analyte exists and the cell is not selected, but has a workflow status of Insufficient Sample (IS) or No Result (NR). |
|
Medium purple. |
|
A sample scheme analyte exists, the cell is not selected and does not contain a workflow status of IS or NR, but is locked due to one of the following reasons: a) The cell contains a formula and the cell has not been unlocked. b) The cell contains a sample scheme analyte that is expired. c) The cell contains a workflow status listed within the AUTO_LOCK_WORKFLOW_STATUS application preference setting and has not been unlocked. d) The job or job scheme is locked by another application. |
|
Pale yellow. |
|
A sample scheme analyte exists, the cell is not selected, does not contain a workflow status of IS or NR and is not locked, but a formula exists on the sample scheme analyte. |
|
Light blue. |
Cell Fonts
If the WKBK_FONT_SETTING application preference is
- Defined and contains a valid comma-delimited font family and size, when a workbook is opened in either normal or transposed mode, then the workbook cells are displayed using that font.
- Not defined or contains an invalid comma-delimited font family and size, when a workbook is opened in either normal or transposed mode, then the workbook cells are displayed using the default font as specified in JI framework (for example, Times New Roman, 11).
|
Situation |
Colour or Font |
Comment |
|---|---|---|
|
The cell contains an unresolved formula. |
|
'#VALUE?' displayed on top of cell background colour. |
|
The cell contains an entered or determined result (from formula), and therefore has a workflow status of Analysed. |
|
Regular font plus any underlying highlighting due to composite QC or specification failure, check, lock on the cell. |
|
The cell contains a result that is released, and therefore has a workflow status of Released. |
|
Italic font plus any underlying highlighting due to composite QC or specification failure, check, lock on the cell. |
|
The cell contains a result that is validated, and therefore has a workflow status of Completed. |
|
Bold font plus any underlying highlighting due to composite QC or specification failure, check, lock on the cell. |
|
The sample scheme analyte has no result, but has a Workflow Status of Listed Not Received. |
|
'LNR' displayed on top of cell background colour. |
|
The sample scheme analyte has no result, but has a Workflow Status of Not Analysed. |
|
'NA' displayed on top of cell background colour. |
|
The sample scheme analyte has no result, but has a Workflow Status of Insufficient Sample. |
|
'IS' displayed on top of cell background colour. |
|
The sample scheme analyte has no result, but has a Workflow Status of No Result. |
|
'NR' displayed on top of cell background colour. |
Cell Corners
|
Situation |
Colour or Font |
Comment |
|---|---|---|
|
The result has a composite QC failure as one of the critical QC assessments has failed. |
|
Bottom-left solid red. |
|
The result has a composite QC warning. |
|
Bottom-left solid yellow. |
|
The result has a composite QC failure ignored, although the underlying critical QC assessment failure still exists. |
|
Bottom-left solid green. |
|
Result needs a check as it is outside of critical detection limits. |
|
Bottom-left solid red. |
|
The result has a composite specification failure as one of the specification assessments has failed, or the cell has a specification failure, depending on which is toggled to show (see below). |
|
Top-right solid red. |
|
Comments exist for the sample scheme analyte analysis. |
|
Top-right small black triangle comment marker plus any underlying font or highlighting; comments visible in lower panel, if required |
|
Where a sample scheme analyte has the isUsedInAggregate attribute set to false or contains a space, when the sample scheme analyte is displayed in a workbook cell, then the cell has a small black triangle displayed in the bottom-right corner of the cell to show that the result are not used in aggregate function calculations. |
|
Bottom-right small black triangle excluded from aggregate calculations marker plus any underlying font or highlighting. |
The top-right triangle cell highlighting can show either the sample scheme analyte's Composite Specification Status or Specification Status (the specification status of the primary specification).
Toggle cell highlighting to show either composite or primary specification status
When the primary specification status is displayed, the top-right triangle of each workbook cell is highlighted according to the sample scheme analyte's Specification Status. A red triangle in the cell background indicates a failure status, and an orange triangle in the cell background indicates a warning status.
When the composite specification status is displayed, the top-right triangle of each workbook cell is highlighted according to the sample scheme analyte's Composite Specification Status. A red triangle in the cell background indicates a failure status, and an orange triangle in the cell background indicates a warning status.
The bottom-left triangle of each workbook cell is highlighted according to the sample scheme analyte's Composite QC Status. A red triangle in the cell background indicates a failure status, and an orange triangle in the cell background indicates a warning status.
Navigating the Workbook and Selecting Cells
Keyboard arrows, the Enter, Shift+Enter, Page keys, Home-End, Ctrl Home-End keys, mouse scroll wheel and vertical scroll bars. are al available to move through the workbook.
Cell selection includes multiple continuous and non-continuous selections.
When a workbook cell is selected, any related event scripts, first from the generic workbook script (defined by the WORKBOOK_SCRIPT preference), and then from the scheme workbook script for each scheme opened in the workbook, in the order in which the schemes are displayed in the workbook, are run to perform custom logic. This can be used to display various details of the selected sample scheme analyte/s in the application status bar or lower panel (if it is displayed). Refer to the Workbook API.
To apply an action to multiple workbook cells, select one or more contiguous blocks of cells and apply the action. When multiple cells are selected, the active cell has a different colour to distinguish it from the other selected cells.
Using Cut, Copy and Paste
Data and formula in cells can be cut, copied and pasted into other cells.
Copy, cut or paste content in workbook cells
Cut, Copy and Paste with formula (CTRL+C, CTRL+V, CTRL+X); Cut, Copy and Paste with values only (CTRL+SHIFT+C, CTRL+SHIFT+V, CTRL+SHIFT+X) is also available.
Showing and Hiding Sub-analytes
Sub-analytes can be hidden and shown.
Toggling the Bottom Panel to Show More Detail for a Cell
Toggle showing or hiding the analysis detail lower panel
The lower panel, called the Details Panel, that shows content pertaining to the current selected workbook cell can be toggled to show or hide.
The upper panel in workbook can be resized to show more or less of the lower panel.
The lower panel displays nominated sample scheme and sample scheme analyte properties for the sample scheme analyte of the current workbook cell. Some fields in the lower panel are updatable. Changes are saved when the focus moves to another workbook cell.
If focus is placed on a workbook cell where the sample scheme analyte does not exist, then all fields on the lower panel are disabled and display nothing (except for readings taken when a laboratory batch job was opened in workbook, but the sample scheme analyte is now de-linked from the laboratory batch).
If a laboratory batch job is opened in workbook, some workbook cells may not be associated with a sample scheme analyte. This occurs when a sample scheme analyte never existed to start with in the laboratory batch job, or when a sample scheme analyte is de-linked from the laboratory batch. If focus is placed on one of these workbook cells, then the Readings grid in the Details Panel shows readings associated with the sample scheme analyte that were taken during the time that the sample scheme analyte was linked to the laboratory batch and the laboratory batch job was opened in a workbook session to enter those results.
The properties displayed for the current sample scheme analyte are defined by the CCWKOPPANE—Workbook Open Panel Detail application. The lower panel contains the following tabs:
- Details—The top section contains updatable properties associated with the current sample scheme analyte. The bottom section contains a read-only data grid of the readings for the current sample scheme analyte.
- Notes—Sample scheme analyte notes and sample scheme notes, all updatable. Any updates to notes are persisted immediately.
- Status—Sample scheme status dates and user details, all read-only.
The fields that can be changed on the lower panel include:
- Sample scheme properties in the Details tab, persisted upon submit.
- Sample scheme analyte Report Notes on the Notes tab, persisted immediately.
Any changes to the following sample scheme analyte fields are discarded, including:
- Unit Code (and Unit Id)
- Report Unit Code (and Report Unit Id)
- Rounding Table Code (and Rounding Table Id)
- Internal Lower Detection Limit
- Internal Upper Detection Limit
- Dilution Factor
- Uncertainty Value (by default, not shown on the form)
- User QC Status
- User Workflow Status
- Is Used in Aggregate (by default, not shown on the form)
If the analyte has a Data Type of Image or Document, then image and file attachments are retained on workbook cell focus change, then persisted upon Submit.
If the analyte does not have a Data Type of Image or Document, then image and file attachments are persisted on workbook cell focus change.
Where multiple cells are selected at a time, then the lower panel displays details related to the active sample scheme analyte, that is, the cell where the cursor is located.
Firing Events
Events that fire include:
-
FormLoad
-
BeforeChange
-
AfterChange
-
OnSelect.
Performing an Action by Scanning a Barcode or Entering Content into the Barcode Field
Often you want to be able to scan a sample code or sample identifier to locate the sample in the current rack, or scan a pre-set command that performs a particular function. This places the focus on the barcode input box (unless you are in the middle of cell data entry).
Focus on the barcode input box
Perform an action by scanning a barcode or entering content into the barcode field
This functionality is provided by a call to a workbook service.
Any entry into the Barcode field, terminated by CR (carriage return) or the ENTER key, is trapped and passed to the generic workbook script (defined by the WORKBOOK_SCRIPT application preference), where the related barcode event script contained within the script is run to perform custom logic.
This does not occur when the user is in the process of entering content into a workbook cell, in which case, any keyboard/barcode entry is treated as a result for the sample scheme analyte.
As most barcode scanners can be programmed either without termination character/s, it would be presumed that the barcode string is either not terminated such that the user needs to press enter after the barcode is scanned, or programmed with a terminating CR, or perhaps CRLF (carriage return and line feed) such that the entry is terminated and sent straight to the processing event.
The related barcode event script is run to perform custom logic. This can be used to execute a particular workbook command, locate a sample in the current workbook (by locating the cursor to that sample if it exists and to prompt a message in a dialog box or the status bar if the samples does not exist), load a specific sample into the current workbook (equivalent to loading a sample in the Worklist mode of workbook, such that, the loading of a new sample triggers the saving of the current sample if it is not yet persisted, and any invalid entry causes an error to be displayed in a dialog box or on the status bar), or load the next rack. Refer to the Workbook API.
Note: When a block of workbook cells are selected, the barcode action is performed on all selected cells.
As the processing of the input is up to the script writer, if a user just pressed ENTER in an empty Barcode text input field, this empty value is still sent straight to the processing event.
Once the processing event is triggered, Barcode is cleared.
