Configuring the Consumables Application

Forms

See also

CONSUMABLES—AddConsumable Form CONSUMABLES—AddSupplierConsumable Form CONSUMABLES—AddUsage Form CONSUMABLES—AddUsageConsumable Form CONSUMABLES—ConsumableEdit Form CONSUMABLES—Consumables Form CONSUMABLES—ConsumableSupplierEdit Form CONSUMABLES—ConsumableTypeEdit Form CONSUMABLES—RecordSupply Form CONSUMABLES—RecordUsage Form CONSUMABLES—SupplierContactEdit Form CONSUMABLES—SupplierEdit Form CONSUMABLES—SupplierHistory Form CONSUMABLES—UsageEdit Form CONSUMABLES—UsageHistory Form

Configuring Access to CCLAS Applications, Tables and Fields Maintaining Consumable Types Maintaining Consumables Recording Consumable Usage by Scheme Managing Consumable Suppliers Recording Consumable Supply

Overview

The Consumables application allows users to configure consumable usage by scheme and consumable suppliers, and to then record consumable use and supply, to then allow for the generation of reports to indicate reordering requirements.

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.

Relevant Program Settings

See the following topics for descriptions of program settings:

• Program Settings - CONSUMABLES
• Program Settings - CMCONSUMETYPE
• Program Settings—GLOBALSETTINGS for CCLASMGR
• Program Settings - CMSUPPLIER

Process

Configuring Access to the Consumables Application

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

To display tips to users upon start up of the Consumables application, enable the ShowTipOfTheDay CONSUMABLES setting, 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 CONSUMABLES setting.

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

To maintain the window size and position between closing and launching the Consumables application, set the Window CONSUMABLES setting.

Configuring Consumable Types Maintenance

Consumable types are maintained under the Type node within the Consumables application. To configure user access to this node, set the AccessLevel CMCONSUMETYPE setting.

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

• To display a query form on the main screen:

  • Create the CMConsumeTypeUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• To filter consumable types based on field criteria:

  • Set the Criterian CMCONSUMETYPE setting to specify the column filtering properties using the CMCONSUMETYPE table, and set the CurrentCriteria CMCONSUMETYPE setting to hold the current criteria.

  • To enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties CONSUMABLES setting.

Set the MainListViewColumnn CMCONSUMETYPE setting to specify which columns from the CMCONSUME_TYPE table are presented in the grid when the Type node is selected.

An organisation often has the requirement to store additional details for a consumable type. To provide a form to manage entry of this data, create the CMConsumeTypeUser.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 consumable types in the Consumables application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn CMCONSUMETYPE setting to each report template.

Configuring Suppliers Maintenance

Suppliers are maintained under the Supplier node within the Consumables application. To configure access to this node, set the AccessLevel CMSUPPLIER setting.

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

• To display a query form on the main screen:

  • Create the CMSupplierUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• To filter suppliers based on field criteria:

  • Set the Criterian CMSUPPLIER setting to specify the column filtering properties using the CMSUPPLIER table, and set the CurrentCriteria CMSUPPLIER setting to hold the current criteria.

  • To enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties CONSUMABLES setting.

Set the MainListViewColumnn CMSUPPLIER setting to specify which columns from the CMSUPPLIER 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 supplier. To provide a form to manage entry of this data, create the CMSupplierUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting. This makes the screen available from the User fields tab when a supplier is updated.

To add report templates to the Report main menu option for suppliers in the Consumables application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn CMSUPPLIER setting to each report template.

Configuring Consumable Supplier Contact Maintenance

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

• To display a query form on the main screen:

  • Create the CMSupplierContactUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all supplier contacts are returned to the list-view panel.

Set the Edit1ListViewColumnn CMSUPPLIER setting to specify which columns from the CMSUPPLIER_CONTACT table are presented in the grid when the supplier's Contacts node is selected for a consumable supplier.

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

Configuring User Forms for Supplier Contact Maintenance

The ConsumableSupplyContactRunn CONSUMABLES setting define the user forms available to apply custom functionality within the Consumables application to maintain supplier contacts.

Configuring Consumables Maintenance

Consumables are maintained under the Consumables node within the Consumables application. To configure access to this node, set the AccessLevel CMCONSUME setting.

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

• To display a query form on the main screen:

  • Create the CMConsumeUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• To filter consumables based on field criteria:

  • Set the Criterian CMCONSUME setting to specify the column filtering properties using the CMCONSUME table, and set the CurrentCriteria CMCONSUME setting to hold the current criteria.

  • To enable the Properties main menu option to allow users to update the criteria, enable the AllowProperties CONSUMABLES setting.

