Opening a Workbook Session

• Opening a Workbook Session
  • Overview
  • Process
    • Presentation of the Workbook Grid
      • Read-only Mode
      • Sample Types
      • Racks
      • Display Mode
      • Limitation
      • Exporting the Workbook Grid Content to Excel™
    • Header Content
      • Scheme Column Headers in Normal Display Mode
      • Analyte Column Headers in Normal Display Mode
      • Sample Column Header in Transposed Display Mode
    • Column Widths
      • Changing Scheme-Analyte Column Widths in Normal Display Mode
      • Changing Sample Column Widths in Transposed Display Mode
    • Open Workbook(CCWKOP) with Default Scheme Group or Data Mode

Overview

After locating workbooks, a workbook session can be opened for one or more selected workbooks. A workbook is essentially a set of samples for a job scheme (or linked job scheme).

A workbook session can be opened to:

• Enter preparation weights and volumes and other preparation data, dilution factors, raw results or final results

• Display the data as read-only

• Include all QC samples, duplicate QC samples only, or no QC samples

• Include samples from one or more racks

• Display in normal mode with samples across and analytes down the page, or in transposed mode with samples down and analytes across page, in a grid-like format.

Results for sample scheme analytes can be entered by a user or captured interactively form an instrument.

Test results based on formulas are automatically determined by the spreadsheet.

The spreadsheet allows the user to navigate through the samples and analytes, use cut-copy-paste functions, expand and collapse schemes to show or hide analytes, and access in-built workbook functions or custom functionality driven by script using the workbook's main or right-click menu.

Results are assessed for detection, QC and specification limits. Cell highlighting is used to indicate specification and QC warnings and failures, and workflow status.

Once the operator is satisfied with the results, the results can be released, and subsequently validated where there are no QC failures on them.

Each laboratory might have their own rules as to whether cells that contain formulas should be locked, whether cells that are associated with an expired sample scheme analyte should be locked, whether cells that contain results can have another result entered, which workflow status of a SSA should trigger a cell to be locked, and which workflow status of a SSA can a user unlock. These rules are set by a laboratory preferences.

The workbook environment allows for:

• A customised menu that executes in-built cell formulas and commands so that results can be entered quickly and accurately.
• The execution of commands on, or result entry into, one or more contiguous or non-contiguous selected cells.
• Easy navigation through the samples and across the scheme and analytes.
• The inclusion of custom menu options which execute in-built cell formulas or functions that support script-based logic.
• Customisation of a workbook session based upon various preferences, scheme, scheme version and scheme version analyte settings. Workbook customisation is usually pre-set for specific users, roles or tests.

Process

Once workbooks are located, one or more can be selected for opening in a workbook session. Refer to Locating Jobs for Analysis and Locating Workbooks.

Workbook sessions are opened from the CCWKOP—Open Workbook application search page.

One or more schemes and/or analytes can be selected for opening in a workbook session. Only rows pertaining to one scheme version of a scheme can be selected and opened in the workbook, that is, the same scheme with a different scheme version is not allowed for data entry.

Open a workbook session

The Read-only Mode, Sample Types and Racks (from - to) search criteria provided when Locating Workbooks are not actually used by the search but dictate whether a workbook session is opened read-write or read-only and which samples are included in a workbook session.

• Conditions for Paging the Loading of Samples into the Workbook

• Conditions for Loading Linked Samples into the Workbook

• Conditions for Setting Job Scheme Locks from Workbook

• Conditions for Releasing Job Scheme Locks Set by Workbook

• Conditions for Workbook Sub-analytes Display

When a job scheme is opened for read-write in workbook, then job scheme locks are applied to stop other users updating the job structure or data for the job scheme. Refer to Conditions for Setting Job Scheme Locks from Workbook and Conditions for Releasing Job Scheme Locks Set by Workbook.

One audit record is written for each scheme loaded into the workbook containing a comma-separated list of analytes opened for the session.

Multiple workbook sessions can be opened at a time.

Presentation of the Workbook Grid

Read-only Mode

Where Read-only Mode is selected, when the workbook is opened, then the cells are read-only.

Sample Types

Specifying Sample Types is not used to locate workbooks, but dictates whether specific QC samples are opened in a workbook session.

If Sample Types is set to:

• Include all QC samples, then the workbook session includes samples regardless of the sample's Primary Analytical Type
• Include job QC samples, then the workbook session only includes samples where the sample's Primary Analytical Type is Unknown or Duplicate
• Include no QC samples, then the workbook session only includes samples where the sample's Primary Analytical Type is Unknown.

Refer to Managing the Workbook Sample List.

Racks

The selected From Rack and To Rack limit which samples are included in the workbook session.

Where only one job and one scheme is being opened, then the samples can be selected by specifying the Racks. If no racks are specified, then samples from all racks are loaded.

