Locating Workbooks

Overview

A workbook is essentially a set of samples for a job scheme (or linked job scheme).

Workbooks are located by one of several data modes to allow for the entry of different types of results for a test, given that analytical techniques can have multiple steps. Typically this involves weighing and optionally diluting a portion of the sample, after which the weighed/diluted sample portions are analysed by an instrument, that provides the laboratory with the results of the analysis. Often instrument results are automatically calculated by the instrument as final results, however, raw results can be captured and final results determined from them using weight-volume, instrument and dilution factor corrections.

Process

Workbooks are located by a search using the CCWKOP—Open Workbook application.

Search for workbooks

Workbooks are located by Job Name, Archive Status and Data Mode.

Note that the Read-only Mode, Sample Types and Racks (from - to) search criteria 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.

Schemes and analytes returned from a search can be exported to a report. Refer to Generating Grid Reports. Available report templates are defined in the SEARCH_REPORT_CCWKOP application preference.

Searching by Job Name and Archive Status

Where one or more job names are known, the CCWKOP—Workbook Open can be launched from the menu or quick search, and Job Name and Archive Status entered as search criteria.

Select an Archive Status to make the job search more efficient.

Where the CCWKOP—Search Open Workbook application is launched from the CCWKBK—Search Workbook application, then the Job Name and Archive Status are passed through from there and displayed as search criteria.

At least one Job Name must be supplied for the search.

Only production, laboratory batch, internal, proposal and template jobs are searched. Schedule and draft jobs are not searched.

Only activated jobs are searched.

The specified jobs are searched to derive the unique list of schemes. One scheme row appears for each unique scheme version throughout all the selected jobs.

Searching by Data Mode

The Data Mode can be selected as Weight/Volume mode, Dilution mode, Raw results mode or Final results mode to determine the type of result being entered during the workbook session, and limits the types of schemes and analytes that can be opened.

The schemes that are returned from a search depend upon the Scheme Type and the selected Data Mode of the workbook session. For example, for a weight/volume workbook session, a job scheme has to contain an analyte with an Analyte Code of WEIGHT or VOLUME or where the analyte's Analyte Type is PREPARATION OTHER.

Weight/Volume Mode

If a sample requires digestion into a solution for the scheme analysis, you first weigh the sample and digest it into a volume of solution. The weight/volume mode is used to enter sample aliquot weights and volumes for those results that require correction, or view weight or volume data.

The weight/volume data mode is not available if more than one job, or more than one scheme in a job, is being opened, or the scheme is not flagged as having Correction Applied.

Schemes are returned from the search where the scheme's Correction Applied is selected and the scheme in the selected jobs contains an analyte with a Code of WEIGHT and an analyte with a Code of VOLUME. Both analytes with these codes must exist in the job scheme. Also note that the system looks for an analyte with a Code of WEIGHT and an analyte with a Code of VOLUME, and does not rely on the Analyte Type of Preparation Weight and Preparation Volume. The sample scheme analyte final result is displayed in the cell, but note, it is the final result of the weight or volume, not the final result of analytical analytes.

A job scheme link relationship allows only the first (as determined by the 'from' and 'to' linked scheme relationships in the job schemes) in a series of linked job schemes to be opened after searching for workbooks with weight/volume mode. Refer to Conditions for Loading Linked Samples into the Workbook.

Analytes with an Analyte Type of Preparation Other are also returned from the search, and if selected for the workbook session, can have results entered.

Analytes with an Analyte Type of Analytical cannot be opened.

When workbook cells are populated in weight/volume mode, if a sample scheme analyte exists for the sample and test, the cell displays the current result. Depending upon the sample scheme analyte's Current Data Type, the result is extracted from either Numeric Final Value, Boolean Value, Date Time Value or Text Value. Typically for a weight or volume, the result is numeric. If the scheme version analyte's Display Mask is defined, any numeric final value is rendered according to the display mask. If a sample scheme analyte does not exist, the cell displays dark blue.

As weights and volumes are entered, the system checks that they obey the tolerances set up in the scheme. The ALLOW_ACCEPT_OUT_OF_RANGE_WEIGHTS_AND VOLUMES application preference determines whether or not the user may accept out of range values.

As a raw result is captured (next entered in raw results mode), it is automatically corrected for actual weight and volume, or by a dilution factor (previously entered in dilution modes), to derive the final result.

Weights and volumes entered in analytical preparation and analytical schemes are propagated into sample scheme analytes in the same and any linked scheme, as long as there is no existing final result already, thereby ensuring that the raw results can be corrected for those analytes that require it.

Functionality for Weight/Volume mode:

Lock cell—Based on access level, Workflow Status and formula lock
Unlock cell—Based on Workflow Status and formula lock
Instrument—Select, start, stop
Alphanumeric mode—Toggle on/off
Data entry—Non-numeric result is allowed, reading created after entry, can view readings, Numeric Final Result is pushed to associated SSA.Weight or SSA.Volume
Formulas—Cannot be entered into any cell
Workflow Status changes—Mark as LNR, IS, NA or NR, release, validate, request repeat, activate upper scheme, reassess results, reset Workflow Status
QC Status changes—Ignore DL Failures, Ignore QC Failures.

Dilution Mode

