Configuring the Batch Application

Forms See also
BATCH—AddSchemes Form

BATCH—AnalyteList Form

BATCH—Batch Form

BATCH—CriteriaInstrument Form

BATCH—CriteriaScheme Form

BATCH—CriteriaSubcontract Form

BATCH—DialogBatch Form

BATCH—FilterQuery Form

BATCH—ProcedureAdd Form

BATCH—ProfJobSchemeEditANA Form

BATCH—QCFile Form

BATCH—Reset Form

BATCH—SelectLine Form

BATCH—SeqMove Form

BATCH—Summary Form

BATCH—Waiting Form

Configuring Access to CCLAS Applications, Tables and Fields

Creating a Laboratory Batch Job

Creating a Subcontract Batch Job

Creating an Instrument Run File

Maintaining Batch Samples

Setting Waiting Times on Analysis

Overview

Batching allows for the creation of laboratory batch jobs, subcontract batch jobs and instrument run files, all types, of batches, that is, groups of samples for a given scheme or linked schemes.

This process is pertinent to LIMS and laboratory managers who configure the LIMS, and the look and feel of applications to enhance laboratory processes and the user experience, and batching sessions in particular, to limit access, configure query forms, and to customise the process.

Process

Configuring Access to the Batch Application

Ensure the Batch.exe file is located in the folder defined by the ExeDirectory Program Settings—GLOBALSETTINGS for CCLASMGR. Give users, or users with specific roles, access to the application by setting the AccessLevel Program Settings - BATCH. Once a user has sufficient access rights, they can run the Batch application either from the Batch node on the CCLAS menu or directly from the CCLAS Exe folder.

To display tips to users upon start up of the Batch application, enable the ShowTipOfTheDay Program Settings - BATCH, and enter the tips, with one tip per line, in a file, place the file in a folder under the CCLAS root folder defined by the CCLASRootDirectory Program Settings—GLOBALSETTINGS for CCLASMGR, then set the TipofTheDayFile Program Settings - BATCH to the folder and file name, for example %CCLASRootDirectory%TIPS\BATCH.TIP.

To maintain the window size and position between closing and launching the Batch application, set the Window Program Settings - BATCH.

Configuring Batch Sample Search

Set the MainListViewColumnn Program Settings - BATCH to specify which columns from the SAMPLE table are presented in the grid.

To filter samples for batching based on field criteria:

Set the CriteriaReadyWaiting Program Settings - BATCH to specify the criteria based on a ready or waiting laboratory batching status.

When searching by scheme:

When searching by subcontract:

When searching by instrument:

Set the GridAlternateColour1 and GridAlternateColour2 Program Settings - BATCH to the rows' background colour of alternating jobs returned from a search.

Enable the LockOpenSamples Program Settings - BATCH to lock samples for update in other applications whilst they are being searched for and batchjed.

If the BatchSchemeAddNew.SCR script file is located in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR and contains a query form, then it is displayed at the bottom of the scheme search screen to return schemes based on criteria. If it does not exist, then all schemes are returned.

If the BatchProcedureAddNew.SCR script file is located in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR and contains a query form, then it is displayed at the bottom of the procedure search screen to return procedures based on criteria. If it does not exist, then all procedures are returned.

Configuring Laboratory Batch Creation

The LBAutoJobNo Program Settings—GLOBALSETTINGS for CCLASMGR defines the default job template.

Configuring Subcontract Batch Creation

The SubContractAutoJobNo Program Settings—GLOBALSETTINGS for CCLASMGR defines the default job template.

The SubContractCuidSequence Program Settings - BATCH defines the default CUID unique number sequence used to determine the sample idents in a subcontract batch job.

The laboratory in which a subcontract batch job is created depends upon the scheme's Executing Lab code and the analytical laboratories defined for the scheme (refer to the SCHEME—SchemeEdit Form), and the AutoDeleteSubContractBatch and AutoRetrieveSubContractBatch Program Settings - BATCH:

  • Where the scheme's Executing Lab code is not defined (which is only possible where no analysis laboratories are defined for the scheme), or is defined and set to the current laboratory, then the subcontract batch job is created within the current laboratory.
  • Where the scheme's Executing Lab code is defined and set to one of the scheme's analysis laboratories excluding the current laboratory, then the subcontract batch job is created within the current laboratory, and if the AutoRetrieveSubContractBatch Program Settings - BATCH is enabled, then the subcontract batch job is exported to the subcontracted executing laboratory, and further to this, if the AutoDeleteSubContractBatch Batch program setting is enabled, then the subcontract batch job is deleted from the current laboratory leaving the batch job only in the subcontracted executing laboratory.

The SubContractCuidSequence Program Settings - BATCH defines the default CUID unique number sequence used to determine the sample idents in a subcontract job.

Configuring Batch Creation

If the BatchUDF.VBS script file is located in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR, and:

  • The BeforeQueryData subroutine exists in the script, before samples are located matching the criteria, then it is invoked. The exposed objects are: clsBatch, clsBDProfJob, clsSecurity, and oRSSamples.
  • The AfterQueryData subroutine exists in the script, after samples are located matching the criteria, but before the samples are displayed on the form, then it is invoked. The exposed objects are: clsBatch, clsBDProfJob, clsSecurity, and oRSSamples.
  • The BatchUDF1 subroutine exists in the script, before the analytical result records (PROFJOB_CUID_SCHEME_ANALYTE) are created, then it is invoked. The Job number is passed in as a parameter.
  • The BatchUDF2 subroutine exists in the script, after the analytical result records are created, but before requested paperwork is generated, then it is invoked. This script typically displays a job paperwork dialog box. The Job number is passed in as a parameter.
  • The BatchUDF3 subroutine exists in the script file, after the instrument run file is generated, then it is invoked. The Instrument Run File name is passed in as a parameter.
Configuring Report Generation

Set the ReportLDFn Program Settings - BATCH to the required report templates.

Configuring Paperwork Generation

If the PRepUDF.VBS script file is located in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR, and:

  • The PRepUDF1 subroutine exists in the script, before the paperwork report is created in Microsoft Excel™, then it is invoked.
  • The PRepUDF2 subroutine exists in the script, after the paperwork report is created in Microsoft Excel™, then it is invoked.
  • The PRepUDF3 subroutine exists in the script, before the paperwork report is created in Microsoft Word™, then it is invoked.
  • The PRepUDF4 subroutine exists in the script, after the paperwork report is created in Microsoft Word™, then it is invoked.
  • The BeforeCrystalGenerate subroutine exists in the script, before the paperwork report is generated in Crystal Reports™, then it is invoked.
  • The AfterCrystalGenerate subroutine exists in the script, after the paperwork report is created in Crystal Reports™, then it is invoked.
Configuring User Forms

The ScreenFilen Program Settings - BATCH define the user forms available to apply custom functionality within the Batch application.

Configuring Weight and Volume Transfer to the Original Sample Scheme

Results entered against a sample in a laboratory batch job is stored directly to the original component jobs. Weights and volumes captured against sample-CUID schemes in laboratory batches are copied back to the original job's sample scheme where the LBWeightVolumeTransfer Program Settings—GLOBALSETTINGS for CCLASMGR is enabled, to allow for the reporting of raw results to the client.

Configuring Data Entry into Laboratory Batch Jobs

Enable the LBWeightVolumeTransfer Program Settings—GLOBALSETTINGS for CCLASMGR to have the weights and volumes captured against batch CUID schemes automatically copied back to the original job's sample scheme, thereby allow for the reporting of raw results to the client.