Cisco Active Network Abstraction Customization User Guide, 3.6.3 - Managing Workflows [Cisco Active Network Abstraction]

Table Of Contents

Managing Workflows

Starting Cisco ANA Manage

Workflow Engine Branch

Viewing the List of Templates and Template Properties

Deleting a Workflow Template

Viewing the Output Of a Workflow

Aborting a Workflow

Deleting a Workflow

Viewing the Workflow History Using Cisco ANA EventVision

Logging Out

Managing Workflows

This chapter provides instructions for launching Cisco ANA Manage. In addition, it describes the lists of all the deployed workflow templates for the Cisco ANA gateway, and the actions that can be performed.

•Starting Cisco ANA Manage—Describes how to open the Cisco ANA Manage application.

•Workflow Engine Branch—Describes the Workflow Engine branch that enables the user to manage templates and scripts during runtime.

•Viewing the List of Templates and Template Properties—Describes how to view the list of workflow templates and template properties and attributes.

•Deleting a Workflow Template—Describes how to delete a workflow template.

•Viewing the Output Of a Workflow—Describes how to view the output of a workflow.

•Aborting a Workflow—Describes how to abort a workflow that is running.

•Deleting a Workflow—Describes how to delete a workflow that is done or has been stopped.

•Viewing the Workflow History Using Cisco ANA EventVision—Describes how to view the workflow history using EventVision.

•Logging Out—Describes how to log out of Cisco ANA Manage.

Starting Cisco ANA Manage

This section provides instructions for launching Cisco ANA Manage. Cisco ANA Manage is password protected to ensure security. Before you start, make sure you know the username, password, and the Cisco ANA gateway IP address that is required.

To start Cisco ANA Manage:

Step 1 From the Start menu, choose the Programs folder, then Cisco ANA/Cisco ANA Manage. The Cisco ANA Manage Login dialog box is displayed.

Step 2 Enter your username, password and host (Cisco ANA gateway IP address).

Note The gateway IP address that was used when the user last logged in is automatically displayed in the Host field.

Step 3 Click OK. The Cisco ANA Manage window is displayed.

Figure 11-1 Cisco ANA Manage Window

The window is divided into two panes, as follows:

•The tree pane.

•The context pane.

Note For a detailed description of the Cisco ANA Manage application, refer to the Cisco Active Network Abstraction Administrator Guide.

Workflow Engine Branch

The Workflow Engine branch is used to manage templates and workflows and includes the following sub-branches:

•Templates—Displays a list of the workflow templates, and enables the user to view the properties of the workflow template. For a detailed description of Cisco ANA Manage, refer to the Cisco Active Network Abstraction Administrator Guide.

•Workflows—Enables the user to manage the script in runtime by viewing and altering its current status. For a detailed description of Cisco ANA Manage, refer to the Cisco Active Network Abstraction Administrator Guide.

Viewing the List of Templates and Template Properties

Cisco ANA Manage enables the user to view a list of the workflow templates and template properties (attributes).

To view the list of templates and template properties:

Step 1 Choose the Templates sub-branch. The list of workflow templates is displayed in the table.

Step 2 Choose the required workflow template in the table.

Step 3 Right-click to display the menu, and choose Properties. The Workflow Template Properties dialog box is displayed with the properties and attributes of the required workflow template.

Figure 11-2 Workflow Template Properties Dialog Box

The name of the selected template is displayed in the header and at the top of the dialog box. The following properties are displayed in the table of the Workflow Template Properties dialog box:

•Name—The attribute names defined for the tasks included in the workflow, as defined in the Task Properties dialog box using the Workflow Editor.

•Value—The values defined for the tasks included in the workflow, as defined in the Task Properties dialog box using the Workflow Editor.

Step 4 Click in the top right-hand corner to close the Template Properties dialog box.

Deleting a Workflow Template

Cisco ANA Manage enables the user to delete a workflow template.

To delete a workflow template:

Step 1 Choose the Templates sub-branch. The list of workflow templates is displayed in the table.

Step 2 Choose the workflow template that you want to delete in the table.

Step 3 Right-click on the required workflow template to display the menu, and choose Delete, or on the toolbar, click Delete. A warning message is displayed.

Step 4 Click Yes. The selected workflow template is deleted, and is no longer displayed in the table.

Viewing the Output Of a Workflow

The user can view the output of a workflow whether it is running, done or aborted.

To view the output of a workflow:

Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table.

Step 2 Choose the required workflow in the table.

Step 3 Right-click to display the menu, and choose Show Output. The Output dialog box is displayed.

Figure 11-3 Output Dialog Box

The Output dialog box displays the output and details of the workflow.

Step 4 Click Close. The Output dialog box is closed.

Aborting a Workflow

The user can abort a workflow that is running. In addition, if any task in the workflow aborts, the workflow itself will abort.

When a workflow aborts a workflow rollback will occur:

•Workflow rollback causes the activation scripts that have already been run (by Execute BQL task) to rollback.

