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.
• Submit and Close—Submit workbook changes and close the worksheet.

Header

• Command Menu

  The command menu displays across the top of the workbook and is built to reflect the commands and options that the user needs to apply to the workbook. The command menu is dynamically loaded at application start-up based on the WORKBOOK_CMD_MENU application preference. If multiple menus are required in the command menu, then the preference can hold a comma-separated list of script codes.

  The right-click menu displays when a cell in the workbook is right-clicked and is built to reflect the commands and options that the user needs to apply to the cell. The right-click menu is dynamically loaded at application start-up based on the WORKBOOK_RCLICK_MENU application preference. If multiple menus are required in the right-click menu, then the preference can hold a comma-separated list of script codes.

  For both the command menu and right-click menu:

  • Typically, the preference's Scope is set at Laboratory level.

  • The preference's Value must be the code of a script that contains the content defining the commands within the menu, where the script's Script Type is Workbook.

  In a menu script, each menu option can be configured to either execute one of the few inbuilt workbook commands or a particular workbook script.

• 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. Typically, the barcode event would execute a workbook command, for example, to locate a sample in the workbook, or load the next rack.

  This workbook service can be run from the generic workbook script that is defined by the WORKBOOK_SCRIPT application preference. Typically, the preference's Scope is set depending upon the laboratory's or user's requirements. The preference's Value must be the code of a script that contains the content defining the action taken by the barcode entry, where the script's Script Type is Workbook.

Sample Details Grid

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 Sample Details grid is displayed on the left-hand side when the workbook is opened in normal display mode. All sample detail grid properties are display only. All of the sample grid properties are not displayed on the grid by default, but can be added via showing individual grid items.

Refer to Conditions for Workbook Sample Biofield Display.

• Row No

  The number of the row in the workbook.

• Rack No

  The number of the rack containing the sample scheme. The rack number is populated only when a single scheme is opened for the workbook. The rack size is determined from the container type's Default Number of Containers for the scheme's Container Type Code. An update or overwrite QC process on a job scheme sets this, as can a re-rack action on a job scheme in the CCQCSM—QC Sample Modification application.

  A workbook script can be used to hide this column when more than one scheme is opened for the workbook.

• Primary Analytical Type

  The primary analytical type of the sample that denotes the type of QC assessment that the sample primarily undergoes after receiving a result. Display only. This can be:

  • Unknown

  • Duplicate

  • Replicate

  • Blank

  • Standard

  • Spike.

• Secondary Analytical Type

  The secondary analytical type of the sample that denotes the type of QC assessment that the sample undergoes after receiving a result. Display only. This can be:

  • Duplicate

  • Replicate

  • Blank

  • Standard

  • Spike.

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

• Sample Code

  The system-generated, organisation-wide, unique identification code of the sample. Display only.

• Sample Name

  The name of the sample. Display only.

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

• Client Sample Name

  The client's name for the sample. Display only.

• Sample Description

  The description of the sample. Display only.

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

• Job Code

  The code of the job associated with the sample. Display only.

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

• Job Name

  The name of the job associated with the sample. Display only.

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

• Job Type

  The type of job associated with the sample, such that, the sample is considered also to be of that type. Display only. This can be:

  • Production—A production job is a collection of samples and their tests submitted from a client, from which a certificate report of results is generated for the client.

  • Lab Batch—A laboratory batch job is a collection of samples for common testing, gathered together to save on costs and for time efficiency of preparation and analysis.

  • Internal—An internal job is a collection of samples and tests registered for internal purposes, for example, analysis of instrument calibration.

  • Proposal—A proposal job is a collection of proposed samples and tests for a client, so that the client can be given an example of a typical report and invoice if real samples were submitted for testing.

  • Template—A template job is used to create other jobs and can contain a collection of template samples and their tests that are optionally included when creating a job from it.

  • Schedule—A schedule job is similar to a template job except that it has a registration frequency, and contains a collection of stream samples and their tests, that may be used interactively to draft a job, update the draft job content, and from that create or update a production job, or that may be used by the batch queue at the scheduled time to create or update a production job with stream samples. A stream sample is a sample of a known product that is taken a particular location in the production process, or a standard sample that is inserted into the analytical stream of samples from the production process.

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

• Product Code

  The code of the product associated with the sample. Display only.

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

• Primary QC Type Code

  The code of the primary QC type that is a sub-classification of the Primary Analytical Type. Display only.

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

• Secondary QC Type Code

  The code of the secondary QC type that is a sub-classification of the Secondary Analytical Type. Display only.

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

• Standard Code

  The code of the standard associated with the sample. Applicable only where the Primary Analytical Type or Secondary Analytical Type is Blank, Standard or Spike. Display only.

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

• Standard Lot Code

  The code of the current standard lot for the standard associated with the sample. Applicable only where the Primary Analytical Type or Secondary Analytical Type is Blank, Standard or Spike. Display only.

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

• Primary Product Specification Code

  The primary specification on the sample, which indicates which sample scheme analyte specification's Specification Status is rolled into a sample scheme analyte's Composite QC Status. Display only.

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

• QC Mask Code

  No functional use in core CCLAS. Represents the code of the QC mask associated with the sample. Display only.

