Using Sub-analytes

Sub-analytes are considered child entities of an existing analyte, and are created typically to:

Record properties or measurements not specific to the expected results of analysis of the parent analyte.
These may be as simple as additional limits values for a sample, or complex, requiring calculation by formula.
Assist in the review or calculation of a parent analyte, for example in a formula
Hold intermediate, alternate data or user workflow status.

Sub-analytes are hidden easily from view in the workbook data grid should the operator require it.

Apart from the hide/show sub-analyte functionality in the workbook grid, sub-analytes are treated as any other analyte for all other processes:

Addition of tests to samples during registration (the addition of sub-analytes is a manual process, just like adding other types of analytes)
System-calculation of formulas in workbook
Execution of formula calculations when results are received
Update of QC history when results are received
Execution of commands impacting sample scheme analytes in workbook
Validation of sample scheme analytes in validation
Roll-up of a sample scheme analyte's workflow status by the cascade engine
Inclusion of analytes in a report request
Inclusion of analytes in an invoice.

Defining an Analyte as a Sub-analyte

Sub-analytes are created similarly to other analytes, the only difference being that a sub-analyte has a link to a parent analyte in the same scheme version.

Analytes are configured for schemes that have a Scheme Type of Analytical Preparation or Analytical.

A sample scheme analyte is treated as a sub-analyte if it has Parent Analyte Code defined. The parent analyte is any other analyte within the same scheme version.

Typically, a sub-analyte does not have the following options checked: Workflow Active, QC Active, Reportable and Invoiceable.

Sub-analytes are created and maintained in the same way as regular analytes using the CCSCHM—Scheme application.

The intended parent analyte must have a Parent Analyte Code defined.

The sub-analyte must be in the same scheme version as the parent analyte.

The Scheme Type to which the sub-analyte is being added must be either Analytical Preparation or Analytical.

Refer to Maintaining Scheme Version Analytes.

Examples

You want to capture three analytical results and have the calculated average placed into the final analytical result.
Create an analyte and set Analyte Code to CU, Data Type to Numeric, and Analyte Type to ANALYTICAL.
Create three analytes and set Analyte Code to CU1, CU2 and CU3, respectively, Data Type to Numeric, and Analyte Type to ANALYTICAL so that they can be opened in a raw/final workbook session along with the CU analyte, and Parent Analyte Code to CU.
Add a Spreadsheet Formula to analyte CU: AVERAGE(CU1,CU2,CU3).
You want to record the image produced by an instrument and various intermediary results, but to hide those results in the workbook.
Create an analyte and set Analyte Code to AL, Data Type to Numeric, and Analyte Type to ANALYTICAL.
Create an analyte and set Analyte Code to AL_IMAGE, Data Type to Image, and Analyte Type to ANALYTICAL, and Parent Analyte Code to AL.
Create an analyte and set Analyte Code to AL_RAW1, Data Type to Numeric, and Analyte Type to ANALYTICAL, and Parent Analyte Code to AL.
Create an analyte and set Analyte Code to AL_RAW2, Data Type to Numeric, and Analyte Type to ANALYTICAL, and Parent Analyte Code to AL.

Adding a Sub-analyte to a Sample

Sub-analytes are added to sample schemes in the same way as regular non-sub-analytes.

Sub-analytes are added to sample schemes using the CCREGN—Job application.

When searching for schemes to add to a sample, all analytes from the highest published scheme version, regardless of whether they are sub-analytes or not, are returned to the available tests grid.

If you select to Add Entire Scheme with Mandatory Analytes, then all analytes within selected scheme where the Mandatory Profile is selected are added to the sample, regardless of whether they are sub-analytes or not.

If you select to Add Entire Scheme, then all analytes within the selected scheme are added to the sample, regardless of whether they are sub-analytes or not.

After schemes and analytes are added to a sample, whether they are sub-analytes or regular analytes, the job scheme and job scheme analyte are synchronised as they are composites of the sample schemes and sample scheme analytes below them.

Ensure the parent analyte is added along with the sub-analyte, otherwise the sub-analyte cannot be accessed in the workbook.

Ensure the job is activated so it can be opened in the CCWKOP—Open Workbook application.

Refer to Maintaining Sample Tests.

Displaying Sub-analytes in Workbook

Sub-analytes are shown or hidden in a workbook session, and are released and validated in the same way as regular non-sub-analytes.

A number of efficiencies are introduced when sub-analytes are added to samples:

Sub-analytes do not need to be selected when opening a workbook session (they are not visible in workbook unless configured to do so).
If the parent analyte is selected for workbook, the sub-analytes are included automatically.
Operators can quickly and easily hide or show sub-analytes for a parent analyte.

Sub-analytes can be shown or hidden in a workbook session using the CCWKOP—Open Workbook application by simply toggling display options within the workbook.

When searching for workbooks, regardless of whether the workbook session's Data Mode is selected as Final results mode, Weight/Volume mode, Dilution mode, or Raw results mode, when you expand a job scheme to view the job scheme analytes, only analytes that are not sub-analytes are displayed.

A sub-analyte may require manual data entry, but once this data is entered, it is referenced only as a component of a formula used to resolve the parent analyte result, and therefore does not need to be seen.

Similarly, there may be a collection of sub-analytes associated with a single parent analyte which hold alternative results for the parent. An example of this would be an ICP-OES instrument, where a number of results, each read at different wavelengths, are exported and captured into CCLAS. Typically one of these readings would be the default for day to day analysis and the parent analyte would use that result automatically via a formula. In this case, these sub-analytes would not need to be displayed to the operator and would be hidden except where the data quality is questionable.

Typically the operator hides sub-analytes when validating samples, particularly where the analyte count is very high and workflow-active samples are interspersed with sub-analytes.

When a workbook for a job scheme, all sub-analytes are displayed by default. When a workbook is opened in normal mode, columns that contain sub-analytes are highlighted, and can be hidden or shown using the Show Sub-analytes and Hide Sub-analytes commands configured in the workbook main command menu or right-click menu. When a workbook is opened in transposed mode, rows that contain sub-analytes are highlighted can be hidden using the same command.

Workbook commands and APIs exist to act solely on sub-analytes. For example, the system can be configured to show sub-analytes by default when a workbook first opens.

Ensure the workbook menu is configured to access commands or scripts to show and hide columns (in normal display mode) or rows (in transposed display mode).

Refer to Appendix—Workbook Commands.

A requirement on opening a workbook is that at least one of the selected analytes has no parent analyte. This means that if a sub-analyte was added to a sample without the parent analyte being added to the sample, then it would be impossible to open that sub-analyte in workbook.