Configuring the Job Application

Forms See also
PROFILE—AutoIdents Form

PROFILE—CUIDEdit Form

PROFILE—GenerateJobReport Form

PROFILE—JobAddNew Form

PROFILE—JobEdit Form

PROFILE—JobSaveAs Form

PROFILE—ProcedureAdd Form

PROFILE—Profile Form

PROFILE—ProfJobAnalyteList Form

PROFILE—ProfJobSchemeAdd Form

PROFILE—ProcRegSchemeAnalyteEdit Form

PROFILE—ProfJobSchemeEditANA Form

PROFILE—ProfJobSchemeEditMISHDR Form

PROFILE—ProfJobSchemeEditPRP Form

PROFILE—ProfJobSeqMove Form

PROFILE—SchemeEdit Form

PROFILE—SampleGrid Form

PROFILE—Status Form

PROFILE—UpdateSchemeQC Form

Maintaining Jobs

Maintaining Clients

Maintaining Client Groups

Maintaining Cost Centres

Maintaining Holidays

Maintaining Ident Rules

Configuring Access to CCLAS Applications, Tables and Fields

Configuring the Sample Type Application

Overview

Job registration involves the creation and profiling of a job, its samples, and tests.

The job registration environment is configured by the LIMS administrator to limit access, configure query forms, and to customise the process.

This process is pertinent to LIMS and laboratory managers who configure the LIMS, and registration sessions in particular.

Process

Configuring Access to Jobs

Ensure the Profile.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 PROFILEAPP program setting. Once a user has sufficient access rights, they can run the Job application either from the Jobs node on the CCLAS menu or directly from the CCLAS Exe folder.

To display tips to users upon start up of the Jobs application, enable the ShowTipOfTheDay PROFILE 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 PROFILE program setting to the folder and file name, for example %CCLASRootDirectory%TIPS\PROFILE.TIP.

To configure user access to the Clients or Jobs node, depending upon whether the list-view is accessed by client and project, or directly by job. set the AccessLevel PROFILE program setting.

To present the list-view panel with grid lines, enable the MainListViewGrid PROFILE program setting.

To maintain the window size and position between closing and launching the Audit application, set the Window PROFILE program setting.

Configuring Registration Job Search

Jobs are located either from a nominated view (refer to Configuring Database Views for Registration Job Search below), or directly from the database tables. Where they are located from database tables, the jobs are located either via client and project, or directly by job. The list of clients comes from the active list of clients in the PROFCLIENT table which are a subset of clients in the CLIENT table.

Access registration job data by database view, or database tables using the PROFJOB table directly, or using the CLIENT, CLIENT_PROJECT and PROFJOB tables in a drill-down:

Two methods exist to filter records returned to the list-view panel as each node is selected:

  • To display a query form on the main screen:

  • To filter registered jobs based on field criteria:

