Maintaining Template Jobs

Overview

The following types of jobs are managed by CCLAS:

  • Registered jobs, including production, internal and proposal jobs

  • Template jobs

  • Schedule jobs and draft jobs raised from schedule jobs.

  • Laboratory batch jobs which comprise samples from multiple registered jobs for a suite of tests.

A template job is a template of a commonly occurring request for analysis for one or more samples taken from the field, plant, production line or other place.

  • Template jobs are used to create registered jobs, quickly and accurately, for analysis, reporting and invoicing. There are some circumstances where the job can be quickly copied from a template that is previously set up, particularly if the client is a regular submitter of samples. Routine tests performed on the same type of sample each time can be set up in a template job, and that template job then be used to create the production job.

  • The use of template jobs allows for a more structured workflow where the user is only prompted for the information that is required for that type of job or sample. A template job contains pre-defined information such as job name syntax, client, quote, template samples and tests. A template job may be simple enough to only contain a job name or sample name format, or be more complex and contain extra job and sample details for testing, reporting or invoicing, and define the schemes and analytes for each sample type in the template.

  • A template job also allows the user to re-define the job registration form layout.

A template sample is a template of commonly occurring requests for analysis for a sample taken from the field, plant, production line or other place, exists in context of a template job.

  • Template samples are used to create samples in registered jobs, with the definition of the sample and its analysis being set by the template sample.

  • The use of template samples allows for a more structured workflow where the user is only prompted for the information that is required for that type of sample. A template sample contains pre-defined information such as sample name syntax, client sample name syntax, description, and tests. When a sample is used to create another sample, its entire structure is inherited, including biofields, sample duplication details, sample grade specification groups, sample specifications, sample portions and portion hazards, and the sample’s schemes and analytes.

  • A template sample also allows the user to re-define the job registration form layout.

Tests within template samples can be added to existing samples within registered jobs.

Template jobs can be very client-specific, so in these cases, selecting and assigning the actual client can be meaningful.

Template jobs are scoped by organisation or laboratory. Org-scope template jobs are used to either trial schemes or to assist in registering routine org-scope tests. Lab-scope template jobs are used to assist in registering routine lab-enabled or lab-scope tests or samples.

Process

These steps outline the registration of a template job and its template samples:

  • Create the template job in CCLAS 6, either as an ad-hoc template job, or save another job as a template job.

    Note: A registered job must have a Workflow Status of Registered in order for it to be saved as a template job.

  • Update the job with the header details, biofields, samples and test details. Any sample group remains in unexpanded form.

  • Add samples and tests to the template job. Samples created within a template job are deemed template samples.

The CCREGN—Job application is used to create and maintain template jobs.

Note: Security options can be set up to permit the creation of specific job types within an organisation or laboratory.

Only uses who have the CAN_CREATE_ORG_JOB_TEMPLATE application preference set can create template jobs with org-scope.

Creating a Template Job

Create a template job

Upon job creation, select the Job Type is as Template.

  • Selecting an Organisation Scope creates the job at the organisation level, otherwise it is created at the laboratory level.
  • Note: An org-scope template job can only be used by a laboratory if all job schemes are enabled for use by the laboratory. Refer to Using Organisational Schemes vs Laboratory Schemes.

    • Jobs have two primary identifiers: Code and Job Name.

    • Each job Code and Job Name must be unique within the organisation for org-scope jobs, and unique within the laboratory for lab-scope jobs.

    • Either select a Job Name Syntax Code to generate the job name or enter the Job Name.

    • The JOB_NAME_ONLY_FROM_SYNTAX application preference is used to force syntax use.

    • The DEFAULT_PRODUCTION_JOB_NAME_SYNTAX application preference is used to set a default Job Name Syntax Code for a production job.

    Refer to:

    Use a Registration Mode of New Job by Client, in which case a Client Code must be entered with an optional Project Code and Contact Code. It may be advantageous to create a dummy client for template jobs, for example, INTERNAL_CLIENT or DEFAULT_CLIENT, or the template job could be set up with a specific client. The client may contain project attributes such as Project Code that allow for the grouping of related template jobs.

    Refer to Maintaining Clients.

    Since the template job's details are used as defaults for any destination registered job when a registered job is created from the template job, the choice of adding information at this point depends upon whether it is a fixed value or needs to be edited for each target registered job. For example, Priority may always be 7 days, or Authorisation Group could be the same for all target registered jobs in the laboratory.

    Upon Creating Template Jobs

    Upon template job creation:

    Active Status

    A template job can be made active or inactive for use by toggling Is Active. This action does not affect the active status of template samples in the template job.

    When Maintaining Jobs, template jobs are searchable by whether they are active for use.

    Default Cost Centre

    The following processes are used so that the system can assign a default cost centre based on a template job's client.

    Default Priority

    The following processes are used to set a default value for a job's priority, set the working days of the week for the laboratory, and maintain holidays.

    If the job has a project defined, and priority is defined on the project, then the job's priority is set from there. Otherwise, if priority is defined on the client, then the job's priority is set from there. Otherwise if a default priority is set up in the DEFAULT_PRIORITY application preference, then the job's priority is set from there.

    A template job's priority is inherited by any job created from the template.

    The AUTO_RECEIVE_JOBS application preference configures whether a destination job's Received Date and Received By are set automatically, or left empty for manual update, for a job created from the template job.

    Job and Sample Biofields

    For any target registered job or sample, where any of the following conditions hold for the template job or sample, respectively:

    then these biofields and their values are added to any target registered job or sample, after which, job-scope biofields from the template job are added to the target registered job and sample-scope biofields from the template samples are added to the target registered samples. The relative biofield sequence in the target job or sample remains the same as in the source job or sample, respectively.

    Reporting Requirements

    In general, reporting requirements are already contractually defined at the time that the template job is created. In the case where a template job is applied across many different clients, several report templates may be required, so a choice can be made as to whether the paperwork in the template job is configured before or after a registered job is created from it.

    What to do Next

    Refer to Creating Template Samples within a Template Job