•The rollback of an activation script is the execution of the rollback section of the script, as defined in the Command Builder.

•The order of the scripts rollback is the reverse of their execution order.

Note Gateway commands do not support rollback.

Rollback can be disabled for specific BQL tasks by setting the RollbackEnabled value task attribute to false in the respective BQL task. This is useful for a BQL task executing a script which does not have an appropriate rollback, or a BQL task executing a Gateway command.

Note A workflow instance can only be aborted when it is running. It cannot be aborted when the process is done.

To abort a running workflow:

Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table.

Step 2 Right-click on the required workflow, and choose Abort. A warning message is displayed.

Step 3 Click Yes. The workflow is stopped, and the state of the workflow changes to Aborted in the table of the Workflows sub-branch.

Deleting a Workflow

The user can delete a workflow from the Workflows sub-branch in the Cisco ANA Manage window. The workflow is deleted from the database.

To delete a workflow:

Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table.

Step 2 Right-click on the required workflow to display the menu, and choose Delete, or on the toolbar, click Delete. A warning message is displayed.

Step 3 Click Yes. The selected workflow is deleted, and is no longer displayed in the table.

Viewing the Workflow History Using Cisco ANA EventVision

Event Vision enables the user to view the workflow history, including when workflows have been completed, their status, and the command invoked, as shown in the example.

Figure 11-4 Cisco ANA EventVision - Provisioning Tab

The user can also view the properties of the event, as shown in the example below.

Figure 11-5 Properties Of The Event

The Description area of the Provisioning Event Properties dialog box displays the details of the execution of the workflow, including all the scripts, script rollback (if it occurred), and log messages.

Logging Out

When the user has finished working with Cisco ANA Manage and logs out of the application, any changes that were made are automatically saved.

To log out of Cisco ANA Manage:

Step 1 From the File menu, choose Exit,

or

Click in the top right-hand corner to close the Cisco ANA Manage window.

Cisco ANA Manage is closed.

	Cisco Active Network Abstraction Customization User Guide, 3.6.3
	Managing Workflows
