Configuring Processes
Configuring Processes is done bottoms-up, starting with Instruments, then Instrument Types, then Unit Operations, and finally Processes in the Web UI.
Once a Process is defined, individual Run creation can be performed either manually from the Web UI on the corresponding Instrument Run, Unit Operations, or Process page, or programmatically via API calls.
Run tracking and retrieval are done by API calls from Agents and Flows, referencing the corresponding run + scoped to the relevant unit of execution. This maximizes flexibility in how Processes are executed and tracked.
- Instrument Runs track execution of individual Instruments.
- Unit Operation Runs track execution of Unit Operations.
- Process Runs track execution of entire Processes.
InstrumentId, unitOperationId, and processId are each small integers that can be found in the URL when navigating to the corresponding Instrument, Unit Operation, or Process page in the Web UI. Each integer increments by 1 for each new item created.
Instruments
Adding an instrument
New instruments can be added by clicking on the
button to open New Instrument form, shown below.
The New Instrument Form allows you to populate instrument characteristics relevant for tracking, associate an instrument with a Connection, and associate an instrument with an Instrument Type. The only required field is the Name field, which must be unique within the environment.
Adding instruments in bulk
If you have a list of instruments to add, you can upload them using the Bulk Upload Instruments feature.
To use this feature, download the template CSV file in the bulk upload instruments form and fill it out, adding one instrument per row.
Upon upload, the CSV file will be validated by Ganymede. If any errors are found, a descriptive error message is displayed, explaining the issue.
The "Connection Id" column in the instrument bulk upload template file requires Connection ID. This differs from the form for adding instruments individually, which requests a Connection name from a dropdown list. Connection ID can be found on the Connection page.
Instrument Types
Adding an instrument type
New Instrument Types can be added by clicking on the
button to open New Instrument Type form, shown below.
Once created, click on the Instrument Type to open the Instrument Type Edit page, where you can associate Instrument types with Flows, Dashboards, Tables, and MA applications.
After doing so, you can view all associated items from the Instrument Type Details page.
Creating runs for instrument types
To create a unique run for an instrument type, click on the
button on the Instrument Type page or calling the API.
The instrument type ID can be found in the URL https://<subtenant>.ganymede.bio/<environment>/instrument-types/<instrument_type_id>.
Unit Operations
Associating instrument types with unit operations
Instrument Types can be grouped into Unit Operations on the Edit tab.
Creating runs for instrument types
To create a unique run for a unit operation, click on the
button on the corresponding Unit Operation page or calling the API.
The unit operation ID can be found in the URL https://<subtenant>.ganymede.bio/<environment>/unit-operations/<unit_operation_id>.
Processes
Associating unit operations with processes
Unit Operations can be grouped into Processes on the Edit tab.
Creating runs for instrument types
To create a unique run for a process, click on the
button on the corresponding Process page or calling the API.
The process ID can be found in the URL https://<subtenant>.ganymede.bio/<environment>/processes/<process_id>.