LIMS configuration parameters

LIMS

The tab shows the parameters necessary to configure your LIMS connection.

In this first section, select a LIMS connection, and define a folder path for the commands generated by the LIMS.

Parameter detailsParameter details

Command folder

Enter the folder path where the LIMS generates the commands (the default value of the default LIMS is C:\LIMS_Commands\).

Define this path on the computer where the Agilent Sample Scheduler LIMS agent is installed. If the LIMS Command folder is created on another computer, use the following syntax: \\<computerName>\<Lims folder> where LIMS folder is a shared folder that can be accessed by the LIMS agent user (for details, refer to the In a regulated environment: Create a service user chapter in the Sample Scheduler for OpenLab Installation & Configuration Guide). If you change this folder, ensure the defined folder exists on the corresponding computer and is shared accordingly.

Selected LIMS

Select a LIMS from the drop-down list to view and edit the configuration parameters. The default LIMS connection is always the first item in the list.

General

In this section, you define:

  • a name for the LIMS configuration

  • the analysis life time for ended analyses in the database

Parameter detailsParameter details

Name

Enter a name for the LIMS connection. You may also change the name of the Default LIMS connection.

Make sure that you use a unique name for each LIMS connection.

Analysis life time

Enter the time (in hours) the Ended commands will stay in the database before deletion (the default value of the default LIMS connection is 48 hours).

If you have configured Use Sign-Off, the Ended commands are not deleted after the specified life time, but the commands in Transferred state are deleted. If 0.00 is defined, commands are never deleted from the database. To configure a life time shorter than 1 hour, use the decimal format. You can define up to two digits after the decimal separator.

LIMS XML Commands

In this section, you define:

  • the location where the XML command is moved after successful validation and processing by the Sample Scheduler

  • the life time of the processed commands

  • the date format used for the values of Sample Custom Parameters

Parameter detailsParameter details

Processed command folder

Enter the folder path where the commands are moved to once processed by the Scheduler (that is stored in the Sample Scheduler database). This can be useful if you want to keep the XML files for a period.

The Processed command folder has to be created manually. If the folder does not exist, the XML commands will be deleted after their entry in the database.

Commands that are not successfully processed by the Sample Scheduler (for example, due to an invalid LIMS connection specified) will be deleted.

Processed command life time

Enter the time (in hours) the commands should stay in the Processed command folder before deletion (the default value of the default LIMS is 48). If 0 is defined, commands are never deleted.

Date format

Enter the format in which the LIMS delivers values for Sample Custom Parameters that have the type date (the default value of the default LIMS connection is MM/dd/yyyy hh:mm tt). This can be used in case the LIMS has internally a date representation that is different from the one used by the CDS. The format that is configured here is used to convert the date coming from the LIMS into the format the CDS can use. The formatting options are described under https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx

Sign-Off for LIMS

In this section, you define:

  • a manual submission of the results to the LIMS after review

  • the location where the result reports are copied to and from where the LIMS can collect them

  • the file types to be copied into the LIMS result folder

Parameter detailsParameter details

Use Sign-Off

Select the check box to enable the Sign-Off workflow.

Result folder

Enter the folder path to which the result reports are copied if Submit to LIMS is selected (for example, C:\LIMS_Results). The LIMS collects the result reports from this folder.

You can only edit this field if Use Sign-Off is enabled. Then a folder path must be specified. Make sure that you use a unique folder path for each LIMS connection.

This path must be defined on the computer where the Agilent Sample Scheduler LIMS agent is installed. If the LIMS result folder is defined on another computer, respect the following syntax: \\<computerName>\<LIMS folder> where LIMS folder is a shared folder. Ensure the defined folder exists and the users of the Windows sessions have the appropriate rights to access the folder.

Note that in a regulated environment, the LIMS result folder is protected. For more information, refer to the Installation chapter of the Sample Scheduler for OpenLab Installation & Configuration Guide.

Only result reports stored in the CDS system are copied to the LIMS result folder. Reports copied to the Windows file system are not considered.

File types to copy

The files are copied from the CDS system into the LIMS result folder before they are submitted to the LIMS.

