Screen flows

• Submit—Validate and save the changes.
• Refresh—Reload the original data. Any changes made since the last submit are lost.
• Delete—Confirm and delete the current item.
• New Search—Return to the Search screen and clear the search results and the search criteria.
• Publish—Publish a new scheme version.
• Suspend—Suspend the current entity making it unavailable for use.
• Approve—Approve the scheme version for export so that they can be used globally by all laboratories. This updates a scheme version's Approve Date and user who has approved the entity. This action only applies to org-scope entities and is only valid for entities in the user’s current organisation.

• Unapprove—Reverse the approval of the scheme version that was previously approved for export. This clears a scheme version's Approved Date and user who previously approved the entity. This action only applies to org-scope entities, and is only valid for entities in the user’s current organisation.

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 version's scope upon successful creation depends upon the user's security level for the CCSCHEMEVERSION: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.

• Scheme Code

  The unique code assigned to the scheme. Display only.

• Is Active

  Indicates whether the related scheme is active. Display only.

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

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

• First Used Date

  The date on which the scheme version was first registered on a sample.

• Name

  The name of the scheme version. If it is the first scheme version for the scheme, the name defaults to the scheme's Name.

• Description

  The description of the scheme version. Maximum length of 400 characters. If it is the first scheme version for the scheme, the name defaults to the scheme's Description.

• Report Name

  The reportable name for the scheme version.

• Report Description

  The reportable description for the scheme version.

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

• Status Changed Date

  The date-time at which the last change was made to the status of the entity. Display only.

• Status Changed by User Code

  The code of the user who changed the status. Display only.

• Status Changed Reason

  The reason for the change in status. Display only.

• Approved Date

  The date-time at which the org-scope scheme version was approved for export. Only relevant where the Organisation Scope is selected.

• Display only.

• Approved By

• Name of the user who approved the org-scope scheme version for export. Only relevant where the Organisation Scope? is selected. Display only.

Details Tab

The primary details of the scheme version.

• Method Code

  The method used in the laboratory for this scheme version. A method may be selected from the drop-down list that contains active methods in scope, as configured in the CCMTHD—Method application. Click the field hyperlink to display the CCMTHD—Search Method 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.

• Priority

  The default priority for sample schemes registered with this scheme version. Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

• Internal Cost

  No functional use in core CCLAS and has no bearing on WIP/EST invoices or job costs. This field may represent the internal cost to the laboratory for performing the scheme version on a sample, for use in custom reports.

• Holding Time

  The default holding time for sample schemes registered with this scheme version.

  Holding time is used to avoid sample expiry, and is the maximum time that a sample has to be prepared by, analysed and validated for a sample scheme before the sample deteriorates to such a point that the correctness of an analytical result is questionable. The point of deterioration is known as the sample scheme's or sample scheme analyte's Expiry Date. For this reason, any sample scheme analyte that has exceeded the sample scheme's or sample scheme analyte's Holding Time cannot have results entered. A Warning Date is calculated (back from the expiry date) so that this information is available for display to the batching operator as a warning that the expiry date is approaching. In addition, a script or report could be configured to warn of expected deterioration.

  For a sample scheme with no precursor scheme, Holding Time is counted from the earliest of the sample's Received On or Sampled On date. For a sample scheme with a precursor scheme, Holding Time is counted from the Completed Date of the precursor scheme.

  When a duplicate sample is created, the sample scheme and sample scheme analyte's holding times, warning times, possible dates and expiry dates for duplicate samples default to those set on the original sample.

  Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

• Warning Time

  The default warning time of sample expiry before analysis must be done for sample schemes registered with this scheme version. Warning time refers to the time that a sample may be held before a warning can be given that it needs to be prepared or analysed (for example, before the sample deteriorates). Warning Time needs to be equal or less than Holding Time.

  For a sample scheme with no precursor scheme, warning time is counted from the earliest of the sample's Received On or Sampled On date-time.

  For a sample scheme with a precursor scheme, warning time is counted from the Completed Date (date-time) of the precursor scheme.

• Waiting Time

  The time that you need to wait before a sample scheme is ready for batching.

  If a scheme version's Waiting Time is defined, when a sample scheme's Workflow Status becomes Started, then the sample scheme's Ready Date is set to the sample scheme's Started Date + the scheme version's Waiting Time.

  Note: This calculation does NOT take into consideration holidays or a section's non-working time periods. If a scheme version's Waiting Time is not defined, then the sample scheme's Ready Date is left empty.

  Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

