You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-47Lines changed: 54 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,16 @@
8
8
9
9
A Node-RED node for interacting with the Seqera Platform API.
10
10
11
+
Gives new Node-RED node types for your automation workflows, which are designed to work together:
12
+
13
+
-[Create Dataset](#create-dataset)
14
+
-[Launch and Monitor a Run](#launch-and-monitor-a-run)
15
+
16
+
Also [Launch](#launch) and [Workflow](#workflow) nodes for more custom workflows where polling workflow status is not required and it's helpful to have full control.
17
+
11
18
# Installation
12
19
13
-
Install via the Node-RED palette manager **or** from the command line inside your Node-RED user directory (`~/.node-red`):
20
+
Install via the Node-RED palette manager **or** from _ the command line inside your Node-RED user directory _ (`~/.node-red`):
14
21
15
22
```bash
16
23
npm install node-red-contrib-seqera
@@ -26,7 +33,28 @@ Create a Seqera Config node to store your API credentials and default settings.
26
33
-**Workspace ID**: Your Seqera workspace ID
27
34
-**Token**: Your Seqera API token
28
35
29
-
## Seqera Launch Monitor Node
36
+
## Create Dataset
37
+
38
+
Creates a new dataset and uploads its file contents in one step.
39
+
40
+
### Inputs
41
+
42
+
-`datasetName`: Name of the dataset to create
43
+
-`fileContents`: CSV/TSV (string or Buffer) to upload. Defaults to `msg.payload`.
44
+
-`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.
45
+
-`description`: Optional description string for the dataset
46
+
-`workspaceId`: Override the workspace ID from the \* config node
47
+
48
+
### Outputs (one output)
49
+
50
+
Fired once when the upload completes successfully.
51
+
52
+
-`msg.payload`: Upload response from the API
53
+
-`msg.datasetId`: The ID of the created dataset
54
+
-`msg._seqera_request`: Details of the dataset creation request (for debugging)
55
+
-`msg._seqera_upload_request`: Details of the file-upload request (for debugging)
56
+
57
+
## Launch and Monitor a Run
30
58
31
59
Launches a workflow and then periodically checks its status until completion.
32
60
@@ -35,7 +63,7 @@ Launches a workflow and then periodically checks its status until completion.
35
63
-`pollInterval`: How frequently to check workflow status (in seconds)
36
64
-`launchpadName`: The Human-readable name of a pipeline in the launchpad to use
37
65
-`params`: JSON object containing parameters to merge with the launchpad's default parameters
38
-
-`workspaceId`: Override the workspace ID from the config node
66
+
-`workspaceId`: Override the workspace ID from the \*config node
39
67
-`sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
40
68
41
69
Alternative input:
@@ -55,57 +83,15 @@ Each message contains:
55
83
-`msg._seqera_request`: The request details sent to the API (when error occurs)
Creates a new dataset and uploads its file contents in one step.
82
-
83
-
### Inputs
84
-
85
-
-`datasetName`: Name of the dataset to create
86
-
-`fileContents`: CSV/TSV (string or Buffer) to upload. Defaults to `msg.payload`.
87
-
-`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.
88
-
-`description`: Optional description string for the dataset
89
-
-`workspaceId`: Override the workspace ID from the config node
90
-
91
-
### Outputs (one output)
92
-
93
-
Fired once when the upload completes successfully.
94
-
95
-
-`msg.payload`: Upload response from the API
96
-
-`msg.datasetId`: The ID of the created dataset
97
-
-`msg._seqera_request`: Details of the dataset creation request (for debugging)
98
-
-`msg._seqera_upload_request`: Details of the file-upload request (for debugging)
99
-
100
-
## Seqera Launch Node
86
+
## Launch
101
87
102
88
Launches a workflow using the Seqera API.
103
89
104
90
### Inputs
105
91
106
92
-`launchpadName`: The Human-readable name of a pipeline in the launchpad to use
107
93
-`params`: JSON object containing parameters to merge with the launchpad's default parameters
108
-
-`workspaceId`: Override the workspace ID from the config node
94
+
-`workspaceId`: Override the workspace ID from the \*config node
109
95
-`sourceWorkspaceId`: The source workspace ID (if a shared workflow and different to workspaceId)
110
96
111
97
Alternative input:
@@ -119,6 +105,27 @@ Alternative input:
119
105
-`msg._seqera_request`: The request details sent to the API (when error occurs)
120
106
-`msg._seqera_error`: Any error details if the request fails
121
107
108
+
## Workflow
109
+
110
+
Queries the status of a workflow.
111
+
112
+
### Inputs
113
+
114
+
-**workflowId**: The ID of the workflow to query
115
+
-**workspaceId**: Override the workspace ID from the \* config node
116
+
117
+
### Outputs (two outputs)
118
+
119
+
1. Only receives messages when the workflow is active (submitted, running, or pending)
120
+
2. Receives messages when the workflow has completed (success or failure) OR when an API error occurs
121
+
122
+
Each message contains:
123
+
124
+
-`msg.payload`: The workflow details from the API
125
+
-`msg.workflowId`: The ID of the workflow
126
+
-`msg._seqera_request`: The request details sent to the API (when error occurs)
0 commit comments