Filetypes are comma separated lists of multiple file extensions.

The default values of the default LIMS connection are csv, and txt. You can use pdf, docx, xlsx, csv, and txt.

You can only edit this field if Use Sign-Off is enabled.

LIMS Database Queries

Collect analysis orders from the LIMS database with SQL queries. Use this option if you prefer to use SQL queries instead of files or the LIMS is not able to generate XML commands.

If SQL query is set up for a LIMS database, SQL command query is preferred for that LIMS connection. XML commands are neglected for that LIMS connection and moved to the trash folder.

In this section, you define:

  • the database provider

  • the LIMS database connection string to connect the Sample Scheduler to the LIMS database

  • a LIMS query to collect pending commands from the LIMS database

  • the frequency in which the Sample Scheduler sends a query to collect commands from the LIMS database

  • notifications to flag commands in the LIMS database as valid and invalid

Parameter detailsParameter details

Query frequency

Define the frequency (in seconds) the Sample Scheduler queries the LIMS database to collect commands (If 0 is defined, the LIMS database query is disabled).

Database provider

Enter the database provider which allows the Sample Scheduler to connect to the LIMS database, and to execute the queries.

When the Database provider is configured from the machine where the Scheduler LIMS agent is running, you can select the provider to use among the list of installed providers.

When the Database provider is configured from another computer, you must enter the provider manually. This provider must exist on the machine where the Scheduler LIMS agent is running.

In the case you are using an Oracle database, you need to install Oracle Client on the Sample Scheduler LIMS agent computer. During the Oracle Client install, ensure to select the Oracle data provider for .NET (ODP.NET) option. This will allow you to select the Oracle.ManagedDataAccess.Client Database provider in the list of installed Database providers. Ensure the Oracle Client version corresponds to the Oracle database server version.

LIMS Database connection string

Enter a string which allows the Sample Scheduler to connect to the LIMS database. It contains all the information required to connect to your LIMS database: provider, database source, login...

Once the Database provider and the Connection string are configured, you can test them both from the computer where the LIMS agent is installed by clicking Test Connection in the Home ribbon tab. If you test the connection from another computer, only the Connection string is tested, not the Database provider.

LIMS query for command creation

Enter a query which is sent to the LIMS database to collect pending commands. The query must recover analysis parameters from the LIMS database and define the rules to be applied to assign the LIMS database parameters to the corresponding Sample Scheduler parameters.

Once the LIMS query is configured, you can test it by clicking Test LIMS Query in the Home ribbon tab.

LIMS notification for valid command

Enter a query which is sent to the LIMS database to notify a valid command has been handled, leading to the creation of an analysis in the Sample Scheduler database.

The goal of this query is to assign a flag to this command in the LIMS database to avoid the LIMS query to collect it again and to inform the LIMS database the command was properly handled.

LIMS notification for invalid command

Enter a query which is sent to the LIMS database to notify an invalid command has been handled. Due to at least one incorrect parameter value the command was considered invalid and did not lead to the creation of an analysis in Sample Scheduler database.

The goal of this query is to assign a flag to this command in the LIMS database, to avoid the LIMS query to collect it again, and to inform the LIMS database something wrong happened.

Write-protected LIMS

If set to false, analysis requests with duplicate identifiers coming from the LIMS SQL query are handled as error. If set to true, analysis requests with duplicate identifiers will no longer be reported in notifications. This may lead to cases where a misconfiguration of the LIMS is not noticed. The default value is set to false.

  • If set to false:

    • The current behavior is unchanged

    • The notification is logged as configured

    • LIMS SQL query result is stored as csv in the trash folder

    • LIMS notification for SQL commands is executed if configured for this LIMS connection

  • If set to true:

    • No notification will be generated

    • No csv file is written

    • LIMS notification for SQL commands is not executed if configured for this LIMS connection

    • The input fields for the notifications commands are inactive

    • Stored commands are not deleted

    • Scheduler goes to the next analysis coming from LIMS

    • No audit trail is added for failed analysis received

For details, refer to the Command collected via SQL query chapter in the Sample Scheduler for OpenLab Installation & Configuration Guide.