Maintaining Schemes

Overview

A scheme is an implementation of a method. It specifies the steps required to apply the method to a sample:

Sample Preparation—These schemes do not contain analytes as no results are to be measured (for example, dry, crush, mill a sample before testing). These schemes have a workflow status (for example, not started, started, completed).

As a sample preparation scheme has no analytes, the scheme cannot be reported as a set of results, although it might be reported as an appendix after the main body of the analytical report (detailing the preparation tasks that were performed on a job or sample).

In the life-cycle of a sample undergoing analysis, 'As Received' sample portions are received by the laboratory into the sample preparation area. Here, the sample is prepared and split into 'laboratory' sample portions, according to the number of container types associated with schemes registered for the sample.
The sample preparation, creation of duplicate QC samples, and any preparation blank or standard QC samples, is managed by a sample scheme that has a scheme type of sample preparation. Some samples come into the laboratory already prepared, in which case, the sample would not have a sample preparation scheme registered for it.
Analytical Preparation—These schemes have analytes which are used for analytical preparation measurements, and are typically not reported (for example, weighing up and preparation for analytical measurement). It is useful to keep analytical preparation schemes separate from the analytical scheme if workflow is tracked separately for preparation tasks and measurement tasks.

A common analytical preparation scheme could be used with multiple analytical schemes. It is also useful for KPI reporting or invoicing.

Each laboratory sample portion is then sent to the relevant analysis area in the laboratory where it is prepared for analysis, including any weighing or digestion to prepare the aliquot. The analytical preparation, creation of replicate QC samples, and any analytical blank, standard or spike QC samples is typically managed by a sample scheme that has a scheme type of analytical preparation.
Analytical—These schemes are functionally the same as analytical preparation schemes but are used for recording final results. Note that preparation weight and/or preparation volume-type analytes, used for raw-result-to-final-result correction, can exist either in an analytical preparation or in an analytical scheme. Some laboratories combine the analytical preparation tasks and the measurement tasks into a single analytical scheme.

After analytical preparation, the sample is analysed and results collected. The analysis, and creation of any instrument blank or standard QC samples, is managed by a sample scheme that has a scheme type of analytical.
Miscellaneous—These schemes are not preparation nor analytical tasks to be performed on samples, but are a specific task within a job. A miscellaneous scheme could be used for a step in the laboratory workflow, or for extra job costing on an invoice (for example, a handling fee or surcharge). Miscellaneous schemes can be registered up front, or added at invoice generation.

A sample scheme with a scheme type of miscellaneous is typically used to manage a specific step in the analytical process, or to add a cost to the invoice.

The AUTO_COMPLETE_MISC application preference is used to automatically mark miscellaneous sample schemes completed when a sample is started, that is, when a result is put against one of the sample scheme analytes associated with the sample.

The AUTO_CASCADE_MISC application preference is used to roll up the sample scheme workflow status, where the scheme is of Scheme Type equal to Miscellaneous, to the sample workflow status.

Note: A sample scheme's Workflow Status does NOT cascade to the sample's Workflow Status if this preference is turned off. For situations where only a miscellaneous scheme is registered with a sample, then this sample will not be considered to determine the job's status. The job will consider the statuses of all the other samples to determine it's own status.

Schemes are created with scheme versions. For analytical preparation and analytical schemes, the scheme specifies the properties or measurements as analytes within a scheme version, for which analysis is conducted.

Schemes are used to set up specifications for scheme, QC and product limits, and for registration on samples.

A scheme group is a collection of schemes.

Process

Schemes are maintained using the CCSCHM—Scheme application.

Maintain schemes

When searching for schemes, org-scope schemes are automatically filtered by the laboratory's lines of business, such that, only org-scope schemes that have no lines of business defined, or org-scope schemes that have a line of business matching one of the laboratory's lines of business, are returned from the search.

The lines of business criteria when searching for schemes in the CCSCHM—Scheme application only displays a list of the lines of business that are assigned to the laboratory, not all of the lines of business defined in the organisation. This means that you cannot search for, or edit, any scheme that is not linked to a line of business assigned to your laboratory.

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