• Auto Subcontracted

  No functional use in core CCLAS. Represents whether sample schemes registered with this scheme version are to be subcontracted automatically to the subcontract laboratory.

• Default Subcontract Lab Code

  The default subcontract laboratory code for a sample scheme's Subcontract Laboratory Code, that is, the laboratory that can provide subcontracting services to analyse samples for the scheme when the analysis cannot be done in-house. Selected from the active laboratories contained within the laboratory group defined by the SUBCONTRACT_LABS application preference, excluding the current laboratory.

• Scheme Duration

  No functional use in core CCLAS. Represents the amount of time it takes to prepare or analyse a sample by the scheme version. Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

• Scheme Backlog

  No functional use in core CCLAS. Represents the amount of time estimated for the backlog of samples to be analysed by the scheme version. Entered in the format xN, where x is an integer and N is a code for a date-time period: S (second), N (minute), H (hour), D (day), M (month), Y (year). For example, 10D (10 days), 30N (30 minutes).

• Section Capacity

  No functional use in core CCLAS. Represents the number of samples that is considered manageable in a backlog of samples awaiting preparation or analysis by this scheme version.

• Number of Tests for KPI

  No functional use in core CCLAS. Represents the number of units in a KPI measurement contributed by the scheme version. This can be used along with Internal Cost in KPI reports.

• Batch Across Jobs

  Indicates whether any creation of QC samples for a job scheme that was registered using this scheme version should wait until batching.

• QC Mask Code

  The default QC mask for sample schemes registered with this scheme version. A QC mask may be selected from the drop-down list that contains active QC masks in scope, as configured in the CCQCMK—QC Mask application. Click the field hyperlink to display the CCQCMK—Search QC Mask 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.

  Association rules:

  • A sample preparation scheme version can only be associated with a QC mask that does not contain any replicate sample placements as these are created during an analytical preparation or analysis phase.

  • An analytical preparation or analytical scheme version can only be associated with a QC mask that does not contain any duplicate sample placements as these are created during a sample preparation phase.

  • A miscellaneous scheme cannot be associated with any QC mask.

• Default Rack Size

  The default rack size used at registration to assign rack numbers to new samples in the job scheme.

Analysis Tab

The analysis details for the scheme version.

Some analytical methods require that weights and volumes of samples must be within particular tolerances. These are set on the scheme version.

Laboratory supervisors can control how an out-of-range weight or volume result for a preparation weight or preparation volume-type analyte are handled, by setting the ALLOW_ACCEPT_OUT_OF_RANGE_WEIGHTS_AND_VOLUMES application preference:

• False—The user may only accept an in-range weight or volume.

• True—The user may use their discretion to accept an out-of-range weight or volume.

The weights and volumes entered during a weight/volume workbook session are propagated into a sample scheme analyte's weight and volume attribute, respectively, in related samples for the same scheme and for any linked schemes, so that a raw result for the sample scheme analyte can be corrected to determine the final result when there is not already a final result.

• Sample Target Weight

  The expected target weight of a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Weight Tolerance

  The percentage of variance allowed from the Sample Target Weight.

• Sample Minimum Weight

  The minimum weight required for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Maximum Weight

  The maximum weight required for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Weight Allowance

  When an out-of-range weight is entered for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike is entered, an allowance can be provided:

  • Above and Below Weights Allowed

  • Above Weights Only Allowed

  • Below Weights Only Allowed

  • Not Allowed.

• Standard Target Weight

  The expected target weight of a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Weight Tolerance

  The percentage of variance allowed from the Standard Target Weight.

• Standard Minimum Weight

  The minimum weight required for a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Maximum Weight

  The maximum weight required for a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Weight Allowance

  When an out-of-range weight is entered for a sample with an Analytical Type of Blank or Standard is entered, an allowance can be provided:

  • Above and Below Volumes Allowed

  • Above Volumes Only Allowed

  • Below Volumes Only Allowed

  • Not Allowed.

• Sample Target Volume

  The expected target volume of a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Volume Tolerance

  The percentage of variance allowed from the Sample Target Volume.

• Sample Minimum Volume

  The minimum volume required for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Maximum Volume

  The maximum volume required for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike for the sample scheme's portion.

• Sample Volume Allowance

  When an out-of-range volume is entered for a sample with an Analytical Type of Unknown, Duplicate, Replicate or Spike is entered, an allowance can be provided:

  • Above and Below Weights Allowed

  • Above Weights Only Allowed

  • Below Weights Only Allowed

  • Not Allowed.

• Standard Target Volume

  The expected target volume of a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Volume Tolerance

  The percentage of variance allowed from the Standard Target Volume.

