Cisco Active Network Abstraction Workflow User Guide Version 3.5.1
Working with the Cisco ANA Workflow Editor
Download this chapter
Working with the Cisco ANA Workflow EditorWorking with the Cisco ANA Workflow Editor
Download the complete book
Cisco ANA 3.5.1 Workflow User's Guide - PDF of Entire BookCisco ANA 3.5.1 Workflow User's Guide - PDF of Entire Book (PDF - 2 MB)
give_us_feedback

Table Of Contents

Working With the Cisco ANA Workflow Editor

Starting Cisco ANA Workflow Editor

Cisco ANA Workflow Editor Window

Creating a New Workflow Template

Retrieving a Workflow Template

Deploying a Workflow Template

Deleting a Workflow Template

Viewing Workflow Properties

Working With the Task Library

BQL Task

Workflow Call Task

Subflow Task

Lock Task

Unlock Task

Executing a Workflow

Gateway Workflow Commands/Operations

Deleting a Template

Running a Workflow

Aborting a Workflow

Deleting a Workflow

Getting Workflow Output

Logging Out


Working With the Cisco ANA Workflow Editor

This chapter provides instructions for launching the Cisco ANA Workflow Editor application. In addition, it describes the Cisco ANA Workflow Editor working environment and how to operate the customized functionality.

•Starting Cisco ANA Workflow Editor—Describes how to login to the Cisco ANA Workflow Editor.

•Cisco ANA Workflow Editor Window—Briefly describes the Cisco ANA Workflow Editor window and the additional customized functions.

•Creating a New Workflow Template—Provides a brief overview of the workflow template creation process.

•Retrieving a Workflow Template—Describes how to retrieve a workflow template that was previously created from the local server.

•Deploying a Workflow Template—Describes how to deploy a workflow template to the Cisco ANA Server.

•Deleting a Workflow Template—Describes how to delete a workflow template from the local server.

•Viewing Workflow Properties—Describes how to view the properties of a BQL workflow.

•Working With the Task Library—Describes how to view the properties of a BQL, Workflow Call, Subflow, Lock and Unlock tasks.

•Executing a Workflow—Describes how to execute a workflow template on the local server.

•Gateway Workflow Commands/Operations—Describes how to add utility functions using BQL commands.

•Logging Out—Describes how to log out of the Cisco ANA Workflow Editor.

Starting Cisco ANA Workflow Editor

This section provides instructions for launching the Cisco ANA Workflow Editor application. Cisco ANA Workflow Editor is password protected to ensure security. Before you start working with Cisco ANA Workflow Editor make sure you know your user name, password and the Cisco ANA Gateway IP address or host name that you require.Installation of the Cisco ANA Workflow Editor is optional. If you have acquired the activation solution the Cisco ANA Workflow Editor can be installed using the regular client installation package. For more information, refer to Cisco Active Network Abstraction Client Installation Guide. When the client opens it will negotiate with the Server in order to validate the license. If the license is not validated the Cisco ANA Workflow Editor will not open.

To start Cisco ANA Workflow Editor:

Step 1 From the Start menu, select the Programs folder, the Cisco ANA/Workflow Editor. The Workflow Editor Login dialog box is displayed.

Step 2 Enter your User Name, and Password.

Step 3 Enter the required Cisco ANA Gateway's information in the Host field, as an IP address or host name,

or

Select a Cisco ANA Gateway from the Host dropdown list.

Note The Gateway IP address or host name that was used when you last logged in is automatically displayed at the top of the Host dropdown list.

Step 4 Click OK. The Workflow Editor window is displayed. For more information see Figure 2-1

Note The Workflow Editor window appears empty when it is opened. You can create a new workflow and/or retrieve a workflow that was created previously.

Cisco ANA Workflow Editor Window

The Workflow Editor window with a template is displayed.

Figure 2-1 Workflow Editor Window

1

Drawing Area

2

Task toolbar

3

Task Attribute Table

4

Tree

5

Action toolbar


The different areas of the Workflow Editor window display information on the workflow and the tasks within the workflow. For detailed information about the Workflow Editor window, refer to the Dralasoft Workflow™ Manual.

The Workflow Editor window contains several actions that have been customized and added to the action toolbar, as follows:

Button
Function

Retrieves (loads) a workflow from the Gateway.

Deletes a workflow from the Gateway.

Deploys (uploads) the workflow on the Gateway.


All of the customized actions available in the action toolbar and described above can also be accessed from the Tools menu.

In addition, the following customized task has been added to the task toolbar:

The Execute BQL task is used to invoke commands previously created and residing on the Cisco ANA Server. This is the main task used for implementing an activation workflow.

