Types of System Batch Jobs

• Types of System Batch Jobs
  • Test Library Management Export and Import
    • CCBLIBMANEXPORT
    • CCLIBMANUPLOAD
  • Scheduling Registration
    • CCBSJGEN
    • SCHEDULE_JOB_SAMPLE_RECOVERY
    • SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB
  • Paperwork Generation
    • CCBPGEN
  • Emailing
    • CCBEMAIL
  • Printing
    • CCBPRINT
  • Parsing of Instrument Result Uploads
    • CCBINP
  • Instrument Schedules
    • CCBINS
  • Triggering Check Analysis
    • CCBSSAC
  • Certificate Report Functionality
    • CCBRGEN
  • Invoice Functionality
    • CCBINVGEN
    • CCBINVM
    • CCBINVC
    • CCBINVR
    • CCBINVCPM
    • CCBINVRCL
  • Script Execution
    • CCSCRTEXEC
  • General Cleanup
    • BATCHJOBCLEAN
    • CCSSAFILEREMOVER
    • CCCLEANER
  • Personalisation Upgrades (Obsoleted Functionality)
    • MSBCSD

Test Library Management Export and Import

CCBLIBMANEXPORT

Packages and exports library management content for the given organisation code and export file path. The file that LibMan.Export creates is unique for the organisation so as to keep each organisation’s exports separate.

All the source organisation data (including all the linked laboratory data) is deleted prior to the upload batch job. This includes:

• All related custom attributes

• All related EFS files (for example, scripts, images)

• All related I18n records.

A LIBMAN export is only required if the environment is a source of distributed library management content.

Refer to Using a Central Library.

CCBLIBMANEXPORT schedules are created manually, as required.

The task scheduler injects CCBLIBMANEXPORT job types into the system batch queue at the appointed execution time, or users create these batch jobs on demand, as required.

Automatic timeout on the system batch queue: 1 hour.

CCLIBMANUPLOAD

Uploads library management content from a package using the given URL. The package is produced by CCBLIMANEXPORT. Typically in CCLAS, the export path is accessible via URL also.

During the upload process:

If the previous uploaded Zip file is missing from the EFS folder, then the system regenerates the upload file from the destination organisation automatically, so that the destination data can be cleaned up.

The system removes the destination organisation record (in the CCORGANISATION table) and uploaded a new organisation record from the Zip file into the CCORGANISATION table, so that identical organisation codes with different Ids are not created.

Upon completion of the upload process, the system updates all of the laboratory's organisation Ids of the uploaded organisation to the uploaded organisation Id, so that orphan laboratories are not created.

Error messaging is provided when importing schemes, standard, products, biofields, template jobs and template samples.

A LIBMAN upload is only required if the environment is a recipient of distributed library management content.

Refer to Using a Central Library.

CCLIBMANUPLOAD schedules are created manually, as required.

The task scheduler injects CCLIBMANUPLOAD job types into the system batch queue at the appointed execution time, or users create these batch jobs on demand, as required.

Automatic timeout on the system batch queue: 2 steps in the batch execution (upload -> upload notifier), with each step's timeout set to 1 hour each.

Scheduling Registration

CCBSJGEN

Registers samples in a destination job using a schedule job.

The system attempts to create the destination job from the schedule job, and then create the samples within that job from the stream samples within the schedule job. See below for more details on this process. The future event(s) is removed from the Future Events grid on the Schedule tab in the CCREGN—Job application for the schedule job, and a new future event is created automatically based upon the defined frequency and appended to the grid, and the related CCBSJGEN scheduled task is created in the MSESCH—Schedule application.

It makes no sense for CCBSJGEN schedules to be created manually.

The CCREGN—Job application injects CCBSJGEN job types into the system batch queue when Execute is requested in a schedule job. Refer to Creating Production or Internal Jobs from Schedule Jobs.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

SCHEDULE_JOB_SAMPLE_RECOVERY

Note: Each schedule job which was impacted by the batch server being down is distributed to separate SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB batch job in the system batch queue, that is, it does not trigger individual SCHEDULE_JOB_SAMPLE_RECOVER batch jobs for each sample.

Creates all the past-due scheduled samples that were not created, typically due to the batch server being down, by recreating all the scheduled CCBSJGEN scheduled tasks. The process is:

• Delete all the future events that are scheduled for execution earlier than the current server date-time (displayed on the Schedule tab for each job in the CCREGN—Job application), for each organisation on the instance.
• Delete all the scheduled jobs that are scheduled for execution earlier than the current server date-time (displayed as CCBSJGEN scheduled tasks in the MSESCH—Schedule application), for each organisation on the instance.
• Select all the active future events that are earlier than current server date-time and create a SCHEDULE_JOB_SAMPLE_RECOVERY batch job, for each organisation on the instance.

If schedule job sample recovery is not run then some production samples may not be registered automatically if the batch queue system is down at the time the future event is scheduled.

SCHEDULE_JOB_SAMPLE_RECOVERY schedules are created manually, as required.

The task scheduler injects SCHEDULE_JOB_SAMPLE_RECOVERY job types into the system batch queue at the appointed execution time, or users create these jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB

Creates all the past-due scheduled samples that were not created, typically due to the batch server being down, by recreating all the scheduled CCBSJGEN scheduled tasks for a specific schedule job. The process is:

• Delete all the future events that are scheduled for execution earlier than current server date-time (displayed on the Schedule tab for the job in the CCREGN—Job application), for the given job.
• Deletes all the scheduled jobs that are scheduled for execution earlier than the current server date-time (displayed as CCBSJGEN scheduled tasks in the MSESCH—Schedule application), for the given job.
• Selects all the active future events that are earlier than current server date-time and creates a SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB batch job, for the given job.
• If schedule job sample recovery by job is not run, then some production samples may not be registered automatically if the batch queue system is down at the time the future event is scheduled.

SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB schedules are created manually, as required.

The task scheduler injects SCHEDULE_JOB_SAMPLE_RECOVERY_BY_JOB job types into the system batch queue at the appointed time, or users create these jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

Paperwork Generation

CCBPGEN

Generates job paperwork or label documents.

It makes no sense for CCBPGEN schedules to be created manually.

The CCREGN—Job, CCBTCH—Job Batch and CCRPTR—Report Request applications inject CCBPGEN job types into the system batch queue when paperwork is requested. Refer to Maintaining Job Paperwork and Labels, Batching Samples for Analysis and Generating Reports from Report Requests.

Automatic timeout on the system batch queue: 1 hour.

Emailing

CCBEMAIL

Sends a request to the email server to send an email.

It makes no sense for CCBEMAIL schedules to be created manually.

CCLAS 6 applications injects CCBEMAIL job types into the system batch queue when emailing is requested by the user.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

Printing

CCBPRINT

Sends a request to the print server to print a document.

It makes no sense for CCBPRINT schedules to be created manually.

CCLAS 6 application inject CCBPRINT job types into the system batch queue when printing is requested by the user.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

Parsing of Instrument Result Uploads

CCBINP

Runs the GENXML scheduler every minute to perform the upload of results from an instrument or file by running the associated script.

CCBINP schedules are created when Execute is requested for a Schedule Type of Instrument in the CCINSH—Instrument Schedule application for Maintaining Instrument and Task Schedules. It makes no sense for CCBEMAIL schedules to be created manually.

The task scheduler injects CCBINP job types into the system batch queue at the appointed execution time.

Automatic timeout on the system batch queue: 2 hours.

Instrument Schedules

CCBINS

Runs the GENXML scheduler every minute to execute the associated script.

CCBINS schedules are created when Execute is requested for a Schedule Type of Task in the CCINSH—Instrument Schedule application for Maintaining Instrument and Task Schedules. It makes no sense for CCBEMAIL schedules to be created manually.

The task scheduler injects CCBINS job types into the system batch queue at the appointed execution time.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

Triggering Check Analysis

CCBSSAC

Registers additional analysis on a set of samples, generally from triggering check analysis from a workbook session to add, where required, additional schemes and analytes from lower and upper template samples.

It makes no sense for CCBSSAC schedules to be created manually.

The CCWBOP—Open Workbook application injects CCBSSAC job types into the system batch queue when triggering check analysis. Refer to Preparing for Check Analysis in a Workbook Session.

Automatic timeout on the system batch queue: 5 minutes.

Certificate Report Functionality

