Cancelling and Reinstating Jobs

• Cancelling and Reinstating Jobs
  • Overview
  • Process
    • Cancelling a Job
      • List of Reasons for Cancelling Jobs
    • Reinstating a Job
      • List of Reasons for Reinstating Jobs
  • Restrictions on Using Cancelled Jobs and Samples
  • Services permitted or denied for cancelled jobs and samples
    • Services that are permitted for a cancelled job
    • Services that are denied for a cancelled job
    • Services that are permitted for a cancelled sample
    • Services that are denied for a cancelled sample

Overview

Cancelling a job may be required if the client has requested the job to be stopped or cancelled, or the laboratory makes a decision that they cannot proceed with the job testing processes. A cancelled job is effectively removed from the testing schedule for the laboratory.

A cancelled job can be reinstated for completion at a later date, so job cancellation can also be used as a mechanism to place a job on hold for a particular reason, until the reason for the hold is removed.

Process

Cancelling a Job

Only jobs that have a Job Type of Production, Internal, Proposal, Laboratory Batch and Template can be cancelled.

When a job is selected for cancellation, if the CANCEL_JOB_REASON_MANDATORY application preference is defined and selected, then a reason as to why the job is cancelled must be entered for the cancellation to proceed, otherwise entering a reason is optional.

Upon job cancellation:

• The job's Workflow Status is set to Cancelled, Cancelled Date, Cancelled By and Cancelled/Reinstated Reason are set to the current system date-time, code of the current user, and the entered cancellation reason, respectively.
• For each sample in the job the sample's Workflow Status is set to Cancelled.
• Where a sample scheme analyte in the cancelled job is included in laboratory batch jobs, then the sample scheme analyte is de-linked from the laboratory batch job and laboratory batch sample, in which the sample scheme analyte's Laboratory Batch Job and Laboratory Batch Sample are cleared, and the associated laboratory batch sample scheme's Workflow Status set to Not Analysed.
• No changes are made to the job's composite QC status nor composite specification status, or any status-based dates or users set on the job, or any status, status-based dates or users at a lower level.
• The event is audited.

Cancel a job

List of Reasons for Cancelling Jobs

The reasons for cancelling a job are entered as System Table Codes with a Table Type of CC40—Cancel Job Reasons, as configured in the MSETBL—Table Code Service application.

The list of reasons for reinstating a job are entered as System Table Codes with a Table Type of CC41—Reinstate Job Reasons, as configured in the MSETBL—Table Code Service application.

Examples of a reason for cancelling a job:

Table Type	Table File Code System Short Form	Table file entry description	Table File Associated Values
CC40	CLIENT	Client cancellation
CC40	FINRISK	Financial risk
CC40	INTERNAL	Internal reason

For both table types, the Table Code can be set to any combination of letters, digit, and symbols, as appropriate (maximum length is 18).

For both table types, the Entry description can be modified as appropriate for drop-down and reporting purposes (maximum length is 50).

By default, the drop-down list of reasons that are built from the table types CC40—Cancel Job Reasons and CC41—Reinstate Job Reasons, respectively, are ordered by Table File Entry Description. For example, using the table above, the drop-down list presented when cancelling jobs is ordered: FINRISK, CLIENT, INTERNAL.

Use wild-cards to apply filtering on the drop-down list.

Reinstating a Job

Only jobs with a Workflow Status of Cancelled can be reinstated.

When a job is selected for reinstatement, if the REINSTATE_JOB_REASON_MANDATORY application preference is defined and selected, then a reason as to why the job is reinstated must be entered for the reinstatement to proceed, otherwise entering a reason is optional

Upon job reinstatement:

• The job's Workflow Status is re-determined based on which job status dates are populated, and the Cancelled/Reinstated Reason is set to the entered reinstatement reason.
• For each sample in the job, the sample's Workflow Status is re-determined based on which sample status dates are populated.
• The job's Composite Specification Status and Composite QC Status is re-evaluated from the composite of those on the job's samples.
• The event is audited.

Reinstate a job

List of Reasons for Reinstating Jobs

The list of available reasons for reinstating a job are entered as System Table Codes with a Table Type of CC41—Reinstate Job Reasons, as configured in the MSETBL—Table Code Service application.

Note: That table types are set up across the instance and cannot be filtered by organisation nor laboratory, that is, the list of reasons for reinstating a job are set instance-wide.

Examples of the list of reasons for reinstating a job:

Table Type	Table File Code	Table file entry description	Table File Associated Values
CC41	CLIENT	Client reinstatement
CC41	CLINOWFIN	Client now financial
CC41	INTERNAL	Internal reason

The Table Code can be set to any combination of letters, digit, and symbols, as appropriate (maximum length is 18).

The Entry description can be modified as appropriate for drop-down and reporting purposes (maximum length is 50).

By default, the drop-down list of reinstatement reasons built from the Table Type of CC41—Reinstate Job Reasons, ordered by Table File Entry Description. For example, using the table above, the drop-down list presented when reinstating jobs is ordered: FINRISK, CLIENT, INTERNAL.

Use wild-cards to apply filtering on the drop-down list.

Restrictions on Using Cancelled Jobs and Samples

