Configuring the SamTrack Application
| Forms | See also |
|---|---|
| SAMPLETRACK—Action Form |
|
Overview
The SamTrack application allows laboratory managers and supervisors know where samples are stored, and the conditions of their storage and eventual disposal or return to client.
The SamTrack application manages the location and storage details for samples that are physically moving through the laboratory, and then finally stored after their analytical analysis has been finalised. Note that Sample Track tracks the individual sample, and not the rack of samples, through the laboratory.
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
Configuring Access to Sample Tracking
Ensure the SampleTrack.exe application 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 - SAMPLETRACK. Once a user has sufficient access rights, they can run the SamTrack application either from the Sample Tracking node on the CCLAS menu or directly from the CCLAS Exe folder.
To display tips to users upon start up of the SamTrack application, enable the ShowTipOfTheDay Program Settings - SAMPLETRACK, 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 Program Settings—GLOBALSETTINGS for CCLASMGR, then set the TipofTheDayFile Program Settings - SAMPLETRACK to the folder and file name, for example %CCLASRootDirectory%TIPS\SAMTRACK.TIP.
Give users, or users with specific roles, access to the Location type, Location, Container, Physical type, Transport, Action or Job nodes by setting the AccessLevel Program Settings - STLOCATIONTYPE, Program Settings - STLOCATION, Program Settings - STPHYSICALTYPE, Program Settings - STTRANSPORT, Program Settings - STACTION and Program Settings - STJOB, respectively.
The UseLocationShortname Program Settings - STJOB indicates whether or not the short location name can be entered when specifying tracking details for jobs.
To present the list-view panel with grid lines, enable the MainListViewGrid Program Settings - SAMPLETRACK.
To maintain the window size and position between closing and launching the SamTrack application, set the Window Program Settings - SAMPLETRACK.
Configuring Location Type Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STLocationTypeUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter location types based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STLOCATIONTYPE to specify the column filtering properties using the STLOCATIONTYPE table, and set the CurrentCriteria Program Settings - STLOCATIONTYPE to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Location typenode—Set the MainListViewColumnnProgram Settings - STLOCATIONTYPE to specify which columns from the STLOCATIONTYPE table are presented in the grid.
Define reports for location types:
-
Set the ReportLDFn Program Settings - STLOCATIONTYPE to the name of each required report.
Configuring Location Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STLocationUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter locations based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STLOCATION to specify the column filtering properties using the STLOCATION table, and set the CurrentCriteria Program Settings - STLOCATION to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Locationnode—Set the MainListViewColumnnProgram Settings - STLOCATION to specify which columns from the STLOCATION table are presented in the grid.
Define reports for locations:
-
Set the ReportLDFn Program Settings - STLOCATION to the name of each required report.
Configuring Container Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STContainerUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter containers based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STCONTAINER to specify the column filtering properties using the STCONTAINER table, and set the CurrentCriteria Program Settings - STCONTAINER to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Container node—Set the MainListViewColumnn Program Settings - STCONTAINER to specify which columns from the STCONTAINER table are presented in the grid.
Define reports for containers:
-
Set the ReportLDFn Program Settings - STCONTAINER to the name of each required report.
Configuring Physical Type Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STPhysicalTypeUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter physical types based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STPHYSICALTYPE to specify the column filtering properties using the STPHYSICALTYPE table, and set the CurrentCriteria Program Settings - STPHYSICALTYPE to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Physical typenode—Set the MainListViewColumnnProgram Settings - STPHYSICALTYPE to specify which columns from the STPHYSICALTYPE table are presented in the grid.
Define reports for physical types:
-
Set the ReportLDFn Program Settings - STPHYSICALTYPE to the name of each required report.
Configuring Transport Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STTransportUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter transport types based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STTRANSPORT to specify the column filtering properties using the STTRANSPORT table, and set the CurrentCriteria Program Settings - STTRANSPORT to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Transportnode—Set the MainListViewColumnn Program Settings - STTRANSPORT to specify which columns from the STTRANSPORT table are presented in the grid.
Define reports for transport types:
-
Set the ReportLDFn Program Settings - STTRANSPORT to the name of each required report.
Configuring Action Maintenance
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists for the node.
- Create the STActionUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
- To filter sample handling actions based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist for the node.
- Set the Criterian Program Settings - STACTION to specify the column filtering properties using the STTRANSPORT table, and set the CurrentCriteria Program Settings - STACTION to hold the current criteria.
- Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type:
- Actionnode—Set the MainListViewColumnnProgram Settings - STACTION to specify which columns from the STACTION table are presented in the grid.
Define reports for sample handling actions:
-
Set the ReportLDFn Program Settings - STACTION to the name of each required report.
Configuring Sample Tracking Jobs Search
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 sample tracking job data by database tables using the PROFJOB table directly, or using the CLIENT, CLIENT_PROJECT and PROFJOB tables in a drill-down:
- Database table(s):
- Using the PROFJOB table directly—Disable the ListViewByClient Program Settings - STJOB.
- Using the CLIENT, CLIENT_PROJECT and PROFJOB tables in a drill-down—Enable the ListViewByClient Program Settings - STJOB.
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists.
- Create the STJobUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine.
- To filter tracked jobs based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist.
Set the CriteriaPROFCLIENTn Program Settings - STJOB to specify the column filtering properties using the CLIENT table, and set the CurrentCriteriaPROFCLIENT Program Settings - STJOB to hold the current criteria.
Set the CriteriaPROFCLIENTPROJECTn Program Settings - STJOB to specify the column filtering properties using the CLIENT_PROJECT table, and set the CurrentCriteriaPROFCLIENTPROJECT Program Settings - STJOB to hold the current criteria.
Set the CriteriaPROFJOBn Program Settings - STJOB to specify the column filtering properties using the database view or PROFJOB table, and set the CurrentCriteriaPROFJOB Program Settings - STJOB to default the current criteria.
Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
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 Program Settings - STJOB 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 Program Settings - STJOB to specify which columns from the CLIENT_PROJECT table are presented in the grid.
- Jobs node—Set the Sub2ListViewColumnn Program Settings - STJOB to specify which columns from the database view or STJOB table are presented in the grid.
Configuring the Adding of Jobs to Sample Tracking
Jobs available for adding to sample tracking 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, that are not yet added to sample tracking.
Access jobs data for adding to sample tracking by database tables using the PROFJOB table directly, or using the CLIENT, CLIENT_PROJECT and PROFJOB tables in a drill-down:
- Database table(s):
- Using the PROFJOB table directly—Disable the ListViewByClient Program Settings - STJOB.
- Using the CLIENT, CLIENT_PROJECT and PROFJOB tables in a drill-down—Enable the ListViewByClient Program Settings - STJOB.
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:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists.
- Create the STJobAddUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine.
- To filter tracked jobs based on field criteria:
Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will load the browser where a query file does not exist.
Set the CriteriaPROFCLIENTnProgram Settings - STJOB to specify the column filtering properties using the CLIENT table, and set the CurrentCriteriaPROFCLIENT Program Settings - STJOB to hold the current criteria.
Set the CriteriaPROFCLIENTPROJECTnProgram Settings - STJOB to specify the column filtering properties using the CLIENT_PROJECT table, and set the CurrentCriteriaPROFCLIENTPROJECT Program Settings - STJOB to hold the current criteria.
Set the CriteriaPROFJOBnProgram Settings - STJOB to specify the column filtering properties using the database view or PROFJOB table, and set the CurrentCriteriaPROFJOB Program Settings - STJOB to default the current criteria.
Note: The Properties main menu option is enabled where no query script file exists for the node, however, the AllowProperties Program Settings - SAMPLETRACK mus be enabled to allow the user access to filter data using column criteria. Refer to Using the Screen Interface.
Define the columns of the grid based on the selected node type to add jobs to sample tracking:
- Clients node (only presented where job data is accessed by database tables using client-project-job drill-down)—Set the Edit1ListViewColumnnProgram Settings - STJOB 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 Edit2ListViewColumnnProgram Settings - STJOB to specify which columns from the CLIENT_PROJECT table are presented in the grid.
- Jobs node—Set the Edit3ListViewColumnnProgram Settings - STJOB to specify which columns from the database view or PROFJOB table are presented in the grid.
Configuring Sample Tracking Reports
Define reports for tracked jobs:
-
Set the ReportLDFn Program Settings - STJOB to the name of each required report.
Customising Sample Tracking
Sample tracking often requires custom commands which are tailored to a laboratory's requirements. To add the name of a custom command to the Run main menu option in the Sample Tracking application, set the SampleTrackRunnProgram Settings - SAMPLETRACK to specify the custom commands.
Configuring a Job's Sample Tracking Maintenance
To display a query form to filter physical type and sample records returned to the list-view panel as the Job or a Physical type node is selected:
- Note: This application is coded to not use the LoadBrowser Program Settings - SAMPLETRACK, and internally will not load the browser where a query file exists.
- Create the STJobSampleUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine.
Define the columns of the grid based on the selected node type to display physical type and sample portion details of a tracked job:
- Job node—Set the Edit4ListViewColumnnProgram Settings - STLOCATIONTYPE to specify which columns from the STPHYSICALTYPE table are presented in the grid.
- Physical type node—Set the Edit5ListViewColumnnProgram Settings - STLOCATIONTYPE to specify which columns from the STJOB_SAMPLE table are presented in the grid.
Define reports for a job's sample tracking details:
-
Set the JobReportLDFnProgram Settings - STJOB to the name of each required report.
Configuring the Adding of Samples to Sample Tracking
Set the AddJobSampleSampleType Program Settings - STJOB to the comma-separated list of sample types that are selected by default, for example, UNK,DUP.
To display a query form to filter samples returned to the grid:
- Create the STJobNewSampleUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine.
Enable the AllowChangeDateStored and AllowChangeStaffCode Program Settings - STJOB to allow the user update the Date located and Staff code fields, respectively, otherwise they cannot change them from the default date-time and current staff member.
Define the columns of the sample grid:
- Set the Edit6ListViewColumnnProgram Settings - STLOCATIONTYPE to specify which columns from the PROFJOBCUID table are presented in the grid.
Customising the Update of a Sample Portion's Sample Tracking Details
To allow for the presentation of a user screen for the entry of custom details for a tracked sample portion, create the STJobSampleUser.SCR script file in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR.
Customising the Update of a Job's Containerisation Details
To allow for the presentation of a user screen for the entry of custom details for a containerised job, create the STJobUser.SCR script file in the folder defined by the ConfigDirectory Program Settings—GLOBALSETTINGS for CCLASMGR.
Configuring the Viewing of Sample Tracking History for a Job
Define the columns of the job sample tracking history grid:
- Set the Edit7ListViewColumnnProgram Settings - STJOB to specify which columns from the STJOBAUDIT table are presented in the grid.
Define reports for sample tracking history of a job:
-
Set the JobHistoryReportLDFnProgram Settings - STJOB to the name of each required report.
Customising the Viewing of Sample Tracking History for a Job
To display a query form on the main screen:
-
Create the STJobAuditUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
Configuring the Viewing of Sample Tracking History for a Sample Portion
Define the columns of the sample portion sample tracking history grid:
- Set the Edit8ListViewColumnnProgram Settings - STJOB to specify which columns from the STJOBAUDIT_SAMPLE table are presented in the grid.
Define reports for sample tracking history of a sample portion:
-
Set the JobSampleHistoryReportLDFnProgram Settings - STJOB to the name of each required report.
Customising the Viewing of Sample Tracking History for a Sample Portion
To display a query form on the main screen:
-
Create the STJobAuditSampleUserQuery.SCR script 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 - SAMPLETRACK to the name of the event subroutine. Where this program setting is not defined, then cmdQuery_Click is the default event subroutine.
Configuring the Viewing of Sample Tracking Field Change History for a Sample
Define the columns of the job sample tracking history grid:
- Set the Edit9ListViewColumnnProgram Settings - STJOB to specify which columns from the STJOBAUDIT_SAMPLE_FIELD table are presented in the grid.
Define reports for sample tracking history of a sample portion field change:
-
Set the JobSampleFieldHistoryReportLDFnProgram Settings - STJOB to the name of each required report.
Configuring the Auditing of Sample Tracking Changes to a Job
Set the AuditMode Program Settings - STJOB to configure the level of auditing of changes to sample tracking details for a job.
- 0 - no auditing
- 1 - audit of deletions and additions
- 2 - audit of deletions, additions and modifications.
Related Topics
