Screen flows

• Submit—Validate and save the changes.
• Refresh—Reload the original data. Any changes made since the last submit are lost.
• New—Create a new item related to the application.
• Save As—Create a new item based on the information provided by an existing item.
• Delete—Confirm and delete the current item.
• Open—Display a dialog box to enter an existing item to display its detail.
• New Search—Return to the Search screen and clear the search results and the search criteria.

Header

• Organisation Scope

  Indicates whether this entity is available organisation-wide or laboratory-wide.

  • Checked—The entity is available to users who are logged into any laboratory within the organisation.
  • Unchecked—The entity is only available to users who are logged into the current laboratory.

  Setting the scheme's scope upon successful creation depends upon the user's security level for the CCSCHEME:CREATE resource. The possible security levels for the resource, from greater scope to lower scope, are:

  • full—full
  • 3—LAB AND ORG
  • 2—ORG ONLY
  • 1—LAB ONLY

  A user can have multiple roles, and each role can contain different rights. Any of these role-right combinations may contain the resource.

  If the resource does not exist across all role-right combinations for the user, then the user has no access to the resource. Otherwise the user's security level for the resource is determined as the greatest scope across all role-right combinations for the user. For example, if a user has Role1 that contains RightA, and Right A contains security level 2 for the resource, and the same user has Role2 that contains RightB, and RightB contains security level 1 for the resource, then the user has a security level of 2 for the resource.

  The selection in this field can determine the visibility for other fields in this form, and the content of various drop-down selection lists.

• Organisation Code

  The code of the owning organisation.

• Scheme Code

  The unique code assigned to the scheme.

• Name

  The name of the entity. Maximum length of 200 characters. Multi-language support.

• Description

  The description of the entity. Maximum length of 400 characters. Multi-language support.

• Scheme Category

  A category assigned to the scheme. Selected from categories with a Category Type of SCHEMES.

• Is Active

  Indicates whether the entity is available in drop-down lists when selecting a category for an entity. An inactive entity cannot be selected for use.

• Is Enabled for Lab

  Indicates whether the scheme is an org-scope scheme that is enabled for use by the laboratory and therefore an associated enabled-scope scheme exists for the laboratory, or whether the scheme itself is an enabled-scope scheme. Display only.

• Line of Business Code

  The line of business associated with the org-scope scheme. This field is not relevant for enabled-scoped or lab-scope schemes. An org-scope scheme can only be enabled for use in the laboratory if the scheme does not have a line of business defined, or if the scheme has a line of business matching one of the laboratory's lines of business. A line of business may be selected from the drop-down list that contains active lines of business in scope, as configured in the CCLOFB—Line of Business application. Click the field hyperlink to display the CCLOFB—Search Line of Business screen,select the appropriate value and click Select and Return to populate the field with the selected value.

• Scheme Type

  The scheme type used to denote the use of the scheme. Scheme Type cannot be updated:

  • Sample Preparation—Specifies the preparation and sample splitting requirements for samples, and do not have analytes.

  • Analytical Preparation—Specifies the analytical preparation and requirements of the test, and may optionally have analytes.

  • Analytical—Specifies the measurement portion of the test, and have analytes.

  • Miscellaneous—Specifies administration tasks, and do not have analytes.

  Note: The Scheme Type determines the fields that display on the Details tab, and determines the types of schemes to which it can be linked, including precursor schemes.

  If the Scheme Type is Analytical Preparation or Analytical, then preparation weight and preparation volume-type analytes, respectively, are created automatically when the first scheme version is created. This is to ensure the efficient configuration of schemes for raw-to-final calculations. If these types of analytes are removed, they can be manually added again as required.

  Note: If the AUTO_COMPLETE_PREP application preference is set to true, then sample preparation schemes are automatically marked as complete when a sample is started.

• Document

  Documents can be uploaded, downloaded and removed from this entity. The additional documents can be used for a variety of purposes, for example:

  • Linking additional documentation to an entity, such as a client, contact or project.

  • Reporting additional details about the entity.

• Price Type

  The price type that defines the pricing structure for the scheme:

  • Not Priced—Samples are not priced for the scheme.

  • Scheme-based—The scheme is priced based upon the number of invoiceable sample scheme analytes.

  • Sample-Based—The scheme is priced based upon the number of invoiceable sample schemes.

  • Unit-Based—The scheme is priced based upon a number of units assigned to the job scheme (for example, charging for an hourly-based test or number of containers/consumables used, or number of kilometres travelled).

  • Analyte-Based—The analytes in the scheme are priced individually based upon their analytical result.

  The Price Type cannot be changed during update; it can be set only on create.

  The only options possible for sample preparation and miscellaneous type schemes are Not Priced, Sample-Based or Unit-Based.

  The only options possible for analytical preparation and analytical type schemes are Not Priced, Scheme-Based, Sample-Based, Unit-Based or Analyte-Based.

