Maintain Connection Details for an Instrument

Use this activity to maintain instrument connections for an instrument.

An instrument connection is the means to connect to an instrument, parse the output to extract analytical results, and pass the results onto CCLAS.

Instrument Connection Scope

Instrument connections are scoped by their parent instrument. An instrument can contain multiple instrument connections to manage the variety of transmission formats possible by the instrument.

Properties of an Instrument Connection

An instrument connection can have:

  • A name and description
  • A flag to indicate whether it can start automatically
  • A script and optional parameters 1—5 to be passed into the script—The script contains the logic to control the data collection, that is, connect to the instrument, parse the data sent from the instrument, and pass the results to either the workbook session or directly into CCLAS.
  • Notes.

Use of Instrument Connections

Instrument connections are used to upload results determined by instruments into CCLAS. This involves executing an instrument parsing script, either by configuring:

  • A workbook menu option to execute the script, then launching a workbook session using the CCWKOP—Open Workbook application and selecting the relevant menu option, where upon the results contained within instrument transmissions end up as results in the workbook.
  • An instrument schedule using the CCINSH—Instrument Scheduler application so that at the appointed time the script is executed on the system batch processor, where upon the results in the instrument file end up directly deposited into CCLAS.

To do this, instrument connection scripts reference class methods that are exposed in the CCLAS application interface.

Conflicting Data Capture Sessions

When a user activates an instrument connection for data capture, the capture session id is placed on the instrument connection so that the user's workbook session can be updated with captured results. This means that if another user then activates the same instrument connection, that the first user loses out and cannot capture results any more, as the instrument connection is now controlled by the second user. If the first user had not consumed a captured result on the network folder prior to the second user taking control, it is up to the instrument capture script to detect and control this so that a result cannot be lost.

Conflicts can occur between multiple users of instrument data capture sessions if different instrument connections are configured to write to the same network folder. It is suggested that different instrument connections be configured to write to different network folders.

Activity Steps

  1. Access the CCINST—Instrument application from the main menu or quick launch to display the CCINST—Search Instrument screen.
  2. Enter the relevant search criteria and click Search.

    Instruments that match the criteria display in the grid.

  3. Open the required instrument to display the CCINST—Instrument Detail screen.
  4. Select the Connection tab.

To add an instrument connection:

  1. Click Create Instrument Connection.

    The CCINSTCONN—Instrument Connection Detail screen displays.

  2. Enter the Connection Code, Name and Description.
  3. Check Is Active.
  4. Check whether data collection is to Auto-Start when the instrument is selected in the CCWKOP—Open Workbook application.
  5. Enter up to five Parameters that are to be passed into the instrument script.
  6. Select the instrument connection Script.
  7. Enter Notes on the instrument connection.
  8. Click Submit and return.

    The new connection is added to the instrument and displays in the grid.

To remove an instrument connection:

  1. Click X at the beginning of the row to be removed.
  2. Click Submit.

    The connection is removed from the instrument.

To update an instrument connection:

  1. Open the instrument connection.

    The CCINSTCONN—Instrument Connection Detail screen displays.

  2. Update the fields, as required.
  3. Click Submit.
  4. The instrument connection is updated.