The Lock task is used to obtain a lock on a resource.

The Unlock task is used to unlock a resource.

The Workflow Call task is used to synchronically execute/call another workflow.

The Subflow task is used to embed and execute another workflow.


Creating a New Workflow Template

The workflow template creation process begins by creating a new workflow template with a unique name. A blank template is created, and opened for editing. The user then adds tasks to the template in order to create the logical flow that is required. The workflow template is stored locally, and each update the user makes is automatically saved.

For information about creating new workflows, refer to the Dralasoft Workflow™ Manual.

Retrieving a Workflow Template

The user can retrieve a workflow template that was previously created and deployed on the Gateway or server. Once the workflow template has been retrieved the user can do one of the following:

•Edit the workflow template

•Deploy the workflow template

•Execute the workflow template

•Delete the workflow template

To retrieve a workflow template:

Step 1 In the toolbar, click Retrieve Workflow. The Retrieve Workflow Template from Server dialog box is displayed.

The Retrieve Workflow Template from Server dialog box displays the list of existing workflow templates.

Step 2 Select the required workflow template that you want to load from the list.

Step 3 Click OK. A confirmation message is displayed.

Step 4 Click OK. The required workflow template is opened and displayed in the Workflow Editor window.

Deploying a Workflow Template

After the user has tested the workflow template locally and is satisfied, the workflow template can be deployed to the Cisco ANA Server (remote server), where it will be available to all authorized users.

To deploy a workflow template:

Step 1 In the toolbar, click Deploy Workflow. A confirmation message is displayed.

Step 2 Click Yes. A success message is displayed.

Note If the workflow template already exists the server will ask you if you want to replace the existing workflow.

Step 3 Click OK. The selected workflow template is deployed.

Deleting a Workflow Template

The user can delete a workflow template from the server.

Note A workflow template does not have to be open or displayed in the Workflow Editor window before it can be deleted.

To delete a workflow template:

Step 1 In the toolbar, click Delete Workflow from Server. The Delete Workflow Template from Server dialog box is displayed.

Step 2 Select the template that you want to delete from the list.

Step 3 Click OK. A success message is displayed.

Step 4 Click OK. The workflow template is deleted from the local server.

Viewing Workflow Properties

The Workflow Properties dialog box enables the user to view the workflow callback scripts. The user can view the properties of a BQL workflow.

To view workflow properties:

Step 1 Create or retrieve the required workflow template.

Step 2 Right-click in the Drawing Area to display the menu and select Workflow Properties. The Workflow Properties dialog box for the required workflow template is displayed.

Figure 2-2 Workflow Properties Dialog Box - General Properties Tab

For information about the Workflow Properties dialog box, refer to the Dralasoft Workflow™ Manual.

Step 3 Select the Attributes tab. The attributes of the BQL workflow are displayed.

Figure 2-3 Attributes Tab

Step 4 Select the Callback Scripts tab.

Figure 2-4 Callback Scripts Tab

The Select Script dropdown list enables the user to select one of the following options in order to execute (activate) the script:

•preActiveScript—Executes the script before the workflow is active.

•activeScript—Executes the script when the workflow becomes active.

•doneScript—Executes the script when the workflow is successfully completed.

•exceptionScript—Executes the script if one of the tasks in the workflow fails.

The Execute button runs the script for testing purposes.

Step 5 Click OK. The Workflow Properties dialog box is closed.

Working With the Task Library

This section describes viewing the properties of the following tasks:

•BQL Task

•Workflow Call Task

•Subflow Task

•Lock Task

•Unlock Task

BQL Task

The Execute BQL task is used to invoke commands previously created and residing on the Cisco ANA Server. This is the main task used for implementing an activation workflow.

The command template can include the following parameters:

•$Attribute name$ - is evaluated as a workflow attribute.

•$Task name:Attribute name$ - is evaluated as a task attribute.

To view the properties of an Execute BQL task:

Step 1 Create or retrieve the required workflow template.

Step 2 Select the required BQL task in the Drawing Area.

Step 3 Right-click to display the menu and select Task Properties. The Task Properties dialog box for the required task is displayed.

Figure 2-5 Task Properties Dialog Box - General Properties Tab

Note The "Earliest Start" option is not supported.

For information about the Task Properties dialog box, refer to the Dralasoft Workflow™ Manual.

Step 4 Select the Attributes tab. The attributes of the task are displayed.

Figure 2-6 Attributes Tab

Step 5 Select the Command Template tab.

Figure 2-7 Command Template Tab

The Command Template tab enables the user to edit the command template used to create a command descriptor for executing the activation script. In addition, the user can paste the XML code here in order to invoke the command.

