Configuring the Laboratory Maintenance Application

Overview

The Laboratory Maintenance application allows for the scheduling and auditing of events and activities in the laboratory. These activities can include instrument calibration, instrument service and other routine checks, with possible links to instruments and assigned laboratory staff.

This process is pertinent to LIMS and laboratory managers who configure maintenance work in the laboratory.

Process

Configuring Access to the Laboratory Maintenance Application

Ensure the LabMaintenance.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 - LABMAINTENANCE. Once a user has sufficient access rights, they can run the Laboratory Maintenance application either from the Lab Maintenance node on the CCLAS menu or directly from the CCLAS Exe folder.

To display tips to users upon start up of the Laboratory Maintenance application, enable the ShowTipOfTheDay Program Settings - LABMAINTENANCE, and enter the tips, with one tip per line, in a text 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 - LABMAINTENANCE to the folder and file name, for example %CCLASRootDirectory%TIPS\LABMAINT.TIP.

To present the list-view panel with grid lines, enable the MainListViewGrid Program Settings - LABMAINTENANCE.

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

Configuring Automatic Execution of a Script upon Application Startup

If the AutoRunScript Program Settings - LABMAINTENANCE is defined, and the file referenced by it exists and contains valid VBScript language and optional screen definitions, it is run when the Laboratory Maintenance application is started.

VB scripts can only have custom forms defined if the VBScriptAllowUserInterface Program Settings - LABMAINTENANCE is enabled.

Configuring Maintenance Types

Types of laboratory maintenance are maintained under the Lab Maintenance node within the Laboratory Maintenance application. To configure access to this node, set the AccessLevel Program Settings - LABMAINT.

Two methods exist to filter records returned to the list-view panel:

• To display a query form on the main screen:

  • Create the LabMaintUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR.

  • Code an event subroutine called cmdQuery_Click in the script file.

• To filter types of laboratory maintenance based on field criteria:

  • Set the CriteriaLABMAINTn Program Settings - LABMAINT to specify the column filtering properties using the LABMAINT table, and set the CurrentCriteriaLABMAINT Program Settings - LABMAINT to hold the current criteria.

  • To enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties Program Settings - LABMAINTENANCE.

Set the MainListViewColumnn Program Settings - LABMAINT to specify which columns from the LABMAINT table are presented in the grid when the LabMaintenance node is selected.

An organisation often has the requirement to store additional details for a type of laboratory maintenance. To provide a form to manage entry of this data, create the LabMaintUser.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR. This makes the screen available from the User Screen main menu option when a type of laboratory maintenance is updated.

The AuditLevel Program Settings - LABMAINT defines the level of auditing changes to types of laboratory maintenance.

To add report templates to the Report main menu option for types of laboratory maintenance in the Laboratory Maintenance application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory Program Settings—GLOBALSETTINGS for CCLASMGR, and set the ReportLDFn Program Settings - LABMAINT to each report template.

Configuring Schedules for a Maintenance Type

Laboratory maintenance schedules are maintained under each maintenance type node.

Two methods exist to filter records returned to the list-view panel:

• To display a query form on the main screen:

  • Create the LabMaintScheduleUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR.

  • Code an event subroutine called cmdQuery_Click in the script file.

• To filter laboratory maintenance schedules for a selected laboratory maintenance type based on field criteria:

  • Set the CriteriaLABMAINT_SCHEDULEn Program Settings - LABMAINT to specify the column filtering properties using the LABMAINT table, and set the CurrentCriteriaLABMAINT_SCHEDULE Program Settings - LABMAINT to hold the current criteria.

  • To enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties Program Settings - LABMAINTENANCE.

Set the Edit1ListViewColumnn Program Settings - LABMAINT to specify which columns from the LABMAINT_SCHEDULE table are presented in the grid when a node for a laboratory maintenance type is selected.

An organisation often has the requirement to store additional details for a laboratory maintenance schedule. To provide a form to manage entry of this data, create the LabMaintScheduleUser.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR. This makes the screen available from the User Screen main menu option when a laboratory maintenance schedule is updated.

Configuring the Recording of Laboratory Maintenance

Laboratory maintenance audit records are written in quick or detailed form. To configure access to laboratory maintenance audit, set the AccessLevel Program Settings - LABMAINTAUDIT.

An organisation often has the requirement to store additional details for a laboratory maintenance schedule audit. To provide a form to manage entry of this data, create the LabMaintAuditUser.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR. This makes the screen available from the User Screen main menu option when a laboratory maintenance schedule audit is updated.

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

• The LabUDF1 subroutine exists in the script, before quick or detailed audit records are created for a maintenance type, then it is invoked. The exposed objects are: clsLabMaint, and clsLabMaintSchedule.
• The LabUDF2 subroutine exists in the script, after quick or detailed audit records are created for a maintenance type, then it is invoked. The exposed objects are: clsLabMaint, and .
• The LabUDF3 subroutine exists in the script, before quick or detailed audit records are created for a schedule, then it is invoked. The exposed objects are: clsLabMaint, and clsLabMaintSchedule.
• The LabUDF4 subroutine exists in the script, after quick or detailed audit records are created for a schedule, then it is invoked. The exposed objects are: clsLabMaint, and clsLabMaintSchedule.

Configuring the Viewing of Historical Laboratory Maintenance Audits

Laboratory maintenance schedule audit records are viewed by maintenance type or schedule.

To display a query form on the main screen:

• Create the LabMaintAuditScheduleUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR.

• Code an event subroutine called cmdQuery_Click in the script file.

Set the MainListViewColumnn Program Settings - LABMAINTAUDIT to specify which columns from the LABMAINT table are presented in the grid when the LabMaintenance node is selected.

To add report templates to the Report main menu option for laboratory maintenance audits in the Laboratory Maintenance application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory Program Settings—GLOBALSETTINGS for CCLASMGR, and set the ReportLDFn Program Settings - LABMAINTAUDIT program setting to each report template.

The initial number of audit records returned for a laboratory maintenance schedule is defined by the InitialRecords Program Settings - LABMAINTENANCE.

Configuring the Location of Notes and Script Files

Notes files for laboratory maintenance schedules and audits are placed in the folder defined by the NotesFileDirectory Program Settings - LABMAINTENANCE.

Script files for laboratory maintenance schedules and audits are placed in the folder defined by the ScriptsDirectory Program Settings - LABMAINTENANCE.

Access a Custom Form from Laboratory Maintenance

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

The LabMaintenanceRunnProgram Settings - LABMAINTENANCE define the custom scripts that are launched from the Runmain menu option, which is only available where the user has access to the nodes for types of laboratory maintenance in the Laboratory Maintenance application.

VB scripts can only have custom forms defined if the VBScriptAllowUserInterface Program Settings - LABMAINTENANCE is enabled.