Overview
This article guides a user through the process of connecting their Hamilton Liquid Handler with the Scispot platform. The integration leverages our Scispot agent, a Java application that runs locally on your machine and manages the flow of information from a specified directory to your Scispot account.
Option 1 - Integrate Scispot LIMS with Hamilton using API
Here is the overview of Hamilton software functionalities
Scispot utilises the Hamilton's advanced RESTful API to connect. There's also a notification service that notifies Scispot with job updates.
There are different end points for this integration between Hamilton & Scispot LIMS:
Scispot LIMS to Hamilton (using Hamilton RESTful API)
POST: Create picklist
POST: Create samples
POST: Create pick job
GET: Request JobDetails
Hamilton to Scispot LIMS (using Scispot APIs - docs.scispot.com)
โ
POST: Send JobState Notification
Here are the most common jobs that can be executed using Hamilton & Scispot APIs
List System Alarms
List Container Inventory
List Container Environment Data
List Container job history
List jobs
Create pick jobs
Create / modify other jobs
Notification of samples in / out of the system
Job state notification
Option 2: Integrate Scispot LIMS with Hamilton using an agent
Step 1: Create a Scispot Agent
Navigate to the GLUE application on the left-hand menu of Scispot
Select Agents in the top bar of GLUE
Select Add Agent from on the left side of the screen
Choose a name for the agent you are creating and select your device's operating system to download the appropriate Java application
Select Add Agent to begin the download of the agent application
Step 2: Add Source
The source is the location that will be providing data to be synchronized with Scispot. In this case, it will be your Hamilton Liquid Handler.
Navigate to GLUE within Scispot
Select Sources in the top bar of GLUE
Select Add Source and under Instruments, select Liquid Handler
From the instrument drop down, select the Hamilton Liquid Handler
Add a name for this instrument in the corresponding field
Select the agent created in Step 1 from the dropdown menu
Select Create Source once this information has been added
Step 3: Add Destination
The destination is the location where the data from the source will be sent.
Navigate to Destinations within Scispot Glue
Select Add Destination and from Data Sources, choose Scispot Labsheets (by default, this means data will save to a file called Agent Files)
Select Scispot Labsheets and select Create Destination
Step 4: Create the Connection
To connect the configured source and destination to each other:
Select Connections in the top bar of GLUE
Select Add Connection in the top right corner of GLUE
Define the source as the created Hamilton Liquid Handler source from Step 2
Define the destination as the created Labsheets destination from Step 3
Select Create Connection
Step 5: Locate Hamilton Liquid Handler Data
Find the directory where your instrument is saving data on your network; If this does not exist, select a directory either on device or on network to save files coming from your Liquid Handler
This file directory is the place the Scispot Agent will monitor for live synchronization of instrument data with Scispot (configured in the following step)
Step 6: Configure the Connection
Within GLUE, under the Sources tab, click on your created Liquid Handler under Instruments
Under Configuration, scroll all the way to the bottom to see the field File Watcher Path
Insert a file path into the field; This will be where the agent will watch for file additions and changes. Insert the file path to the directory that you set as the export path for files from your Liquid Handler in the previous step
Confirm your selection once you have input the appropriate path by selecting Update in the upper right hand corner of the configuration tab
Step 7: Running the Agent
The downloaded Scispot agent file from Part 1, Step 1, is a .zip file containing a Java file that is the Agent application, as well as a batch file containing the command needed to run the agent
Extract these two files from the downloaded .zip file into a directory on the device that will be used for file synchronization - this should be a device that has access to the directory configured as the file path in Part 2, Step 1
Execute the command contained in the batch file in a terminal to begin running the agent
Your agent is now running! You can make sure it is connected by returning to the GLUE application within Scispot and navigating to the Agents tab. There, your named agent will appear with a green connected logo next to its name
Step 8: Data Sync Begins
The File Watcher will monitor the paths specified in the configuration and sync the files dropped into the folders to Scispot.
The synced files will now appear by default in a Labsheet called Agent Files
Once you have setup your data input format and desired data output with the Scispot team, the platform will automatically run calculations and transformations on the data so that it appears in custom Labsheets and Manifests, ready to be used by your team
Step 9: View the Connection and Data
Now, your folder paths are monitored by the Scispot agent, and whenever any file lands there, it will be sent to Scispot.
To view the status of the connection as well as monitor what files have been synced, from GLUE select Connections and select your specific Hamilton Liquid Handler to Labsheets connection - here you can see the transaction logs of file synchronization
Navigate to the Labsheet called Agent Files within Scispot to view the uploaded raw files
After setting up your data input format and desired data output, data will now also populate in custom Labsheets with names corresponding to the file names of each data file as well as corresponding manifests containing the test layouts from your Liquid Handler!