• Price Code

  The price code associated with the scheme. A scheme can have a price code assigned only if the scheme's Price Type is Scheme-Based, Sample-Based or Unit-Based. A job scheme requires a price code to be priced in an invoice. A job scheme's Price Code defaults to the scheme's Price Code. A price code may be selected from the drop-down list that contains active price codes in scope with a Price Type of Scheme-Based, Sample-Based or Unit-Based, as configured in the CCPRCCODE—Price Code application. Click the field hyperlink to display the CCPRCCODE—Search Price Code screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  Scope rules apply. If the scope of the entity is org-scope then the drop-down list for the linked entity contains org-scope entities only, and the entity can be linked to org-scope entities only. If the scope of the entity is lab-scope then the drop-down list for the linked entity contains both org-scope and lab-scope entities, and the entity can be linked to either org-scope or lab-scope entities.

  Line of business rules apply. The drop-down list for the linked price code is filtered further to contain only org-scope price codes where the price code has not been assigned to any scheme or analyte, and org-scope price codes where the price code is assigned to a scheme or analyte where the scheme is enabled for the laboratory. However, there is no validation upon submit for the line of business rules, allowing a price code that is org-scope where the price code is assigned to a scheme or analyte where the scheme has not been enabled for the laboratory, allowing any price code to be available during scheme configuration.

Scheme Versions Tab

The scheme versions associated with the scheme.

• Version Number

  The version number of the scheme in CCLAS. (It does not refer to the version number of the scheme according to the accreditation body.) The Version Number is incremented every time a new version is created for the scheme. Display only.

• Name

  The name of the scheme version. Display only.

• Description

  The description of the scheme version. Display only.

• Report Name

  The reportable name of the scheme version. Display only.

• Status

  The status of the scheme version. Display only. This can be:

  • Draft—The scheme version is under development.

  • Published—An org-scope scheme is ready for laboratory use in registration via enabling the scheme (re-enabling of a scheme that is already enabled by a laboratory results in the highest published scheme version being enabled by the laboratory, if it is not already enabled); a lab-scope scheme is ready for laboratory use in registration.

  • Suspended—The scheme version is no longer the highest-published scheme version, so any use of the scheme accesses the next highest-published scheme version available to the laboratory.

• Approved Date

  The date on which the scheme version was approved for export. Display only.

• Approved By

  The user who approved the scheme version for export. Display only.

Details Tab

The primary details of the scheme.

• Section Code

  The laboratory section in which this scheme is performed. A section may be selected from the drop-down list that contains active sections in scope, as configured in the CCSECT—Section application. Click the field hyperlink to display the CCSECT—Search Section screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  If a scheme is associated with a section, the Access User Group Code, Release Result User Group Code and Validate Result User Group Code associated with the section come into play to limit which users can access, release and validate results, respectively.

• Pretreatment Category

  A category of pre-treatment that is required on a samples before the scheme can be performed, for example, acid digestion, filtering. Selected from categories with a Category Type of PRE_TREATMENTS.

• Container Type Code

  The specimen container type associated with the scheme. This container type is used when creating and managing the individual sample portions used in the laboratory. Each sample portion is in a container of type Container Type. A container type may be selected from the drop-down list that contains active container types in scope with a Capacity Type of Single, as configured in the CCCNTP—Container Type application. Click the field hyperlink to display the CCCNTP—Search Container Type screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  For sample tracking, one sample portion with a Portion Type of Laboratory is created for each distinct container type associated with the schemes, for a sample. The sample portion can either be considered as created or used by the scheme. For example, if the scheme is a sample preparation scheme, a container of a specific container type might be used to hold the created milled sample portion. If the scheme is an analytical scheme, it might be used to indicate the milled sample portion should be used for the test.

• Instrument Group Code

  The instrument group whose instruments are used to perform the scheme, for example, ICPGROUP1, XRF_ROOM1, GC. An instrument group may be selected from the drop-down list that contains active instrument groups in scope, as configured in the CCINGP—Instrument Group application. Click the field hyperlink to display the CCINGP—Search Instrument Group screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Default Grid Orientation

  The default orientation of the grid in workbook:

  • Down—Schemes and analytes down the page, samples across

  • Across (default)—Schemes and analytes across the page, samples down the page.