Cisco Active Network Abstraction Customization User Guide, 3.6.3 Preface Cisco ANA Overview Customizing Network Element Information Using the Soft Properties Manager Introducing the Cisco ANA Soft Properties Manager Getting Started with the Soft Properties Manager Soft Property Examples Parsing Operators/Rules Alarm Threshold Triggers Regular Expressions Using the Workflow Editor to Create Task Workflows Introducing the Cisco ANA Workflow Editor Working With the Cisco ANA Workflow Editor Getting Started with the Workflow Editor Managing Workflows Customizing the Workflow Editor Managing and Deploying Configuration Changes Using the Command Builder Introducing the Command Builder Getting Started with the Command Builder Creating an ANA Macro Language Command: An Example Running Command Scripts ANA Macro Language Bean Shell Commands Working with BQL Getting Started with Cisco BQL Understanding IMO IMO Specification BQL Generic Commands Encrypted SSL Sockets Detailed BQL Errors Catalog and Examples Best Practices for Integration BQL Parsing Index	Download this chapter Managing Workflows Download the complete book PDF of Cisco ANA Customization User Guide, 3.6.3 (PDF - 3 MB) Table Of Contents Managing Workflows Starting Cisco ANA Manage Workflow Engine Branch Viewing the List of Templates and Template Properties Deleting a Workflow Template Viewing the Output Of a Workflow Aborting a Workflow Deleting a Workflow Viewing the Workflow History Using Cisco ANA EventVision Logging Out Managing Workflows This chapter provides instructions for launching Cisco ANA Manage. In addition, it describes the lists of all the deployed workflow templates for the Cisco ANA gateway, and the actions that can be performed. •Starting Cisco ANA Manage—Describes how to open the Cisco ANA Manage application. •Workflow Engine Branch—Describes the Workflow Engine branch that enables the user to manage templates and scripts during runtime. •Viewing the List of Templates and Template Properties—Describes how to view the list of workflow templates and template properties and attributes. •Deleting a Workflow Template—Describes how to delete a workflow template. •Viewing the Output Of a Workflow—Describes how to view the output of a workflow. •Aborting a Workflow—Describes how to abort a workflow that is running. •Deleting a Workflow—Describes how to delete a workflow that is done or has been stopped. •Viewing the Workflow History Using Cisco ANA EventVision—Describes how to view the workflow history using EventVision. •Logging Out—Describes how to log out of Cisco ANA Manage. Starting Cisco ANA Manage This section provides instructions for launching Cisco ANA Manage. Cisco ANA Manage is password protected to ensure security. Before you start, make sure you know the username, password, and the Cisco ANA gateway IP address that is required. To start Cisco ANA Manage: Step 1 From the Start menu, choose the Programs folder, then Cisco ANA/Cisco ANA Manage. The Cisco ANA Manage Login dialog box is displayed. Step 2 Enter your username, password and host (Cisco ANA gateway IP address). Note The gateway IP address that was used when the user last logged in is automatically displayed in the Host field. Step 3 Click OK. The Cisco ANA Manage window is displayed. Figure 11-1 Cisco ANA Manage Window The window is divided into two panes, as follows: •The tree pane. •The context pane. Note For a detailed description of the Cisco ANA Manage application, refer to the Cisco Active Network Abstraction Administrator Guide. Workflow Engine Branch The Workflow Engine branch is used to manage templates and workflows and includes the following sub-branches: •Templates—Displays a list of the workflow templates, and enables the user to view the properties of the workflow template. For a detailed description of Cisco ANA Manage, refer to the Cisco Active Network Abstraction Administrator Guide. •Workflows—Enables the user to manage the script in runtime by viewing and altering its current status. For a detailed description of Cisco ANA Manage, refer to the Cisco Active Network Abstraction Administrator Guide. Viewing the List of Templates and Template Properties Cisco ANA Manage enables the user to view a list of the workflow templates and template properties (attributes). To view the list of templates and template properties: Step 1 Choose the Templates sub-branch. The list of workflow templates is displayed in the table. Step 2 Choose the required workflow template in the table. Step 3 Right-click to display the menu, and choose Properties. The Workflow Template Properties dialog box is displayed with the properties and attributes of the required workflow template. Figure 11-2 Workflow Template Properties Dialog Box The name of the selected template is displayed in the header and at the top of the dialog box. The following properties are displayed in the table of the Workflow Template Properties dialog box: •Name—The attribute names defined for the tasks included in the workflow, as defined in the Task Properties dialog box using the Workflow Editor. •Value—The values defined for the tasks included in the workflow, as defined in the Task Properties dialog box using the Workflow Editor. Step 4 Click in the top right-hand corner to close the Template Properties dialog box. Deleting a Workflow Template Cisco ANA Manage enables the user to delete a workflow template. To delete a workflow template: Step 1 Choose the Templates sub-branch. The list of workflow templates is displayed in the table. Step 2 Choose the workflow template that you want to delete in the table. Step 3 Right-click on the required workflow template to display the menu, and choose Delete, or on the toolbar, click Delete. A warning message is displayed. Step 4 Click Yes. The selected workflow template is deleted, and is no longer displayed in the table. Viewing the Output Of a Workflow The user can view the output of a workflow whether it is running, done or aborted. To view the output of a workflow: Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table. Step 2 Choose the required workflow in the table. Step 3 Right-click to display the menu, and choose Show Output. The Output dialog box is displayed. Figure 11-3 Output Dialog Box The Output dialog box displays the output and details of the workflow. Step 4 Click Close. The Output dialog box is closed. Aborting a Workflow The user can abort a workflow that is running. In addition, if any task in the workflow aborts, the workflow itself will abort. When a workflow aborts a workflow rollback will occur: •Workflow rollback causes the activation scripts that have already been run (by Execute BQL task) to rollback. •The rollback of an activation script is the execution of the rollback section of the script, as defined in the Command Builder. •The order of the scripts rollback is the reverse of their execution order. Note Gateway commands do not support rollback. Rollback can be disabled for specific BQL tasks by setting the RollbackEnabled value task attribute to false in the respective BQL task. This is useful for a BQL task executing a script which does not have an appropriate rollback, or a BQL task executing a Gateway command. Note A workflow instance can only be aborted when it is running. It cannot be aborted when the process is done. To abort a running workflow: Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table. Step 2 Right-click on the required workflow, and choose Abort. A warning message is displayed. Step 3 Click Yes. The workflow is stopped, and the state of the workflow changes to Aborted in the table of the Workflows sub-branch. Deleting a Workflow The user can delete a workflow from the Workflows sub-branch in the Cisco ANA Manage window. The workflow is deleted from the database. To delete a workflow: Step 1 Choose the Workflows sub-branch. The list of workflows is displayed in the table. Step 2 Right-click on the required workflow to display the menu, and choose Delete, or on the toolbar, click Delete. A warning message is displayed. Step 3 Click Yes. The selected workflow is deleted, and is no longer displayed in the table. Viewing the Workflow History Using Cisco ANA EventVision Event Vision enables the user to view the workflow history, including when workflows have been completed, their status, and the command invoked, as shown in the example. Figure 11-4 Cisco ANA EventVision - Provisioning Tab The user can also view the properties of the event, as shown in the example below. Figure 11-5 Properties Of The Event The Description area of the Provisioning Event Properties dialog box displays the details of the execution of the workflow, including all the scripts, script rollback (if it occurred), and log messages. Logging Out When the user has finished working with Cisco ANA Manage and logs out of the application, any changes that were made are automatically saved. To log out of Cisco ANA Manage: Step 1 From the File menu, choose Exit, or Click in the top right-hand corner to close the Cisco ANA Manage window. Cisco ANA Manage is closed.
	© 1992-2009 Cisco Systems, Inc. All rights reserved. Terms & Conditions \| Privacy Statement \| Cookie Policy \| Trademarks of Cisco Systems, Inc.