Promoting Entities to Use a New Scheme Version

A scheme version is the generational portion of a scheme, and allows for various aspects of the scheme, including the analytes, to vary from version to version.

New scheme versions are created when significant changes are made to the methods or operational procedures. Specific rules exist, that once the scheme version is enabled for use by a laboratory, then the latest active scheme version is used when the scheme is registered on a sample.

When a new scheme version is published this process promotes specifications, standards, products and template jobs to link to the new scheme version.

  • Specification scheme version analytes in standalone specifications
  • Specification scheme version analytes in specifications linked from standards
  • Specification scheme version analytes in specifications linked from products
  • Job schemes, job scheme analytes, sample schemes, sample scheme analytes in template jobs.

Standalone specifications, and specifications associated with standards and products, can contain links to multiple scheme versions. When specifications, standards or products are promoted to use the latest published scheme version, the entities associated with the existing scheme versions remain in place, and additional entities are created for the latest published scheme version.

Production, internal, template and schedule jobs contain links to schemes for a single scheme version. When jobs are promoted to use the latest published scheme version, the entities associated with the existing scheme version (job schemes, job scheme analytes, sample schemes and sample scheme analytes) are updated to link to the latest published scheme version. Job scheme analytes and sample schemes are removed for any analytes that no longer exist in the latest published scheme version.

Create and Publish a new Scheme Version

Create the next version of a scheme, then publish the scheme version. Refer to Maintaining Versions of a Scheme.

Promote Entities to use the new Scheme Version

When org-scope entities are promoted, they are linked to the highest published version of a scheme. When lab-scope entities are promoted, they are linked to the highest published version of the scheme that is available to the laboratory. This means that where the entity links to an enabled-scope scheme version, it is linked to the highest published version of the scheme THAT IS ENABLED by the laboratory.

After an org-scope scheme version is published:

  • Org-scope entities can be promoted to link to the highest published version of the scheme.

  • Lab-scope entities can be promoted to link to the highest published and laboratory-enabled version of the scheme.

After a lab-scope scheme version is published, lab-scope entities can be promoted to use the new scheme version.

Specifications

Promote Any Specification

Promote scheme limit specifications, standard specifications and product specifications using the CCSPFN—Specification application. Refer to Maintaining Scheme Limit Specifications, Maintaining Standard Specifications and Maintaining Product Specifications.

After locating the specifications for the nominated type within the application, each selected specification is promoted.

During specification promotion, where a specification scheme version analyte exists for the previously highest scheme version, if the analyte still exists in that scheme version, then a new specification scheme version analyte is created for the now highest available scheme version, and if the analyte no longer exists in that scheme version, then no new specification scheme version analyte is created for the now highest available scheme version.

Promote scheme limit specifications

Promote Specifications for Product Use

Promote Specifications for Standard Use

Promote Standard Specifications via the Standard

Promote standards, and therefore all associated standard specifications, using the CCSTND—Standard application. Refer to Maintaining Standards.

After locating the standards within the application, for each selected standard, the current standard lot's specification is promoted.

Promote standards to use the latest scheme versions

Promote Product Specifications via the Product

Promote products, and therefore all associated product specifications, using the CCPRDT—Product application. Refer to Maintaining Product Specifications.

After locating the products within the application, for each selected product, the associated specifications are promoted.

Promote products to use the latest scheme versions

Jobs

Promote production, internal, template and schedule jobs using the CCREGN—Job application. These are the only types of jobs that can be promoted. Refer to Maintaining Jobs.

Promote production jobs to use the latest scheme versions

Promote internal jobs to use the latest scheme versions

Promote template or schedule jobs to use the latest scheme versions

Each selected job is promoted as follows. A dialog displays the possible list of fields from the Job Scheme, Job Scheme Analyte, Sample Scheme and Sample Scheme Analyte records that are potentially promotable. A checked check box next to a field indicates that the field value is retained upon promotion. Fields that are checked on by default are defined by a comma-separated list of fields defined by a preference based on job type.

Set the INTERNAL_PROMOTION_OVERRIDE_LIST Preference

Set the PRODUCTION_PROMOTION_OVERRIDE_LIST Preference

Set the PROMOTION_OVERRIDE_LIST Preference