Set the MainListViewColumnn CMCONSUME setting to specify which columns from the CMCONSUME table are presented in the grid when the Consumables node is selected.

The AdjustmentNote CMCONSUME setting contains the note inserted when inventory adjustments are made, however, this is only usable via VBScript.

The WTUnitTextn CMCONSUME setting contains the weight units available for selection in the Unit text drop-down box where the Unit type is set to WT.

The VOLUnitTextn CMCONSUME setting contains the volume units available for selection in the Unit text drop-down box where the Unit type is set to VOL.

The UNITUnitTextn CMCONSUME setting contains the volume units available for selection in the Unit text drop-down box where the Unit type is set to UNIT.

A laboratory often has the requirement to store additional details for a consumable. To provide a form to manage entry of this data, create the CMConsumeUser.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 consumables in the Consumables application, create the reports as Crystal Report templates, place them in the folder defined by the TemplateDirectory GLOBAL setting, and set the ReportLDFn CMCONSUME setting to each report template.

Configuring Consumable Usage by Scheme

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

• To display a query form on the main screen:

  • Create the CMConsumeUsageUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all usages by scheme of a consumable are returned to the list-view panel.

Set the Edit1ListViewColumnn CMCONSUME setting to specify which columns from the CMCONSUME_USAGE table are presented in the grid when the Usage node is selected for a consumable.

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

Configuring a New Consumable Usage by Scheme

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

• To display a query form on the main screen:

  • Create the CMConsumeUsageAddUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all schemes are returned to the list-view panel.

Set the CMConsumeUsageLVWDisplayColumn CMCONSUME setting to specify which column from the SCHEME table is presented in the grid.

Configuring the Recording of Consumable Usage by Scheme

The LastAutoUpdate CMCONSUME setting contains the date inserted when consumer usage is recorded, however, this is only usable via VBScript.

Configuring the Management of Historical Consumable Usage by Scheme

Two methods exist to filter historical consumable usage by scheme records returned to the list-view panel:

• To display a query form on the main screen:

  • Create the CMConsumeAuditUsageAddUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all historical consumable usage by scheme records are returned to the list-view panel.

Set the Edit5ListViewColumnn CMCONSUME setting to specify which columns from the CMCONSUME_AUDITSUPPLIER table are presented in the grid when the Supplier node is selected for a consumable and history of usage by scheme is viewed.

A laboratory often has the requirement to store additional details for an historical consumable usage by scheme. To provide a form to manage entry of this data, create the CMConsumeUsageUser.SCR screen file and place it in the folder defined by the ConfigDirectory GLOBAL setting, and enable the AllowAuditRecordUserForm CMCONSUME setting. This makes the screen available from the User screen main menu option.

To permit the update of historical consumable usage by scheme records, enable the AllowEditAuditRecord CMCONSUME setting. (This also impacts permissions to permit the update of historical consumable supply records.)

To permit the deletion of historical consumable usage by scheme records, enable the AllowDeleteAuditRecord CMCONSUME setting. (This also impacts permissions to permit the deletion of historical consumable supply records.)

Configuring Consumables Suppliers

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

• To display a query form on the main screen:

  • Create the CMConsumeSupplierUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all suppliers of a consumable are returned to the list-view panel.

Set the Edit2ListViewColumnn CMCONSUME setting to specify which columns from the CMCONSUME_SUPPLIER table are presented in the grid when the Supplier node is selected for a consumable.

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

Configuring a New Consumable Supplier

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

• To display a query form on the main screen:

  • Create the CMConsumeSupplierAddUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all suppliers are returned to the list-view panel.

Set the CMConsumeSupplierLVWDisplayColumn CMCONSUME setting to specify which column from the CMSUPPLIER table is presented in the grid.

Configuring the Management of Historical Consumable Supply

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

• To display a query form on the main screen:

  • Create the CMConsumeAuditUsageAddUserQuery.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 CONSUMABLES setting to the name of the event subroutine.

• Otherwise all historical consumable supply records are returned to the list-view panel.

Set the Edit6ListViewColumnn CMCONSUME setting to specify which columns from the CMCONSUME_AUDITUSAGE table are presented in the grid when the Supplier node is selected for a consumable and history of supply by scheme is viewed.

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

To permit the update of historical consumable supply records, enable the AllowEditAuditRecord CMCONSUME setting. (This also impacts permissions to permit the update of historical consumable usage by scheme records.)

To permit the deletion of historical consumable supply records, enable the AllowDeleteAuditRecord CMCONSUME setting. (This also impacts permissions to permit the deletion of historical consumable usage by scheme records.)

Configuring User Forms

The ConsumablesRunn CONSUMABLES setting define the user forms available to apply custom functionality within the Consumables application.