Step 6 Click OK. The Task Properties dialog box is closed.

Workflow Call Task

The Workflow Call task is used to synchronically execute/call another workflow, which will be recognized as a child of this workflow.

Note The maximum workflow nesting depth is defined in the Registry. The default value is 16.

To view the properties of a Workflow Call task:

Step 1 Create or retrieve the required workflow template.

Step 2 Select the required Workflow Call task in the Drawing Area.

Step 3 Right-click to display the menu and select Task Properties. The Task Properties dialog box for the required task is displayed.

Figure 2-8 Task Properties Dialog Box - Assign Attributes Tab

The Assign Attributes tab enables the user to pass parameters as attributes to child workflows.

An attribute can be assigned to a child workflow in two ways:

•By specifying a workflow attribute in a parent workflow, as follows:

–attribute_in_child_workflow=attribute_in_parent_workflow

•By specifying a task in a parent workflow followed by a colon (:) and the attribute name, as follows:

–attribute_in_child_workflow=task_in_parent_workflow:attribute_name

For information about the Task Properties dialog box, refer to the Dralasoft Workflow™ Manual.

Step 4 Select the General Properties tab. The general properties of the task are displayed.

Figure 2-9 General Properties Tab

Note The "Earliest Start" option is not supported.

Step 5 Select the Attributes tab. The attributes of the task are displayed.

Step 6 Select the Target Template tab.

Figure 2-10 Target Template Tab

The Target Template tab enables the user to choose the workflow template that will be defined as the child workflow.

Step 7 Click OK. The Task Properties dialog box is closed.

Subflow Task

The Subflow task is used to embed and execute another workflow in this workflow instance.

Note The maximum workflow nesting depth is defined in the Registry. The default value is 16.

To view the properties of a Subflow task:

Step 1 Create or retrieve the required workflow template.

Step 2 Select the required Subflow task in the Drawing Area.

Step 3 Right-click to display the menu and select Task Properties. The Task Properties dialog box for the required task is displayed.

Figure 2-11 General Properties Tab - Subflow

Note The "Earliest Start" option is not supported.

For information about the Task Properties dialog box, refer to the Dralasoft Workflow™ Manual.

Step 4 Select the Attributes tab. The attributes of the task are displayed.

Step 5 Select the Target Template tab.

Figure 2-12 Target Template Tab - Subflow

The Target Template tab enables the user to select the workflow template that will be embedded.

Step 6 Click OK. The Task Properties dialog box is closed.

Lock Task

The Lock task is used to create a lock on specific resources.

To view the properties of a Lock task:

Step 1 Create or retrieve the required workflow template.

Step 2 Select the required Lock task in the Drawing Area.

Step 3 Right-click to display the menu and select Task Properties. The Task Properties dialog box for the required task is displayed.

Figure 2-13 General Properties Tab - Lock

Note The "Earliest Start" option is not supported.

For information, refer to the Dralasoft Workflow™ Manual.

Step 4 Select the Attributes tab. The attributes of the task are displayed.

Step 5 Select the Resource Names tab.

Figure 2-14 Resource Names Tab - Lock

The Resource Names tab enables the user to specify the resources that should be locked.

Note It is possible to lock multiple resources as well.

Step 6 Click OK. The Task Properties dialog box is closed.

Unlock Task

The Unlock task is used to unlock specific locked resources.

To view the properties of an Unlock task:

Step 1 Create or retrieve the required workflow template.

Step 2 Select the required Unlock task in the Drawing Area.

Step 3 Right-click to display the menu and select Task Properties. The Task Properties dialog box for the required task is displayed.

Figure 2-15 General Properties Tab - Unlock

Note The "Earliest Start" option is not supported.

For information about the Task Properties dialog box, refer to the Dralasoft Workflow™ Manual.

Step 4 Select the Attributes tab. The attributes of the task are displayed.

Step 5 Select the Resource Names tab.

Figure 2-16 Resource Names Tab - Unlock

The Resource Names tab enables the user to specify the resources that should be unlocked.

Step 6 Click OK. The Task Properties dialog box is closed.

Executing a Workflow

The user can execute (test) a BQL workflow locally on the client. For general information about executing a workflow, refer to the Dralasoft Workflow™ Manual. This section describes executing (testing) a workflow that includes a BQL task.

To execute a BQL workflow:

Step 1 Create a new workflow in the Workflow Editor window (see Creating a New Workflow Template) or retrieve a workflow (see Retrieving a Workflow Template).

Step 2 In the toolbar, click Execute Workflow. The Workflow Editor window changes and displays an additional set of views, as shown in the example.

