|
29 | 29 | </div> |
30 | 30 | </script> |
31 | 31 |
|
| 32 | +<!-- prettier-ignore --> |
32 | 33 | <script type="text/markdown" data-help-name="seqera-launch-monitor"> |
33 | | - Launches a workflow and then periodically checks its status until completion. |
| 34 | +Launches a workflow and then periodically checks its status until completion. |
34 | 35 |
|
35 | | - ### Inputs |
| 36 | +### Inputs |
36 | 37 |
|
37 | | - : launchpadName (string) : The human-readable name of a pipeline in the launchpad to use. |
38 | | - : params (object) : JSON object containing parameters to merge with the launchpad's default parameters. |
39 | | - : pollInterval (number) : How frequently to check workflow status, in seconds (default `5`). |
40 | | - : workspaceId (string) : Override the workspace ID from the config node. |
41 | | - : sourceWorkspaceId (string) : The source workspace ID (if a shared workflow and different to workspaceId). |
42 | | - : body (object) : A full launch request body (alternative to using launchpadName). |
| 38 | +: launchpadName (string) : The human-readable name of a pipeline in the launchpad to use. |
| 39 | +: params (object) : JSON object containing parameters to merge with the launchpad's default parameters. |
| 40 | +: pollInterval (number) : How frequently to check workflow status, in seconds (default `5`). |
| 41 | +: workspaceId (string) : Override the workspace ID from the config node. |
| 42 | +: sourceWorkspaceId (string) : The source workspace ID (if a shared workflow and different to workspaceId). |
| 43 | +: body (object) : A full launch request body (alternative to using launchpadName). |
43 | 44 |
|
44 | | - ### Outputs |
| 45 | +### Outputs |
45 | 46 |
|
46 | | - 1. Status updates (active workflows) |
47 | | - : payload (object) : The workflow details from the API, sent on every status poll while workflow is active. |
48 | | - : workflowId (string) : The ID of the workflow. |
| 47 | +1. Status updates (active workflows) |
| 48 | + : payload (object) : The workflow details from the API, sent on every status poll while workflow is active. |
| 49 | + : workflowId (string) : The ID of the workflow. |
49 | 50 |
|
50 | | - 2. Success |
51 | | - : payload (object) : The workflow details from the API, sent once when workflow completes successfully. |
52 | | - : workflowId (string) : The ID of the workflow. |
| 51 | +2. Success |
| 52 | + : payload (object) : The workflow details from the API, sent once when workflow completes successfully. |
| 53 | + : workflowId (string) : The ID of the workflow. |
53 | 54 |
|
54 | | - 3. Error |
55 | | - : payload (object) : The workflow details from the API, sent once when workflow fails or is cancelled. |
56 | | - : workflowId (string) : The ID of the workflow. |
57 | | - : \_seqera_request (object) : The request details sent to the API (when API error occurs). |
58 | | - : \_seqera_error (object) : Error details (when API error occurs). |
| 55 | +3. Error |
| 56 | + : payload (object) : The workflow details from the API, sent once when workflow fails or is cancelled. |
| 57 | + : workflowId (string) : The ID of the workflow. |
| 58 | + : \_seqera_request (object) : The request details sent to the API (when API error occurs). |
| 59 | + : \_seqera_error (object) : Error details (when API error occurs). |
59 | 60 |
|
60 | | - ### Details |
| 61 | +### Details |
61 | 62 |
|
62 | | - This node combines the functionality of the "Launch" and "Check Workflow" nodes: |
| 63 | +This node combines the functionality of the "Launch" and "Check Workflow" nodes: |
63 | 64 |
|
64 | | - 1. First, it launches a workflow using the provided launchpad name or request body |
65 | | - 2. Then it automatically polls for status updates at the specified interval |
66 | | - 3. It sends status updates to the appropriate output based on workflow state |
| 65 | +1. First, it launches a workflow using the provided launchpad name or request body |
| 66 | +2. Then it automatically polls for status updates at the specified interval |
| 67 | +3. It sends status updates to the appropriate output based on workflow state |
67 | 68 |
|
68 | | - This is ideal for creating complete automation flows that take action when workflows complete. |
| 69 | +This is ideal for creating complete automation flows that take action when workflows complete. |
69 | 70 |
|
70 | | - ### References |
| 71 | +### References |
71 | 72 |
|
72 | | - - [Seqera Platform API docs](https://docs.seqera.io/platform/latest/api) - information about launching and monitoring workflows |
| 73 | +- [Seqera Platform API docs](https://docs.seqera.io/platform/latest/api) - information about launching and monitoring workflows |
73 | 74 | </script> |
74 | 75 |
|
75 | 76 | <script type="text/javascript"> |
|
0 commit comments