• Limit Specification Code

  The specification associated with the scheme to allow results to be assessed against the specification's limits and set the sample scheme analyte's Scheme Limit Status. A specification may be selected from the drop-down list that contains active specifications in scope with a Specification Type of Scheme, as configured in the CCSPFN—Specification application. Click the field hyperlink to display the CCSPFN—Search Specification screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Correction Applied

  Indicates the type of weight-volume correction that is applied when an analyte is to have a correction factor applied.

  If Correction Applied is cleared and the scheme version analyte's Apply Correction Factor is selected, then normal correction is applied in which a sample scheme analyte's Numeric Final Result is set to:

  Numeric Raw Result / Weight x Volume x Dilution Factor x Instrument Factor

  If Correction Applied is checked (default), and the scheme version analyte's Apply Correction Factor is selected, then weight, volume, dilution and instrument correction is applied in which a sample scheme analyte's Numeric Final Result is set to:

  Numeric Raw Result / Weight x Volume x ( Expected Weight / Expected Volume ) x Dilution Factor x Instrument Factor

  where, if the sample is an unknown, duplicate, replicate or spike QC sample, then the Expected Weight and Expected Volume are the scheme version's Sample Target Weight and Sample Target Volume, respectively, and if the sample is a blank or standard QC sample, then the Expected Weight and Expected Volume are the scheme version's Standard Target Weight and Standard Target Volume, respectively.

  If the Expected Weight is empty or zero, or the Expected Volume is empty or zero, then the Expected Weight / Expected Volume ratio is treated as 1.

  Note: The Instrument Factor is only retained at the sample scheme analyte reading level.

  This field is only displayed for, and relevant to, schemes that have a Scheme Type of Analytical or Analytical Preparation.

• Workbook Script

  The code of the script run upon workbook events where the scheme is loaded in the workbook session. Scheme workbook scripts run before workbook scripts based on the WORKBOOK_SCRIPT application preference. A script may be selected from the drop-down list that contains active scripts in scope with a Script Type of Workbook, as configured in the CCSCRT—Script application. Click the field hyperlink to display the CCSCRT—Search Script screen, select the appropriate value and click Select and Return to populate the field with the selected value.

• Auto Release

  Indicates the default for a scheme version analyte's Auto Release flag. Defaults to checked.

  When a sample scheme analyte achieves a Workflow Status of Analysed, then the sample scheme analyte is released automatically to attain a Workflow Status of Released where one of the following is true:

  • The result was entered in context of a job that is not a laboratory batch job, and the sample scheme analyte is linked to a scheme version analyte that is flagged for automatic release.

  • The result was entered in context of a laboratory batch job, the sample scheme analyte is linked to a scheme version analyte that is flagged for automatic release, and the LAB_BATCH_MANUAL_RELEASE_RESULTS application preference is cleared.

  Where a sample scheme analyte is not released automatically, it must be released manually. When a sample scheme analyte achieves a Workflow Status of Analysed, then a user can release a result manually where the scheme is not linked to a section, or where the scheme is linked to a section and the section is not linked to a user group for result release, or where the scheme is linked to a section and the section is linked to a user group for result release and the user is a member of the user group.

• Auto Validate

  Indicates the default for a scheme version analyte's Auto Validate flag. Defaults to checked.

  When a sample scheme analyte achieves a Workflow Status of Released through either a manual or automatic process and the sample scheme analyte does not have a Composite QC Status containing one of the failure statuses, then the sample scheme analyte is validated automatically to attain a Workflow Status of Completed and have its Validated Date stamped, where one of the following is true:

  • The result was entered in context of a job that is not a laboratory batch job, and the sample scheme analyte is linked to a scheme version analyte that is flagged for automatic validation.

  • The result was entered in context of a laboratory batch job, the sample scheme analyte is linked to a scheme version analyte that is flagged for automatic validation, and the LAB_BATCH_MANUAL_VALIDATE_RESULTS application preference is cleared.

  • The result is for a sample that is linked to one or more specifications, the laboratory's Auto Validate Product Specs is set to All, and all specifications are passed for the result.

  • The result is for a sample that is linked to a product, and the sample is linked to a one or more specifications associated with the product, the laboratory's Auto Validate Product Specs is set to By Product, and the product specifications are passed for the result.

  • The result is for a sample that is linked to a product, and the sample is linked to a one or more specifications associated with the product, the product's Auto-validate is checked, and the product specifications are passed for the result.

  Where a sample scheme analyte is not released automatically, it must be released manually. When a sample scheme analyte achieves a Workflow Status of Released through either a manual or automatic process and the sample scheme analyte does not have a Composite QC Status containing one of the failure statuses, then a user can validate a result manually where the scheme is not linked to a section, or where the scheme is linked to a section and the section is not linked to a user group for result release, or where the scheme is linked to a section and the section is linked to a user group for result validation and the user is a member of the user group.