Schemes are created either with org-scope or lab-scope.

A scheme's Scheme Code, Scheme Type nor Price Type is mandatory.

If the CODEVALIDATION_CHARACTERLIST_01 application preference is defined and contains a list of visible ASCII characters, then a scheme code must only contain characters from this list. If this preference is not defined, then a scheme code must only contain characters from the ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789 string. The Scope for this preference is usually set at laboratory level.

A scheme's Scheme Type can be:

Sample Preparation
Analytical Preparation
Analytical
Miscellaneous

When a scheme is created:

When a scheme is created from another scheme:

The new scheme has the same Scheme Type and Price Type as the source scheme.
The new scheme has one scheme version created, copied from the source scheme's highest scheme version, regardless of whether the source scheme's highest scheme version's Status is Draft, Published or Suspended. The copied scheme version is created with a Status of Draft.
The scheme version in the new scheme has Approved Date and Approved By User cleared.

When a scheme that belongs to another organisation is opened, then the scheme is read-only.

Refer to the section below on Enabling Org-scope Schemes for Use in the Laboratory regarding which enabled-scope scheme DTO properties are editable.

A scheme's Scheme Code, Scheme Type nor Price Type cannot be updated.

Schemes cannot be deleted where:

The scheme or scheme version is linked to by another entity (for example, it is registered on a sample group, included in a quote, or used for setting analytical limits in a scheme limit specification, standard specification or product specification)
The scheme has organisation scope but it is enabled for use by a laboratory. Refer to Making Org-scope and Lab-scope Schemes Ready for Registration.
The scheme has enabled scope (an organisation scope scheme that is enabled for use by a laboratory) and the scheme is a precursor scheme of another scheme

When a scheme is deleted:

If the scheme is a sequel scheme of another scheme then the precursor scheme relationship is removed.
If the scheme is linked to another scheme then the link relationship is removed.
If the scheme is linked to a QC mask, the QC mask has the same code as the scheme, the QC mask is not used on any other scheme version or sample scheme, and the SCHEME_AUTO_CREATE_QC_MASK application preference is checked, then the QC mask is deleted also.
If the scheme is linked to a scheme limits specification, the specification has the same code as the scheme, the specification is not used on any other scheme or sample scheme, and the SCHEME_AUTO_CREATE_LIMITS_SPEC application preference is checked, then the specification is deleted also.
If any of the scheme's versions is linked to a method, the method has the same code as the scheme, the method is not used on a scheme version in another scheme, and the SCHEME_AUTO_CREATE_METHOD application preference is checked, then the method is deleted also.
If the scheme is linked to a price code, the price code has the same code as the scheme, the price code is not used on any other scheme, or on a scheme version analyte in another scheme, or in a price book schedule or quote, and the SCHEME_AUTO_CREATE_PRICE_CODE application preference is checked, then the price code is deleted also.
If the scheme is a member of a scheme group, it is removed from the group.

Price Type and Price Code

A scheme's Price Type is selected when the scheme is created. The type of pricing can be:

Scheme-Based—the number of invoiceable analytes are counted, for the samples
Sample-Based—the number of invoiceable samples are counted
Unit-Based—the number units on the job scheme are used
Analyte-Based—the analyte is invoiced with its pricing determined by the magnitude of the result.

For a scheme with a Price Type of Scheme-Based, Sample-Based or Unit-Based, the Price Code is at the scheme level and can only be selected from price codes that have the same Price Type, and if left empty, then the scheme cannot be invoiced.

For a scheme with a Price Type of Analyte-Based, the Price Code is at the analyte level and can only be selected from price codes that have the same Price Type, and if left empty, then the analyte cannot be invoiced.

When a scheme is created with a Price Type of Sample-Based, Scheme-Based or Unit-Based, where the SCHEME_AUTO_CREATE_PRICE_CODE application preference is:

Defined and is checked, and a price code exists that has the same Price Type, Scope and Code as the scheme, then the price code is linked to the scheme.
Defined and is checked, and a price code exists that has the same Price Type and Code as the scheme but not the same Scope, then you are given a message that the scheme could not be linked to the price code due to the different scope.
Defined and is checked, and a price code does not exist that has the same Price Type, Scope and Code as the scheme, then a price code with the same Price Type, Scope, Code, Name and Description as the scheme is automatically created with the price code's isSystemGenerated flag is set to Y, and the price code is associated with the scheme.
Not defined, or is defined and is cleared, then the scheme is not automatically associated with a price code.

Set the SCHEME_AUTO_CREATE_PRICE_CODE Preference

Line of Business

Where lines of business are configured, org-scope schemes created can be associated with a line of business.

Refer to Limiting User Visibility of Schemes and Functionality by Line of Business.

Scheme Details

The following table shows where particular properties or entities can be defined for a scheme based on its Scheme Type.

Field	Sample Preparation	Analytical Preparation	Analytical	Miscellaneous
Section Code	Y	Y	Y	Y
Container Type Code	Y	Y	Y	Y
Instrument Group Code	Y	Y	Y	N
Default Grid Orientation	N	Y	Y	N
Limit Specification Code	N	Y	Y	N
Data Column Header	N	Y	Y	N
Workbook Script	Y	Y	Y	Y
Correction Applied flag	N	Y	Y	N
Auto Release flag	Y	Y	Y	Y
Auto Validate flag	Y	Y	Y	Y
Allow Report of Non-Validated Data?	N	Y	Y	N
Reportable flag	Y	Y	Y	Y
Report details	Y	Y	Y	Y
Invoiceable flag	Y	Y	Y	Y
Include in Costs flag	Y	Y	Y	Y
Notes	Y	Y	Y	Y
Precursor Schemes	Y	Y	Y	N
Linked Schemes	Y	Y	Y	N
Create New Version	N	Y	Y	N
Analytes	N	Y	Y	N

Laboratory Sections

Schemes are linked to a section to restrict functionality to users of particular groups, for access, result release and result validation, and to apply comments from a results canned comment group.

Container Types for Laboratory Sample Portions

Schemes can be associated with a container type, such that, when laboratory portions are created for sample schemes, they are created according to the Default Number of Containers associated with the scheme's container type.

Instrument Groups for Analysis

Schemes are linked to an instrument group to then later associated related sample schemes with an instrument in that group, for data capture into sample scheme analytes.

Workbook Settings

The Default Grid Orientation can be used by a workbook script to have the workbook default to display in normal or inverted mode.

If the workbook is displayed in normal mode, the scheme's Data Column Header is used instead of the scheme code to identify the columns containing test results for this scheme.

Scheme Limit Specifications

Where a scheme is linked to a scheme specification, when the scheme is registered on an unknown, duplicate or replicate sample, then the sample scheme is linked to the scheme specification, such that, when a result is received for the sample scheme, the result is assessed against the limits for the MATCHING SAMPLE SCHEME ANALYTE UNIT in the scheme specification on the sample scheme, to set the sample scheme analyte's Limit Status. This status rolls into the sample scheme analyte's Composite QC Status.

The SCHEME_AUTO_CREATE_LIMITS_SPEC application preference is used to create a specification automatically when a scheme is created, and link it automatically to the scheme.

Set the SCHEME_AUTO_CREATE_LIMITS_SPEC Preference

Scheme Workbook Scripts

A scheme is linked to a workbook script so that custom logic is run upon workbook events (workbook open, workbook save, on workbook cell select, before workbook cell change and after workbook cell change), based upon the scheme being opened in a workbook session.

The system first runs any preference-based workbook event scripts, then runs the scheme's Workbook Script. Refer to the Customising Workbook Events in the CCLAS 6 Customisation Guide.

Applying Raw-to-Final Correction

A scheme version analyte can have a correction factor applied so that when a numeric raw result is received during a workbook session, then the numeric final result can be determined using the correction. Note that, if a numeric final value is entered for a sample scheme analyte, then the numeric raw value is determined by applying the reverse correction.