• Client Code

  The code of the client associated with the sample. Note that this is NOT the code of the client associated with the job. Display only.

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

• Client Name

  The name of the client associated with the sample. Note that this is NOT the name of the client associated with the job. Display only.

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

• Project Code

  The code of the project associated with the sample. Note that this is NOT the code of the project associated with the job. Display only.

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

• Sample Type Code

  The code of the sample type associated with the sample. Display only.

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

• Sample Point Code

  The code of the sample point associated with the sample. Display only.

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

• Is Composite

  Indicates whether the sample is a composite sample. Display only.

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

• Priority

  The priority of the sample with respect to other samples in the system. Display only.

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

• Required On

  The date-time by which the sample's results must be reported. Display only.

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

• Possible On

  Although this should be the possible date-time at which the sample's results can be reported, based on the longest duration of sample analysis, currently this is the same as Required On. An update to Possible On is persisted where the date-time provided is valid, and later than the Received On date-time where one is defined, otherwise an error message displays upon submit. Display only.

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

• Registered On

  The date-time at which the sample was registered into CCLAS. Display only.

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

• Sampled On

  The date-time at which the sample was taken. Display only.

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

• Started On

  The date-time at which the sample was started, when the sample's Workflow Status became Started.c

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

• Analysed On

  The date-time at which the sample was analysed, when the sample's Workflow Status became Analysed. Display only.

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

• Validated On

  The date-time at which the sample was validated. Display only.

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

• Finalised On

  The date-time at which the sample was finalised. Display only.

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

• Released On

  The date-time at which the sample was released, when the sample's Workflow Status became Released. Display only.

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

• Composite Specification Status

  The composite specification status of the sample indicating the status of the underlying analytical results against all sample specifications. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Failure.

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

• Composite QC Status

  The composite QC status of the sample indicating the status of the underlying analytical results. Display only. This can be:

  • Not Tested

  • Not Required

  • Pass

  • Warning

  • Failure

  • Ignored Failure.

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

• Workflow Status

  The status of the sample indicating the stage it is at within its life-cycle. Display only. This can be:

  • Registered

  • Not Started

  • Started

  • Analysed

  • Released

  • Completed

  • Not Analysed

  • No Result

  • Insufficient Sample

  • Listed Not Received

• #Sch

  The number of schemes registered for the sample. Display only.

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

• #Sch STA

  The number of sample schemes associated with the sample where the sample scheme's Workflow Status is Started. Display only.

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

• #Sch CPL

  The number of sample schemes associated with the sample where the sample scheme's Workflow Status is Listed Not Received, Insufficient Sample or Completed. Display only.

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

• Profile Sequence

  The sequence of the scheme on the sample.

  Not displayed on the screen by default, but can be added via screen personalisation.

• Registration Sequence

  The sequence of the sample in the job scheme.

  Not displayed on the screen by default, but can be added via screen personalisation.

Results Grid

The Results Grid is displayed on the right-hand side when the workbook is opened in normal display mode.

If a parent analyte is included in the results grid, 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 for the scheme version analyte) ensure that only valid data can be 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 can be displayed by invoking the CCWKOPPANE—Workbook Lower Panel application from a 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 grid cell.

An image or document can be uploaded into a grid 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 grid cell is changed. If a grid cell is used in one or more formulas in other grid cells or in sample scheme analytes not loaded into the workbook, 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 grid cell, a null value is returned to the cell and the conventions of failed formulas are followed.

Whenever a result in entered into a grid cell, specification and QC assessment is performed, based upon a sample's Primary Analytical Type and Secondary Analytical Type, and the sample scheme analyte's Workflow Status is evaluated. Users can select various post-assessment functions to manage the outcomes of those assessments, or to mark a sample as being listed but not received, or a sample scheme analyte to having insufficient sample for analysis, being not analysed, or having no result.

• Error Display

  If invalid formula parameters are entered (via manual entry or via script), then 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.

• Results Grid

  • Scheme Header and Analyte Header

    The scheme's Data Column Header and the scheme version analyte's Data Column Header.

    When a workbook is opened, where an analytical preparation or analytical scheme's Data Column Header:

    • Contains text, then the scheme header is displayed using that text (up to 100 characters, and might include CRLF for a multi-line display), centre-justified, with the row height increased, as required.

    • Is empty, then the scheme header is displayed using scheme code, centre-justified, with the row height increased, as required.

    When a workbook is opened, where a scheme version analyte's Data Column Header:

    • Contains text, then the analyte header is displayed using that text (up to 100 characters, and might include CRLF for a multi-line display) left-justified (though can be realigned via script), with the row height increased, as required.

    • Is empty, then the analyte header is displayed using analyte code, left-justified (though can be realigned via script), with the row height increased, as required.

    Where an analyte's workbook settings are configured such that the analyte's Default Data Entry Column Width is:

    • Not empty and not zero, then the column width for the scheme-analyte column is the defined width.

    • Is empty or contains 0, then the column width for the scheme-analyte column is 12 characters.

    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 grid 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 grid cells are displayed using the default font as specified in JI framework (for example, Times New Roman, 11).

  • Grid 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.

• Status Bar

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