CCREGN—Job application:

• The only action that can be performed on a cancelled job is Reinstate.
• Cancelled jobs are excluded by default in search results, but are included where the Include Cancelled Jobs is selected in the search criteria.
• The date-time on which the job was cancelled, the code of the user who cancelled the job, and the reason as to why the job was cancelled (or reinstated) are visible by showing the individual grid columns in the search results, and are visible in the Status tab for the job.
• When a cancelled job is opened, then the entire job is locked for update.
• A biofield cannot be updated on, added to, nor removed from, a cancelled job.
• A sample cannot be updated on, appended to, nor deleted from, a cancelled job.
• A composite sample cannot be updated on, nor created, in a cancelled job.
• A scheme or analyte cannot be updated on a cancelled job.
• QC samples cannot be modified for a scheme in a cancelled job.

CCJAUD—Job Audit application

• No impact.

CCSAMP—Sample application:

• When sample within a cancelled job is opened, then the entire sample is locked for update.
• A specification cannot be updated on, added to, nor removed from, a sample within a cancelled job.
• A scheme or analyte cannot be updated on, added to, nor removed from, a sample within a cancelled job.

CCSGRD—Sample Gridding application

• When Applying Sample Gridding, if a job's Workflow Status is Cancelled, then a sample scheme analyte cannot have its Workflow Status updated via Set to LNR, Set to IS, Set to NA, Set to NR or Reset actions.

CCBTCH—Job Batch application

• Samples within a cancelled job are excluded from the sample search and cannot be included in a laboratory batch job. The job's samples can be included in an export to report.

  Note: If a laboratory batch job is opened in the CCQCSM—QC Sample Modification application and its production job is cancelled, then duplicate, replicate or spike QC samples related to a sample in the cancelled production job can be created in the laboratory batch job.

CCQCSM—QC Sample Modification application

• When a cancelled job is opened, then QC samples cannot be added, re-sequenced, deleted nor updated. The job's samples can be included in an export to report.

  Note: When a laboratory batch job is opened in the CCQCSM—QC Sample Modification application and a related production job is cancelled, then duplicate, replicate or spike QC samples related to a sample in the cancelled production job can be created in the laboratory batch job.

CCWKOP—Open Workbook and CCWKOPTRAN—Open Transposed Workbook applications

• Samples within a cancelled job cannot be opened for a workbook or worklist session.
• If a laboratory batch sample belongs to a production job that is cancelled, that sample is read-only in a workbook or worklist session, and readings cannot be changed.

CCVALN—Validation application

• Samples within a cancelled job are not visible, such that, the job and its samples cannot be validated nor unvalidated, job and sample notes cannot be entered, signatories cannot be added to the job, sample scheme analyte results cannot be validated, released, have detection limit failures ignored, have QC failures ignored, or have repeat analysis requested.

CCRPTR—Report Request application

• A cancelled job and its samples, schemes and analytes cannot be added to a report request of any type.
• If a report request contains any cancelled jobs and the Report Request Type is Certificate, then reports cannot be generated from the report request.
• If a report request contains any cancelled jobs and the Report Request Type is Paperwork, Labels or Analysis, then then reports can be generated from the report request.

CCINV—Invoice application, and job cost services

• If an invoice contains a job invoice where the related job's Workflow Status is Cancelled, then invoice processes are still available so that the invoice can be released.
• Where a job's Workflow Status is Cancelled, then job cost processes are still available so that the job can be costed.

CCPRTN—Portion

• Where a portion is associated with a sample in a cancelled job, when the portion's Location Code is updated that could potentially mark a sample preparation scheme's Workflow Status as Not Started, Started or Completed, based upon the location's configuration, then NO changes are made to the associated sample scheme, sample, job scheme or job's Workflow Status.

General

• Cancelled jobs and samples within cancelled jobs are excluded when a drop-down list is populated for job or sample selection, respectively.

Services permitted or denied for cancelled jobs and samples

Services that are permitted for a cancelled job

Name of permitted resource	Resource description
CCJOB:ARCHIVE	Archive *Unimplemented operation (legacy/placeholder)
CCJOB:CALCULATEEXPIRYDATENOW	CalculateExpiryDateNow *Unimplemented operation (legacy/placeholder)
CCJOB:GENERATEREPORT	GenerateReport *Unimplemented operation (legacy/placeholder)
CCJOB:GENERATEWORKSHEETREPORT	GenerateWorksheetReport *Unimplemented operation (legacy/placeholder)
CCJOB:GETJOBREGISTRATIONSAMPLEBIOFIELDSBASEDONPREFERENCES	Get Job Registration Biofields *Internal operation, where if a job is blocked, it breaks system functionality
CCJOB:ONCLOSE	On Close *Internal operation, where if a job is blocked, it breaks system functionality
CCJOB:READ	Read
CCJOB:REINSTATE	Reinstate
CCJOB:RETRIEVE	Retrieve
CCJOB:SEARCH	Search
CCJOB:SEARCHFORDROPDOWN	SearchForDropdown
CCJOB:SEARCHCREATEBATCHJOBTEMPLATE	SearchCreateBatchJobTemplate
CCJOB:SEARCHCREATEBATCHJOBTEMPLATEFORDROPDOWN	SearchCreateBatchJobTemplateForDropdown
CCJOB:SEARCHCANCELJOBREASONS	SearchForCancelJobReasons

