Screen flows

• Submit—Validate and save the changes.
• Refresh—Reloads the original data. Any changes made since the last submit are lost.
• New Search—Return to the Search screen and clear the search results and the search criteria.

Header

• Workbook Menu

  The workbook command menu is built to reflect the commands and options that the user needs to apply to the data in the workbook. The worklist command menu is dynamically loaded at application start up time, based on the WORKLIST_CMD_MENU application preference. If multiple command menus are required across the top of the workbook grid, then the WORKLIST_CMD_MENU application preference can actually hold a command separated list of script codes. The Scope for this preference could be set at instance, organisation, laboratory or user level. Typically the preference is set at laboratory level. The Value of the preference needs to be the code of a script which contains the content to define the commands within the menu. In a menu script, each menu option can be configured to either execute one of the few inbuilt workbook commands or a definable workbook script. Refer to the Appendix—Workbook Commands.

  Note: There is also a workbook right-click menu. The workbook right-click menu is built to reflect the commands and options that the user wishes to apply to the data in the workbook, and typically includes choices that are selection driven, although this is not mandatory.

  The workbook right-click menu is dynamically loaded at application start up time, based on the WORKLIST_RCLICK_MENU application preference. The Scope for this preference could be set at instance, organisation, laboratory or user level. Typically the preference is set at laboratory level. The Value of the preference needs to be the code of a script which contains the content to define the commands within the menu. In a menu script, each menu option can be configured to either execute one of the few inbuilt workbook commands or a definable workbook script. Refer to the Appendix—Workbook Commands.

• Workbook Cell Content Bar

  The content of the current selected cell. If the current selected cell contains value resolved from a formula. then the formula is displayed in the content bar.

• Barcode

  The barcode scanned in by a user.

  This Workbook Service can be run from the generic workbook script that is defined by the WORKBOOK_SCRIPT application preference, such that, the preference value contains the Script Code, and a script exists with that Code and a Script Type of Workbook.

  Typically this would execute a workbook command, for example, locate a sample in the workbook, or load the next rack.

