Installing the VGL report

Prerequisites

This installation presumes that SampleManager 2000 (or later) has been installed successfully.

Overview

The installation of L4L Server involves several steps.  These steps should be implemented in the order specified. It is important that each step is carried out in full before another is started. The following should be ensured:

  1. The SampleManager System account is used to carry out the installation, as the necessary logicals will already be active, and the correct file ownership will be maintained.

  2. All users must be logged out of SampleManager and all background processes stopped before the installation is carried out. This ensures old versions of compiled reports and global sections are not in use following installation.

Distributing Files to Directories

You must copy the Stability files to their relevant SampleManager directories. Overwrite any files with the same names. Make sure you have a back-up of any files you replace.

  • Copy all the files with the extension .RPF to the Report directory.

  • Copy the file: l4l_server_messages.txt to the Message directory.

  • Copy all files with the extension .csv to the Data directory.

Adding the L4L Server Messages

To add the L4L Server messages, take the following steps:

  1. Log out of SampleManager

  2. Move to the SMP$MESSAGES directory

  3. Edit the file MESSAGE.TXT and place the following lines at the end:

INCLUDE “l4l_server_messages.txt”

  1. Save the modified MESSAGE.TXT

  2. Run the CREATE_MESSAGE utility.

Remember that the CREATE_MESSAGE command should be used when all SampleManager users and background processes have logged out.

Adding the CSV Table Entries

In this section you will add a master menu. This is imported from csl4l_master_menu.csv. This entry uses a PROCEDURE_NUM value of 1001. Your SampleManager system might already use this. Check with your SampleManager administrator. If it is in use you must change the value before importing. If you change the value in csl4l_master_menu.csv, you must also update the value in csl4l_role_entry.csv and  for CONSTANT L4L_SERVER_PRIVILEGE in l4l_server.rpf

Log into SampleManager as user SYSTEM. Select the Setup/System/Install Options/Table Loader option.

The Load Database Table from File screen is displayed. To add the Role Header and Role Entry Table Entries:

To add Role Header Table Data Entries

  1. Check the Use client file check box, if the data file is stored in a local folder. Clear the checkbox if the file is stored on the server.

  2. At the File to load data from field, use browse and select: csl4l_role_header.csv.

  3. At the Table writing mode field, select Do not overwrite table data.

  4. At the Transaction mode for writing field, select Single transaction. Click on the OK button.

  5. At the Ready to write data to <table_name> message, click on the Yes button to continue. A confirmation message is displayed when the operation is completed.

To add Role Entry Table Data Entries

  1. At the File to load data from field, use browse and select: csl4l_role_entry.csv

  2. At the Table writing mode field, select Do not overwrite table data

  3. At the Transaction mode for writing field, select Single transaction

  4. Click on the OK button

  5. At the Ready to write data to <table_name> message, click on the Yes button to continue. A confirmation message is displayed when the operation is completed.

To add the Config Header Table Entries

  1. Check the Use client file check box if the data file is stored in a local folder. Clear the check box if the file is stored on the server.

  2. At the File to load data from field, use browse and select: csl4l_config_header.csv

  3. At the Table writing mode field, select Do not overwrite table data

  4. At the Transaction mode for writing field, select Single transaction

  5. Click on the OK button

  6. At the Ready to write data to <table_name> message, click on the Yes button to continue. A confirmation message is displayed when the operation is completed.

To add Master Menu Table Entries

  1. Check the Use client file check box if the data file is stored in a local folder. Clear the check box if the file is on the server.

  2. At the File to load data from field, use browse and select: csl4l_master_menu.csv

  3. At the Table writing mode field, select Do not overwrite table data

  4. At the Transaction mode for writing field, select Single transaction

  5. Click on the OK button

  6. At the Ready to write data to <table_name> message, click on the Yes button to continue. A confirmation message is displayed when the operation is completed.

To add L4L Server Report Table Data Entries

  1. Check the Use client file check box if the data file is stored in a local folder. Clear the check box if the file is stored on the server.

  2. At the File to load data from field, use browse and select: csl4l_report.csv

  3. At the Table writing mode field, select Do not overwrite table data

  4. At the Transaction mode for writing field, select Single transaction

  5. Click on the OK button

  6. At the Ready to write data to <table_name> message, click on the Yes button to continue. A confirmation message is displayed when the operation is completed.

VGL Report Format Compilation

This step is used for adding and compiling the VGL report code formats.

Compile Reports

Click File>Run in the SampleManager client and then type dev.

This will open the VGL Report Development console screen.

Type L4L into one of the cells and use the button to browse for a report file.



Select one of the L4L files and open the other in a different cell on the dev console.

And then for each file, click the Compile button and verify that the file compile with no errors. If errors are present, these must be rectified before the VGL report will run.

