Configuring the Setup Application

Overview

The Setup application allows users to configure entities used in the analytical environment.

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.

Process

Link Shortcuts

The following links are mentioned throughout this content. Refer to these links to read further if they are mentioned in the paragraphs.

 

Configuring Access to the Setup Application

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

To display tips to users upon start up of the Setup application, enable the ShowTipOfTheDay Program Settings - CONFIG, 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 GLOBAL setting, then set the TipofTheDayFile Program Settings - CONFIG to the folder and file name, for example %CCLASRootDirectory%TIPS\SETUP.TIP.

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

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

Configuring Line of Business Maintenance

Lines of business are maintained under the Lines of business node within the Setup application. To configure user access to this node, set the AccessLevel Program Settings - LOB. Note that you also have to be logged in to the GLOBAL laboratory using the CCLASMGR staff account to have visibility to this node.

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

  • To display a query form on the main screen:

    • Create the LOBUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - CONFIG to the name of the event subroutine.

  • To filter lines of business based on field criteria:

    • Set the Criterian Program Settings - LOB to specify the column filtering properties using the LOB table, and set the CurrentCriteria Program Settings - LOB to hold the current criteria.

    • To enable the Propertiesmain menu option to allow users to update the criteria, enable the AllowProperties Program Settings - CONFIG.

Set the MainListViewColumnn Program Settings - LOB to specify which columns from the LOB table are presented in the grid when the Lines of business node is selected.

An organisation often has the requirement to store additional details for a line of business. To provide a form to manage entry of this data, create the LOBUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting. This makes the screen available from the User Screen main menu option.

To add report templates to the Report main menu option for lines of business in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - LOB to each report template.

Configuring Laboratory Maintenance

Laboratories are maintained under the Laboratory codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - LAB. Note that you also have to be logged in to the GLOBAL laboratory using the CCLASMGR staff account to have visibility to this node.

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

  • To display a query form on the main screen:

    • Create the LabUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - CONFIG to the name of the event subroutine.

  • To filter laboratories based on field criteria:

    • Set the Criterian Program Settings - LAB to specify the column filtering properties using the LAB table, and set the CurrentCriteria Program Settings - LAB to hold the current criteria.

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

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

An organisation often has the requirement to store additional details for a laboratory. To provide a form to manage entry of this data, create the LabUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting. This makes the screen available from the User Screen main menu option.

To add report templates to the Report main menu option for laboratories in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - LAB to each report template.

When a laboratory is created, content from specific tables is copied from the GLOBAL laboratory to the new laboratory. These tables are defined by the InsertDataWhenAdding Program Settings - LAB. Therefore, before adding a new laboratories, ensure that these tables contain the correct information.

When a request is made to delete a laboratory, the deletion proceeds only where the list of CCLAS database tables defined by the AllowDeleteWhenEmpty Program Settings - LAB are empty.

If the LabUDF.VBS script file is located in the folder defined by the ConfigDirectory GLOBAL setting, and:

  • The AfterAddLab subroutine exists in the script, after a laboratory is created, then it is invoked to perform custom logic.
  • The AfterDeleteLab subroutine exists in the script, after a laboratory is deleted, then it is invoked to perform custom logic.

When selecting clients associated with the laboratory, the F2 function key opens a client lookup form to display matching client codes from all laboratories, including clients that are disabled. Set the ClientInvoiceLookupColumns Program Settings - LAB to specify which columns from the CLIENT table are presented in the grid.

Configuring Laboratory Group Maintenance

Laboratory groups are maintained under the Laboratory groups node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - GROUPLAB. Note that you also have to be logged in to the GLOBAL laboratory using the CCLASMGR staff account to have visibility to this node.

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

  • To display a query form on the main screen:

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

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - CONFIG to the name of the event subroutine.

  • To filter laboratory groups based on field criteria:

    • Set the Criterian Program Settings - GROUPLAB to specify the column filtering properties using the GROUPLAB table, and set the CurrentCriteria Program Settings - GROUPLAB to hold the current criteria.

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

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

To add report templates to the Report main menu option for laboratory groups in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - GROUPLAB to each report template.

Configuring Laboratory Section Maintenance

Sections are maintained under the Laboratory section node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - BATCH.

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

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

Laboratory section maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom laboratory section maintenance form to the Run main menu option for laboratory sections in the Setup application, set the SectionScreenn Program Settings - BATCH to specify the custom forms.

