Workflow outputs
A workflow can take data connections or index collections as outputs:
- When you select an index collection as an output, the fields produced by the workflow task are added to an index that users can search against.
- When you select a data connection as an output, you can select the action that you want the data connection to perform on documents exiting the pipeline. For information on actions, see Actions.
A workflow is not required to have an output. For example, you should omit a workflow output if you want to process and examine your data but not index it or write anything back to the data source.
Adding existing outputs to a workflow
You can add any existing index collection or data connection as an output to a workflow.
For information on:
- Creating index collections to use as workflow outputs, see Adding new index collections to a workflow.
- Creating data connections to use as workflow outputs, see Creating data connections.
Workflow Designer instructions
To add an existing output to a workflow:
Procedure
Click on the Workflow Designer panel.
Click on the workflow that you want.
Click on the Output panel.
Click on the Add Output button.
Do one of these:
- Click on Select Index. Then select an index collection from the
list. Choose either Index (Documents get indexed) or Index or
delete (Documents get indexed and any deleted documents get
removed from the index.)
-or-
- Click on Select Data Connection. Then:
Select a data connection.
Select an action.
Configure the action.
The configuration settings for data connection actions differ depending on the data connection. For information on these settings, see the topic for the applicable data connection under Data connection types and settings.
Click on the Add to Workflow button.
Related CLI command(s)
editWorkflow
Related REST API method(s)
PUT /workflows/{uuid}
- Click on Select Index. Then select an index collection from the
list. Choose either Index (Documents get indexed) or Index or
delete (Documents get indexed and any deleted documents get
removed from the index.)
Adding new index collections to a workflow
On the Workflow Designer page in the Admin App, you can create new index collections while adding new outputs to a workflow, rather than having to create the index collections first.
To do this using the REST API or CLI, you need to first create the index collection and then edit the workflow.
You can also add existing data connections as workflow outputs. For information, see Adding existing outputs to a workflow.
To add a new index collection to a workflow:
Procedure
Click the Workflow Designer window.
Select the workflow that you want.
Click the Output window.
Click Add Output.
Click Create New Index.
Use the Create Index page to create a new index. For information, see Adding index collections.
The new index is added to the workflow.
Related CLI commands
editWorkflowRelated REST API methods
POST /indexesPUT /workflows/{uuid}
Removing outputs from a workflow
You can remove an output from a workflow at any time, even while a task is running for the workflow.
Workflow Designer instructions
To delete an output from a workflow:
Procedure
Click on the Workflow Designer panel.
Click on the workflow that you want.
Click on the Output panel.
Click on the remove icon (
)
for the output you want to remove.Click on the OK button in the prompt.
Related CLI command(s)
editWorkflow
Related REST API method(s)
PUT /workflows/{uuid}