Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document stable time and check interval for file watcher agents #407

Closed
wants to merge 3 commits into from
Closed

document stable time and check interval for file watcher agents #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62a6bdf
document stable time and check interval
bensonlee5 Nov 7, 2024
18697cf
clarify stable time
bensonlee5 Nov 7, 2024
9bc4bd1
upd
bensonlee5 Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,4 +371,5 @@ LIMS
reproducibility
runtimes
BulkUploadInstruments
NewInstrument
NewInstrument
statefully
20 changes: 16 additions & 4 deletions docs/app/agents/Agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,6 @@ The _Configuration_ input specifies the action performed by the Agent, with opti

A Connection watches a directory (and associated subdirectories) for new files and updates to existing files. The Flow configured with the Agent is triggered when all expected files are found.

The _input_path_ variable, configured for each Connection [at installation](./AgentInstall#windows-installation), specifies the directory to watch.

#### Input Parameters

- `Flow Name`: The flow to run upon observing new files matching the specified pattern.
Expand All @@ -141,6 +139,16 @@ The _input_path_ variable, configured for each Connection [at installation](./Ag
- `Image`: An image to associate with agent in the Ganymede UI.
- `Auto deploy code and configuration changes to Live Connections`: If checked, updates to Agent code will be reflected on current Connections.

#### Reserved Variables

Reserved variables are used to configure Connection behavior. These can be set [at installation](./AgentInstall#windows-installation) or in the Connections panel post-installation.

- `input_path`: specifies the directory to watch.
- `check_interval`: for Agents v5.1.28+, specifies frequency (in seconds) with which a Connection will poll the local directory for new files. If left blank, the default value is 5 seconds.
- `stable_time`: for Agents v5.1.28+, specifies the time (in seconds) that must have elapsed since the last modified time before being considered stable. If left blank, the default value is 5 seconds.

#### User-Defined Code

The user-defined code will be generated to map those file patterns to parameters. Three functions may require modification during configuration:

- `get_param_mapping`: This function is called whenever a file is added or modified in the watch directory. Modify this function to specify the files you want to look for prior to triggering a flow.
Expand Down Expand Up @@ -373,8 +381,6 @@ Multiple flow cytometers are used to observe cell populations for a related set

A Connection that monitors Flow file outputs, saving them to local directories as specified by the Agent logic.

The _output_path_ variable, configured for each Connection [at installation](./AgentInstall#windows-installation), specifies the directory to store files to.

#### Input Parameters

- `Flow Name`: The flow from which to download output files. This will autopopulate the glob pattern matching field correspondingly.
Expand All @@ -393,6 +399,12 @@ The _output_path_ variable, configured for each Connection [at installation](./A

Additional examples can be found on the [Agent Templates page](./AgentTemplates.mdx#watch-for-flow-outputs-then-save-locally)

#### Reserved Variables

For this configuration, the following reserved variables are available:

- `output_path`: specifies the directory to store files to.

#### Example use case

Instructions for lab execution are generated in Ganymede Cloud and downloaded to the instrument PC for execution.
Expand Down