Maintaining Batch Syntaxes

Overview

When a laboratory batch job or subcontract batch job is created, the job's Code and Name can be generated from syntax.

Process

Configure a syntax to generate laboratory batch job codes

The job's Code is generated using syntax from the current laboratory or organisation, where the syntax's Syntax Type is Batch Code and the Syntax Code is BATCH_CODE_SYNTAX. Only one syntax should be in use per current lab or organisation.

Configure a syntax to generate laboratory batch job names

The job's Name can be generated using syntax from the current laboratory or organisation, where the syntax's Syntax Type is Batch Name and the Syntax Code is selected by the user. The default laboratory batch name syntax is set from the DEFAULT_BATCH_NAME_SYNTAX application preference. The default subcontract batch name syntax is set from the DEFAULT_SUBCONTRACT_NAME_SYNTAX application preference.

Syntax Generation Process

The syntax comprises a pattern (for example, $yyyy_###), a floor, ceiling and increment value, and the last number used for both the inner and outer patterns. Note that the magnitude of the ceiling must match the available size of pattern, for example, #### could only fit a number up to 9999.

Org-scope and lab-scope variables are available for use in the syntaxes. Variables can include references to properties of objects exposed to the syntax generator and can invoke custom scripts. Refer to Maintaining and Using Syntax Variables.

Multiple syntaxes can be generated in one run. When a syntax is generated, the last number is updated.

Example

  1. A Batch Code Syntax where the laboratory name is followed by fixed characters and an incrementing number:
    ${
    String Lab=Laboratory.name.asEllipseValue
    return Lab}_LB##########

    where:

    • Outer Seq Floor = 1
    • Outer Seq Ceiling = 9999999999
    • Outer Seq Increment = 1
    • Last No = 517