What are the components of a workflow?
Workflows in the NSP UI
The landing page for Workflows is the Dashboard. Dashlets in the Dashboard provide information about the status of recent, running, failed, and scheduled workflow executions. You can use the view selector to navigate to workflow-related views for the NSP. For example, the Workflow Executions view displays a list of executions for all workflows.
Choose Workflows in the view selector to display the list of workflows created in or imported to NSP. Double-click on a workflow to navigate to a set of views specific to the selected workflow:
Info
The Info page provides a dashboard for the selected workflow, displaying execution status, workflow metadata, and, if available, a workflow readme.
Executions
In the executions list, you can see the list of executions of the workflow that have been run since the last cleanup, including their status (Idle, Running, Success, Error, or Canceled), their run time, and how they were triggered.
Note: The executions list on the Dashboard does not include subworkflows.
Double-click on an execution to drill down for further information about tasks, actions executed, input/output, or the execution flow diagram. From the flow diagram, you can debug action executions, or evaluate YAQL expressions.
Action Executions Waiting On User Input
If an action in the workflow requires user input during execution, such as a confirmation message, the action enters Waiting On User Input status. The Action Executions Waiting On User Input view shows the list of action executions executed by the selected workflow, filtered by Waiting On User Input status.
To open the user input form and complete the execution, choose the action execution and click (Table row actions), Update.
Definition
The definition view shows the YAML script of the workflow. See What does a workflow look like? for more information about workflow structure. For detailed information about workflow design, see the Workflows tutorial on the Network Developer Portal.
Flow
A Flow diagram is a graphical representation of a workflow or workflow execution. Tasks are shown as boxes, and dependencies as lines between the boxes.
The Flow diagram of a workflow shows all of the tasks that could be run by the workflow and their dependencies. For example: on success of Task 1, perform Task 2; on failure of Task 1, perform Task 3. For this example, the dependency is indicated by a solid line, colored green for success or red for failure. If the dependency is conditional, the diagram shows a dotted green line. Hover your mouse over the word Condition to see the condition.
Tasks are all in Preview status because the diagram is showing a workflow, not a completed execution.
Choose a task to see the path to the task; for example, the success of two previous tasks. With a task selected, click Details on the right of the page to open the Details panel and view information about the task, including the action performed, the task definition, and the information published by the action, if any. See
What is a flow? for more details.
Input form
The input form defines the UI for executing the workflow, that is, the Input and Parameters panel of the Create Execution form.
The required input is configured in the workflow’s YAML definition; see What does a workflow look like?. For example, the workflow may require a username to be entered. The input form defines the appearance of the fields in the Input and Parameters panel. For example, the input form defines the width of the username field, and whether the field for the next parameter appears on a new line in the form.
If the developer has included standard input attributes in the workflow script, the input form can include execution mode options; see the Workflows tutorial on the Network Developer Portal. The following options can be included:
-
Dry Run: execute the workflow without pushing any information to the network.
-
Compare: execute the workflow and provide a summary of what has changed, or, if Dry Run is also enabled, what would be changed if you set Dry Run to false
-
Force: execute the workflow with predefined user input values.
See How do I update an input form? to update the input form.
Schedules
The Schedules view shows the list of configured schedules that execute the selected workflow, including information about remaining executions. You can create a schedule for the workflow from this view if needed.
Kafka triggers
The Kafka Triggers view shows the list of configured Kafka triggers that execute the selected workflow, including the Kafka topic and event that trigger execution. See What is a Kafka trigger? for more details.
Note: You can delete a workflow from the Table row actions menu in the Workflows view; see “How do I navigate a list?” in the NSP User Guide. If there is a Kafka trigger associated with a workflow, the Kafka trigger must be removed before the workflow can be deleted.