• Scheme Analyte Details Grid

  The grid that contains the scheme and analyte details. Display only.

  A workbook can be opened in normal mode when there are few schemes and analytes and many samples. In normal mode, samples appear in rows and schemes and analytes appear in columns. Normal mode is selected by clicking Normal Mode in the CCWKOP—Open Workbook application.

  A workbook can be opened in transposed mode when there are few samples and many schemes and analytes. In transposed mode, samples appear in columns and schemes and analytes appear in rows. Transposed mode is selected by clicking Transposed Mode in the CCWKOP—Open Workbook application.

  The Scheme Analyte Details Grid is displayed on the left-hand side when the workbook is opened in transposed display mode.

  • Scheme Code

    The code of the scheme on the sample.

  • Scheme Name

    The name of the scheme the sample.

  • Scheme Description

    The description of the scheme on the sample.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Method Code

    The code of the method associated with the version of the scheme on the sample.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Method Name

    The name of the method associated with the version of the scheme on the sample.

  • Method Description

    The description of the method associated with the version of the scheme on the sample.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Analyte Code

    The code of the analyte on the sample, from the associated scheme version.

  • Analyte Name

    The name of the analyte on the sample, from the associated scheme version.

  • Analyte Description

    The description of the analyte on the sample, from the associated scheme version.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Unit Code

    The code of the analysis unit associated with the sample scheme analyte.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Unit Name

    The name of the analysis unit associated with the sample scheme analyte.

  • Unit Description

    The description of the analysis unit associated with the sample scheme analyte.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Int Lower DL

    The numeric value of the analysis lower detection limit associated with the sample scheme analyte.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Int Upper DL

    The numeric value of the analysis upper detection limit associated with the sample scheme analyte.

    Not displayed on the grid by default but can be added via showing individual grid items.

  • Workbook Results Grid

    The grid that contains the analytical results.

    A workbook can be opened in normal mode when there are few schemes and analytes and many samples. In normal mode, samples appear in rows and schemes and analytes appear in columns. Normal mode is selected by clicking Normal Mode in the CCWKOP—Open Workbook application.

    A workbook can be opened in transposed mode when there are few samples and many schemes and analytes. In transposed mode, samples appear in columns and schemes and analytes appear in rows. Transposed mode is selected by clicking Transposed Mode in the CCWKOP—Open Workbook application.

    The Workbook Result Grid is displayed on the right-hand side when the workbook is opened in transposed display mode.

    Each Workbook Cell contains content of the underlying sample scheme analyte. The actual property that is displayed depends upon the Data Mode used to open the workbook. A workbook script can change the workbook to display other properties of the sample scheme analyte.

    If a parent analyte is included in the workbook grid, then the sub-analytes are also included. The sub-analyte columns are visible by default, unless hidden by a script. Hidden columns remain accessible, that is, formulas in other cells can successfully reference the hidden cells, and instrument results can be received for hidden sub-analyte cells.

    The right-hand grid provides spreadsheet functionality.

    A cell may be locked due to various restrictions. If a cell is not locked, the cell can be directly updated with values or formulas, and resulting changes is made to values in related cells.

    Data masks (set up in CCSCHM—Scheme application for the scheme version analyte) ensure that only valid data is entered in the relevant cells, for example, a cell for a DATE analyte does not accept an arbitrary string of unformatted letters and numbers.

    The Lower Grid is displayed by invoking the CCWKOPPANE—Workbook Lower Panel application from a workbook menu script, and is used to provide details of the selected cells. Some fields in the details panel are editable. Changes are saved when the focus moves to another workbook cell.

    An image or document can be uploaded into a workbook cell, either as the sample scheme analyte's result when the sample scheme analyte's Data Type is Image or Document, or as an attachment to the sample scheme analyte when the Data Type is not Image or Document. If the same file is uploaded to multiple workbook cells, only one copy is stored on the server.

    Script functions and formulas are recalculated dynamically when data in a Workbook Cell is changed. If a workbook cell is used in one or more formulas in other workbook cells or in sample scheme analytes not loaded into the workbook, then each of the formulas are re-calculated with the new value, including those formulas that include a script function. If the formula or function cannot be evaluated for a workbook cell, a null value is returned to the cell and the conventions of failed formulas are followed.

    Whenever a result in entered into a workbook cell, specification assessment and QC assessment is performed, based upon the sample's Primary Analytical Type and Secondary Analytical Type, and the Workflow Status is evaluated. Users can select various post-assessment functions to manage the outcomes of those assessments, or to set the Workflow Status to Listed Not Received, Insufficient Sample, Not Analysed or No Result.

    If the WKBK_TRANSPOSED_GRID_SAMPLE_HEADER application preference is:

    • Defined and contains a comma-separated list of sample attributes (primaryAnalyticalType, sampleName, description, clientSampleName, workflowStatus), when a workbook is opened in transposed mode, then the sample header is displayed using these fields with each field on a new line, where invalid field names are ignored, and the row height is adjusted to accommodate the content based on how many lines of text are included in the header content.
    • Not defined, when a workbook is opened in transposed mode, then the sample header is displayed using the sampleCode field.

    If the WKBK_TRANSPOSED_GRID_COLUMN_WIDTH application preference is:

    • Defined and contains an integer, when a workbook is opened in transposed mode, then the column width for the sample columns is the defined width (120 if font size is 10, 100 if font size is 9).
    • Not defined, when a workbook is opened in transposed mode, then the column width for the sample columns is 120.

    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).

    If invalid formula parameters are entered (via manual entry or via script) the appropriate error is returned and the calculation is not completed. These errors could include:

    #DIV/0!	Division by zero.
    #N/A	No value is available.
    #NAME?	No name is available.
    #NULL!	Null intersection.
    #NUM!	Number problem.
    #REF!	Reference error.
    #VALUE!	Incorrect argument type.
    #REF!	Script reference error.
    #N/A	Script execution error.

    The grid contains:

    • Sample Details

      The details of the sample.

    • Workbook Cell

      The result of the underlying sample scheme analyte. The actual property that is displayed depends upon the Data Mode used to open the workbook, that is, the cell could contain the final result, raw result, weight/volume or dilution factor. A workbook script can change the workbook to display other properties of the sample scheme analyte as well.

• Workbook Status Bar

  The status of the current workbook cell, populated from the workbook script for the onCellSelect event.