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 GLOBAL setting. Give users, or users with specific roles, access to the application by setting the AccessLevel BATCH program setting. 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 BATCH program setting, 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 GLOBAL setting, then set the TipofTheDayFile BATCH program setting 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 BATCH program setting.

Configuring Batch Sample Search

Set the MainListViewColumnn BATCH program settings to specify which columns from the SAMPLE table are presented in the grid.

To filter samples for batching based on field criteria:

  • Set the Criterian BATCH program setting to specify the column filtering properties using the database view or PROFJOB table, and set the CurrentCriteria BATCH program setting to default the current criteria.
  • o enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties BATCH program setting.

Set the CriteriaReadyWaiting BATCH program setting to specify the criteria based on a ready or waiting laboratory batching status.

When searching by scheme:

  • Set the SchemeSampleTypes BATCH program setting to nominate the default sample types. If this setting is not defined, then the SampleTypes BATCH program setting is used.

  • Set the SchemeDateField BATCH program setting to nominate the date field used in the criteria. If this setting is not defined, then the DateField BATCH program setting is used.

  • Enable the DateSelect BATCH program setting to default the date criteria to Between, thereby forcing the entry of a date range to enhance system performance of the sample search.

  • Set the SchemeAnalyteStatus and SchemeLabbatchStatus BATCH program settings to contain the default setting for whether to await checks.

  • Set the SchemeSelectAnalytes BATCH program setting to nominate the default selection when specifying whether any or all analytes must be registered for a scheme for selection of a sample.

  • Set the SchemeMaxSampleNumbers and SchemeMinSampleNumbers BATCH program settings to contain the default sample counts.

  • Set the Edit1ListViewColumnn BATCH program setting to the columns of scheme details displayed in the CriteriaScheme form.

  • Set the SummaryExpandAll BATCH program settings to control the default state of expansion of the summary grid.

  • Set the SummaryBandBackgroundColour BATCH program settings to the alternating rows' background colour for scheme summary grid.

When searching by subcontract:

  • Set the SampleTypes BATCH program setting to nominate the default sample types.

  • Set the InstrumentDateField BATCH program setting to nominate the date field used in the criteria. If this setting is not defined, then the DateField BATCH program setting is used.

  • Enable the DateSelect BATCH program setting to default the date criteria to Between, thereby forcing the entry of a date range to enhance system performance of the sample search.

  • Set the InstrumentAnalyteStatus BATCH program setting to contain the default setting for whether to await checks.

When searching by instrument:

  • Set the InstrumentSampleTypes BATCH program setting to nominate the default sample types. If this setting is not defined, then the SampleTypes BATCH program setting is used.

  • Set the InstrumentDateField BATCH program setting to nominate the date field used in the criteria. If this setting is not defined, then the DateField BATCH program setting is used.

  • Enable the DateSelect BATCH program setting to default the date criteria to Between, thereby forcing the entry of a date range to enhance system performance of the sample search.

  • Set the InstrumentAnalyteStatus and InstrumentLabbatchStatus BATCH program settings to contain the default setting for whether to await checks.

  • Set the InstrumentMaxSampleNumbers and InstrumentMinSampleNumbers BATCH program settings to contain the default sample counts.

Set the GridAlternateColour1 and GridAlternateColour2 BATCH program settings to the rows' background colour of alternating jobs returned from a search.

Enable the LockOpenSamples BATCH program setting 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 GLOBAL setting 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 GLOBAL setting 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 GLOBAL setting defines the default job template.

Configuring Subcontract Batch Creation

The SubContractAutoJobNo GLOBAL setting defines the default job template.

The SubContractCuidSequence BATCH program setting 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 BATCH program settings:

  • 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 BATCH program setting 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 BATCH program setting 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 GLOBAL setting, 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 BATCH program setting to the required report templates.

Configuring Paperwork Generation

If the PRepUDF.VBS script file is located in the folder defined by the ConfigDirectory GLOBAL setting, 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 BATCH program settings 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 GLOBAL setting is enabled, to allow for the reporting of raw results to the client.

Configuring Data Entry into Laboratory Batch Jobs

Enable the LBWeightVolumeTransfer GLOBAL setting 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.