A laboratory often has the requirement to store additional details for a laboratory section. To provide a form to manage entry of this data, create the SectionUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting. This makes the screen available from the User Screen main menu option.

To add report templates to the Report main menu option for laboratory sections in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - BATCH to each report template.

Configuring Section Group Maintenance

Section groups are maintained under the Section groups node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - GROUPSECTION.

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

  • To display a query form on the main screen:

    • Create the GroupSectionUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - CONFIG to the name of the event subroutine.

  • To filter section groups based on field criteria:

    • Set the Criterian Program Settings - GROUPSECTION to specify the column filtering properties using the SECTIONGROUP table, and set the CurrentCriteria Program Settings - GROUPSECTION to hold the current criteria.

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

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

Section group maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom section group maintenance form to the Run main menu option for section groups in the Setup application, set the GroupSectionScreenn Program Settings - GROUPSECTION to specify the custom forms.

A laboratory often has the requirement to store additional details for a section group. To provide a form to manage entry of this data, create the SectionGroupUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting. This makes the screen available from the User Screen main menu option.

To add report templates to the Report main menu option for section groups in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - GROUPSECTION to each report template.

Configuring Holiday Maintenance

Holiday down-time is defined so that the system can more accurately determine turnaround times from sample submission to reporting more accurately.

Holidays are maintained under the Holidays node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - HOLIDAYS.

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

  • To display a query form on the main screen:

    • Create the HolidayUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter holidays based on field criteria:

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

Holiday maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom holiday maintenance form to the Run main menu option for holidays in the Setup application, set the HolidayScreenn Program Settings - HOLIDAYS to specify the custom forms.

To add report templates to the Report main menu option for holidays in the Setup 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 - HOLIDAYS to each report template.

Configuring Unique Number Sequence Maintenance

Unique number sequences are maintained under the Unique numbers node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - UNIQUENO.

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

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

Unique number sequence maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom unique number sequence maintenance form to the Run main menu option for unique numbers in the Setup application, set the SectionScreenn Program Settings - UNIQUENO to specify the custom forms.

A laboratory often has the requirement to store additional details for a unique number sequence. To provide a form to manage entry of this data, create the UniqueNoUser.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.

To add report templates to the Report main menu option for unique number sequences in the Setup 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 - UNIQUENO to each report template.

Configuring Ident Rule Maintenance

Ident rules are used to decode a string of information read from a barcode or text reader, on a label accompanying a sample sent from a production environment, to determine the job and sample code for registration.

Ident rules are maintained under the Ident rules node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - IDENTRULES.

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

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

Ident rule maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom ident rule maintenance form to the Run main menu option for ident rules in the Setup application, set the IdentRuleScreenn Program Settings - IDENTRULES to specify the custom forms.

To add report templates to the Report main menu option for ident rules in the Setup 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 - IDENTRULES to each report template.

Configuring Unit Maintenance

Units are maintained under the Unit codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - UNIT.

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

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

Unit maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom unit maintenance form to the Run main menu option for units in the Setup application, set the UnitScreenn Program Settings - UNIT to specify the custom forms.

A laboratory often has the requirement to store additional details for a unit. To provide a form to manage entry of this data, create the UnitUser.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.

To add report templates to the Report main menu option for units in the Setup 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 - UNIT to each report template.

Configuring Unit Conversion Maintenance

Set the Edit1ListViewColumnn Program Settings - UNIT to specify which columns from the UNIT_CONVERT table are presented in the grid when the unit's ConversionUnit node is selected.

Configuring Rounding Table Maintenance

Rounding tables are maintained under the Rounding codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - ROUNDING.

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

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

Rounding table maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom rounding table maintenance form to the Run main menu option for rounding tables in the Setup application, set the RoundingScreenn Program Settings - ROUNDING to specify the custom forms.

To add report templates to the Report main menu option for rounding tables in the Setup 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 - ROUNDING to each report template.

Configuring Status Codes Maintenance

Status codes are maintained under the Status codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - STATUSCODES.

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

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

Status code maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom status code maintenance form to the Run main menu option for status codes in the Setup application, set the StatusCodesScreenn Program Settings - STATUSCODES to specify the custom forms.

To add report templates to the Report main menu option for status codes in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - STATUSCODES to each report template.

Configuring Instrument Maintenance

Instruments are maintained under the Instrument codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - INSTRUMENT.

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

  • To display a query form on the main screen:

    • Create the InstrumentUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter instruments based on field criteria:

    • Set the Criterian Program Settings - INSTRUMENT to specify the column filtering properties using the INSTRUMENT table, and set the CurrentCriteria Program Settings - INSTRUMENT to hold the current criteria.

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

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

