@seqera/node-red-seqera 0.2.0

Node-RED nodes for interacting with the Seqera Platform API

npm install @seqera/node-red-seqera

A Node-RED node for interacting with the Seqera Platform API.

Gives new Node-RED node types for your automation workflows, which are designed to work together:

• Create Dataset
• Launch and Monitor a Run
• List Files from Data Explorer
• Poll Data Link Files

Also Launch and Workflow nodes for more custom workflows where polling workflow status is not required and it's helpful to have full control.

Typical Use cases

• Integration with events coming from and going to third-party services (AWS, Slack, and >5000 others supported by Node-RED)
• Link triggers and actions to build automation logic using a graphical builder
• Chain workflows, launching downstream automatically
• (Bonus) Use with Home Assistant to make your office lights go into disco mode when a pipeline completes 🪩 🕺🏻 🎉

Installation

Within Node-RED

File > Manage Palette, then the Install tab. Search for @seqera/node-red-seqera (or just "seqera") and you should find this package. Click Install and the nodes will be available.

Via the command line

Install via the Node-RED palette manager or from the command line inside your Node-RED user directory (~/.node-red):

npm install @seqera/node-red-seqera

Seqera Studios

This repository comes with a custom Docker image containing botth Node-RED and the Seqera nodes, designed to run within Seqera Studios.

Simply create a new Studio with the Template set to Prebuilt container image and enter ghcr.io/ewels/node-red-seqera:latest. Make sure that the studio is set to Always keep the session running.

Your new Studio should launch with a complete Node-RED instance that's ready for you to customise and use with Seqera automation.

[!NOTE] This image is designed to be a reference only to get you started only. For production usage, please customise the studios-template/Dockerfile and studios-template/settings.js files to meet your security and usage requirements.

Example Flows

Once installed, example flows are available in the Node-RED import menu under Import > Examples > @seqera/node-red-seqera.

Usage

Seqera Config Node

Create a Seqera Config node to store your API credentials and default settings.

This is used by all other Seqera Node-RED nodes, so that you only have to enter your Seqera credentials once.

• Base URL: The base URL for the Seqera API (default: https://api.cloud.seqera.io)
• Workspace ID: Your Seqera workspace ID
• Token: Your Seqera API token. Create a Seqera access token via Your Tokens in the user menu.

Create Dataset

Creates a new Dataset and uploads its file contents in one step.

Inputs

• datasetName: Name of the dataset to create
• fileContents: CSV/TSV (string or Buffer) to upload. Defaults to msg.payload.
• fileType: csv or tsv – Select the MIME type for the upload (defaults to csv). This is required by Seqera Platform to validate the file contents.
• description: Optional description string for the dataset
• workspaceId: Override the workspace ID from the * config node

Outputs (one output)

Fired once when the upload completes successfully.

• msg.payload: Upload response from the API
• msg.datasetId: The ID of the created dataset
• msg._seqera_request: Details of the dataset creation request (for debugging)
• msg._seqera_upload_request: Details of the file-upload request (for debugging)

Launch and Monitor a Run

Launches a workflow and then periodically checks its status until completion.

Inputs

• launchpadName: The Human-readable name of a pipeline in the launchpad to use
• params: JSON object containing parameters to merge with the launchpad's default parameters
• pollInterval: How frequently to check workflow status (in seconds)
• workspaceId: Override the workspace ID from the * config node
• sourceWorkspaceId: The source workspace ID (if a shared workflow and different to workspaceId)

Alternative input:

• msg.body: A full launch request body (alternative to using launchpadName)

Outputs (three outputs)

1. Sent on every status poll (only when workflow is active)
2. Sent once when the workflow completes successfully
3. Sent once when the workflow fails, is cancelled, or any non-success terminal state

Each message contains:

• msg.payload: The workflow details from the API
• msg.workflowId: The ID of the workflow
• msg._seqera_request: The request details sent to the API (when error occurs)
• msg._seqera_error: Error details (when error occurs)

List Data Link Files

Lists files and folders from a Seqera Platform Data Explorer link.

Inputs

• dataLinkName (string): The Data Explorer link to query.
• basePath (string): Path within the data link to start browsing. Leave blank for the root.
• prefix (string): Optional prefix filter (applies to files and folders).
• pattern (string): Optional regular-expression pattern filter (applies to files only).
• returnType (string): Choose what to return: files, folders, or all (everything).
• maxResults (number): Maximum number of results to return (default: 100).
• depth (number): How many directory levels to recurse into (0 = current dir only).
• workspaceId (string): Override the workspace ID from the Config node.

Outputs (one output)

• msg.payload (array): Array of objects returned by the API after filtering.
• msg.files (array): Convenience array containing only the file names.

Poll Data Link Files

Like List Data Link Files, but runs automatically on a timer so that you can trigger downstream automation whenever new data appears.

This node has no inputs – it starts polling as soon as the Node-RED flow is deployed.

Inputs (typed-input fields)

Same as List Data Link Files, plus:

• pollFrequency (number): How often to poll, expressed in minutes (default: 15).

Outputs (two outputs)

1. All results – Fired every poll with the full list returned from the API.
2. New results – Fired only when at least one object is detected that wasn't present in the previous poll (will not send anything if there are no new objects).

Each message contains the same properties as List Data Link Files (payload, files).

Launch

Launches a workflow using the Seqera API.

Inputs

• launchpadName: The Human-readable name of a pipeline in the launchpad to use
• params: JSON object containing parameters to merge with the launchpad's default parameters
• workspaceId: Override the workspace ID from the * config node
• sourceWorkspaceId: The source workspace ID (if a shared workflow and different to workspaceId)

Alternative input:

• msg.body: A full launch request body (alternative to using launchpadName)

Outputs (one output)

• msg.payload: The launch response from the API
• msg.workflowId: The ID of the launched workflow
• msg._seqera_request: The request details sent to the API (when error occurs)
• msg._seqera_error: Any error details if the request fails

Workflow

Queries the status of a workflow.

Inputs

• workflowId: The ID of the workflow to query
• workspaceId: Override the workspace ID from the * config node

Outputs (two outputs)

1. Only receives messages when the workflow is active (submitted, running, or pending)
2. Receives messages when the workflow has completed (success or failure) OR when an API error occurs

Each message contains:

• msg.payload: The workflow details from the API
• msg.workflowId: The ID of the workflow
• msg._seqera_request: The request details sent to the API (when error occurs)
• msg._seqera_error: Error details (when error occurs)

License

Apache-2.0 license