• Allow Report of Non-Validated Data

  Indicates whether results for this scheme that are not validated can be reported. This could be used to determine whether a result could be included on an internal report. Allow Report of Non-Validated Data may also be set on the analyte. Currently no core functionality uses this, although it could be used by a script or report template.

• Reportable

  Default setting for a sample scheme's Reportable check box which ultimately sets the reportability of the scheme in certificate report requests.

• Report Sequence

  Schemes are added to a report request in the order in which they are registered in the job. However, the business may wish to always place a particular scheme on a report ahead of any other scheme on the job, regardless of registration sequence. A report script would need to contain logic to use the scheme's Report Sequence to do this. A Report Sequence may also be set on the analyte.

• Report Name

  The reportable name for the scheme. Defaults to the Scheme Code with the first character in uppercase and subsequent characters converted to lowercase for readability. When a report request is generated and the scheme is added to it, then the report request scheme's Report Name defaults to the scheme's Report Name.

• Report Description

  The reportable description of the scheme. When a report request is generated and the scheme added to it, then the report request scheme's Report Description defaults to the scheme's Report Description.

• Data Column Header

  The text displayed in the header of the column containing this scheme in a workbook session opened in normal display mode.

• Export Name

  An alternative name for the scheme that can be placed in a report that is exported to another system, or uploaded to an instrument.

• Import Name

  An alternative name for the scheme that can be used in an instrument upload script to identify the scheme.

• Invoiceable

  Indicates whether results for this scheme are included in client invoices, as follows. If Invoiceable is selected and the scheme is subsequently registered for a sample, then the sample scheme's Invoiceable defaults to the scheme's Invoiceable. This may be updated. When a client invoice is generated and the scheme added to it, then the invoice scheme's Invoiceable is selected by default if any sample schemes in the client invoice have their Invoiceable check box checked.

• Include in costs

  Indicates whether results for this scheme are to be included in job cost invoices.

Notes Tab

Notes associated with the scheme.

• Notes 1—2

  Scheme notes. Rich text formatting can be used to control the appearance of the information, with basic formatting ribbon and hyperlink entry field. For example, the name of a contact can be entered in bold, the telephone number in italics, and hyperlinks can be used. The formatting is saved along with the actual content.

Precursor Schemes Tab

The precursor schemes associated with the current scheme. A precursor scheme is a scheme that occurs before the current scheme in the laboratory workflow.

When samples are being located for batching for a particular scheme, they can be located based on whether their precursor scheme is started or completed.

Although many precursor schemes can be defined for a scheme, when registering schemes for samples, any given sample scheme can only have one sample scheme that is a precursor scheme registered for it. That is, the sample scheme can have only one workflow source.

• Grid flows

  • Lookup CCSCHM—Open the CCSCHM—Scheme Search screen to perform a search.

• Precursor Scheme Code

  The code of a precursor scheme of the current scheme. Selected from active schemes with the applicable Scheme Type. A scheme may be selected from the drop-down list that contains active schemes in scope, as configured in the CCSCHM—Scheme application. Click the field hyperlink to display the CCSCHM—Search Scheme screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  Scope rules apply. If the scope of the entity is org-scope then the drop-down list for the linked entity contains org-scope entities only, and the entity can be linked to org-scope entities only. If the scope of the entity is lab-scope then the drop-down list for the linked entity contains both org-scope and lab-scope entities, and the entity can be linked to either org-scope or lab-scope entities.

  Line of business rules apply. The drop-down list for the linked entity is filtered further to contain only those org-scope entities that have no associated line of business or a line of business that matches one of the laboratory's lines of business. The entity can be linked to an org-scope entity only where the org-scope entity has no associated line of business or a line of business that matches one of the laboratory's lines of business.

  When configuring precursor schemes:

  • A scheme with a Scheme Type of Sample Preparation can only have a precursor scheme that has a Scheme Type of Sample Preparation.

  • A scheme with a Scheme Type of Analytical Preparation can only have a precursor scheme that has a Scheme Type of either Sample Preparation or Analytical Preparation.

  • A scheme with a Scheme Type of Analytical can only have a precursor scheme that has a Scheme Type of either Sample Preparation or Analytical Preparation.

  • A scheme with precursor schemes can only be a linked scheme with another scheme that has the same set of precursor schemes.