During job promotion,

  • For each sample scheme, those attributes on the sample scheme that originate from the scheme version, and flagged to be retained, are updated to apply the value from the highest available scheme version.

    • SS.SCHEME_VERSION_ID = SV.ID

    • SS.SCHEME_VERSION_NUMBER = SV.SCHEME_VERSION

    • If PreservedSSProperties parameter does not contain 'HoldingTime' then SS.HOLDING_TIME = SV.HOLDING_TIME

    • If PreservedSSProperties parameter does not contain 'InternalCost' then SS.INTERNAL_COST = SV.INTERNAL_COST

    • SS.SUBCONTRACT_LABORATORY_ID = SV.DEFAULT_SUBCNTR_LAB_ID

    • SS.PRIORITY = SV.PRIORITY

    • If PreservedSSProperties parameter does not contain 'QC Mask' then SS.QC_MASK_ID = SV.QC_MASK_ID

    • If PreservedSSProperties parameter does not contain 'SchemeDuration' then SS.SCHEME_DURATION = SV.SCHEME_DURATION

  • For each job scheme analyte:

    1. Where a job scheme analyte exists for the previously highest scheme version, if the analyte still exists in that scheme version, then those attributes on the job scheme analyte that originate from the scheme version analyte are updated to apply the value from the highest available scheme version analyte.

      • JSA.SCHEME_VERSION_ANALYTE_ID = SVA.ID

      • JSA.SCHEME_VERSION_NUMBER = SV.SCHEME_VERSION_NO

      • JSA.IS_REPORTABLE = SVA.IS_REPORTABLE

      • JSA.REPORT_NAME = SVA.REPORT_NAME

      • JSA.REPORT_SEQUENCE = SVA.REPORT_SEQUENCE

    2. Where a job scheme analyte exists for the previously highest scheme version, if the analyte no longer exists in that scheme version, then the job scheme analyte and any associated sample scheme analytes are deleted (with the event being audited).

  • For each remaining sample scheme analyte (that is, where they are not deleted because the analyte still exists in highest available scheme version), then those attributes on the sample scheme analyte that originate from the scheme version analyte are updated to apply the value from the highest available scheme version analyte.

    • SSA,SCHEME_VERSION_ID = SV.ID

    • SSA.SCHEME_VERSION_NUMBER = SV.SCHEME_VERSION

    • SSA.SCHEME_VERSION_ANALYTE_ID = SVA.ID

    • SSA.SPREADSHEET_FORMULA = SVA.SPREADSHEET_FORMULA

    • If PreservedSSAProperties parameter does not contain 'HoldingTime' then SSA.SSA.HOLDING_TIME = SVA.HOLDING_TIME

    • If PreservedSSAProperties parameter does not contain 'IsIncludeOnWorksheet' then SSA.IS_INCLUDE_ON_WORKSHEET = SVA.IS_INCLUDE_ON_WORKSHEET

    • If PreservedSSAProperties parameter does not contain 'UnitCode' then SSA.UNIT_ID = SVA.UNIT_ID

    • If PreservedSSAProperties parameter does not contain 'InternalLowerDetectionLimit' then SSA.INT_LOWER_DET_LIMIT = SVA.INT_LOWER_DL

    • If PreservedSSAProperties parameter does not contain ' InternalUpperDetectionLimit' then SSA.INT_UPPER_DET_LIMIT = SVA.INT_UPPER_DL

    • If PreservedSSAProperties parameter does not contain 'IsInternalLowerLimitCritical' then SSA.IS_INT_LOWER_LIM_CRITICAL = SVA.IS_INT_LOWER_DL_CRITICAL

    • If PreservedSSAProperties parameter does not contain 'IsInternalUpperLimitCritical' then SSA.IS_INT_UPPER_LIM_CRITICAL = SVA.IS_INT_UPPER_DL_CRITICAL

    • SSA.IS_QC_ACTIVE (recent story only uses this from SVA so this field should be obsolete or removed by now)

    • If PreservedSSAProperties parameter does not contain 'IsReportable' then SSA.IS_REPORTABLE = SVA.IS_REPORTABLE

    • If PreservedSSAProperties parameter does not contain 'ReportLowerDetectionLimit' then SSA.REP_LOWER_DET_LIMIT = SVA.REP_LOWER_DL

    • If PreservedSSAProperties parameter does not contain 'ReportUpperDetectionLimit' then SSA.REP_UPPER_DET_LIMIT = SVA.REP_UPPER_DL

    • If PreservedSSAProperties parameter does not contain 'RoundingTableCode' then SSA.ROUNDING_TABLE_ID = SVA.ROUNDING_TABLE_ID

    • If PreservedSSAProperties parameter does not contain 'IsInvoiceable' then SSA.IS_INVOICEABLE = SVA.IS_INVOICEABLE

    • If PreservedSSAProperties parameter does not contain 'PriceItemCode' then SSA.PRICE_ITEM_ID = SVA.PRICE_ITEM_ID

    • SSA.REPORT_SEQUENCE = SVA.REPORT_SEQUENCE

Note: The details updated in an org-scope template job's Job Scheme records are taken from the org-scope Scheme Version records, to match what happens when a scheme is added to an org-scope.

The details updated in a lab-scope template job's Job Scheme records are taken from the enabled-scope Scheme Version records for an associated org-scope scheme that is enabled for the laboratory, and from the lab-scope Scheme Version records for an associated lab-scope scheme, to match what happens when a scheme is added to a lab-scope job.

For example: Where a lab-scope template job has version 1 of an org-scope scheme (that is, the template job contains the enabled-scope scheme), yet version 2 of the org-scope scheme exists that is not enabled as yet for the lab, then the scheme cannot be promoted in the template job to use the new Scheme Version or Scheme Version Analyte properties. The scheme version must be enabled in the laboratory prior to this for this to proceed.