Figure 2-17 Execute Workflow

The new tab that is created (in the upper row) and displayed in the Workflow Editor window reflects the activation status. For more information about activation status, refer to page 1-2.

In addition, the following views are displayed in the window (lower row) relating to the activation of the workflow:

•Graphical View—Displays the workflow as a graphical presentation.

•Tabular View—Displays a table of all of the tasks in the workflow.

•Workflow State Analysis—Displays an analysis of the activation status of the workflow.

•XML View—Displays the XML code of the current workflow.

In addition, the following buttons are displayed at the bottom of the window:

•Activate—Activates the workflow.

Note This button toggles to Abort when Activation is clicked. Clicking Abort aborts the workflow.

•Copy—Copies the workflow.

•Delete—Deletes an executing workflow.

Step 3 Click Activate. The Console window is displayed.

Figure 2-18 Console Window

The Console window displays the results of each task in the workflow.

Step 4 Click to close the Console window. The Workflow Editor window is displayed.

The tasks displayed in the Graphical View tab (lower row) display the activation status of each task using an oval shape and colors (in the bottom right corner), as shown in the example.

Figure 2-19 Tasks Displayed In the Graphical View Tab

These colors change as the status of the task changes during the execution process, as follows:

•Blue—Ready

•Green—Active

•Red—Abort

•Grey—Done

•Light Grey—Passive

For more information about activation status, see page 1-2.

Step 5 Review the results of the execution of the workflow in the Workflow Editor window.

Once the workflow has been executed (tested) successfully locally on the client the user can deploy the workflow to the Cisco ANA Gateway. For more information, see Deploying a Workflow Template.

Gateway Workflow Commands/Operations

This section describes how to add utility functions using BQL commands.

Deleting a Template

To delete a template from the server, use the following BQL command: 

<?xml version="1.0" encoding="UTF-8"?> 
<command name="Delete"> 
    <param name="oid"> 
    <value>{[WorkflowTemplate(Name=template-name)]}</value> 
    </param> 
</command>

Running a Workflow

To execute a workflow based on an installed template, use the following BQL command: 

<?xml version="1.0" encoding="UTF-8"?>

<command name="RunWorkflow">

    <param name="templateOid">

    <value>{[WorkflowTemplate(Name=template-name)]}</value>

    </param>

    <param name="workflowAttributes">

      <value>

        <IWorkflowAttribute>

          <ID type="Oid">{[WorkflowAttribute(Name=attribute1-name)]}</ID>

          <Value type="String">attribute1-value</Value>

        </IWorkflowAttribute>

        <IWorkflowAttribute>

          <ID type="Oid">{[WorkflowAttribute(Name=attribute2-name)]}</ID>

          <Value type="String">attribute2-value</Value>

        </IWorkflowAttribute>

...and so on for other attributes... 

      </value>

    <IMObject_Array/>

  </param>

</command>

This command returns the OID of the new workflow. For example: 

------ com.sheer.framework.imo.Oid ------ 
{[Workflow(Id=801)]} 
-----------------------------------------

Aborting a Workflow

To abort a workflow, which includes, stopping it if it is running and rolling back all the activation scripts that it has executed, use the following BQL command: 

<?xml version="1.0" encoding="UTF-8"?>

<command name="AbortWorkflow">

    <param name="oid">

    	<value>{[Workflow(Id=workflow-id)]}</value>

    </param>

</command>

If successful, this command returns nothing.

Deleting a Workflow

To delete a workflow that is not active, namely, one that has already been completed or was aborted, use the following BQL command: 

<?xml version="1.0" encoding="UTF-8"?>

<command name="Delete">

    <param name="oid">

    	<value>{[Workflow(Id=workflow-id)]}</value>

    </param>

</command>

If successful, this command returns nothing.

Getting Workflow Output

To get the output of a workflow, both during its execution and afterwards, use the following BQL command: 

<?xml version="1.0" encoding="UTF-8"?>

<command name="GetWorkflowOutput">

    <param name="oid">

    	<value>{[Workflow(Id=workflow-id)]}</value>

    </param>

</command>

This command returns the output as a string. For example: 

<?xml version="1.0" encoding="UTF-8"?>

<IMO>

  <Output type="String">

    ...

progress messages and script execution results 

...

</Output>

</IMO>

Logging Out

When you have finished working with the Cisco ANA Workflow Editor you can log out of the application. Any open workflow templates are automatically saved when you log out.

To log out of the Cisco ANA Workflow Editor:

Step 1 From the File menu, select Exit,

or

Click in the top right-hand corner to close the Workflow Editor window.

The Cisco ANA Workflow Editor is closed.