Starting the L4L Server Background Process

With each SampleManager instance with which L4L Server is to be implemented, a background process is required to establish communication between Links for LIMS and SampleManager.

To install L4L_SERVER as a service on SampleManager (Versions 10 and above)

Previous versions used the background_config.exe utility. Version 10 and later installs each background process as a separate service. The procedure describes how to install L4L_SERVER as a SampleManger Windows service. It has been written using SampleManager version 10 running on Windows XP.

Create the service

Run the program setup.exe  (in the server exe folder, e.g. C:\Program Files\Thermo\SampleManager\Server\VGSM\Exe)

You’ll the Setup form.

Enter the following values: (NOTE Application path should match your installation)

Service Name :

 smpbatchvgsm_L4L_SERVER

Description:

SampleManager Batch Service for VGL program L4L_SERVER : VGSM

Application: 

 C:\Program Files\Thermo\SampleManager\Server\<INSTANCE NAME>\Exe\SampleManagerBatch.exe

Create Registry Key

Create a new registry key in:

HKLM\Software\Wow6432Node\LabSystems\Sample Manager Server

The key name should match the Service Name from above.

Create two string entries:

Instance <INSTANCE NAME>

Report L4L_SERVER

Note

This step might not be necessary

Check the service setting in the registry for the following key:

HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\smpbatchvgsm_L4L_SERVER

Ensure the value of Type is 10 (might be 110). If a change is required, restart the server.

Start should be 3.

Starting The Service

If you start SampleManager using a batch file, add the following line:

net start smpbatchvgsm_l4l_server

Put the entry after other services (you will likely have other entries with names starting smpbatchvgsm)

Installing the L4L Server on Windows NT (SampleManager 9 and lower)

Installing the Server process

  1. Move to the SMP$PROGRAMS directory

  2. Run the BACKGROUND_CONFIG utility.

  3. Select the Batch tab

  4. Click the ADD button. Type the following

            l4l_server

  1. Click on OK to accept the new configuration.

Restart the Background Process

To start the L4L Server Background Process:

  1. Open Windows Control Panel.

  2. Open the Services applet.

  3. For each smpback<instance> service in the list select the entry and click the Restart button.

At this stage L4L Server is executing correctly.

Post Installation Activities

The new Role must be added to all users who will use the L4L Server.

  1. Log in to the SampleManager for Windows Client Interface as user SYSTEM. Select the Setup/System/Operators/Modify option.

  2. Click on the Browse button and select the user to which the new Role will be added

  3. Click on the Roles … button.

  4. Click on the Add button. Type the following

            L4L_USER

  1. Click on the OK button to add the new Role to the Roles list.

  2. Click on the Close button to exit the Role Assignment window.

  3. Click on the OK button to accept the changes.

  4. Repeat the process for each user to which the new Role will be added.

At this stage users can access the L4L Server using Links for LIMS.

To Check if l4l_server is running:

Note that this step no longer works for SampleManager systems >12.2

You can use this procedure to check if l4l_server is running.

  1. from a command box type telnet

  2. type open <server> 1235 (Substitute <server> with your server name or ip address)

Press Enter:

If you see this the service is running. You can check if it responds to commands by typing help.

Configuring SampleManager

The list below gives a brief description of each file and its intended purpose in the L4L Server.  The second file must be set up as a background process for client communications with the LIMS.



L4l_cstp_lib

Library containing return and error codes.

L4l_server

The L4L socket server is the main process by which the L4L client communicates to SampleManager.



The table below lists al of the configuration options that are set as part of the setup of the L4L server.



Configuration Items

Allowed settings

Pupose

L4L_SERVER_ALLOW_POSTING

Yes or No

Allows or prevents the Links for LIMS software from posting results.

L4L_SERVER_COMMAND_CRITERIA

0 through 10.  Default is 4

Security Level for the client command CRITERIA.

L4L_SERVER_COMMAND_GET_SAMPLES

0 through 10.  Default is 0

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_HELP

0 through 10.  Default is 0

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_LOGON

0 through 10.  Default is 4

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_RESULTS

0 through 10.  Default is 4

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_SAMPLES

0 through 10.  Default is 4

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_TABLE

0 through 10.  Default is 4

Security Level for the client command GET_SAMPLES.

L4L_SERVER_COMMAND_TABLENAMES

0 through 10.  Default is 4

Security Level for the client command GET_SAMPLES.

L4L_SERVER_CONNECTIONS

Only tested to 20.

Maximum number of allowable L4L connections.

L4L_SEFVER_CONNECTION_TIMEOUT

Tested up to 600.

Inactivity timeout for connections in seconds.

L4L_SERVER_PORT_NUMBER

Any valid open TCP port.  Default is 1235.

TCP/IP Port Number.