Launch a Wrkflow
Launch a Wrkflow.
Application
- Wrkflow Tools
Inputs (what you have)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Wrk API key | Your Wrk API key from https://account.wrk.com/api-key | Text (Short) | Yes | |
| Wrkflow UUID | The Wrkflow UUID of the Wrkflow you would like to launch | Text (Short) | Yes | cfb38adb-3f27-4ff5-8e5c-e0db2d857f72 |
| Wrkflow name | Name of the Wrkflow launch. A default name will be generated if not provided | Text (Short) | No | My Wrkflow |
| Wrkflow start values | Key value pairs used to provide data to launch config values. | Text (Long) | No | {"email":"jon@email.com"} |
| Priority | The priority of the jobs in this Wrkflow. Jobs of a higher priority will all be completed before moving to jobs of a lower priority. Lower priority Wrflow will take longer to complete | Pre-defined Choice List | No | Normal |
| Wrkflow launch file 1 | A file to be provided as an input variable | File | No | File.pdf |
| Wrkflow launch file variable name 1 | If file 1 is provided, the input variable name for that file in the Wrkflow being launched | Text (short) | No | Invoice |
| Wrkflow launch file 2 | A file to be provided as an input variable | File | No | File.pdf |
| Wrkflow launch file variable name 2 | If file 2 is provided, the input variable name for that file in the Wrkflow being launched | Text (short) | No | Invoice |
| Wrkflow launch file 3 | A file to be provided as an input variable | File | No | File.pdf |
| Wrkflow launch file variable name 3 | If file 3 is provided, the input variable name for that file in the Wrkflow being launched | Text (short) | No | Invoice |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Wrkflow launch ID | ID of the launch that was created | Number | Yes | 287235 |
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected when the Wrkflow is successfully started. |
| Unsuccessful | This status is selected in the event that:There is an error while starting the Wrkflow |
Wrkflow Start Values Configuration
-
Open the Launch Configuration: In your target Wrkflow select the rocket ship to open the Launch Configuration Card. This card is used to define the data type and corresponding field names that your Wrkflow expects at the start.
-
Add Input Fields:
-
Click on the '+' button to add a new input field.
-
In the 'data type' dropdown, select the appropriate type for the data you need to input.
-
In the 'insert field name' text box, enter the name of the Launch parameter that will be used in the JSON object to pass data to the Wrkflow.
-
-
Example JSON Configuration:
{ "email": "user@example.com" }In the example above,
emailis a key corresponding to an input field configured in the target Wrkflow. In the triggering Wrkflow the JSON above can be provided to start the Wrkflow with the Launch parameter email set to "user@example.com"
Notes:
-
Ensure that the keys in the JSON object match the field names defined in the Wrkflow configuration.
-
The data types of the values in the JSON object should correspond to the data types specified in the Wrkflow configuration.
Requirements
- N/A