For this correction to occur, the scheme's Correction Applied must be selected, the scheme version analyte's Analyte Type must be Analytical, and the scheme version analyte's Apply Correction Factor flag must be selected.

A scheme that is flagged to have Correction Applied can be opened in a workbook using a Data Mode of Weight/Volume mode to allow results to be entered for a preparation weight or preparation volume-type analyte, which then allow for raw-to-final result calculations.

Reporting

A scheme can be flagged to be reportable, and have report details.

To be included in a reporting result set, a report request scheme must be Reportable.

A report request scheme's Reportable flag is inherited from the job scheme's Reportable flag, which, in turn, is inherited from the interim sample scheme's Reportable flag when adding a group of samples to a job, which, in turn, is inherited from the scheme's Reportable flag.

A report request scheme's Report Sequence can be used by the report template to order schemes output to the report.

A report request scheme's Report Sequence is inherited from the job scheme's Report Sequence, which, in turn, is inherited from the interim sample scheme's Report Sequence when adding a group of samples to a job, which, in turn, is inherited from the scheme's Report Sequence.

Invoicing and Job Costs

Schemes can be flagged to be invoiceable and included in job costs.

To be invoiceable, regardless of whether the scheme's Price Type is Sample-Based, Scheme-Based, Unit-Based or Analyte-Based, a scheme must be both active for invoicing, and associated with a valid pricing model (via a price book and price schedule).

An invoice scheme's Invoiceable flag is inherited from the job scheme's Invoiceable flag, which, in turn, is inherited from the interim sample scheme's Invoiceable flag when adding a group of samples to a job, which, in turn, is inherited from the scheme's Invoiceable flag.

A job cost is the actual cost of analysis to the laboratory for the job. The pricing framework for internal costs is maintained in exactly the same manner as with client invoicing. A costing price catalogue group is created and associated with the laboratory and related price books contain price schedules for the costs. The price codes used for costing are the same as those assigned for client invoicing.

For a scheme to be activated for internal costing, the scheme's Include in Costs must be selected.

Notes

Schemes can have rich text notes which are only used for reference or reporting. HTML formatted text can be pasted from one CCLAS 6 rich text notes field into another rich text notes field, such that, the formatting is preserved.

Precursor Schemes and Sequel Schemes

Schemes can have one or more precursor schemes which are schemes that need to be performed earlier in the workflow.

Schemes that are processed after a precursor scheme are known as a sequel scheme.

Precursor and sequel schemes are useful where a specific sequence of analysis is required, and may be included in batch jobs to initiate processing of schemes in a prescribed order.

Schemes that have precursor schemes are limited to being linked to other schemes with the same precursor schemes. This is due to the sample portions and rack containers being the same, therefore requiring the same precursor scheme.

Scheme Links

Schemes can have one or more linked schemes which are schemes that share the same tray/rack and QC sample layout.

Links between schemes can be applied to allow sample weights and volumes to be shared, rather than separately record these properties for each scheme. There are however, limitations on the links that can be created between schemes.:

Sample preparation scheme types can only be linked to another sample preparation scheme.
Analytical or analytical preparation scheme types can only be linked to other analytical or analytical preparation schemes.
Schemes with precursor schemes can only be linked to other schemes that have the same set of precursor schemes:
- Analytical or analytical preparation scheme types can only be linked to precursor schemes with a scheme type of either sample preparation or analytical preparation.
- Sample preparation scheme types can only be linked to a precursor scheme with a scheme type of sample preparation.

Scheme Versions

Schemes have at least one scheme version. Analytical preparation and analytical schemes can have other versions created.

Refer to Configuring Versions of a Scheme.

Scheme Version Analytes

Analytical preparation and analytical scheme versions can have analytes.

Refer to Maintaining Scheme Version Analytes.

Enabling Org-scope Schemes for Use in the Laboratory

Enable an org-scope scheme for use in a laboratory