CCBRGEN

Generates a report document and triggers the distribution.

Note that, in MSEJEX, and in the batch configuration file, the following job names are referenced internally from CCLAS, but map just to CCBRGEN:

• CCBRGEN_INTCERT
• CCBRGEN_FINALCERT
• CCBRGEN_PRECERT
• CCBRGEN_PAPERWORK
• CCBRGEN_LABEL.

It makes no sense for CCBRGEN schedules to be created manually.

The CCRPTR—Report Request application injects CCBRGEN job types into the system batch queue when Generating Reports from Report Requests or Distributing Certificate Reports.

Automatic timeout on the system batch queue: The 5 types of CCBRGEN batch jobs have 3 steps in the batch execution (generate report -> email -> print). Only the generate report step is set to have a 1 hour timeout, and the other two steps are not specified, so default to 5 minutes each:

• CCBRGEN_INTCERT = 1 hour + 5 minutes + 5 minutes
• CCBRGEN_FINALCERT = 1 hour + 5 minutes + 5 minutes
• CCBRGEN_PRECERT = 1 hour + 5 minutes + 5 minutes
• CCBRGEN_PAPERWORK = 1 hour + 5 minutes + 5 minutes
• CCBRGEN_LABEL = 1 hour + 5 minutes + 5 minutes

Invoice Functionality

CCBINVGEN

Generates an invoice document and trigger the distribution.

It makes no sense for CCBINVGEN schedules to be created manually.

The CCINV—Invoice application injects CCBINVGEN job types into the system batch queue when Release is requested. Refer to Releasing Invoices.

Automatic timeout on the system batch queue: There are 3 steps in the batch execution (generate invoice -> email -> print), with each step's timeout not specified, so each step defaults to 5 minutes.

CCBINVM

Creates an invoice by combining multiple job invoices using a group-by-job pricing mode.

It makes no sense for CCBINVM schedules to be created manually.

The CCINV—Invoice application injects CCBINVM job types into the system batch queue are created when Merge Invoices is requested. Refer to Drafting Invoices.

Automatic timeout on the system batch queue: 24 hours.

CCBINVC

Creates an invoice by combining multiple job invoices using a combined-by-job pricing mode.

It makes no sense for CCBINVC schedules to be created manually.

The CCINV—Invoice application injects CCBINVC job types into the system batch queue when Combine Invoices is requested. Refer to Drafting Invoices.

Automatic timeout on the system batch queue: 24 hours.

CCBINVR

Reprices an invoice.

It makes no sense for CCBINVR schedules to be created manually.

The CCINV—Invoice application injects CCBINVR job types into the system batch queue are created when Reprice is requested. Refer to Maintaining Invoices.

Automatic timeout on the system batch queue: 24 hours.

CCBINVCPM

Changes the pricing mode of a merged invoice.

It makes no sense for CCBINVCPM schedules to be created manually.

The CCINV—Invoice application injects CCBINVCPM job types into the system batch queue when Change Pricing Mode is requested. Refer to Maintaining Invoices.

Automatic timeout on the system batch queue: 24 hours.

CCBINVRCL

Recalculates the WIP or estimate amounts of a merged invoice.

It makes no sense for CCBINVRCL schedules to be created manually.

The CCINV—Invoice application injects CCBINVRCL job types into the system batch queue are created when Recalculate WIP / Est is requested. Refer to Maintaining Invoices.

Automatic timeout on the system batch queue: 24 hours.

Script Execution

CCSCRTEXEC

Runs the associated Groovy script. If the script execution is not done, there is no system impact unless the defined script is required for other system performance or maintenance tasks.

CCSCRTEXEC schedules are created manually, as required.

The task scheduler injects CCSCRTEXEC job types into the system batch queue at the appointed execution time, or users create these jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

General Cleanup

BATCHJOBCLEAN

Cleans system batch job execution histories if they are older than a defined number of days, to keep system batch job histories to a manageable level. If system batch job clean is not done, then the speed of searching and displaying system batch job histories is impacted.

BATCHJOBCLEAN schedules are created manually, as required.

The task scheduler injects BATCHJOBCLEAN job types into the system batch queue at the appointed execution time, or users create these system batch jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

CCSSAFILEREMOVER