If the sample solution is too concentrated for the instrument to determine a result, the dilution mode is used to enter sample aliquot dilutions for liquid samples by specifying how much extra dilution solution is added to the sample so that it can be taken into account when applying a correction to the result, or view dilution data. Then, as a raw result is captured (next entered in raw results mode), it is automatically corrected for actual weight and volume (previously entered in weight/volume mode), or by a dilution factor, to derive the final result.

The dilution mode is not available if more than one job or more than one scheme in a job is being opened, or the scheme is not flagged as having Correction Applied.

Schemes are returned from the search where the scheme in the selected jobs contains at least one analyte with an Analyte Type of Analytical.

Analytes with an Analyte Type of Analytical and Preparation Other are returned from the search, however, preparation other analytes are opened as read-only in the workbook session.

Functionality for the Dilution mode:

Lock cell—Cannot unlock a locked cell
Data entry—Numeric data only, saved to SSA.DilutionFactor
Formulas—Cannot be entered into any cell
Force recalculation and reassessment of results—Cannot be done.

Raw Results Mode

The raw result mode is used to enter raw data, uncorrected for weight and volume, which has been captured from an instrument or entered from a worksheet and requires correction for actual weight and volume (previously entered in Weight/Volume mode), instrument factor and/or dilution factor (previously entered in Dilution mode), or view raw data.

The raw results data mode is not available if more than one job, or more than one scheme in a job, is being opened, or the scheme is not flagged as having Correction Applied.

Final results are calculated dynamically as raw results are entered/captured.

Schemes are returned from the search where the scheme in the selected jobs contains at least one analyte with an Analyte Type of Analytical.

Analytes with an Analyte Type of Analytical and Preparation Other are returned from the search, however, preparation other analytes are opened as read-only in the workbook session.

Only analytes with an Analytical Type of Analytical are displayed.

Only analytes with a Data Type of Numeric and Numeric Only display the raw result of the sample scheme analyte in editable mode.

Functionality for Raw Results mode:

Lock cell—Based on access level, Workflow Status and formula lock
Unlock cell—Based on Workflow Status and formula lock
Instrument—Select, start, stop
Data entry—Non-numeric result is allowed, readings created after entry, can view readings. Depending upon the sample scheme analyte's Current Data Type, the result is extracted from either Numeric Raw Value, Boolean Value, Date Time Value or Text Value. If the scheme version analyte's Display Mask is defined, any numeric final value is rendered according to the display mask.
Raw-Final calculations—Calculation of the Final Result
Formulas—Not available, but are resolved on a calculated Final Result
Workflow Status changes—Request repeat, activate upper scheme, reassess results, reset Workflow Status.

Final Results Mode

If the instrument provides final results, or you just want to look at what the final results are after entering raw results, perhaps to see calculations, or to validate the data, then you selects the final results data mode. Final results is calculated dynamically as raw results are entered/captured.

The final result mode is used to enter final data which does not require any correction or dilution, or view final data (raw data which has already been corrected for weight, volume or dilution).

The final results mode is the default mode for a workbook, and is the only mode available if more than one job, or more than one scheme in one job, is being opened, or the scheme is not flagged as having Correction Applied.

Schemes are returned from the search where the scheme in the selected jobs contains at least one analyte with an Analyte Type of Analytical.

Analytes with an Analyte Type of Analytical and Preparation Other are returned from the search, however, preparation other analytes are opened as read-only in the workbook session.

If correction was applied to determine a final result and the final result is amended, then the raw result is re-calculated.

Analytes with a code of WEIGHT or VOLUME or an Analyte Type of Analytical or Preparation Other are displayed; those of Preparation Weight or Preparation Volume are not displayed.

Bottom-left cell highlighting indicates Composite QC Status, top-right cell highlighting indicates Composite Specification Status or Primary Specification Status (these two modes can be toggled by a workbook script).

Functionality for Final Results mode:

Lock cell—Based on access level, Workflow Status and formula lock
Unlock cell—Based on Workflow Status and formula lock
Instrument—Select, start, stop
Alphanumeric mode—Toggle on/off
Data entry—Non-numeric result is allowed, readings created after entry, can view readings. Depending upon sample scheme analyte's Current Data Type, the result is extracted from either the Numeric Final Value, Boolean Value, Date Time Value or Text Value. If the scheme version analyte's Display Mask is defined, any numeric final value is rendered according to the display mask.
Raw-Final calculations—Calculation of the Raw Result
Formulas—Displayed, can be entered, resolved
Workflow Status changes—Mark as LNR, IS, NA or NR, release, validate, request repeat, activate upper scheme, reassess results, reset Workflow Status.

Viewing the Scheme Summary Returned from a Search

A scheme can be expanded to show its analytes that exist on the searched jobs. One analyte row appears under each scheme row for each unique scheme version analyte throughout all the selected jobs. Sub-analytes are not displayed in this grid (that is, where the scheme version analyte's Parent Analyte Code is not defined), however they are displayed in the workbook). Refer to Conditions for Workbook Sub-analytes Display.

When a user is searching for workbooks, the section's Access User Group Code associated with the opened schemes determines which schemes are visible to a user.

Scheme's Section Code is defined	Section's Access User Group Code is defined	User is a member of the Access User Group	User has visibility to the scheme when searching for workbooks to open
No	--	--	Yes
Yes	No	--	Yes
Yes	Yes	No	No
Yes	Yes	Yes	Yes