When an org-scope scheme is selected to be enabled for the laboratory, if the scheme has:

Org-scope and the highest published scheme version, is not yet enabled for the laboratory, then the scheme version is enabled.
Org-scope and the highest published scheme version is already enabled for the laboratory, then the scheme version is not re-enabled.
Enabled scope or lab-scope, then an error returns saying that the scheme is not suitable for laboratory enabling.

If a scheme version is enabled, then:

A copy of the org-scope scheme record is created and given enabled-scope for that laboratory (other laboratories can enable their own set of schemes).
A copy of the org-scope highest published scheme version is created and given enabled-scope for the laboratory.
A copy of the org-scope scheme version analytes in the enabled scheme version are created and given enabled-scope for the laboratory.

An enabled-scope scheme can be localised by the laboratory by configuring the ALLOW_SCHEME_EDITABLE_PROPERTIES application preference which specified which scheme DTO properties are editable. This allows properties that are inherited from the scheme into a sample scheme or job scheme to be tailored to local requirements, but also ensures that those properties which are deemed to be organisation-controlled remain inviolate.

Set the ALLOW_SCHEME_EDITABLE_PROPERTIES Preference

Automatic Establishment of Linked and Precursor Scheme Relationships when an Org-scope Scheme is Enabled for Use in a Laboratory

As org-scope schemes are enabled for use by a laboratory, scheme links and precursor scheme relationships are established amongst the enabled-scope schemes.

For example, consider the scenario where scheme A is a precursor scheme of both schemes B and C, and schemes B and C are linked schemes. In the following table, schemes A, B and C are lab-enabled schemes.

Actions	Expected Outcome	Case #1	Case #2	Case #3	Case #4	Case #5	Case #6
Step #1	Scheme enabled	A	A	B	B	C	C
	Linked scheme relationship established	-	-	-	-	-	-
	Precursor schemer relationship established	-	-	-	-	-	-
Step #2	Scheme enabled	B	C	A	C	A	B
	Linked scheme relationship established	-	-	-	B-C	-	B-C
	Precursor schemer relationship established	A-B	A-C	-	-	-	-
Step #3	Scheme enabled	C	B	C	A	B	A
	Linked scheme relationship established	B-C	B-C	B-C	-	B-C	-
	Precursor schemer relationship established	A-C	A-B	A-C	-	A-B	-
Relationship establishment	Full	Full	Partial	Partial	Partial	Partial

Registering Schemes on Samples

After an org-scope scheme is successfully enabled for use by a laboratory, it is available for adding to registered samples.

Only enabled-scope and laboratory-scope schemes can be registered on a sample.

When an org-scope scheme is registered on an org-scope or lab-scope sample, it is the org-scope scheme version relating to the highest enabled-scoped scheme version in the laboratory that is added to the sample, however:

For an org-scope sample, the sample scheme details are taken from the org-scope scheme and scheme version, and the sample scheme analyte details are taken from the org-scope scheme version analyte.
For a lab-scope sample, the sample scheme details are taken from the enabled-scope scheme and scheme version, and the sample scheme analyte details are taken from the enabled-scope scheme version analyte.

The WORKBOOK_OVERRIDE_SCHEME_LIST application preference is used by the system to allow the CCWKOP—Open Workbook application to use enabled-scope scheme properties.

Refer to the Using Organisational Schemes vs Laboratory Schemes.

Suspending and Deleting Schemes

If the org-scope scheme version achieves a Status of Suspended, then the laboratory can no longer use that scheme version for adding to live samples.

An org-scope scheme version cannot be deleted if it is added to a sample, or is associated with from any entity (for example, precursor scheme, linked scheme, scheme group, specification or quote).

An enabled-scoped scheme or scheme version can be deleted. If the scheme and scheme version was used to register a production sample, then the sample schemes and job scheme still link to the org-scope scheme and scheme version. Deletion of the enabled-scoped scheme or scheme version just means that the laboratory would not be able to register further samples with that scheme version as the related enabled-scoped scheme version would not exist for the laboratory.