Cleans up orphan files associated with sample scheme analyte records (documents, images) that are left behind when a sample scheme analyte record is deleted.

Image and documents attached to sample scheme analytes (as results or as attachments to results) are stored in EFS. Attachments may be shared by more than one sample scheme analyte. If these attachments are removed there is situations where the files on EFS become orphaned and need to be cleaned up. Uploaded files could get orphaned in these scenarios, and therefore require clean up:

• When an image or document is removed from a sample scheme analyte, and it is no longer referenced by any other sample scheme analyte
• When a sample scheme analyte, sample scheme, sample or job is deleted.

If the SSA file remover is not run, then CCTEXT and EFS files might be left as orphan records.

CCSSAFILEREMOVER schedules are created manually, as required.

The task scheduler injects CCSSAFILEREMOVER job types into the system batch queue at the appointed execution time, or users create these jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

CCCLEANER

Cleans up stale cached or staging table data created and used by:

• Deletion of interim records created by the CCREGN—Job application samples during sample creation, where the interim sample is > 3 days old:

  • CCBIOFIELDVAL and CCBIOFIELDVAL_I18N

  • CCTEXT and CCTEXT_I18N

  • CCSAMPLESCHEMEANALYTE and CCSAMPLESCHEMEANALYTE_I18N

  • CCSAMPLESCHEMELINK

  • CCSAMPLESPEC

  • CCSAMPLEPORTION

  • CCSAMPLESCHEME

  • CCSAMPLE and CCSAMPLE_I18N

  • And custom attributes for all of the above.

• Deletion of job batch session records created by the CCBTCH—Job Batch application, where the job batch session is > 3 days old:

  • CCJOBBATCHSCHEMESESSION

• Deletion of workbook session and dependency cache records created by the CCWKOP—Open Workbook application, where the workbook session is > 3 days old:

  • CCWORKBOOK

  • CCWKBKSVAR

  • CCWKBKSAMPLE

  and the dependency cache is > 14 days old:

  • CCSSA_DEPS

• Deletion of job and job-scheme lock records created by the CCREGN—Job, CCWKOP—Open Workbook and CCINV—Invoice applications (and maintained by the CCLOCK—Lock application), where the lock record has a populated LOCK_DATE time-stamp > 28 days old:

  • CCLOCK

• Deletion of temporary job sets in the staging table, used to generate reports from report requests, where the REQUEST_DATE time-stamp is > 3 days old, to cater for occasions where report generation terminates before having the change to empty the staging table for the current report generation session:

  • CCREPREQJOBTEMP

3 days is generally long enough time for laboratory personnel to:

• Finish registering samples to a job.
• Finish searching for samples to add to a new batch.
• Finish performing data entry into a workbook.

14 days is generally enough time for laboratory personnel to:

• Complete a job, such that, there is not further need of cached formula dependencies. Should there be a case where a job takes longer than 14 days, workbook recreates dependencies as they are required.

Note: These clean-up tasks are applied to ALL laboratories, even though the schedule might be linked to a specific Laboratory Code.

If the cleaner is not run, then some registration, laboratory batching and workbook functions may deteriorate in performance.

CCCLEANER schedules are created manually, as required.

The task scheduler injects CCCLEANER job types into the system batch queue at the appointed execution time, or users create these jobs on demand, as required.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.

Personalisation Upgrades (Obsoleted Functionality)

MSBCSD

Upgrades all personalised or customised application screens.

Warning: The MSECSD batch job SHOULD NOT BE USED as it could corrupt personalised or customised screens, thus rendering them unusable.
* Use the Upgrade or Upgrade All flows in the CCCSD—Custom Screen Definitions application to perform all personalised or customised screen upgrades.
* The CCCSD—Custom Screen Definitions application is a personalisation of the MSECSD—Custom Screen Definitions application, and supplied in the CCLAS package as it contains improved upgrade, upgradeAll and import services compared to the older MSECSD application.
* Core rights to run the upgrade, upgradeAll and import services of the MSECSD—Custom Screen Definitions application are removed in the CCLAS package, so unless these are actively re-instated, these older, and now out-dated, services do not run.

Automatic timeout on the system batch queue: Not specified, so defaults to 5 minutes.