Create a Workflow
Note: You can double-click the Stop action to define a rule to trigger an auto
rollback or an associated cleanup workflow.
Note: To rename a task that is created and configured, you can double-click it and then
click
.
-
Click
and select
Studio > Workflow.
The Workflow screen appears. -
Click
in the Command bar.
- On the New workflow screen that appears, enter a name for the new workflow.
- (Optional) Provide additional details about the workflow.
- (Optional) From the Category dropdown, select the group to which the workflow must belong.
-
Click the Create button to add the workflow to the system.
The new workflow workspace appears.
-
Upon clicking, the following sections and corresponding tasks appear on the left side
of the workspace:
- Search
- General
- Delay - Configure custom delay intervals between workflow tasks.
- If - Configure different actions to be performed upon the success or failure of a task in a workflow.
- Switch - Group a set of rules to trigger multiple sets of actions in a workflow.
- Retry - Configure the specific time or interval at which the execution of a work order must be retried.
- Work order - Add child work orders to a parent work order. The child work order consists of one or more tasks.
- Join - Connect two or more parallel flows in a workflow.
- REST - Define URLs of the external APIs (along with the authorization and required headers) to be triggered.
- REST(I) - Define the internal APIs to be triggered.
- Split - Trigger parallel set of tasks at the same time.
- Schedule - Plan one or more tasks in a workflow to be executed at a particular period.
- Dependency - Decide the execution of tasks based on the completion of particular tasks.
- Script - Use Python scripts to be executed in a workflow. You can create one or more Python scripts, which can be dragged and dropped to the workspace later on.
- Loop - Define a sequence of instructions to be repeated continually until a certain condition is reached.
- BreakLoop - Define a condition upon reaching which a loop must be terminated.
- Implementation
- Prevalidation
- Post validation
- Rollback
- Ansible Executor - Configure an Ansible host instance and path to discover the playbooks.
- User interface
- Form - Use a form builder along with the custom associate script. This task consists of four tabs, namely, Information, Form Builder, Hooks, and Roles & settings. You can define the Global variables in the Roles & Settings tab or click the field in the Form Builder tab.
- Grid - Display the provided data in the form of an editable or non-editable table.
- Review - Display the final editable or non-editable commands in the script that have been implemented in the device.
- Chart - Display the provided data as a pie, bar, or stacked bar chart.
- YAML - Provide input in YAML format, which is very easy to understand. You can also import playbooks into Studio.
- Diff Checker - View side-by-side comparisons of configuration files.
- ITSM - Click Change and the following tasks appear:
- Create - Create a ticket in ServiceNow.
- Close - Close a ticket in ServiceNow. The details of a closed ticket cannot be edited.
- Get - Retrieve the details of a ticket from ServiceNow.
- Push Config - Push the data into a particular ticket in ServiceNow.
- Push Logs - Push the logs into a particular ticket in ServiceNow.
- Validate - Validate the ticket created in ServiceNow using the Create option.
- Withdraw - Remove a ticket from ServiceNow. The details of a withdrawn ticket can be edited.
- Notification
Note: If the SMTP is not configured in the AppViewX settings, an email notification will not be sent and the event will be recorded in the Audit logs.
- Email - Configure an auto-generated email that is triggered along with
the workflow data. These emails can be configured with various levels of approval
required to trigger a workflow. You can create one or more email templates that
can be dragged and dropped to the workspace later on. Also, you can do the following:
- Attach the global variables available in the workflow.
- Browse and attach other files from your PC.
- Slack - Send notifications through Slack as a part of the workflow process.
- PagerDuty - The PageDuty users will receive a notification on their device. This is based on the information they have provided their PagerDuty account.
- Email - Configure an auto-generated email that is triggered along with
the workflow data. These emails can be configured with various levels of approval
required to trigger a workflow. You can create one or more email templates that
can be dragged and dropped to the workspace later on. Also, you can do the following:
- Folders
- Add - Create a new user or global folder in which you can place your tasks, workflows, or sub-workflows.
- Import - Import tasks from other workflows to a specific folder of your choice.
- Default - The contents of this folder will be deleted once you exit the workflow.
- Integrations - View the external entities that are integrated with the Studio module.
- FAQ - Use the ready-made tasks that are most commonly used to design a workflow.
- Store - View the multi-level folder hierarchy for the Out of the Box (OOB) tasks and flows.
- Drag and drop the tasks you want
to the workspace and fill in a minimum of all the mandatory fields
for each task in the following sections:
- General - Consists of all the details and the configurations of the task.
- Global variables - Consists of pre-defined values that can be reused in other
tasks. In a workflow, you can click
in the command bar to view all the
variables that have been defined. - Custom message - Consists of text messages that must appear during various stages of the task.
- Action - Consists of labels that can be defined for the tasks depending on their statuses. These labels will be displayed in the tree-view of the workflow upon the success or failover of a task.
-
Create a workflow using connectors between the tasks as appropriate. You can click
in the command bar to
select one of the following types of connectors you want to use in the workflow:
- Default
- Flow
- Curved
- Straight
Note: When you use a second outgoing connector from a task, a Link Selection window appears, in which you can define the Flow Type and provide a Display Name for it.