Services that are denied for a cancelled job

Name of denied resource	Resource description
CCJOB:ACTIVATE	Activate
CCJOB:ADDSIGNATORY	AddSignatory
CCJOB:CANCEL	Cancel
CCJOB:CHANGEOWNER	ChangeOwner
CCJOB:CREATE	Create
CCJOB:CREATEDRAFT	CreateDraft
CCJOB:CREATEFROMXML	CreateFromXml
CCJOB:DELETE	Delete
CCJOB:ENACT	Enact
CCJOB:EXECUTE	Execute
CCJOB:FINALISE	Finalise
CCJOB:MARKRECEIVED	MarkReceived
CCJOB:OVERWRITEQC	OverwriteQC
CCJOB:PROMOTE	Promote
CCJOB:SAVEAS	SaveAs
CCJOB:SAVEASRETURNNEW	SaveAsReturnNew
CCJOB:SUSPEND	Suspend
CCJOB:TERMINATE	Terminate
CCJOB:UNFINALISE	Unfinalise
CCJOB:UPDATE	Update
CCJOB:UPDATEPREPMISCWORKFLOWSTATUS	UpdatePrepMiscWorkflowStatus
CCJOB:UPDATEQC	UpdateQC

Services that are permitted for a cancelled sample

Name of permitted resource	Resource description
CCSAMPLE:CREATEQCSAMPLE	CreateQcSample *Unimplemented operation (legacy/placeholder)
CCSAMPLE:DROPDOWN	DropDown
CCSAMPLE:GENERATEREPORT	GenerateReport *Unimplemented operation (legacy/placeholder)
CCSAMPLE:LISTEDNOTRECEIVESAMPLE	ListedNotReceiveSample *Unimplemented operation (legacy/placeholder)
CCSAMPLE:READ	Read
CCSAMPLE:RECEIVESAMPLE	ReceiveSample *Unimplemented operation (legacy/placeholder)
CCSAMPLE:SEARCH	Search
CCSAMPLE:SEARCHCREATESAMPLEFROMTEMPLATEFORDROPDOWN	SearchCreateSampleFromTemplateForDropdown
CCSAMPLE:SEARCHCREATESAMPLEFROMTEMPLATE	SearchCreateSampleFromTemplate
CCSAMPLE:SEARCHFORDROPDOWN	SearchForDropdown
CCSAMPLE:SEARCHFORREPORTREQUEST	SearchForReportRequest
CCSAMPLE:SEARCHFORSAMPLERECEIVE	SearchForSampleReceive *Unimplemented operation (legacy/placeholder)
CCSAMPLEB:SEARCHSAMPLETEMPLATESFORJOB	SearchSampleTemplatesForJob
CCSAMPLE:SEARCHWITHRESULTSCONTAININGBIOFIELDSASCUSTOMATTRIBUTES	SearchWithResultsContainingBioFieldsAsCustomAttributes
CCSAMPLE:UNDORECEIVEDORLISTED	UndoReceivedorListed *Unimplemented operation (legacy/placeholder)

Services that are denied for a cancelled sample

Name of denied resource	Resource description
CCSAMPLE:ACTIVATE	Activate
CCSAMPLE:ADDSCHEMESFROMSAMPLES	AddSchemesFromSamples
CCSAMPLE:APPLYTEMPLATEPRICING	ApplyTemplatePricing
CCSAMPLE:APPROVE	Approve
CCSAMPLE:CHANGEOWNER	ChangeOwner
CCSAMPLE:CREATE	Create
CCSAMPLE:CREATECOMPOSITESAMPLE	CreateCompositeSample
CCSAMPLE:CREATEDRAFT	CreateDraft
CCSAMPLE:DEACTIVATE	Deactivate
CCSAMPLE:DELETE	Delete
CCASMPLE:EXPAND	Expand
CCSAMPLE:IMPORTSAMPLE	ImportSample
CCSAMPLE:IMPORTSCHEDULESAMPLE	ImportScheduleSample
CCSAMPLE:MARKRECEIVED	MarkReceived
CCSAMPLE:MULTIEDITPOSTSUBMIT	MultiEditPostSubmit
CCSAMPLE:PREPAREUPDATEMULTIPLESAMPLES	PrepareUpdateMultipleSamples
CCSAMPLE:REMOVETEMPLATEPRICING	RemoveTemplatePricing
CCSAMPLE:SAVEAS	SaveAs
CCSAMPLE:SYNCHRONISEPORTIONS	SynchronisePortions
CCSAMPLE:UNAPPROVE	Unapprove
CCSAMPLE:UPDATE	Update
CCSAMPLE:UPDATENONWORKFLOW	UpdateNonWorkflow
CCSAMPLE:UPDATESAMPLEBIOFIELDSWHEREBIOFIELDSARECUSTOMATTRIBUTES	UpdateSampleBiofieldsWhereBiofieldsAreCustomAttributes