• Description

  the description of the precursor scheme relationship with the current scheme.

• Automatically Profile

  Indicates whether the precursor scheme is automatically registered for the sample when the current scheme is registered for the sample.

Linked Schemes Tab

The linked schemes associated with the current scheme. A linked scheme is where the analysis is performed on the same racks of samples.

Linked job schemes share the same samples, including QC samples and rack layout, and limit which job scheme can be opened to enter weights and volumes:

• When appending or overwriting QC samples for a job, linked job schemes are processed such that the QC masks used are from the first linked job scheme to determine the QC samples and rack layout, which is then applied to the linked job schemes.

• QC sample additions or deletions are synchronised when modifying QC samples in a job scheme.

• Only the first linked job scheme is allowed to be opened after searching for workbooks with weight/volume mode.

• Job scheme links default to the linked scheme relationships contained within the master scheme, when both schemes are registered on the job.

• When an org-scope scheme is registered on a lab-scope job, the master scheme from where linked scheme relationships are determined is the enabled-scope scheme.

• The first linked job scheme is determined by the 'from' and 'to' linked scheme relationships between the job schemes, such that, the 'from' job scheme is deemed the first linked job scheme, regardless of where it is registered in the job. Where more than one scheme link relationship is in play, that is, multiple 'from' linked job schemes exist in the job, then the first (by job scheme registration sequence) is used as the first linked job scheme. Examples: Where a job has schemes A, B and C registered in that sequence, and linked job schemes A-->C and B-->C exist, then A is the primary 'from' linked job scheme as it is registered before B. Where a job has schemes C, B and A registered in that sequence, and linked job schemes A-->C and B-->C exist, then B is the primary 'from' linked job scheme as it is registered before A.

Linked sample schemes control whether weights and volumes are transferred from one sample scheme to a linked sample scheme when entering a value in weight/volume mode in a workbook session, since linking denotes that the same aliquot is used for both schemes.

Only the first linked job scheme is allowed to be opened after searching for workbooks with weight/volume mode.

Sample scheme links default to the linked scheme relationships contained within the master scheme, when both schemes are registered on the sample.

When an org-scope scheme is registered on a lab-scope sample, the master scheme from where linked scheme relationships are determined is the enabled-scope scheme.

• Grid flows

  • Lookup CCSCHM—Open the CCSCHM—Scheme Search screen to perform a search.

• Linked Scheme Code

  The parent scheme within the linked scheme relationship. Set to the current scheme.

  When configuring linked schemes:

  • A scheme with a Scheme Type of Sample Preparation can only have a linked scheme that has a Scheme Type of Sample Preparation.

  • A scheme with a Scheme Type of Analytical Preparation or Analytical can only have a linked scheme that has a Scheme Type of either Analytical Preparation or Analytical.

  • A scheme with precursor schemes can only be a linked scheme with another scheme that has the same set of precursor schemes.

• Linked To

  The child scheme within the linked scheme relationship. Selected from active schemes with the applicable Scheme Type. A scheme may be selected from the drop-down list that contains active schemes in scope, as configured in the CCSCHM—Scheme application. Click the field hyperlink to display the CCSCHM—Search Scheme screen, select the appropriate value and click Select and Return to populate the field with the selected value.

  Scope rules apply. If the scope of the entity is org-scope then the drop-down list for the linked entity contains org-scope entities only, and the entity can be linked to org-scope entities only. If the scope of the entity is lab-scope then the drop-down list for the linked entity contains both org-scope and lab-scope entities, and the entity can be linked to either org-scope or lab-scope entities.

  Line of business rules apply. The drop-down list for the linked entity is filtered further to contain only those org-scope entities that have no associated line of business or a line of business that matches one of the laboratory's lines of business. The entity can be linked to an org-scope entity only where the org-scope entity has no associated line of business or a line of business that matches one of the laboratory's lines of business.

  When configuring linked schemes:

  • A scheme with a Scheme Type of Sample Preparation can only have a linked scheme that has a Scheme Type of Sample Preparation.

  • A scheme with a Scheme Type of Analytical Preparation or Analytical can only have a linked scheme that has a Scheme Type of either Analytical Preparation or Analytical.

  • A scheme with precursor schemes can only be a linked scheme with another scheme that has the same set of precursor schemes.

• Description

  No functional use in core CCLAS.

• Share Same Correction Factor

  No functional use in core CCLAS.

• Share Same Batch

  No functional use in core CCLAS.