Display Mode

A workbook is displayed initially in, or toggled to display in, either:

• Normal mode—Where samples are presented down the page and scheme-analytes across the page
• Transposed mode—Where samples are presented across the page and scheme-analytes down the page, which is good where an instrument produces many analytes for a scheme.

Limitation

The workbook grid has a limit of 100,000 sample scheme analytes.

Exporting the Workbook Grid Content to Excel™

The content of a workbook session can be exported to Excel™.

The default mode for the export is to export all visible rows and all visible columns, however options are available to export all data from the server (as only downloaded data is exported), and to export all columns, including hidden columns.

Upon export of the grid data from CCLAS 6 to XLS native format, the following formatting is also exported:

• Sample row colours (set up by the onLoad method in the workbook script, that is, the script with a Code of WKB_LOAD and Script Type of Workbook).
• Composite QC status highlight.
• Text font (italic/bold) for a Workflow Status of Released or Validated.
• Numeric formats, as currently presented on the workbook.

Header Content

Scheme Column Headers in Normal Display Mode

When a workbook is opened in normal display mode, where an analytical preparation or analytical scheme's Data Column Header on the Details tab of the CCSCHM—Scheme Detail screen:

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

Toggle showing the scheme column group header as the scheme's data column header or as the scheme code

Analyte Column Headers in Normal Display Mode

When a workbook is opened in normal display mode, where a scheme version analyte's Data Column Header on the Data Entry tab of the CCSCHMVERANA—Scheme Version Analyte Detail screen:

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

Toggle showing the analyte column group header as the analyte's data column header or as the analyte code

Sample Column Header in Transposed Display Mode

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

Toggle showing the sample column header as per application preference or as the sample code

Column Widths

Changing Scheme-Analyte Column Widths in Normal Display Mode

Where an analyte's Default Data Entry Column Width is:

• Not empty and not zero, when a workbook is opened, then the column width for the scheme-analyte column is the defined width.
• Is empty or contains 0, when a workbook is opened, then the column width for the scheme-analyte column is 12 characters.

Change scheme-analyte column widths in normal display mode

This functionality is provided also using a workbook service, called from a script associated with the workbook main menu or right-cilck menu. Refer to the Workbook API.

Any multi-lined scheme-analyte headers truncate or grow, as required.

Changing Sample Column Widths in Transposed Display Mode

Given that 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.

Change sample column widths in transposed display mode

This functionality is provided also using a workbook service, called from a script associated with the workbook main menu or right-click menu. Refer to the Workbook API.

Any multi-lined sample headers truncate or grow, as required.

Example: If the workbook column header has three lines:

SampleName

SampleDescription

SampleID

if the column is made too narrow, then each line is individually truncated to:

SampleNa...

SampleDe...

SampleID

Open Workbook(CCWKOP) with Default Scheme Group or Data Mode

To lessen the amount of clicks and navigation when trying to find a job, scheme and data mode in workbook, two application preferences have been introduced: WORKBOOK_OPEN_SCHEME_GROUPS and WORKBOOK_OPEN_DATA_MODE.

WORKBOOK_OPEN_SCHEME_GROUPS is a preference whose value (can be more than one) is an active scheme group. If the scheme group is the value of the preference then when the user opens CCWKOP, the scheme group field is populated by the value entered in the preference. If this scheme group contains schemes and if these schemes were profiled under the job that is being opened in Workbook, then only the schemes that are part of the scheme group is displayed in the grid. Its purpose is for a topical filter where the user is not concerned about any other scheme except for the ones in the group.

A practical example is in sample preparation. If the lab technician only wants to enter data on analytical preparation schemes and not concerned with any other schemes, the current practice without this preference is to find the job, select the data mode, go through the list of schemes displayed, select the scheme, open it in workbook and enter the weights and volume. If the WORKBOOK_OPEN_SCHEME_GROUPS is used as described where the analytical prep scheme is assigned to a scheme group, and this scheme group is a value of the preference, then once the user opens CCWKOP, the user does not have to go through a list of schemes to select. The user only sees the schemes that are part of the group and therefore does not have to go through a list of schemes to find the one the technician is responsible for. This is a subtle enhancement but one that lessens the time spent on looking for the scheme and also reduces possible misselection of schemes by severely narrowing down the options visible to the technician. No value in the scheme group in CCWKOP displays all of the schemes which is the current functionality.

WORKBOOK_OPEN_DATA_MODE is a preference whose value (only one) can be FINAL, RAW, WT_VOL or DILUTION. This would default the CCWKOP Data Mode field to the value entered in the preference. This takes away another step the user has to select and is useful for analysts that perform routine and repetitive tasks. This and in combination with WORKBOOK_OPEN_SCHEME_GROUPS takes away at least two steps (looking for the scheme and selecting the data mode) the user has to do in workbook.