Define the columns of the grid based on the selected node type:

  • Clients node (only presented where job data is accessed by database tables using client-project-job drill-down)—Set the MainListViewColumnn PROFILE program settings to specify which columns from the CLIENT table are presented in the grid.
  • Projects node (only presented where job data is accessed by database tables using client-project-job drill-down—Set the Sub1ListViewColumnn PROFILE program settings to specify which columns from the CLIENT_PROJECT table are presented in the grid.
  • Jobs node—Set the Sub2ListViewColumnn PROFILE program settings to specify which columns from the database view or PROFJOB table are presented in the grid.

Job registration often requires custom registration forms which are tailored to a laboratory's requirements. To add the name of a custom registration form to the Run main menu option in the Jobs application, set the ScreenFilen PROFILE program settings to specify the custom forms.

Configuring Database Views for Registration Job Search

When searching for registered jobs, a database view allows for a logical presentation of data from multiple tables, with the benefits that the search then only operates on that one database view. Database views are created within the database itself.

Without using a database view, only properties from the PROFJOB table are displayed in the job list-view panel. Database views are used to construct a logical PROFJOB table. All queries on the PROFJOB or PROFJOBUSER tables are done on the view instead. Refer to Using Database Views.

Using a database view allows for the following to be displayed in the job browser:

  • Additional properties of the job (that is, those site-specific properties kept in the PROFJOBUSER table)
  • Additional properties of other objects associated with the job (for example, displaying the client name instead of the client code, displaying the contact name instead of the contact code, or contact and address details)
  • Aggregated statistics from any child table of the PROFJOB table, but grouped on the job number (for example, a dynamic count of the number of samples in a job, or a dynamic count of the samples not validated, or the number of tests in the job that belong to a particular laboratory section).

The application still maintains the links to other CCLAS EL tables, for example, CLIENT_CONTACT, PROFJOB_SCHEME.

Where the Job application displays clients in a tree-view, then the PROFCLIENT_CLIENT and PROFCLIENT_PROJECT tables are joined to the defined view also.

Enable the ListViewByClient PROFILE program settings to display clients in a tree-view in the Job application.

Since the STAFFPROGRAMEDIT table defines the tables and views that are available from which to select the fields, these settings are not specific to the laboratory or staff code used. Therefore, if different views are used for different staff or laboratory codes, then the user must take extra care when selecting the fields for the browser column headings.

Set the browser of the specific CCLAS EL application to point to the view instead of to the PROFJOB table.

To configure the Job application to point to a database view, set the BrowserView PROFILE program settings to the name of the view. The view name from the Example Database View on the PROFJOB Table above is PROFILE_PJVIEW.

Set the columns on display in the browser to come from the view instead of from the PROFJOB table.

To configure the columns on display in the Job application, set the Sub2ListViewColumnnPROFILE program settings to the names of the columns in the view, for example:
Sub2ListViewColumn1=LABCODE,100,Lab
Sub2ListViewColumn2=PRO_JOB,100,Job
Sub2ListViewColumn3=CLI_LABCODE,100,Client Lab
Sub2ListViewColumn4=CLI_CODE,100,Client
Sub2ListViewColumn5=PROJ_CODE,100,Project
Sub2ListViewColumn6=ORDERNO,100,Order Number
Sub2ListViewColumn7=RECEIVED,120,Received,!YYMMDD HH:MM
Sub2ListViewColumn8=REQUIRED,120,Required
Sub2ListViewColumn9=PRODUCTCODE,100,Product
Sub2ListViewColumn10=JOBTYPE,50,Type
Sub2ListViewColumn11=CLI_NAME,150,Client Name
Sub2ListViewColumn12=NOUNKS,50,Number of Samples

The CCLAS EL application then looks for these fields in the view for display in the browser.

Configuring Job Registration
  • The ClientLVWDisplayColumnn PROFILE program settings define the third and subsequent columns of the Client grid. The Project code displays in the first column of the Project grid. The ClientProjectLVWDisplayColumnn PROFILE program settings define the second and subsequent column of the Project grid.

    • To return clients for a job registration to the Client grid based on criteria, create the ProfJobAddNew.SCR script file in the folder defined by the ConfigDirectory GLOBAL setting. Code a QueryEvent subroutine in the script file.

    Where no criteria is to be set up to return clients, the F2 function key can be used to open the client lookup form to display matching client codes from all laboratories, including clients that are disabled. For this functionality, set the ClientReportLookupColumns PROFILE program settings to define the columns of client details on display and the ClientReportLookupField PROFILE program setting to define the field returned from the lookup to the grid.

    Where users are allowed to enter a job number to register a new job, set the ExtraJobNumberCharacters PROFILE program setting to define the acceptable characters for the job number, apart from A-Z and 0-9 which are acceptable by default.

    Where users are not allowed to enter a job number to register a new job, syntaxes are used to return the next job number in a particular JOB Number Sequence. Refer to the Maintaining Unique Number Sequences process. Enable the GetAutoJobNumberImmediate PROFILE program setting to increment the last used number each time ... is clicked, provided that the unique number sequence is configured with # (hash) and not ~ (tilde).

    Job registration often requires custom commands which are tailored to a laboratory's requirements. To add the name of a custom command to the Command main menu option in the Job application, set the ProfileRunn PROFILE program settings to specify the custom commands.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The CanCreateJob subroutine exists within the script file, when a job creation is requested, then it is run to determine whether job creation can proceed, and can cancel the job creation, if required. Example CanCreateJob - Client and Project check
    • The BeforeJobCopy subroutine exists within the script file, when a job copy is requested, then it is run to typically determine whether job copy can proceed, and can cancel the job copy, if required.
    • The AfterJobCopy subroutine exists within the script file, after a job is copied, then it is run to perform custom logic.
    Access a Custom Form from Job Registration

    Often a laboratory requires custom scripts to tailor job registration to their requirements. These scripts may or may not include custom forms.

    The ProfileRunn PROFILE program settings define the custom scripts that are launched from the Command main menu option, which is only available where the user has access to the nodes in the Job application.

    Configuring Job Deletion

    Enable the AllowJobDelete PROFILE program setting to allow a user to delete a job.

    Enable the ZipOnDelete PROFILE program setting so that whenever a job is deleted, the job is automatically archived prior to deletion. This archive removes all data for the job from the CCLAS database.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The CanDeleteJob subroutine exists within the script file, when a job deletion is requested, then it is run to determine whether job deletion can proceed, and can cancel the job deletion, if required.
    • The BeforeJobDelete subroutine exists within the script file, before a job is deleted, then it is run to perform custom logic.
    • The AfterJobDelete subroutine exists within the script file, after a job is deleted, then it is run to perform custom logic.
    Configuring Job Maintenance

    The F2 function key can be used to open the contact lookup form to display matching contact codes for a job's client. For this functionality, set the ClientContactLookupColumns PROFILE program settings to define the columns of contact details on display, and the ClientContactLookupField PROFILE program setting to define the field returned from the lookup to the grid.

    Enable the UpdatePriority GLOBAL setting to allow for the update of a job's priority, and set the PriorityUnit GLOBAL setting to the priority unit.

    Enable the IncludeWeekends GLOBAL setting to add weekends to the calculation for a job's Required date-time from the Received date-time and the job's Priority.

    Set the NotesFileDirectory GLOBAL setting to the folder to contain job notes.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The BeforeJobOpened subroutine exists within the script file, when a job open is requested, then it is run to determine whether job open can proceed, and can cancel the job open, if required.
    • The AfterJobOpened subroutine exists within the script file, after a job is opened, then it is run to perform custom logic. Example BeforeJobOpened - Reset access based on job status
    • The BeforeEditJob subroutine exists within the script file, before a job is opened for update, then it is run to typically determine whether job update can proceed, and can cancel the job update, if required.
    Configuring Job Update

    Enable the ZipOnUpdate PROFILE program setting to automatically archived a job prior to update (which includes the creation of concentration records).

    Enable the AllowJobUnlock PROFILE program setting to allow a user to unlock a job.

    Enable the ModifyTemplateJobs PROFILE program setting to allow a user to update a job that is flagged as a template job.

    Configuring Sample Registration within a Job

    Where users are not allowed to enter a job number to register a new job, syntaxes are used to return the next job number in a particular CUID SYSTEM Number Sequence. Refer to the Maintaining Unique Number Sequences process.

    The attributes of a job's samples include sample idents, external idents, sample descriptions, product codes and an exclusion file to denote which combinations of samples and tests are not required for analysis.

    Enable the UseIdentsFile GLOBAL setting so that when sample identifiers, external sample identifiers, sample descriptions and product codes are entered for a job, then all sample identifiers are written to the Job.IDS Idents file, the Job.EID External Idents file, the Job.DES Descriptions file, the Job.PRD Products file, and the Job.EXC Exclusion file, respectively, in the folder defined by the IdentsDirectory GLOBAL setting. Where the setting is disabled, then an attempt is made to store the sample identifiers in the PROFJOB table, however if the IDSFile, EIDFile, DESFile, PRDFile and EXCFile fields, respectively, in the PROFJOB table do not provide enough space to store all strings, then they are written in file format anyway.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The BeforeIdentsSave subroutine exists within the script file, when idents save is requested, then it is run to typically determine whether the correct sample idents are entered and sample ident addition can proceed, and can cancel the sample ident addition, if required.
    • The AfterIdentsSave subroutine exists within the script file, after sample idents are saved, then it is run to perform custom logic.
    Configuring Scheme and Analyte Profiles for a Job

    Enable the CombinedSchemeAnalyteSelection PROFILE program setting to locate schemes and analytes for the job using combined scheme-analyte selection. Where the setting is disabled, then default scheme-analyte selection is used.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The AfterSchemeOpened subroutine exists within the script file, after a job scheme is opened, then it is run to perform custom logic.
    • The AfterSchemeAnalyteOpened subroutine exists within the script file, after a job scheme analyte is opened, then it is run to perform custom logic.
    • The job tests are maintained using combined scheme-analyte selection and the SchemeUpdated subroutine exists within the script file, then it is run to perform custom logic after a scheme is saved and the Scheme code dialog box is closed.
    • Job tests are maintained using default scheme-analyte selection and the BeforeSchemeUpdate subroutine exists within the script file, before a scheme is updated, then it is run to perform custom logic.
    • Job tests are maintained using default scheme-analyte selection and the BeforeAnalyteUpdate subroutine exists within the script file, before an analyte is updated, then it is run to perform custom logic.
    • Job tests are maintained using default scheme-analyte selection and the AfterSchemeUpdate subroutine exists within the script file, after a scheme is updated, then it is run to perform custom logic.
    • Job tests are maintained using default scheme-analyte selection and the AfterAnalyteUpdate subroutine exists within the script file, after an analyte is updated, then it is run to perform custom logic.
    • The BeforeProcedureAdd subroutine exists within the script file, before a procedure is used to add schemes and analytes to a job, then it is run to perform custom logic.Tthe AfterProcedureAdd subroutine exists within the script file, after a procedure is used to add schemes and analytes to a job, then it is run to perform custom logic.
    • The BeforeSchemeDelete subroutine exists within the script file, before a scheme is deleted, then it is run to perform custom logic.
    • The BeforeAnalyteDelete subroutine exists within the script file, before an analyte is deleted, then it is run to perform custom logic.

    Where the ProSchemeUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting, and the ProSchemeUDF1 subroutine exists within the script file, when a scheme is added to a job, then it is run to typically produce paperwork and labels.

    Where the ProSchemeAnalyteUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting, and the ProSchemeAnalyteUDF1 subroutine exists within the script file, when an analyte is added to a job scheme, then it is run to typically produce additional paperwork and labels, or update the concentration records for the job.

    Configuring the Creation of Concentration Result Records for Sample Schemes and Analytes in a Job

    Enable the DBCreateIncludeQC PROFILE program setting to default the check box, to include QC samples during the creation of concentration records for a job, to checked.

    Enable the DBCreateUpdate PROFILE program setting to default the check box, to update the concentration records where results already exist in the job, to checked.

    Enable the UseCreateConcDBQuick GLOBAL setting to create concentration records (PROFJOB_CUID_SCHEME_ANALYTE records) using a bulk insertion into the CCLAS database.

    Enable the UseCreateConcDBTransaction GLOBAL setting to create concentration records (PROFJOB_CUID_SCHEME_ANALYTE records) in one database transaction.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The CanCreateConcDB subroutine exists within the script file, when a concentration record creation or update is requested, then it is run to determine whether concentration record creation or update can proceed, and can cancel the concentration record creation or update, if required.
    • The CreateConcDB subroutine exists within the script file, when a concentration record creation or update is requested, then it is run to apply custom logic to create or update the concentration records, in lieu of core functionality.

    Where the DBCUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The BeforeCreateConcDB subroutine exists within the script file, when a concentration record creation or update is requested, then it is run before concentration records are created, regardless of the creation of the concentration records is managed by core functionality or custom script.
    • The AfterCreateConcDB subroutine exists within the script file, when a concentration record creation or update is requested, then it is run after concentration records are created, regardless of the creation of the concentration records is managed by core functionality or custom script.
    Configuring Sample Deletion

    Enable the ZipOnSampleDelete PROFILE program setting so that whenever a sample is deleted, the job is automatically archived prior to deletion.

    Configuring Sample Gridding for Specifying Analytical Requirements

    Set the SampleGridDisplayMode PROFILE program setting to default the sample grid display to normal mode with schemes and analytes across the page and samples down the page, or inverted mode with samples down the page and schemes and analytes for the selected sample displayed in a separate grid.

    Set the SampleGridSchCodeDisplayColumn, SampleGridAnalyteCodeDisplayColumn and SampleGridInvertedExtraColumnn PROFILE program settings to define the content of the first, second and subsequent columns, respectively, on display in the sample grid.

    The full list of fields displayed for samples include: CUID, Sample type, Sample ident, External ident, Description and Product Code, however, any of these can be hidden, if required. However, to override this:

    • Set the SampleGridCuidColumnWidth PROFILE program setting to define the default width of the column containing the sample Cuid. If this is set to 0, it is not displayed at all.
    • Set the SampleGridSampleTypeColumnWidth PROFILE program setting to define the default width of the column containing the sample type. If this is set to 0, it is not displayed at all.
    • Set the SampleGridSampleIdentColumnWidth PROFILE program setting to define the default width of the column containing the sample ident. If this is set to 0, it is not displayed at all.
    • Set the SampleGridExternalIdentColumnWidth PROFILE program setting to define the default width of the column containing the external sample ident. If this is set to 0, it is not displayed at all.
    • Set the SampleGridDescriptionColumnWidth PROFILE program setting to define the default width of the column containing the sample description. If this is set to 0, it is not displayed at all.
    • Set the SampleGridProductCodeColumnWidth PROFILE program setting to define the default width of the column containing the product code. If this is set to 0, it is not displayed at all.

    Set the SampleGridInitialSchemes PROFILE program settings to define the schemes initially displayed in the grid when analytical requirements are displayed for multiple job schemes, and enable the SampleGridExpandOnOpen PROFILE program settings to expand all schemes the first time the grid displays in multiple scheme mode.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The SampleGridDataCellClicked subroutine exists within the script file, when a cell in the sample grid is clicked, then it is run to perform custom logic.
    • The BeforeSampleGridSave subroutine exists within the script file, before a sample grid save is requested, then it is run to perform custom logic.
    • The AfterSampleGridSave subroutine exists within the script file, after a sample grid is saved, then it is run to perform custom logic.
    Configuring Job Paperwork Creation

    Set the TemplateDirectory GLOBAL setting to the folder to contain job report template files.

    Enable the OutputfileHasTemplateInName PROFILE program setting to include the report template file name in the report's output file name.

    Set the DefaultViewMode PROFILE program setting to define the default view mode.

    Where the PRepUDF1.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting and:

    • The PRepUDF1 subroutine exists within the script file, before the paperwork report is created in Microsoft ExcelTM, then it is run to perform custom logic.
    • The PRepUDF3 subroutine exists within the script file, before the paperwork report is created in Microsoft WordTM, then it is run to perform custom logic.
    • The BeforeCrystalGenerate subroutine exists within the script file, before the paperwork report is generated in Crystal ReportsTM, then it is run to perform custom logic.
    • The PRepUDF2 subroutine exists within the script file, after the paperwork report is created in Microsoft ExcelTM, then it is run to perform custom logic.
    • The PRepUDF4 subroutine exists within the script file, before the paperwork report is created in Microsoft WordTM, then it is run to perform custom logic.
    • The AfterCrystalGenerate subroutine exists within the script file, after the paperwork report is generated in Crystal ReportsTM, then it is run to perform custom logic.
    Configuring Viewing and Updating Job Status

    A user may only view the status of a job if the AllowJobStatus PROFILE program setting is enabled.

    A user may only update the status of a job if the AllowJobUpdateStatus PROFILE program setting is enabled.

    Configuring Job Status Reports

    The ReportLDFn PROFILE program setting define the available reports.

    Where the ProUDF.VBS VBScript file is located in the folder defined by the ConfigDirectory GLOBAL setting, then the subroutines within it are triggered at particular points during job status viewing to perform custom logic:

    • Where the BeforeStatusView subroutine exists within the script file, before job status is viewed, then it is run to perform custom logic.