Population of the CCJobScheme DTO

The CCJobScheme DTO is referenced when Creating Report Requests from Job Report Stakeholders, to place content into the output document as per the report template.

When an org-scope scheme is registered on an org-scope sample causing a job scheme to be created, then for the org-scope job scheme:

  • The master scheme is the org-scope scheme.
  • The scoped scheme is the org-scope scheme.

When an org-scope scheme is registered on a lab-scope sample causing a job scheme to be created, then for the lab-scope job scheme:

  • The master scheme is the org-scope scheme.
  • The scoped scheme is the enabled-scope scheme.

When a lab-scope scheme is registered on a lab-scope sample causing a job scheme to be created, then for the lab-scope job scheme:

  • The master scheme is the lab-scope scheme.
  • The scoped scheme is the lab-scope scheme.

For enabled-scope schemes, defaults originating from the master org-scope scheme or scheme version are indicated.

Property Default

Org-scope job with
org-scope scheme

Lab-scope job with
enabled-scope scheme

Lab-scope job with
lab-scope scheme

For identification:

 

 

 

 
  • jobSchemeId

Current entity's ID

 

 

 
  • isOrganisationScope

Indicates whether the entity has organisation scope

True

False

False
  • organisationCode

job.organisationCode

Current organisation

Current organisation

Current organisation
  • laboratoryCode

job.laboratoryCode

 

Current laboratory

Current laboratory
  • jobId
  • jobCode

job.id and code

 

 

 
  • jobName

job.name

 

 

 
  • schemeLaboratoryCode

sampleScheme.laboratoryCode

Empty

Empty

Current laboratory
  • schemeId
  • schemeCode

sampleScheme.id and code

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeName

Master scheme.name

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionId
  • schemeVersion

sampleScheme.schemeVersionId and linked schemeVersion.versionNumber

Displays org-scope

Displays org-scope

Displays lab-scope
  • jobAssocSchemeId—Obsolete field; master scheme is never the enabled-scope scheme

Draft sampleScheme.schemeAssocSchemeId, and if empty, then from scheme.assocSchemeId

Empty

Empty

Empty
  • jobAssocSchemeVersionId—Obsolete field; master scheme is never the enabled-scope scheme

Draft sampleScheme.schemeVersionAssocSchemeVersionId, and if empty then from schemeVersion.assocSchemeVersionId

Empty

Empty

Empty
  • isSchemeLabEnabled

Indicates whether the scoped scheme is lab-enabled

False

True

False
  • registrationSequence

Numerical sequence of scheme within the job

 

 

 
  • creationDate
  • creationTime
  • creationUser

 

 

 

 
  • lastModDate
  • lastModTime
  • lastModUser

 

 

 

 

For management:

 

 

 

 
  • numberOfSamples

 

 

 

 
  • numberOfUnknownSamples

 

 

 

 
  • requiredDate

job.requiredDate + sampleScheme.priority + holidays + non-working days of week if job.requiredDate and sampleScheme.priority are defined, else set to job.requiredDate if job.requiredDate is defined, else empty

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • possibleDate

 

 

 

 
  • activatedUserId
  • activatedUserCode

 

 

 

 
  • lastActivatedDate

 

 

 

 
  • workflowStatus

Not Started

 

 

 
  • prepMiscSchemeWorkflowStatus

 

 

 

 

For pre-analysis:

 

 

 

 
  • isIncludedInJobQc?

Inverse of scoped schemeVersion.batchAcrossJobs

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • Precursor scheme relationships—Used for Append/Overwrite QC, where the a scheme is registered on the sample.

Precursor scheme registration using scoped scheme's precursor relationships

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • Linked scheme relationships—Where the two schemes are registered on the job.

Linked scheme relationships using master scheme's scheme links

Uses org-scope

Uses org-scope

Uses lab-scope
  • subcontractLaboratoryCode

Scoped schemeVersion.defaultSubContractLabCode

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • subcontractLaboratoryOrgCode

Scoped schemeVersion.defaultSubContractLabOrgCode

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • currentBatchId

 

 

 

 

For analysis:

 

 

 

 
  • startedDate

 

 

 

 
  • analysedDate

 

 

 

 
  • analysisText
  • analysisTextId

 

 

 

 
  • releasedDate

 

 

 

 
  • completedByUserId
  • completedByUserCode

 

 

 

 
  • completedDate

 

 

 

 
  • compositeQcStatus

Not Tested

 

 

 
  • compositeSpecStatus

Not Tested

 

 

 

For validation:

 

 

 

 
  • isAutoValidate—Obsolete field. The flag on the scheme is used to default the flag for scheme version analytes. The flag on the scheme version analyte is used by the cascade engine.

Scoped scheme.autoValidate

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • validatedDate

 

 

 

 
  • validationUserId
  • validationUserCode

 

 

 

 

For reporting:

 

 

 

 
  • isReportable

Scoped scheme.isReportable

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • reportSequence

Scoped scheme.reportSequence

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • reportName

Scoped schemeVersion.reportName

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • reportDescription

Scoped schemeVersion.reportDescription

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • reportHeaderTextId
  • reportHeaderText

Copy of the notes from master schemeVersion.reportHeader

Uses org-scope

Uses org-scope

This differs to the SS that uses the enabled-scope scheme version

Uses lab-scope
  • reportFooterTextId
  • reportFooterText

Copy of the notes from master schemeVersion.reportFooter

Uses org-scope

Uses org-scope

This differs to the SS that uses the enabled-scope scheme version

Uses lab-scope
  • resultHeaderTextId
  • resultHeaderText

Copy of the notes from master schemeVersion.resultHeader

Uses org-scope

Uses org-scope

This differs to the SS that uses from the enabled-scope scheme version

Uses lab-scope
  • reportTextId
  • reportText

 

 

 

 
  • firstReportedDate

 

 

 

 
  • lastReportedDate

 

 

 

 

For invoicing:

 

 

 

 
  • schemePriceType

Scoped scheme.priceType

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • priceCodeLabCode

Where the price code is org-scope then left empty, where lab-scope then set to the current laboratory

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • priceCode

Scoped scheme.priceCode

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • fixedBasePrice

 

 

 

 
  • fixedBlockPrice

 

 

 

 
  • numberOfUnits