• Standard Minimum Volume

  The minimum volume required for a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Maximum Volume

  The maximum volume required for a sample with an Analytical Type of Blank or Standard for the sample scheme's portion.

• Standard Volume Allowance

  When an out-of-range volume is entered for a sample with an Analytical Type of Blank or Standard is entered, an allowance can be provided:

  • Above and Below Volumes Allowed

  • Above Volumes Only Allowed

  • Below Volumes Only Allowed

  • Not Allowed.

Analytes Tab

The analytes associated with the analytical preparation or analytical scheme.

Multiple rows in a grid are marked/unmarked for selection or deletion by checking/unchecking the far-left check box or the red deletion icon, respectively, on the first row in the selection and holding the Control key and checking/unchecking the far-left check box or red deletion icon, respectively, on the last row in the selection. Multiple rows in a grid can have any Boolean property that is common to all rows (for example, Active? or Reportable check box) marked/unmarked for selection by checking/unchecking the Boolean's check box on the first row in the selection and holding the Control key and checking/unchecking the Boolean's check box on the last row in the selection.

• Grid flows

  • Create Scheme Version Analyte—Create a new scheme version analyte.

  • Create Analyte Price Code—Create a price code for the analyte if the scheme's Price Type is Analyte-Based and the analyte does not already have a price code associated with it.

• Row Number

  The sequence of the analyte when added from the scheme version to a sample, persisted to the Registration Sequence property. The column is hidden by default, but can be shown by clicking the Show or hide individual grid columns grid flow option.

  Note: The Profile Sequence property is obsolete.

• Code

  The code of the analyte. Display only.

• Analyte Data Type

  The type of data expected for the analytical result for the analyte:

  • Numeric Only—A numeric value is expected; only numeric result values are stored.

  • Numeric—A numeric value is expected, however, depending on permissions, a string value can be entered; only a numeric result or string result is stored.

  • Text—A text string is expected; a string result is stored.

  • Boolean—0 or 1 is expected; a Boolean result is stored.

  • Date—A date string is expected (for example, 01/12/2014); a date result is stored.

  • Datetime—A date-time string is expected (for example, 01/12/2014 14:15:11); a date-time result is stored.

  • Image—An image upload is expected; the image result points to the EFS file containing the image.

  • Document—A document upload is expected; the document result points to the EFS file containing the document.

• Name

  The name of the analyte. Display only.

• Description

  The description of the analyte. Display only.

• Analyte Type

  The intended use of the analyte. Display only. This can be:

  • Preparation Weight—Holds the weight of a sample scheme, which is propagated into related sample scheme analytes in the scheme and in linked schemes, and used for raw-to-final calculations. Only one Preparation Weight type analyte can be defined per scheme that has a Scheme Type of Analytical Preparation or Analytical.

  • Preparation Volume—Holds the volume of a sample scheme, which is propagated into to related sample scheme analytes in the scheme and in linked schemes, and used for raw-to-final calculations. Only one Preparation Volume type analyte can be defined per scheme that has a Scheme Type of Analytical Preparation or Analytical.

  • Preparation Other—Holds parameter information/results for a scheme that has a Scheme Type of Analytical Preparation or Analytical. These types of analytes are typically not reported nor impact on QC and workflow statuses.

  • Analytical—Holds an analytical result for a scheme that has a Scheme Type of Analytical Preparation or Analytical.

• Parent Analyte Code

  The code of parent analyte, such that, if populated, indicates that this analyte is a sub-analyte of the parent analyte. Workbook allows columns holding sub-analytes to be collapsed to just display the parent analyte. Display only.

• MSDS Name

  The material safety data sheet name or description of the analyte, to allow it to be cross-referenced to external safety details. Display only.

• Mandatory Profile

  Indicates whether the analyte is registered automatically on the sample when the scheme is registered on a sample during registration. Display only.

• Alignment

  The alignment for the display of results, allowing results to be displayed in a coherent manner for a Workbook session:

  • Auto

  • Left

  • Centre

  • Right

  When Auto is selected, then the default alignment based on data type below applies with the display mask for the analyte:

  Data Type	Alignment
  Numeric Only	Right
  Numeric	Right
  String	Left
  Boolean	Centre
  Date	Left
  Date Time	Left
  Image	Left
  Document	Left

Notes Tab

Notes associated with the scheme version.

• Report Header

  The report header of the scheme version, for use in reporting.

• Report Footer

  The report footer of the scheme version, for use in reporting.

• Results Header

  The results header of the scheme version, for use in reporting.