Managing Workflows

Cisco MSX interacts with Cisco Action Orchestrator (AO) to import and operate on the workflows from within Cisco MSX. This feature is enabled by default.

A workflow consists of activities, invocations of child workflows, and logic components that can be included to automate processes.

The workflow actions can be performed from both the MSX Portal or by using APIs (Workflow, Workflow Instance, and Category APIs). For more information on APIs related to Action Orchestrator/Workflow engine, refer to the Swagger documentation that can be accessed from the MSX portal > Account Settings > Swagger > Manage Microservice API.

For more information on AO-specific permissions, see the latest version of Cisco Managed Services Accelerator (MSX) Platform and Service Pack Permissions Addendum.

This chapter contains the following topics:

Importing a Workflow

Using this procedure, you can import workflows for associated tenants from Service Design Studio (SDS) and view the workflows.

Procedure

Step 1	Log in to the Cisco MSX portal using your credentials.
Step 2	From the left pane, click Workflows. The Workflow window is displayed.
Step 3	Click Import New Workflow to import a workflow into MSX. It is possible to upload a new version of the same workflow. In this case, you will have the option to cancel or overwrite the existing one.
Step 4	Select the Associate Tenants, click Import Workflow, and click OK. After uploading a workflow into Cisco MSX, Cisco MSX lists the imported workflow on the Workflows page. Click on a workflow to view its details.

Running a Workflow

Using this procedure, you can run a workflow, view, and delete a workflow instance details.

Procedure

Step 1	Log in to the Cisco MSX portal.
Step 2	From the left pane, click Workflows. The Workflows window is displayed.
Step 3	Select a workflow and click the Details icon.
Step 4	Enter workflow execution startup parameters, for example, a service name.
Step 5	Click Run to run the workflow. If the workflow runs without any issues, status changes to green for all three checks. If there are issues, select the workflow running instance from the Runs window on the right-hand side, click ellipsis (...) and select View Result to view the error. To delete or cancel a running workflow instance, click ellipsis (...) and select Delete or Cancel.

Deleting a Workflow

Using this procedure, you can delete a workflow.

Procedure

Step 1

Step 2

From the left pane, click Workflows.

The Workflow window is displayed.

Step 3

Select a workflow and click Delete icon to delete the imported workflow.

Creating Account Keys

Account keys are the credentials for the system to be able to authenticate and access the workflows that you are trying to target.

Using this procedure, you can create account keys.

Procedure

Step 1

Step 2

From the left pane, click Workflows.

The Workflows window is displayed.

Step 3

Click Account Keys, and then click Create Account Key.

Create Account Key dialog box is displayed.

Select the Account Key Type from the drop-down list.
Enter the Display Name and Credentials.

Step 4

Click Save.

The new account key is listed on the Workflows > Account keys window.

To edit an account key, select the Account key and click the ellipses button (the button with three dots).

Click the Edit Account Key to edit the selected account key.

Note

If there are secure strings, not modifying them and leaving them as asterisks maintain the previous value.

The Edit Account Key dialog box is displayed. Make the required changes and click Save to save the updates.

To delete an account key, select the account key to be deleted and click the Delete Account Key button.

The Delete Account Key dialog box is displayed. Click Delete to confirm.

Creating Targets

Targets are used by workflows either at the start of the workflow, or, internally during the workflow.

Using this procedure, you can create targets so that the workflow can select any target in runtime.

Note

Having account keys is a prerequisite for most targets. If required, you should have the account keys created first before you create the targets.

Procedure

Step 1	Log in to the Cisco MSX portal using your credentials.
Step 2	From the left pane, click Workflows. The Workflows window is displayed.
Step 3	Click Targets, and then click Create Target. Create Target dialog box is displayed. Select the Target Type from the drop-down list. Enter the Display Name. Select the Account Keys from the drop-down list if an option is provided. Select the Protocol, Host/IP Address and Port.
Step 4	Click Save. The new target is listed on the Workflows > Targets window. To edit a target, select the Target and click the ellipses (...). Click the Edit Target button to edit the selected target. The Edit Target dialog box is displayed. Make the required changes and click Save to save the updates. To delete a target, select the target to be deleted and click the Delete Target button. The DeleteTarget dialog box is displayed. Click Delete to confirm.

Cisco Managed Services Accelerator (MSX) 3.10 Platform User Guide

Bias-Free Language

Book Title

Cisco Managed Services Accelerator (MSX) 3.10 Platform User Guide

Chapter Title