Instrument maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom instrument maintenance form to the Run main menu option for instruments in the Setup application, set the Instrumentn Program Settings - INSTRUMENT to specify the custom forms.

To add report templates to the Report main menu option for instruments in the Setup 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 - INSTRUMENT to each report template.

Configuring Tax Code Maintenance

Taxes are maintained under the Tax codes node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - TAX.

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

  • To display a query form on the main screen:

    • Create the TaxUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter taxes based on field criteria:

    • Set the Criterian Program Settings - TAX to specify the column filtering properties using the TAX table, and set the CurrentCriteria Program Settings - TAX to hold the current criteria.

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

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

Tax maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom tax maintenance form to the Run main menu option for taxes in the Setup application, set the TaxScreenn Program Settings - TAX to specify the custom forms.

To add report templates to the Report main menu option for taxes in the Setup 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 - TAX to each report template.

Configuring Invoice Conversion Maintenance

Invoice conversions are maintained under the Invoice conversions node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - INVCONVERSION.

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

  • To display a query form on the main screen:

    • Create the InvConversionUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter invoice conversions based on field criteria:

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

Invoice conversion maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom invoice conversion maintenance form to the Run main menu option for invoice conversions in the Setup application, set the InvConversionScreenn Program Settings - INVCONVERSION to specify the custom forms.

To add report templates to the Report main menu option for invoice conversions in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - INVCONVERSION to each report template.

Configuring Price Schedule Maintenance

Price schedules for both book pricing and quote pricing are maintained under the Pricing node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - PRICE.

Price schedules are grouped by invoice conversion and then by BOOK or QUOTE pricing.

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

  • To display a query form on the main screen:

    • Create the PriceUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter price schedules based on field criteria:

Set the MainListViewColumn1 Program Settings - PRICE to specify which column from the INVCONVERSION table is presented in the grid when the Pricing node is selected.

Set the MainListViewColumn2 Program Settings - PRICE to specify the column layout on the grid when a Pricing » Invoice conversion node is selected.

Two methods exist to filter price schedule records returned to the list-view panel for the selected invoice conversion BOOK or QUOTE pricing:

  • To display a query form on the main screen:

    • Create the PriceItemUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • Otherwise all price schedules for the invoice conversion BOOK or QUOTE pricing are returned to the list-view panel.

Set the MainListViewColumn3..n Program Settings - PRICE to specify which columns from the PRICE table are presented in the grid when a Pricing » Invoice conversion » BOOK or QUOTE node is selected.

Price schedule maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom price schedule maintenance form to the Run main menu option for price schedules in the Setup application, set the PriceScreenn Program Settings - PRICE to specify the custom forms.

To add report templates to the Report main menu option for price schedules in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - PRICE to each report template.

Configuring Price Group Maintenance

Price groups are maintained under the Price groups node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - GROUPPRICE.

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

  • To display a query form on the main screen:

    • Create the GroupPriceUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter price groups based on field criteria:

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

Price group maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom price group maintenance form to the Run main menu option for price groups in the Setup application, set the PriceGroupScreenn Program Settings - GROUPPRICE to specify the custom forms.

To add report templates to the Report main menu option for price groups in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - GROUPPRICE to each report template.

Configuring Comments Maintenance

Comments are maintained under the Comments node within the Setup application. To configure access to this node, set the AccessLevel Program Settings - CANNEDCOMMENTS.

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

  • To display a query form on the main screen:

    • Create the UniqueNoUserQuery.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting.

    • Code an event subroutine in the script file, then set the QueryEvent Program Settings - BATCH to the name of the event subroutine.

  • To filter comments based on field criteria:

Set the MainListViewColumnn Program Settings - CANNEDCOMMENTS to specify which columns from the CANNEDCOMMENTS table are presented in the grid when the Comments » GLOBAL | PROFILE | MDE | USER node is selected.

Comment maintenance often requires custom maintenance forms which are tailored to a laboratory's requirements. To add the name of a custom comment maintenance form to the Run main menu option for comments in the Setup application, set the CannedCommentScreenn Program Settings - CANNEDCOMMENTS to specify the custom forms.

To add report templates to the Report main menu option for comments in the Setup application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn Program Settings - CANNEDCOMMENTS to each report template.

Related Topics