Cisco Process Orchestrator User Guide 3.5

Target General Tab

Use the General tab to enter general information about a target. The information displayed depends on the configured target.

Target Configuration Tab

Use the Configuration tab to specify the character restrictions for a database identifier. A distinction is made between simple identifiers and special identifiers.

Target Permission Tab

Use the Permission page to define the permissions for SQL commands that can run on the target.

Target General Information

Use the New [Object] Wizard General Information panel to specify the display name and description for the new target.

Completing the New Object Wizard Panel

The Completing the New [Object] Property Wizard panel displays name of the new object.

Review the information to verify that it is correct and click the appropriate button to complete wizard process.

User Assignments tab

Use the User Assignments tab to add and modify security role information between the security principal and the permissions.

The User Assignment tab binds the security principal (either a user or group) and defined security permissions for the security role.

Add

Click this to launch the select User or Group dialog box and change the owner.

Remove

Removes the selected principal from the list of the owners assigned to the security role.

Viewing Adapter Prerequisites

Each adapter can have prerequisites that must be satisfied before the adapter can be fully functional. For example, the Core Functions Adapter has no prerequisites, but the SAP ABAP Adapter requires the SAP .NET 3.0 connector; without this connector, the SAP ABAP adapter will not function correctly.

Prerequisites apply to particular Process Orchestrator servers, so prerequisites can be satisfied on one server but not on another. This means that sometimes an adapter might be functional on one server and not on another if the prerequisites are not met on that other server. If you are running in a high availability environment, it is important that all required adapter’s prerequisites are satisfied on all Process Orchestrator servers.

To check the status of the prerequisites for each adapter:

Step 1 Choose Administration > Adapters , then double-click an adapter name.

Step 2 In the [adapter name] Adapter Properties dialog, click the Prerequisites tab.

Step 3 If your environment contains more than one server, you can view the prerequisites for each server. Choose Administration > Orchestration Servers > PO Server properties > Prerequisites .

Viewing Adapter Properties

To view general information related to the adapter, the specific functions that the adapter provides, and a history of changes that have been made to the adapter, choose Administration > Adapters > Adapter Properties . The information on the property dialog for each adapter varies.

Viewing Objects Provided by the Adapter

Each adapter provides specific functionality within Process Orchestrator. Use the Provides tab in the Administration > Adapters > Adapter Properties dialog to view the functionality that is provided by an adapter.

Getting Started Using the AMQP Adapter

Use the following process to monitor and manage Cisco AMQP instances.

Step 1 Create a Cisco AMQP target (see Defining an AMQP Broker Target).

Step 2 Define a Cisco AMQP command activity (see Automating Cisco AMQP Tasks).

Step 3 View the activity results (see Monitoring Operations).

Managing AMQP Messages

Receiving Messages Based on a Pattern

You can define policies that automatically trigger specific workflows based on certain AMQP messages.  A message-based event starts only when the message matches all of the criteria on both the Content Header and Message pages.

To create the message-based event:

Step 1 Choose AMQP Message Event Properties .

Step 2 Choose an existing queue.

Step 3 Add the message criteria and message body to the message event.

Step 4 Use an AMQP Message Event trigger to fire an event trigger based on the message that is generated.

Defining an AMQP Broker Target

Use the AMQP Broker target to configure the connection information to a vCloud Directory server to be used for process and activities to run against.

Step 1 Choose Definitions > Targets > New > AMQP Broker.

Step 2 On the General panel, enter the required information.

Step 3 On the Connection panel, specify the connection information for the AMQP broker, including:

• Host—The host name or IP address for the AMQP Broker.
• Port—The AMQP protocol port number; the default port is 5672.
• Virtual Host—The virtual host name or IP address for the AMQP Broker.
• Default runtime user—The runtime user required to execute a process or activity against this target.
• SSL enabled—Indicates if SSL is enabled on the AMQP Broker.
• Ignore certificate error— Ignore the certificate error messages when attempting to connect to the service portal.

Step 4 On the Finish panel, click Finish to complete the target definition.

Automating Cisco AMQP Tasks

Declaring an AMQP Exchange

Use the Declare Exchange activity to create or check an AMQP broker exchange.

Step 1 In the Process Editor Toolbox, choose AMQP > Declare AMQP Exchange , then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Note Exchange names must be unique within a virtual host.

Step 3 Click the Declare Exchange tab and specify the information that describes the exchange, including:

• Type— type of exchange you want to declare (see Managing AMQP Messages).
• Durable— Durable exchanges last until they are deleted. Temporary exchanges last until the server shuts-down. Not all scenarios and use cases require durable exchanges.
• Auto delete— Auto-deleted exchanges last until they are no longer used.
• Arguments—Enter the name and value pair arguments for the queue

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Declaring an AMQP Queue

Use the Declare Queue activity to create or check a queue on the AMQP broker. This activity will create a queue if the queue does not already exist.

When you declare a new queue, you can specify various properties that control the durability of the queue and its contents and the level of sharing for the queue.

Step 1 In the Process Editor Toolbox, choose AMQP > Declare AMQP Queue, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Note Message queue names must be unique within a virtual host.

Step 3 Click the Declare Queue tab and specify the information that describes the queue, including:

• Durable—Whether the queue is durable or transient. Durable queues survive broker restart whereas transient queues do not (they must be redeclared when the broker comes back online). Not all scenarios and use cases require durable queues.
• Auto delete—Delete the queue when it is empty.
• Exclusive—The queue belongs to the current connection only, and is deleted when the connection closes.
• Arguments—Enter the name and value pair arguments for the queue

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Binding an AMQP Queue to an Exchange

Use the Bind Queue activity to bind a queue to an AMQP broker exchange.

Step 1 In the Process Editor Toolbox, choose AMQP > Bind AMQP Queue, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Bind Queue tab and specify the information that describes the queue binding, including:

• Queue Name—Name of the queue you want to bind to an exchange.
• Exchange Name—Name of the exchange you want to bind to a queue.
• Routing Key—The key to be sent with the message.
• Arguments—Enter the name and value pair arguments for the queue

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Publishing a Message

Use the Publish Message activity to publish a text message to an existing exchange on the AMQP broker. The message will be routed to queues as defined by the exchange configuration and distributed when the transaction, if any, is committed.

For example, VMWare vCloud Director can publish vCloud AMQP Messages (also known as blocking tasks, notifications, or call-outs) related to different provisioning tasks. A Process Orchestrator can not only receive these events, but can respond to them to delay execution.

Step 1 In the Process Editor Toolbox, choose AMQP > Publish AMQP Message, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Publish Message tab and specify the information that describes the message to be published.

Step 4 To define the content header for the message, click Add to display the Content Header dialog box.

Step 5 Click the Message tab to define the header and body of the message. Click Add to display the Message Header dialog box.

Step 6 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Getting a Message

Use the Get Message activity to retrieve the next available message from a given queue on the AMQP broker.

Note This activity will open and close the channel to get one message; it is not designed to put it into a tight loop. This activity is considered to be a destructive way to get a message from an AMQP queue. The typical way is to subscribe to an AMQP queue.

Step 1 In the Process Editor Toolbox, choose AMQP > Get AMQP Message, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Get Message tab and specify the information that describes the message to be retrieved, including:

• No Acknowledgment Mode—If this option is checked, no acknowledgment is sent after retrieving the message. The server will auto-acknowledge the message.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Purging an AMQP Queue

Use the Purge Queue activity to remove all messages from a queue that are not awaiting acknowledgment on the AMQP broker. In the Process Editor Toolbox on the [AMQP Activity] property page, click the Purge Queue tab, then choose the queue to be purged.

Unbinding an AMQP Queue

Use the Unbind Queue activity to remove the binding between the queue and the exchange. After the binding has been removed, the queue will not receive any more messages until it is bound to another exchange.

Step 1 In the Process Editor Toolbox, choose AMQP > Unbind AMQP Queue , then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Unbind Queue tab and specify the information that describes the queue you want to unbind, including:

• Name—Name of the queue you want to unbind from an exchange.
• Exchange Name—Name of the exchange you want to unbind from a queue.
• Routing Key—The key the messages will be sent with.
• Arguments—Enter the name and value pair arguments for the queue

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Deleting an AMQP Queue

Use the Delete Queue activity to delete a queue from the AMQP broker. When a queue is deleted, any pending messages are sent to a dead-letter queue if this is defined in the server configuration, and all consumers on the queue are canceled.

Step 1 In the Process Editor Toolbox, choose AMQP > Delete AMQP Queue , then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Delete Queue tab and specify the information that describes the queue you want to unbind, including:

• Name—Name of the queue you want to delete
• Delete only if queue is not used—Indicates if queue will only be deleted if it is not used.
• Delete only if queue is empty—Indicates if queue will only be deleted if it is empty.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Argument Instance Dialog

The Argument display-only dialog box displays additional arguments given on queue declaration, including the name and value for the given key.

AMQP Message Event Instance Properties Message Tab

The Message display-only tab displays the attributes used for routing Header exchanges route messages based on message header matching.

AMQP Message Event Instance Properties, Advanced Tab

The Advanced display-only tab displays the advanced attributes used for the AMQP event.

Bind Queue

The Bind Queue display-only tab displays the defined parameters used for binding a queue to an exchange on the AMQP broker.

Content Header

The Content Header display-only tab displays the properties defined for how the AMQP message displays in the header of the message.

Declare Exchange

The Declare Exchange display-only tab displays the properties used to declare an exchange on the AMQP broker.

Declare Queue

The Delete Queue display-only tab displays the properties used to declare a queue on the AMQP broker.

Delete Queue

The Delete Queue display-only tab displays the properties used to delete a queue on the AMQP broker.

Exchange

The Exchange display-only tab displays the selected objects properties.

Get Message

The Get Message display-only tab displays the properties used to subscribe to an existing queue and fire an event trigger based on the message criteria.

Message Tab

The Message display-only tab displays the properties used to define the header and body of a message.

Publish Message

The Publish Message display-only tab displays the properties used to define the text message to an existing exchange on the AMQP broker with a routing key.

Purged Messages

The Purged Messages display-only tab displays the properties used to purge messages in a queue on the AMQP broker.

Purge Queue

The Purge Queue display-only tab displays the properties defined to purge messages in a queue on the AMQP broker.

Unbind Queue

The Unbind AMQP Queue display-only tab displays the properties used to unbind a queue from an exchange on the AMQP broker.

Getting Started Using the Microsoft Service Bus Adapter

Use the following process to monitor and manage Service Bus instances.

Step 1 Create a Microsoft Service Bus target (see Defining an Microsoft Service Bus Target).

Step 2 Define a Microsoft Service Bus activity (see Automating Microsoft Service Bus Tasks).

Step 3 View the activity results (see Monitoring Operations).

Managing Service Bus Messages

Receiving Messages Based on a Pattern

You can define policies that automatically triggers specific workflows based on certain Service Bus messages.  A message-based event starts only when the message matches all criteria on both the Content Header and Message pages.

To create the message-based event:

Step 1 Choose Service Bus Message Event Properties .

Step 2 Choose an existing queue.

Step 3 Add the message criteria and message body to the message event.

Step 4 Use an Service Bus Message Event trigger to fire an event trigger based on the message that is generated.

Defining an Microsoft Service Bus Target

Use the Microsoft Service Bus Broker target to configure the connection information to a vCloud Directory server to be used for process and activities to run against.

Step 1 Choose Definitions > Targets > New > Microsoft Service Bus.

Step 2 On the General panel, enter the required information.

Step 3 On the Connection panel, specify the connection information for the Microsoft Service Bus broker, including:

• Namespace—The container of queues, topics with subscriptions for the Service Bus.

Note You can create 1 or more namespace, when you register in the Microsoft Service Bus portal.

• Service Bus Windows Server — Enter the following information:

– Server — Enter the host name or IP address.

– Runtime Port — Enter the Runtime port number. By default it is 9354.

– Management Port — Enter the Management Port number. By default it is 9355.

• Shared access key—Enter the access key of the account.
• Connection String — Displays the string information about the data source.

Step 4 Click Ok to complete the target definition.

New Shared Access Key Properties

Use the New Shared access key properties to create an access key for the service bus.

Step 1 Choose Definitions > Targets > New > Microsoft Service Bus.

Step 2 On the Connection panel, choose New > Shared Access Key .

Step 3 Enter the Shared access key name and Shared access key for the Service Bus.

Step 4 Click Ok to complete the key properties definition.

Automating Microsoft Service Bus Tasks

Sending a Message

Use the Send Message activity to publish a text message to an existing exchange on the Service Bus broker. The message is routed to queues as defined by the exchange configuration and distributed when the transaction, if any, is committed.

Step 1 In the Process Editor Toolbox, choose Microsoft Service Bus > Send Message, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Publish Message tab and specify the information that describes the message to be published.

You can either use the Queue name or Topic name.

Step 4 To define the content header for the message, click Add to display the Content Header dialog box.

Step 5 Click the Message tab to define the header and body of the message. Click Add to display the Message Header dialog box.

Step 6 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

For more detail on Microsoft Service Bus, see Microsoft Service Bus Adapter

Getting a Message

Use the Get Message activity to retrieve the next available message from a given queue.

Step 1 In the Process Editor Toolbox, choose Microsoft Service Bus > Get Message, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Get Message tab and specify the information that describes the message to be received.

You can either use the Queue name or Subscription name.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

For more detail on Microsoft Service Bus, see Microsoft Service Bus Adapter

Defining a Cloud Center Target

Use the Cloud Center Target to configure the connection information to the Cloud Center server.

Step 1 Choose Definitions > Targets > New > Cloud Center Server .

Step 2 On the General panel, enter the required information.

Step 3 On the Connection panel, specify the following connection information:

• Server name—Enter the Server name for the cloud center.

Note The server name is the property of the target which contains the host part of the URI - a registered name or an IP address.

For more information, see https://en.wikipedia.org/wiki/Uniform_Resource_Identifier

• Port—Enter the port number (default is 443). You can enter values from 1 to 65535.
• Ignore Secure Socket Layer (SSL) certificate error—Check the check box to ignore the SSL certificate error.

Note You can ignore certificate chain errors only, which is useful to test against the servers with self-generated certificates, without importing the certificates on the client machine.

• Runtime user—Select the Runtime user from the drop–down list or choose New to create a New Cloud Center Manage API Access Key.
• Optional: AMQP Target—Select the appropriate target from the drop–down list.
  The list displays AMQP configuration from the Cloud Center, in order to use the Cloud Center trigger you need to select a AMQP target. This will help you monitor actions like Create, Update, or Delete on any service like User, Tenant, or Cloud.

Step 4 Click OK , to create the connection.

New Cloud Center API Access Credentials Properties

Use the New Cloud Center API Access Credentials properties to create an access credentials for the Cloud Center.

Step 1 Choose Definitions > Targets > New > Cloud Center Server.

Step 2 On the Connection panel, choose New > Cloud Center API Access Credentials .

Step 3 Enter the User name for the Cloud Center.

Step 4 Check the API Key check box, and enter the API key.

Step 5 Click OK to complete the key properties definition.

Execute Cloud Center Command

Use the Execute Cloud Center Command activity to execute Cloud Center API command against a Cloud Center server. The Cloud Center activity provides a flexible way to perform the desired action using the request methods. Responses for common information are scanned and displayed as activity results in the Operations Workspace activity instance view.

Step 1 In the Process Editor Toolbox, choose CloudCenter > Execute Cloud Center Command , then drag and drop the activity onto the workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Request tab and specify the following information:

• Path — Enter the Relative URI part of the request.

For example:

For more information, see http://docs.cliqr.com/display/40API/Base+URI+Format.

• Method — Select the required Method from drop–down list:

– GET — To query or view the server information based on a CloudCenter deployment.

– PUT — To replace the entire object for update operations.

– POST — To perform a CloudCenter platform task or creating the resource.

– DELETE — To remove specific aspects of the CloudCenter deployment.

Note The CloudCenter APIs use HTTPS Version 1 to support these request methods.

For more information on HTTPS request methods see, http://docs.cliqr.com/display/40API/HTTPS+Request+Methods

• Content Type — Select the required Content type from the drop–down list. Values are:

– JSON

– XML

• HTTP Message Body — You can send a message body with following methods. Values are:

– PUT

– POST

– DELETE

Note GET request is not sent as part of the request and hence cannot have an HTTP message body.

• Timeout — Check the check box and then enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Cloud Center Response

The Response tab displays the properties of the HTTP Response received from the API call.

• HTTP Status Code — Displays the Status code of the response. This may indicate whether a request is success or failure.

The Cloud Center API can only return a limited set of HTTP status codes. For more information on HTTP Status codes, see http://docs.cliqr.com/display/40API/CloudCenter+API+Overview#CloudCenterAPIOverview-HTTPStatusCodes.

• HTTP Reason Phrase — Displays the HTTP reason phrase for the process activity.
• HTTP Message Body — Displays the HTTP message body in JSON or XML.

For more information on HTTP response message see, https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Response_message

Prerequisites

Installing Remedy client C API Library Files

The Remedy adapter requires the Remedy client C API libraries to be installed in order to communicate with Remedy servers. Before you can create a Remedy Server target, the dll files must be installed on the Cisco Process Orchestrator server.

Step 1 Download the API zip file from the BMC community site (see https://communities.bmc.com/docs/DOC-33310 ).

Step 2 From the folder where the dll files are extracted, locate the following files:

• arapi81_build001_win64.dll
• arrpc81_build001_win64.dll
• arutl81_build001_win64.dll
• arxmlutil81_build001_win64.dll
• icudt32.dll, icuinbmc32_win64.dll
• icuucbmc32_win64.dll

Step 3 Copy the files to the following folder on the Orchestrator server:

<Install drive>:\Program Files\Cisco\Process Orchestrator\Adapters\Remedy

Step 4 Verify the properties of the dll files and unlock them, if necessary.

Getting Started Using the Remedy Adapter

Use the following process to monitor and manage Cisco BMC Remedy instances.

Step 1 Create a Cisco Remedy target (see Defining a Remedy Server Target).

Step 2 Define BMC Remedy activities:

a. In the Process Editor Toolbox, choose BMC Remedy > [BMC Remedy Activity], then drag and drop the activity onto the Workflow pane.

b. Click the General tab and enter the required information.

c. Click the [Activity-Specific] tabs to define the properties specific to the activity.

d. Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

For details about a specific activity, see Managing Remedy Tasks.

Step 3 View the activity results (see Monitoring Operations).

Defining a Remedy Server Target

Use the Remedy Server target to specify the connection information to a Remedy server which is used for processes to run against. Define the Remedy target before attempting to define any Remedy activities. The Remedy target accesses the list of properties on the Remedy server.

Step 1 Choose Definitions > Targets , right-click, and choose New > Remedy Server.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Connection tab to specify the connection information to a Remedy server, including:

• Remedy Server Name—Host name or the IP address of Remedy server
• Port—Port number used to access the Remedy server (Default: 0)

Step 4 Click the Polling tab to configure the frequency in which Process Orchestrator queries a Remedy system.

Step 5 Click OK to close the dialog box and complete the procedure.

Managing Remedy Tasks

Creating a Remedy Entry

Use the Create Remedy Entry activity to create an entry in any Remedy form.

Before You Begin

A Remedy server must be installed and accessible. For installation information, see the BMC Remedy documentation.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Create Remedy Entry, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 On the Entry tab, specify the form properties and associated values to be used to create a Remedy entry, then click Add .

• Form Name—Enter the name of the form containing the entry properties.

Step 4 In the Select Properties box, choose the Remedy server from which the properties will be added to the entry.

Step 5 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Initiating an Incident Request Review

Before You Begin

A Remedy server must be installed and accessible. For installation information, see the BMC Remedy documentation.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Create Remedy Incident, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Incident tab, then specify the properties and associated values to be used to create a Remedy incident.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Creating a Relationship Between an Incident Request and a Problem

Use the Create Remedy Relationship activity to create a relationship between an incident request and a problem (Remedy does this automatically when a problem investigation is created from an incident request). You can use this activity to create the following types of relationships:

• Incident -> Configuration item
• Incident -> Incident
• Configuration -> Incident
• Configuration -> Configuration

Note Because of operations outside of Process Orchestrator control, such as power failure or network outage, only one side of the relationship can be created by the Create Remedy Relationship activity.

Before You Begin

A Remedy server must be installed and accessible. For installation information, see the BMC Remedy documentation.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Create Remedy Relationship, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Item 1 or Item 2 tab to continue and select the appropriate item to configure the relationship properties.

• Item Type—From the drop-down list, select the appropriate item to configure the relationship properties.

– Incident—See Configuring Relationship Incident Properties.

– Configuration—See Selecting an Association Type.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Adding Properties to a Remedy Activity

When configuring the activity properties, you might be required to add properties to the activity. Sort the properties list by the column Type so that all of the required fields for your system are displayed at the top of the list.

The Select Properties dialog box is launched when the Add button on the activity-specific property page is clicked. Use the Select Properties dialog box to specify the incident properties for the activity.

Step 1 On the activity-specific property page tab, click Add .

Step 2 From the Add properties from the following server drop-down list, select the appropriate server from the drop down list.

Step 3 Highlight the appropriate incident properties, then click OK .

Step 4 On the Edit Property dialog box, assign a value to the incident property.

Step 5 Repeat Step 2 through Step 4 to add additional incident properties to the activity.

Configuring Relationship Configuration Item Properties

Use the following steps to define the configuration item properties on the Create Remedy Relationship activity.

Step 1 Click the appropriate Item tab, then choose Item Type > Configuration Items.

Step 2 Complete the following configuration item fields, then click Save:

• Reconciliation ID—Enter the reconciliation ID of the Remedy configuration item.
• Configuration item form name—Enter the name of the form containing the configuration properties.
• Association type—Enter the type of incident property to associate with the Remedy item (see Selecting an Association Type).
• Request description—Enter a description to associate with the incident or configuration item. For example, this could be the name of the item or the name of the related item.

Viewing Results

Click the Item display-only tabs to view the properties of the activity.

• Reconciliation ID—reconciliation ID of the Remedy configuration item
• Configuration item form name—name of the form containing the configuration properties
• Association type—type of incident property to associate with the Remedy item
• Request description—description associated with the incident or configuration item.

Adding Incident Properties to a Remedy Trigger

When configuring a Remedy trigger, you can add incident properties to the trigger which can then be used as additional criteria to monitor for incidents. Sort the properties list by the column Type so that all of the required fields for your system are displayed at the top of the list.

The Select Properties dialog box is launched when the Add button on the Incident Update Criteria tab is clicked. Use the Select Properties dialog box to specify the incident properties for the trigger.

Before You Begin

A Remedy server must be installed and accessible. For installation information, see the BMC Remedy documentation.

Step 1 Choose the Incident Update Criteria tab, click Add , then choose Wildcard match or Exact match .

Step 2 On the Remedy Incident Updated Properties dialog box, select the incident update type, click Add , then select the appropriate server from the drop down list. The Remedy server incident properties display in the columns.

Step 3 Highlight the appropriate incident properties, then click OK.

Step 4 Assign a value to the incident property, then click OK.

Adding a New Work Info Entry to an Existing Remedy Property

Use the Create Remedy Work Info activity to add general notes about the current record, such as the date a particular configuration item was deployed, or vendor-related notes, such as a bulletin sent from a vendor.

This activity can be used to add attachments, such as files and customer emails to the work info property. For information on adding attachments to the activity, see Attaching a File to a Remedy Activity.

Before You Begin

A Remedy server must be installed and accessible. For installation information, see the BMC Remedy documentation.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Create Remedy Work Info, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Work Info tab and modify the list of Remedy work info properties. For information about adding attachments to the activity, see Configuring Relationship Incident Properties.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Deleting a Remedy Entry

Use the Delete Remedy Entry activity to remove entries, such as relationships, work log entries, or custom entries from a Remedy item.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Delete Remedy Entry, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Entry tab and enter:

• Form Name—Enter the name of the form containing the entry properties.

Click Browse to launch the Select a Form dialog box to select the form containing the entry properties to be removed by the activity.

• Entry ID—ID number of the Remedy

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Finding Remedy Objects

Use the Find Remedy Objects activity to query objects, configuration items, and other assets in order to create relationships. It can also be used to find any entry on a Remedy server.

All Cisco Process Orchestrator Remedy activities are based on forms which can be customized by the user. This may cause user misunderstanding as to whether the fields on the forms are required or optional.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Find Remedy Entry, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Criteria tab and enter:

• Form Name—Enter the name of the form containing the entry properties.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Get Remedy Entry Property Values

Use the Get Remedy Entry Property Values activity to retrieve property values for a specific entry on a Remedy server. If the entry ID is known, then this activity may be a better alternative than the Find Remedy Objects activity which allows a broader set of parameters.

All Cisco Process Orchestrator Remedy activities are based on forms which can be customized by the user. This may cause user misunderstanding as to whether the fields on the forms are required or optional.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Get Remedy Entry Property Values, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Entry tab and enter:

• Form Name—Enter the name of the form containing the entry properties.

Click Browse to launch the Select a Form dialog box to select the form containing the entry properties to be removed by the activity.

• Entry ID—Enter the Remedy entry ID number or click the Reference tool to select the appropriate Remedy entry value to be retrieved.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

The Properties to Get box displays the list of Remedy properties to be retrieved by the activity.

Get Remedy Incident Property Values

Use the Get Remedy Incident Property Values activity to retrieve property values for a specific incident on a Remedy server. If the incident ID is known, then this activity may be a better alternative than the Find Remedy Objects activity which allows a broader set of parameters.

All Cisco Process Orchestrator Remedy activities are based on forms which can be customized by the user. This may cause user misunderstanding as to whether the fields on the forms are required or optional.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Get Remedy Incident Property Values, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Incident Property Values tab and enter:

• Incident ID—Enter the Remedy incident number or click the Reference tool to select the appropriate Remedy incident values to be retrieved

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

The Properties to Get box displays the list of Remedy properties to be retrieved by the activity.

Defining an Update Remedy Entry Activity

Use this activity to update the entries in a specific Remedy form, or to update the properties in a Work Info or Relationship entry.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Update Remedy Entry, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Entry tab and enter:

• Form Name—Enter the name of the form containing the entry properties.
• Entry ID—Enter the Remedy entry ID number or click the Reference tool to select the appropriate Remedy entry value to be retrieved.
• Properties to update—See Adding Properties to a Remedy Activity

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining an Update Remedy Incident Activity

Use this activity to update the properties for a specific Remedy incident.

Step 1 In the Process Editor Toolbox, choose BMC Remedy > Update Remedy Incident, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Incident tab and enter:

• Incident ID—Enter the Remedy incident number or click the Reference tool to select the appropriate Remedy incident values to be retrieved
• Properties to update—See Adding Properties to a Remedy Activity

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Selecting a Remedy Form

Use the Select a Form dialog box to select the form containing the properties to be added to a Remedy activity. Activities requiring entry IDs will contain the option to locate the appropriate form on the Remedy server.

Step 1 On the Remedy entry activity tab, click Browse .

Step 2 From the Add a form from the following Remedy Server drop-down list, select the appropriate Remedy server target defined in Process Orchestrator. The displayed forms depend on the server that is selected.

Step 3 From the Selected form list, select the appropriate form containing the available properties to add to the Remedy entry. Only one form can be selected at a time.

Step 4 Click OK to select the Remedy form.

Configuring Relationship Incident Properties

Use the following steps to configure the incident properties on the Create Remedy Relationship activity.

Step 1 Click the appropriate Item tab, then choose Item Type > I ncident.

Step 2 Complete the following incident fields, then click Save:

• Incident ID—Enter the Incident ID number of the Remedy incident.
• Association type—Enter the type of incident property to associate with the Remedy item (see Selecting an Association Type).
• Request description—Enter a description to associate with the incident or configuration item. For example, this could be the name of the item or the name of the related item.

Selecting an Association Type

Use the Select a Property Value dialog box to select the appropriate values to associate the relationship with the Remedy item.

Step 1 On the Remedy activity tab, click Browse.

Step 2 From the Select the property value using the Remedy Server drop-down list, select the appropriate Remedy server target defined in Process Orchestrator. The displayed fields depend on the selected Remedy server.

Step 3 From the Selected field value list, select the appropriate fields containing the available properties to add to the Remedy relationship.

Step 4 Click OK to select the Remedy field.

Attaching a File to a Remedy Activity

Use the following steps to attach a file to a Remedy activity. When attaching a file to a Remedy activity, the file path should be a local path accessible on the Process Orchestrator server machine or a network share path.

Note If an attachment is present in the activity, a Windows user must be specified.

Step 1 On the appropriate Remedy activity property page, click the Credentials tab to specify the Windows runtime user for the remedy activity.

Step 2 Check the Use the following credentials for Remedy attachments check box, then specify the credentials to be used to access the attachment.

To view the properties for the selected runtime user, click the Properties icon. To create a runtime user record for the process, click New > [Runtime User] .

Step 3 Click the Remedy activity-specific tab, then click Add .

Step 4 From the Add properties from the following server drop-down list, select the appropriate server.

Step 5 Scroll to the property labeled Attachment , or sort by the Data Type Attachment , and click OK .

When attaching multiple files, use the Attachment property labeled by number (for example, Attachment 1, Attachment 2).

Step 6 In the Attachment field, enter the path to the appropriate file.

Step 7 Click OK to save the attachment to the Remedy activity property and return to the Remedy object tab.

Instance Properties

Create Remedy Entry

The Entry display-only tab displays the properties used to add an entry on a Remedy incident.

• Form Name—Name of Remedy form containing the entry properties used for selection by the Create Remedy Entry activity.

The following columns display the list of properties added to the Create Remedy Entry activity.

• Name—Name of the property
• ID—ID number of the Remedy property
• Label—Label of the property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Create Remedy Entry Results

The Results display-only tab displays the number created by the remedy entry activity.

• Entry ID— New ID number of the newly created Remedy entry

Create Remedy Incident

The Incident display-only tab displays the list of properties added to the Create Remedy Incident activity.

• Name—Name of the Remedy property
• Label—Label of the Remedy property
• Value—Value assigned to the Remedy property
• ID—Incident ID of the property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Create Remedy Incident Results

The Results display-only tab displays the incident number created by the remedy incident activity

• Incident ID—New ID number of the newly created Remedy incident

Create Remedy Relationship, Configuration

The Item display-only tab displays the properties used to configure relationships between incidents and configuration items.

• Item Type—Selected item used to configure the relationship properties
• Reconciliation ID—ID of the Remedy configuration item
• Configuration item form name—Name of the form containing the configuration properties associated with the activity
• Association type—Type of configuration property to associate with the Remedy item
• Request description—Description associated with the incident or configuration item

The following columns display the list of Remedy properties added to the item.

• Name—Name of the Remedy property
• Label—Label of the Remedy property
• Value—Value assigned to the Remedy property
• ID—ID number of the Remedy item
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Create Remedy Relationship, Incident

The Item display-only tab displays the properties used to configure relationships between incidents and configuration items.

• Item Type—From the drop-down list, select the appropriate item to configure the relationship properties.
• Incident ID—Incident ID number of the Remedy incident
• Association type—Type of incident property to associate with the Remedy item
• Request description—Description associated with the incident or configuration item

The following columns display the list of Remedy properties added to the incident.

• Name—Name of the Remedy property
• Label—Description of the Remedy property
• Value—Value assigned to the Remedy property
• ID—ID number of the Remedy property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Create Remedy Relationship, Item

The Item display-only tab displays the properties used to configure relationships between incidents and configuration items.

• Item Type—Selected item assigned to the relationship properties

– Incident

– Configuration

Create Remedy Relationship Results

The Results display-only tab displays the ID numbers assigned to the newly-linked items.

• Forward link ID—ID number assigned to the first item in the Remedy item relationship
• Back link ID—ID number assigned to the second item in the Remedy item relationship

Create Remedy Work Info

The Work Info display-only tab displays the list of properties added to the Create Work Info activity.

• Name—Name of the property
• ID—ID number of the Remedy work info property
• Label—Value assigned to the work info property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Create Remedy Work Info Results

The Results display-only tab displays the number created by the Create Remedy Work Info activity.

• Work Info ID—New ID number of the newly created Remedy work info entry

Delete Remedy Entry

The Entry display-only tab displays the properties used to remove an entry from a Remedy item.

• Form Name—Name of the form containing the entry properties
• Entry ID—ID number of the Remedy entry

Find Remedy Objects

The Criteria display-only tab displays the properties and entries used to query Remedy objects on a Remedy server.

• Name—Name of the Remedy property
• Label—Description of the Remedy entry
• Value—Value assigned to the Remedy entry
• ID—ID number of the Remedy property

Find Remedy Objects, Results

The Results display-only tab displays the matching properties and entries retrieved by the activity.

• Results—Displays the list of matching Remedy properties

Get Remedy Entry Property Values

The Entry display-only tab displays the properties used to retrieve property values of a Remedy entry.

• Form Name—Name of the form containing the entry properties
• Entry ID—Remedy entry ID number

The following columns display the list of properties queried by the activity.

• Name—Name of the Remedy property
• Label—Description of the Remedy property
• ID—Entry ID of the Remedy property

Get Remedy Entry Property Values, Results

The Results display-only tab displays the list of values for the properties retrieved by the activity.

• Name—Name of the Remedy entry
• Id—ID number for the Remedy property
• Value—User-modified property values
• Raw Value—Raw value for the entry retrieved by the activity

Get Remedy Incident Property Values

The Incident Property Values display-only tab displays the properties used to retrieve property values of a Remedy incident.

• Incident ID—Remedy incident number used to retrieve the incident properties

The following columns display the list of properties queried by the activity.

• Name—Name of the Remedy incident property
• Label—Description of the Remedy incident
• ID—Incident ID of the incident property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Get Remedy Incident Property Values, Results

The Results display-only tab displays the list of values for the properties retrieved by the activity.

• Name—Name of the Remedy incident
• Id—ID number for the Remedy property
• Value—User-modified property values
• Raw Value—Raw value for the incident (case) state retrieved by the activity

Update Remedy Entry

The Entry display-only tab displays the properties used to update the properties of a Remedy entry.

• Form Name—Name of the form containing the entry properties
• Entry ID—Remedy entry ID number

The following columns display the list of properties updated by the activity.

• Name—Name of the Remedy property
• Label—Description of the Remedy property
• ID—Entry ID of the Remedy property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Update Remedy Incident

The Incident Property Values display-only tab displays the properties used to retrieve property values of a Remedy incident.

• Incident ID—Remedy incident number used to retrieve the incident properties

The following columns display the list of properties updated by the activity.

• Name—Name of the Remedy incident property
• Label—Description of the Remedy incident
• ID—Incident ID of the incident property
• Data Type—Type of Remedy property

– Display

– Optional

– Read-Only

– Required

Element Descriptions

Select Remedy Properties Dialog Box

Use the Select Properties dialog box to select the properties from a Remedy server target defined in Cisco Process Orchestrator to add to the list. The displayed properties depend on the server selected.

To select multiple properties, press CTRL and hold the key while making the appropriate selections. When completed selecting properties, click OK.

Getting Started Using the Prime Service Catalog Adapter

Use the following process to monitor and manage Cisco Prime Service Catalog instances.

Step 1 Create a Cisco Prime Service Catalog target (see Defining a Cisco Prime Service Catalog Server Target).

Step 2 Define a Cisco Prime Service Catalog command activity (see Automating Cisco Prime Service Catalog Adapter Activities).

Step 3 View the activity results (see Monitoring Operations).

Configuring the Service Catalog Server Adapter Reconnection Properties

Use the Retry tab to enter the default time period for all Cisco Prime Service Catalog activities to retry to connect to the Service Catalog whenever there are connection failures. This allows the activity to resume running if the Cisco Prime Service Catalog is temporarily unavailable and the running activity was terminated.  

To configure the default reconnection time frame:

Step 1 Choose Administration > Adapters > Cisco Prime Service Catalog Adapter , right-click and choose Properties.

Step 2 Click the Retry tab and complete the following reconnection fields:

• Retry time period (minutes)—Enter the number of minutes Process Orchestrator should attempt to connect to the Cisco Prime Service Catalog. (Default: 15 minutes)
• Retry frequency (seconds)—Enter the number of seconds to determine the frequency Process Orchestrator should retry connecting to the Cisco Prime Service Catalog. (Default: 30 seconds)

Defining a Cisco Prime Service Catalog Server Target

Use the Cisco Prime Service Catalog Server (PSC) target to connect to the Cisco Prime Service Catalog and Request Center services. Process Orchestrator will connect the target to the appropriate service based on the activity that attempts to execute.

Step 1 Choose Definitions > Targets , right-click, and choose New > Cisco Prime Service Catalog Server.

Step 2 On the General panel, enter the appropriate information.

Step 3 On the Connection panel, enter the appropriate information, including:

• Service Link port—Port number used to access the service link port server (Default: 6080)
• Request Center port—Port number used to access the request center port (Default: 6080)
• Access Cisco Prime Catalog via Secure Socket Layer (SSL)—If checked, the connection to the Cisco Prime Catalog server will run on the SSL port.
• Ignore Secure Socket Layer (SSL) certificate error—Check this check box to indicate the target should ignore certificate errors when attempting to connect to the service portal.
• Public key GUID—Optional. The GUID of the external encryption key that is used to encrypt the data sent from Cisco Prime Service Catalog to Process Orchestrator via AMQP. This GUID is generated in the Prime Service Catalog server when user configures external encryption keys for AMQP.

Note The Public key GUID information is configured in Cisco Prime Service Catalog Server. This information is entered only when you use Cisco Prime Service Catalog and AMQP features. It is also used to fetch the broker information via PSC nsAPI.

Step 4 Verify the information on the Completing the New Cisco Prime Service Catalog Server Wizard panel and click Finish to close the wizard.

Automating Cisco Prime Service Catalog Adapter Activities

Defining the Create Service Item Activity

Use the Create Service Item activity to create a service item to be delivered in response to a service request. A service item may be a virtual machine type or a user-defined type in the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Create Service Item and drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Service Item tab and enter the following information:

• Service item type—Enter the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined item.
• Service item name—Enter the unique name for the service item.
• Channel id—Enter the identifier that uniquely identifies each Service Link task (for example, 82fdbbaf-3310-4156-a4ae-173b9f15e07c).
• Timeout—Enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 4 Modify the list of attributes to be used to create the service item. The attribute properties provide additional data used to create service item.

• Add—Click this button to add a attribute properties pane to the service item. Select one of the following options for adding a attribute.

– Manual attribute—Click this button to add a Properties pane to the Service Item tab. After the pane displays on the tab, click the appropriate to modify the list of properties for the attribute. See Adding a Service Item Attribute.

– Browse for attributes—Click this button to launch the Add Attributes dialog box to search for a attribute on a Cisco Prime Service Catalog server.

• Remove—Click the area around the appropriate attribute properties, then click this button to remove the last set of attribute properties from the service item.

Step 5 Click the Subscription tab to specify the service item owner's login information to be used when connecting to the Cisco Prime Service Catalog. The login ID and organizational unit information must match.

Step 6 Click the Retry tab to enter the default time period for the activity to retry to connect to the Service Catalog if there is a connection failure. This allows the activity to resume running if the Cisco Prime Service Catalog is temporarily unavailable and the running activity was terminated.  

The properties entered on this tab override the time period configured on the adapter level.

• Retry on connection failures—Check this check box to indicate the activity should retry to connect to the service portal if there is a connection failure.

If the check box remains unchecked, then activity will fail if there is a connection failure.

• These fields are automatically populated with the default settings defined in the Cisco Prime Service Catalog adapter.

– Time period (minutes)—Clear the field to manually update the time period for when the activity should retry to connect to the Cisco Prime Service Catalog. (Default: 15 minutes)

– Frequency (seconds)—Clear the field to manually to determine the frequency in which Process Orchestrator should retry connecting to the Cisco Prime Service Catalog. (Default: 30 seconds)

Step 7 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Complete Service Request Activity

Use the Complete Service Request activity to notify Service Catalog that the process is complete. The required Task ID is provided in the AMQP message that initiated the process.

Step 1 On the Toolbox, choose Cisco Prime Service Catalog > Complete Service Request and drag and drop the activity onto the Workflow pane.

Step 2 Click the Service Request tab to specify the following properties:

• Task ID—provided in the AMQP message that initiated the process
• Timeout—Check the check box and then enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

• Action—action that can be used with this nsAPI call

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Create Service Item from Table Activity

Use the Create Service Items from Table activity to create multiple service items using a table variable to be delivered in response to a service request in the Cisco Prime Service Catalog.

The table variable should include the service names and values that correspond to the attribute names in the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Create Service Items from Table and drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Service Item tab and enter the following information:

• Service item type—Enter the type of physical or virtual asset for the service item.
• Table variable— Click the Reference tool to query a table variable to be used for the service item. The table must contain a column type for each property being created on the corresponding service item.

For example, the table might contain the following columns for a virtual machine:

Name / IP Address / Host / Memory / DiskSpace

To create multiple VMs from the table, add several rows for the table with the above column values defined.

• Channel id—Enter the identifier that uniquely identifies each Service Link task.
• Timeout—Enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 4 Click the Subscription tab to specify the service item owner's login information to be used when connecting to the Cisco Prime Service Catalog. The login ID and organizational unit information must match.

Step 5 Click the Retry tab to enter the default time period for the activity to retry to connect to the Service Catalog if there is a connection failure. This allows the activity to resume running if the Cisco Prime Service Catalog is temporarily unavailable and the running activity was terminated.  

Step 6 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Delete Service Item Activity

Use the Delete Service Item activity to delete an existing service item in the Cisco Prime Service Catalog.

Step 1 On the Toolbox, choose Cisco Prime Service Catalog > Delete Service Item and drag and drop the activity onto the Workflow pane.

Step 2 Enter the service item properties (see Defining the Create Service Item Activity). Enter the unique name for the service item.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Delete Service Item from Table Activity

Use the Delete Service Items from Table activity to delete multiple service items using a table variable in the Cisco Prime Service Catalog.

The table variable should include the service names and values that correspond to the attribute names in the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Delete Service Items from Table and drag and drop the activity onto the Workflow pane.

Step 2 Enter the service item properties (see Defining the Create Service Item from Table Activity).

The table must contain a “Name” column. This column must contain the uniquely named items that are to be deleted.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Find Service Item Activity

Use the Find Service Item activity to search for attribute properties for the service item.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Find Service Item and drag and drop the activity onto the Workflow pane.

Step 2 Click the Advanced tab to define the service items you want to retrieve.

• Get all matching items—Select this option to retrieve all matching service items
• Get specified row— Start row—enter the row properties you want to retrieve the service item from
• Maximum items to return—enter the number of service items to retrieve

Step 3 Click the Service Item tab to search for attribute properties for the service item.

• Service item type—Enter the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Timeout—Enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 4 Modify the list of Search criteria to be used to find service item.

a. Add—Click this button to add a attribute properties pane to the find service item. Select one of the following options for adding a search criteria.

• Manual search criteria—Click this button to add a Properties pane to the Service Item tab. After the pane displays on the tab, click the appropriate to modify the list of properties for the search criteria for the service item type you want to find.

– Attribute—Enter the attribute name to be added to the service item

– Data Type—From the drop-down list, select the data type for the service item.

Boolean

String

Numeric

Date and Time

– Value—Enter the attribute value to be added to the service item

• Browse for search criteria—Click this button to launch the Add Attributes dialog box to search for a attribute on a Cisco Prime Service Catalog server.

b. Remove—Click the area around the appropriate attribute properties, then click this button to remove the last set of attribute properties from the service item.

Step 5 Modify the list of associated attributes to get to be used to find service item.

a. Add—Click this button to add a attribute properties pane to the service item. Select one of the following options for adding a attribute.

• Manual attribute—Click this button to add a Properties pane to the Service Item tab. After the pane displays on the tab, click the appropriate to modify the list of properties for the attribute.

– Attribute name—Enter the attribute name to find service item. Click the Reference tool to browse for the correct variable reference property for the service item.

– Data type—From the drop-down list, select the data type for the service item (such as Boolean, String, Numeric, Date and Time).

• Browse for attributes—Click this button to launch the Add Attributes dialog box to search for a attribute on a Cisco Prime Service Catalog server.

b. Remove—Click the area around the appropriate attribute properties, then click this button to remove the last set of attribute properties from the service item.

Step 6 Click the Subscription tab to define the subscriber, or current owner of the service item, properties.

• Subscriber login id—The unique ID assigned to the current owner of the service item
• Subscriber OU—The organizational unit to which the subscriber belongs
• Include subscriber information in results—Indicates the subscriber information is included in the results retrieved.

Step 7 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Get Service Item Activity

Use the Get Service Item activity to retrieve attribute properties for the service item.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Get Service Item and drag and drop the activity onto the Workflow pane.

Step 2 On the Service Item tab, enter the service item properties.

• Service item type—Enter the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Service item name—Enter the name of the service to be ordered.

For example:

Order a Virtual Machine

-or-

Start User Provisioning Process

• Timeout—Enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 3 Modify the list of associated attributes to get to be used to get service item.

a. Add—Click this button to add a attribute properties pane to the service item. Select one of the following options for adding a attribute.

• Manual attribute—Click this button to add a Properties pane to the Service Item tab. After the pane displays on the tab, click the appropriate to modify the list of properties for the attribute.

– Attribute name—Enter the attribute name to get service item. Click the Reference tool to browse for the correct variable reference property for the service item.

– Data type—From the drop-down list, select the data type for the service item (such as Boolean, String, Numeric, Date and Time).

• Browse for attributes—Click this button to launch the Add Attributes dialog box to search for a attribute on a Cisco Prime Service Catalog server.

b. Remove—Click the area around the appropriate attribute properties, then click this button to remove the last set of attribute properties from the service item.

Step 4 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Delete Service Item from Table Activity

Use the Delete Service Items from Table activity to delete multiple service items using a table variable in the Cisco Prime Service Catalog.

The table variable should include the service names and values that correspond to the attribute names in the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Delete Service Items from Table and drag and drop the activity onto the Workflow pane.

Step 2 Enter the service item properties (see Defining the Create Service Item from Table Activity).

The table must contain a “Name” column. This column must contain the uniquely named items that are to be deleted.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Get User Information Activity

Use the Get User Information activity to retrieve the properties of a specified user.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Get User Information and drag and drop the activity onto the Workflow pane.

Step 2 Click the User tab to enter the user properties.

• User name—Enter the user name for the user account properties to be retrieved.
• Timeout—Check the check box and then enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Report Requisition Status Activity

Use the Report Requisition Status activity to report the execution status of the service request on the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Report Requisition Status and drag and drop the activity onto the Workflow pane.

Step 2 Click the Requisition Status tab to enter the task properties.

• Channel ID—Enter the unique Channel ID of the service that is created in the Cisco Prime Service Catalog.
• Parent Task name—Enter the name of the task that is parent of the current task.
• Task name—Enter the name for the task.
• Status—Select the status from the drop–down:

– In-Progress

– Succeeded

– Failed

Step 3 Click Save to complete the activity definition.

For example:

The following Create Site Branch Operation shows Report requisition status node added to different places of the workflow to report the progress to Cisco Prime Service Catalog (PSC) with reference to the Channel ID mentioned in the activity, here in this process the tasks such as device configuration, create site, and configure IWAN links is performed.

• Initially the device configuration is performed in this workflow, during this process the status is reported as In-progress in PSC for the activity.
• Once the device configuration is completed, the report is sent to the PSC with status succeeded.
• After the device is configured the Create Site is performed, during this process the status is reported as In-progress in PSC for the activity.
• Once the site is created, the report is sent to the PSC with status succeeded.
• After the Site is created the Configure IWAN Links is performed in this workflow, during this process the status is reported as In-progress in PSC for the activity.
• Once the IWAN links are configured, the report is sent to the PSC with status succeeded.

Once the process is succeeded the status is updated as Complete for the service request created in Cisco Prime Service Catalog.

Defining the Submit Service Request Activity

Use the Submit Service Request activity to submit a request for a service order on the Cisco Prime Service Catalog. In this activity, users can add multiple dictionaries to the service request manually or by browsing for an existing dictionary on a target.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Submit Service Request and drag and drop the activity onto the Workflow pane.

Step 2 Click the Service Request tab to specify the name of the service to be ordered. For example:

• Order a Virtual Machine
• Start User Provisioning Process

Step 3 Modify the list of dictionaries to be used to support the service request. The dictionary properties provide additional data used to request a service and/or fulfill the service request.

• Add—Click this button to add a dictionary properties pane to the service request. Select one of the following options for adding a dictionary.

– Manual dictionary—Click this button to add a Properties pane to the Service Request tab. After the pane displays on the tab, click the appropriate to modify the list of properties for the dictionary. See Manually Adding a Dictionary.

– Browse for dictionary—Click this button to launch the Add Dictionaries dialog box to search for a dictionary on a Cisco Prime Service Catalog server.

• Remove—Click the area around the appropriate dictionary properties, then click this button to remove the last set of dictionary properties from the service request.

Step 4 Click the Advanced tab to provide default customer login information for the requestor. The information defined on this tab will override the runtime user selected on the Credentials tab.

• Customer login name—Enter the log in name for the customer of the service being requested.
• Initiator login name—Enter the log in name of the person initiating the request for the service.
• Quantity—Enter the quantity needed for the service request. (Default: 1)
• Bill to OU—Enter the organizational unit to be billed for the service request.

Step 5 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Update Service Item Activity

Use the Update Service Item activity to update the attributes for an existing service item on the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Update Service Item and drag and drop the activity onto the Workflow pane.

Step 2 Click the appropriate tabs and update the service item properties as necessary. For details, see Defining the Create Service Item Activity.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Update Service Item from Table Activity

Use the Update Service Items from Table activity to update multiple service items using a table variable in the Cisco Prime Service Catalog. The table variable should include the service names and values that correspond to the attribute names in the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Update Service Items from Table and drag and drop the activity onto the Workflow pane.

Step 2 Click the appropriate tabs and update the service item properties as necessary. For details, see Defining the Create Service Item from Table Activity.

Step 3 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Update Service Request Activity

Use the Update Service Request activity to update an existing service request that currently resides on the Cisco Prime Service Catalog server.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Update Service Request and drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Service Request tab and enter the required information, including:

• Channel Id—Enter the identifier for the Service Link task in the service request to be updated.

Note: The identifier for the activity must be retrieved directly from the Cisco Prime Service Catalog. Do not reference an output property of the Submit Service Request activity.

• Take action—Check this check box to indicate that a specific action should be taken when updating the service request. From the enabled drop-down list, select the appropriate option.
• Comments—Enter any comments related to the service task or service request.

Step 4 Click the Parameters tab to specify the parameters needed by the Service Link to update data on the service request to coordinate the completion of a task.

• Do not send parameters—Select this radio button to indicate that no parameters are required in order to update the task in the service request.
• Send the following parameters—Select this radio button to enable the Parameters pane.
• Send parameters from table variable—Select this radio button to enable the text field.

Step 5 Click the Reference icon to query a table variable to be used for the service request. The table must contain both a "Name" and a "Value" column. The name column must correspond to an attribute name in the service portal.

Defining the Cancel Service Request Activity

Use the Cancel Service Request activity to cancel a request for a service order on the Cisco Prime Service Catalog.

Step 1 In the Process Editor Toolbox, choose Cisco Prime Service Catalog > Cancel Service Request and drag and drop the activity onto the Workflow pane.

Step 2 Click the Service Request tab and select the Requisition ID of the service to be canceled.

Step 3 Enter the time period the activity should wait before failing.

Step 4 Check the Force Monitor Plan Cancellation check box to force the cancellation, if the service request is configured not to allow cancellation after the task has started.

Defining the Execute Python Script

Use the following procedure to execute python script.

Step 1 In the Process Editor Toolbox, choose Code Executions > Execute Python Script and drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Execute Python Script tab to specify the commands used to execute an activity.

• Script Name—Enter the name for the Python Program.
• Local windows runtime user that the python code will run on behalf—Enter the runtime user to the local windows that python code will run on behalf.

Note The Windows users must have access to the machine, where the Process Orchestrator server is located at.

• Script arguments—Enter the collection of argument values for the script, users can pass to sys module in Python code. For example:

– Add—Click this button and choose one of the following to launch the Select Argument to Add dialog box. Enter the appropriate script in the text field or click Reference icon to select from the list.

– Edit—Select a script argument from the list and click this button to modify the script argument in the Select Argument to Add dialog box.

– Remove—Select a script argument from the list and click this button to remove the script argument from the list.

• Import Module Path—Enter the Path to import module of any custom python code files or any third party python library.

Note The path must exist in Process Orchestrator server machine.

• Script—Enter the script of the python code or click the Reference tool to select from the list.
• Enter the time period the activity should wait before failing.

Step 4 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Execute Python Code Properties

The Execute Python Script tab displays the properties used to execute the python script in the Process Orchestrator.

• Script name—Displays the script name of the python program
• Local windows runtime user that the python script will run on behalf—Displays the name of local Windows user
• Script argument—Displays the arguments users can pass to the sys module in python code
• Import module path—Displays the path of the python files
• Script—Displays the python code script
• Wait for command to complete or time out in—Displays the time period the activity should wait before failing

Python Code Results

The Results tab displays the result from the python code execution.

Typical Cisco Prime Service Catalog Tasks

Adding a Service Item Attribute

Use the following steps to add attribute properties to the service item.

Step 1 On the Service Item tab, click Add.

Step 2 Complete the following fields to enter the attributes for the service item.

• Attribute name—Enter the attribute name to be added to the service item. Click the Reference tool to browse for the correct variable reference property for the service item.
• Data type—From the drop-down list, select the data type for the service item (such as Boolean, String, Numeric, Date and Time).
• Value—Enter the value for the associated attribute.

For example:

Step 3 Click the Save tool to complete the activity definition

Manually Adding a Dictionary

Use the following options to add a Dictionary properties pane for manually adding a dictionary to the service request.

Step 1 On the Service Request tab, click Add > Manual Dictionary .

Step 2 Under Properties, enter the name of the dictionary to included with the service request.

Step 3 Click Add > [Name] Property to launch the Add Property dialog box to add a property to the dictionary.

• Property name—Enter the name of the dictionary property.
• Native data type—Data type that may not be used by Process Orchestrator, but was retrieved from the Cisco Prime Service Catalog as part of an existing item within a dictionary property. (Ex. Number, Text, Double)
• Data type—Data type assigned to the item
• Required—Check this check box to indicate the property is required.
• Property is multi-valued—Check this check box to indicate more than one value should be assigned to the item.
• Value—Enter the value(s) for the associated property. If the Property is multi-valued check box is checked, complete each Value field, as necessary.

Step 4 Click OK to close the Add Property dialog box and return to the Service Request tab.

Step 5 Click the Save tool to complete the activity definition.

Browsing for Dictionaries

Use the Add Dictionaries dialog box to add dictionaries and their related properties to a service request from a defined Cisco Prime Service Catalog server target. Use the following steps to browse for a dictionary to be included in the service request.

The queried dictionary completes all the fields required for service request.

Step 1 On the Service Request tab, click Add > Browse for Dictionaries.

Step 2 From the Add Dictionaries from the following Cisco Prime Service Catalog server drop-down list, select the appropriate server containing the dictionaries from which you want to query.

Step 3 In the Service name field, enter the service name for the product containing the dictionaries to be used with the service request.

Step 4 Click Refresh to display the dictionaries from the service in the list.

Step 5 Under the Names list, select the appropriate dictionary to be included in the service request, then click OK.

Specifying the Owner for the Service Item

Use the Subscription tab to provide the service item owner's login information to be used when connecting to the Cisco Prime Service Catalog. The login ID and organizational unit information must match the information in the portal.

Step 1 Click the Subscription tab on the service item activity.

Step 2 Complete the fields, as necessary.

Specifying Requestor Credentials for the Service Request

Use the Advanced tab on the Submit Service Request activity to provide login information for the requestor which can be used to override the runtime user credentials configured in the process properties. The login ID and organizational unit information must match the information in the portal.

Step 1 Click the Advanced tab on the Submit Service Request activity.

Step 2 Complete the login and organizational information needed for this activity, as necessary.

• Customer login name—Enter the log in name for the customer of the service being requested.
• Initiator login name—Enter the log in name of the person initiating the request for the service.
• Quantity—Enter the quantity needed for the service request. (Default: 1)
• Bill to OU—Enter the organizational unit to be billed for the service request.

Step 3 Click the Save tool to complete the activity definition.

Instance Properties

Cancel Service Request

The Service Request display-only tab displays the properties defined to cancel a service item to be delivered in response to a service request. A service item may be a Virtual Machine type or a user-defined type in the Cisco Prime Service Catalog.

• Requisition ID—Click the Insert Variable Definition button to select the variable reference.

Complete Service Request

The Complete Service Request display-only tab displays the existing service request that completed on the Cisco Prime Service Catalog server.

• Task Id—the identifier that uniquely identifies each Service Link task.
• Action—indicates that a specific action should be taken when updating the service request. From the enabled drop-down list, select the appropriate option.

– Done—Indicates task should be noted as completed

• Timeout—indicates the time period the activity waits before failing.

Create Service Item

The Service Item display only page displays the properties used to create a service item to be delivered in response to a service request in the Cloud Service Portal.

• Service item type—the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Service item name—the name of the service to be ordered.

For example:

Order a Virtual Machine

-or-

Start User Provisioning Process

• Channel Id (Service Link only)—the identifier that uniquely identifies each Service Link task. If provided, the current SOAP based interface to Service Catalog will be utilized. If not provided, the nsAPI will be used for the implementation of the activity.
• Timeout— the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

• Attributes—The following options display the properties used to configure the attributes to add to the service item.

– Attribute name—Attribute name to be added to the service item.

• Data type—Displays the selected data type for the service item.

– Boolean

– String

– Numeric

– Date and Time

• Value—Value for the associated attribute.

Create Service Items from Table

The Service Item display-only page displays the properties used to create multiple service items using a table variable to be delivered in response to a service request in the Cisco Prime Service Catalog.

• Service item type—the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Table variable—the table variable data containing the information needed to create the service items.
• Channel Id (Service Link only)—the identifier that uniquely identifies each Service Link task. If provided, the current SOAP based interface to Service Catalog will be utilized. If not provided, the nsAPI will be used for the implementation of the activity.
• Timeout—the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Delete Service Item

The Service Item tab displays the properties used to delete an existing service item in the Cisco Prime Service Catalog.

• Channel id—Displays Identifier that uniquely identifies each Service Link task
• Service item type—Type of physical or virtual asset for the service item
• Service item name—Name or IP address of the service item

Delete Service Items from Table

The Service Item tab displays the properties used to delete multiple service items using a table variable in the Cisco Prime Service Catalog.

• Channel ID—Displays the identifier that uniquely identifies each Service Link task
• Service item type—Type of physical or virtual asset for the service item
• Table variable—Displays the table variable data containing the information needed to delete the service items

Find Service Items, Advanced

The Advanced read only tab displays the service items that were defined for retrieval.

• Get all matching items—Retrieves all matching service items
• Get specified row

– Start row—the row properties you want to retrieve the service item from

– Maximum items to return—the number of service items to retrieve

Find Service Items, Results

The Results display-only tab displays the matching service items results.

• Matching service items—Displays the matching service items

Find Service Items, Service Item

The Service Item display-only tab displays the attribute properties for the service item.

• Service item type—Enter the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Search criteria—Enter the search criteria for the service item type you want to find

– Attribute—Enter the attribute name to be added to the service item

– Data Type—From the drop-down list, select the data type for the service item.

Boolean

String

Numeric

Date and Time

– Value—Enter the attribute value to be added to the service item

• Attributes to get—The list of associated attributes for the selected type

Find Service Item, Subscription

The Subscription display-only tab displays the subscriber, or current owner of the service item, properties.

• Subscriber login id—The unique ID assigned to the current owner of the service item
• Subscriber OU—The organizational unit to which the subscriber belongs
• Include subscriber information in results—Indicates the subscriber information is included in the results retrieved.

Get Service Item

Display-only. Use the Get Service Item activity to retrieve attribute properties for the service item.

• Service item type—Enter the type of physical or virtual asset for the service item. The service item can be a virtual machine or a user-defined type.
• Service item name—Enter the name of the service to be ordered.

Example

Order a Virtual Machine

-or-

Start User Provisioning Process

• Timeout—Check the check box and then enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

• Attributes to get—The list of associated attributes for the selected type

Get User Information

Display-only.Use the Get User Information activity to retrieve the properties of a specified user.

• User name—Enter the user name for the user account properties to be retrieved.
• Timeout—Check the check box and then enter the time period the activity should wait before failing.

Note Click the time unit link to change the time interval.

Get User Information Results

Use the Results tab to view the response output in the selected format.

• XML—Click this option to display the XML output results if the page is available in XML format.
• Text—Click this option to display the results in a text format.

Submit Service Request

Display-only. Use the Submit Service Request activity to submit a request for a service order on the Cisco Prime Service Catalog. In this activity, users can add multiple dictionaries to the service request manually or by browsing for an existing dictionary on a target.

• Service name—Name or IP address of the service item.

The following displays the dictionary and its related properties that were included in the service request.

• Dictionary name—Name of the dictionary included with the service request.

The following table displays the properties associated with the dictionary assigned to the service request.

• Name—Name of the dictionary property
• Values—Value assigned to the dictionary property
• Native data type—Data type originally assigned to the property
• Data Type—Data type assigned to the property

– Boolean

– Date

– Numeric

– String

• Required—Indicates the property is required
• Multivalued—Indicates the property has multiple values assigned (True, False)

Submit Service Request, Advanced

The Advanced display-only tab displays the default customer login information for the requestor used by the service request.

• Customer login name—Log in name for the customer of the service being requested
• Initiator login name—Log in name of the person who initiated the service request
• Quantity—Quantity needed for the service request (Default: 1)
• Bill to OU—Organizational unit to be billed for the service request.

Submit Service Request, Results

The Results tab displays the details of the service request submitted.

• Service Name—Name of the service request submitted
• Requisition ID—Identifier for the service that has been ordered as part of a service request
• Status—Status of the service request
• Started date—Date the service request was started
• Due date—Date the service request should be completed
• Customer login date—Login name of the customer who submitted the request for the service
• Initiator login name—Login name of the person initiating a request for the service

Update Service Item

The Service Item tab displays the attributes used to update an existing service item on the Cisco Prime Service Catalog.

• Channel Id (Service Link only)—Enter the identifier that uniquely identifies each Service Link task. If provided, the current SOAP based interface to Service Catalog will be utilized. If not provided, the nsAPI will be used for the implementation of the activity.
• Service item type—Type of physical or virtual asset for the service item.
• Service item name—Name or IP address of the service item.

This section displays the attributes updated on the service item.

• Attribute name—Attribute name to be updated on the service item.
• Data type—Selected data type for the service item.

– Boolean

– String

– Numeric

– Date and Time

• Value—Value for the associated attribute.

Update Service Items from Table

The Service Item tab displays the properties used to update multiple service items using a table variable in the Cisco Prime Service Catalog.

• Channel Id (Service Link only)—Displays the identifier that uniquely identifies each Service Link task. If provided, the current SOAP based interface to Service Catalog was utilized. If not provided, the nsAPI was used for the implementation of the activity.
• Service item type—Type of physical or virtual asset for the service item
• Table variable—Displays the table variable data containing the information needed to update the service items

Update Service Request

The Service Request display-only tab displays the properties used to update an existing service request that currently resides on the Cisco Service Catalog server.

• Channel Id—Identifier for the Service Link task in the service request to be updated
• Take action—Checked box and completed text field indicates the specific action that should be taken when the service request is updated.

– Approval—Indicates task should be sent for approval

– Cancel—Indicates task should be canceled

– Done—Indicates task should be noted as completed

– Reject—Indicates task should be rejected

– Skip—Indicates task should skipped

• Comments—Comments related to the service task or service request

Update Service Request, Parameters

The Parameters display-only tab provides the properties used on whether to send parameters with the service request and any parameters needed by the Service Link to update the data on the service request.

• Do not send parameters—Selected option indicate that no parameters were required to update the task in the service request.
• Send the following parameters—Selected option indicates that the displayed parameters in the Parameters Column were used to update the service request.
• Send parameters from table variable—Selected option indicates a table variable was used for updating the service request.

The following table displays the parameters that are included in the Update Service Request activity.

• Name—Displays the name of the agent parameter.
• Values—Displays the value assigned to the agent parameter
• Data Type—Data type assigned to the parameter

– Boolean

– Date

– Numeric

– String

• Multivalued—Indicates the parameters has multiple values assigned (True, False)

Getting Started Using the OpenStack Adapter

Use the following process to monitor and manage OpenStack instances.

Step 1 Create an OpenStack target (see Defining an OpenStack Server Target).

Step 2 Define an OpenStack user (see Defining an OpenStack User).

Step 3 Define an OpenStack command activity (see Automating OpenStack Adapter Activity).

Step 4 View the activity results (see Monitoring Operations).

Defining an OpenStack User

Use the following instructions to define the user credentials required to access OpenStack. The level of access for the network device is dependent upon the type of user logging in.

Step 1 Choose Definitions > Runtime Users , right-click and choose New > OpenStack User.

Step 2 Click the General tab to specify the required information, including:

• Display name—Enter the display name for the runtime user. This field is populated with the information specified in the User name text field, but can be overwritten by the user.
• Type—Display only. Type of object.
• Owner—User name of the owner of the object. This is typically the person who created the object.
• User name—The user name assigned to access the OpenStack server.
• Password—Check the Password check box and then enter the password assigned to access the OpenStack server.

Step 3 Click OK to close the dialog box.

Defining an OpenStack Server Target

Use the OpenStack Server target to connect to the OpenStack server.

Step 1 Choose Definitions > Targets , right-click, and choose New > OpenStack Server.

Step 2 On the General panel, enter the appropriate information.

Step 3 On the Connection panel, enter the appropriate information, including:

• OpenStack server name—Enter the host name or the IP address of the OpenStack server.
• Override default URL—Select this option to enter an appropriate URL to use to override the default URL.
• API Version—Select the appropriate API version to which your automation content is associated.
• Ignore Secure Socket Layer (SSL) certificate error—Check this check box to indicate the target should ignore certificate errors when attempting to connect to the service portal.
• Runtime user—Select this radio button to specify the runtime user required to execute a process or activity against this target.
• Project—The project or an organizational unit in the cloud that is used to scope the command. It is also known as tenant.

Step 4 Verify the information on the Completing the New OpenStack Server Wizard panel and click Finish to close the wizard.

Automating OpenStack Adapter Activity

Defining the Execute OpenStack Command Activity

Use the Execute OpenStack Command activity to execute OpenStack RESTful API command against an OpenStack server. The Execute OpenStack Command activity provides a flexible way to automatically track authentication tokens and renew them as needed. Responses for common information are scanned and displayed as activity results in the Operations Workspace activity instance view.

Step 1 In the Process Editor Toolbox, choose OpenStack > Execute OpenStack Command and drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Request tab and enter the following information:

• Project—The project or an organizational unit in the cloud that is used to scope the command. It is also known as tenant.
• Base URL—Select the appropriate service and the endpoints through which you can access the resources and perform operations.

– Service—The OpenStack services supported by the OpenStack server.

– Endpoint—The endpoint to access the OpenStack service.

• Relative URL—Enter the URL to be requested. The Relative URL is case-sensitive.

From the Insert Variable Reference dialog box, select the reference variable and then enter the rest of the URL to be requested. For example, if you want to request for all the tenants available in the OpenStack service, you can enter [Process.Target.IDentity Endpoints FirstRowAdminURL]/tenants .

• Method—The method to be performed on the resource identified by the Request-URI. For a list of common header methods, see HTTP Header Methods.
• Request Content Type—The value for the content type used to define the structure of the request.
• Request—Enter any additional HTTP request details using JSON or XML format.
• Response Content Type—The value for the content type used to define the structure of the response.
• When request creates a task, wait for its completion (in seconds)—Check the check box to indicate that when a task request is sent using methods, PUT, POST, DELETE, the activity should wait for the specified time period for the completion of the task before continuing.

In the enabled text box, enter the time period the activity should wait for the task. Click the time unit link to change the time interval.

• Rate limit wait time—Enter the number of seconds that the web service call must wait to prevent the call from exceeding the limits.
• Archive request text upon successful activity completion—Check the check box to indicate whether to archive the data request after the successful completion of the activity.
• If the check box remains unchecked, the data generated by the activity is removed from the database upon successful completion of the activity.
• Restart activity if interrupted —Check this check box to indicate the activity should resume after an interruption in the execution.

If the check box remains unchecked, then the activity remains paused if there is an interruption in the execution.

Step 4 Click the Paging tab and enter the following information:

• Limit—Enter the number of items to be displayed on each page. By default, the limit is set to 0 and the search returns all the items.
• Marker—Set the marker to the last item returned in the previous list and then request for subsequent items.
• Page reverse—Check this check box to indicate that the list can be reversed.

Step 5 Complete the appropriate information in the remaining tabs as necessary, then click Save to complete the activity definition.

Overview

The Email adapter provides the ability to execute email objects and send email messages to a specified user. This guide provides instructions for viewing Email adapter properties, defining Email targets, triggers, and activities, instructions for completing the property pages for each specific activity, and instructions on viewing the activity results.

The Email adapter properties dialog box displays general information about the functionality provided by the adapter, version number, release date and install date, any prerequisites, and the history of changes made to the adapter.

Managing Email Objects

Email Targets Overview

Users can define an email target to run a process or activity against an Internet Message Access Protocol (IMAP) email server, a Post Office Protocol (POP3) email server, or an SMTP Server.

The IMAP email server allows an email client, such as Microsoft Outlook, to retrieve email on a remote mail server. The POP3 email server allows an email client to retrieve e-mail from a remote server over a TCP/IP connection.

An Email (IMAP) target must be connected to an Exchange 2007 Server with Service Pack 3. An authentication failure will occur when attempting to create an Email (IMAP) target against an Exchange 2007 Server that does not have service pack 3.

The following table provides a listing of the targets that are associated with the adapter.

• Email Account (IMAP)—Specify the connection information to the IMAP email server
• Email Account (POP3)—Specify the connection information to the POP3 email server
• Email SMTP Server—Specify the connection information to the SMTP email server

Defining the Email Account Target

Use the following steps to define an Email Account (IMAP) target. This target allows a process or activity to execute against an email account on an IMAP mail server.

An Email (IMAP) target must be connected to an Exchange 2007 Server with Service Pack 3. An authentication failure will occur when attempting to create an Email (IMAP) target against an Exchange 2007 Server that does not have service pack 3.

To define the target:

Step 1 On the Definitions > Targets view, right-click and choose New > Email Account (IMAP).

The New Email Account (IMAP) Properties dialog box displays.

Step 2 On the General Information panel, specify the name and description of the new object, then click Next.

Step 3 On the Email Account settings panel, specify the email server, email user name and port for the email account.

• Email server—Name of the email server that relays email to the mailbox
• Protocol—Display-only field of the type of email protocol being used by the email server
• Email user—Select the default runtime user account used to connect to the target. Select the default runtime user from the drop-down list.
• Port Override—Check the check box and enter the port number in the adjacent field to override the default port used by the protocol if the port is being used by another application.
• Enable TLS authentication—If checked, the authorization of the Email server will use TLS.
• Enable SSL—If checked, the connection to the Email server will run on the SSL port.

Note You may also need to override the default IMAP port (143) to the SSL port.

• Ignore Certificate Error—If checked, any errors regarding the certificate will be ignored.
• Enable server push notifications—If checked, Email Simple or Advanced Events will be monitored through email server push notifications.

Step 4 Click the Keystore tab and enter the key file password that provides access to the file.

Step 5 Click the Advanced tab to specify the reconnection settings to the appropriate email server (IMAP, POP3) after a connection failure.

• Reconnect to email server on connection failure—Check this check box to enable the reconnection settings for the target.
• Reconnect every ____seconds—Select this option and in the text field, enter the number of seconds the target should take to reconnect to the server.
• Reconnect up to—In the text field, enter the maximum number of times the target should attempt to reconnect to the server.
• Attempt to reconnect at the following intervals (in seconds)—Select this option and in the text field, enter the number of seconds the target should wait before attempting to reconnect to the server.

Step 6 Click OK to close the dialog box and complete the procedure.

The new target displays in the list of targets on the Definitions > Targets view.

Defining the Email Activity

Use the Email activity to specify the information required for sending an email as part of the process.

To define the Email activity

Step 1 On the Toolbox pane, under Email Activities, select the Email activity, then drag and drop the activity onto the Workflow pane.

The Email property pages display.

Step 2 On the General tab, enter the appropriate information.

Step 3 Click the Email tab to specify the properties used to generate the email. Use commas to separate multiple email addresses.

• To—Enter the email address of the primary recipient(s) of the email.
• Cc—Enter the email address of the recipient(s) who are to be carbon-copied on the email.
• Bcc—Enter the email address of the recipient(s) who are to blind carbon-copied on the email.
• Subject—Enter the subject heading of the email.
• Message—Enter the content of the message in the body of the email.

Note HTML code can be used for formatting if the email is saved in HTML format.

• Save as HTML—Check this check box to send the email contents as an HTML file.

For example, if the content is <B> Cisco Process Orchestrator </B>, then the contents in the email will be shown in bold text.

Step 4 Click the Attachments tab to specify the file paths for the attachments to be sent as part of the email.

• User with access to attachments—From the drop-down list, select the runtime user account to attach files to the email.
• Attachment Paths—Displays the list of file paths for attachments

Step 5 Click OK to complete the activity definition.

Define a Get Email Attachments Activity

Use the Get Email Attachments activity to specify the parameters for the attachments to be sent as part of the email.

To define the activity

Step 1 On the Toolbox pane, under Email Activities, select the Get Email Attachments activity, then drag and drop the activity onto the Workflow pane.

The Get Attachments tab display.

Step 2 On the Get Attachments tab, specify the properties used for the attachments.

• Mail folder—[Required] mail folder name that contains the message
• Message ID—[Required] the unique message ID.
• Select attachments—Include all the attachments in the message; (b) specify the attachment file table with a “File Name” column, containing attachment file names Usually, user may user the variable reference to the attachment output table from the trigger Email Advanced Event; or (c) Specify the attachment file name, user may use “*” wild card to specify the attachment file name pattern. The default choice is to include all the attachments.
• What to do with the attachments—(a) Download the attachments; or (b) return the text attachment in the output table. Download is the default. If choose to return the text attachment in the output table, the text of the attachment can be referenced in the exposed attachment table. The size of the text attachment file needs to be no larger than the max allowed size specified in the Email Adapter Advanced settings. If oversized, the activity will fail.
• [Optional] If choose to download—Window Runtime User to access file systems for downloading attachments. The default user is “Orchestrator Server User” that was created during product installation.
• [Optional] If choose to download—Directory to save the downloaded files. In high availability environment server setup, the directory should be a network share accessible to all the servers.
• [Optional] Mutually exclusive choices—If you choose to download, what to do if the file exists. The default is ‘Always replace’. The other two choices are ‘Do not replace’ and ‘Replace only if newer’.

Step 3 Click OK to close the dialog box and complete the procedure.

Service Request Parsing Rules Page

Use the Service Request Parsing Rule page to set up the predefined XPath query based parsing rule for a given type of the service request payloads.

• Display Name—Name of the parsing rule
• Description—Description of the parsing rule
• Automation Pack—Name of the automation pack associated with the parsing rule

Add/Edit Property Dialog

Use this dialog to add or edit dictionary properties to/for a service request. Select one of the following data types to the request and enter a value for the associated attribute:

• Boolean
• String
• Numeric
• Date and Time

Add Value Dialog Box

Use this dialog box to add or modify the properties and parameters to be included in the service request.

Note The displayed fields depend on the dialog box that is opened.

• Property/Parameter name—Enter the name of the agent parameter or dictionary property.
• Native data type—Display-only. Data type that may not be used by Process Orchestrator, but was retrieved from the Cisco Prime Service Catalog as part of an existing item within a dictionary property. (Ex. Number, Text, Double)
• Data type—Display-only. Data type assigned to the item

– Boolean

– Date

– Numeric

– String

• Required—Check this check box to indicate the item is required.
• Property/Parameters is multi-valued—Check this check box to indicate more than one value should be assigned to the item.
• Value—Enter the value(s) to be associated with the item.

XPath Query Page

Use the XPath Query page to fill in the XPath namespaces defined in the service request XML payload.

• Prefix—Enter the prefix element associated with the namespace URI reference in the attribute value
• Uri—Enter the Uniform resource identifier (URI) used to identify the attribute value of the namespace name or resource on the Internet
• Property Name—Enter the property name
• Property Type—Select the data type associated with the path expression to query.

– String

– Numeric

– Boolean

– DateTime

Configuring Automation Pack Repository Share

Use the following steps to specify how the automation pack repository are to be saved. The file paths specified indicate the path that will be used when viewing the automation pack repository.

To view automation pack repository, it is recommended that Automation pack repositories are saved on a UNC share path.

If the automation pack repository is set to be saved only on the local computer, then only local users will have access to the automation pack repository. The automation pack repository will not display for users with remote access, such as those accessing Process Orchestrator from the web console or the remote client.

Step 1 Choose Administration > Adapters, right-click Git Adapter and choose Properties.

Step 2 Click the Automation Pack Repository Share tab to enter or modify repository and runtime user information.

a. Repository file share:

Share path—Enter the UNC path to a share directory. This path will be used to store automation pack repositories.

Note Verify that the UNC share file path is on a network where the Cisco Process Orchestrator service account has write permissions.

b. Runtime User:

• Select the runtime user account used to connect to the automation pack repository file share. Select the runtime user from the drop-down list.
• To view the properties for the selected runtime user, click the Properties tool.
• To create a new windows user, click New > Windows User to create a new Windows User account.

Creating a New Git Repository

Use the New Git Repository Wizard to create or modify Git repository properties for an automation pack repositories. An example of properties includes values such as repository URL, repository user, branch and code path.

Step 1 The Welcome to the Git Repository Wizard panel displays.

Note If you do not want to display the Welcome panel the next time the wizard is launched, check the Do not show this page next time check box.

Step 2 Click Next to continue to the General Information Panel and specify the name and description.

Step 3 On the Git Repository panel, specify the following information to create a repository:

• Repository URL—Enter the Git URL of the repository.
• Repository User—Select the repository user from the drop–down or click New > Repository User to create a new runtime user. For more information see, Defining a Repository User.
• Branch—Enter default branch name master. As you initially make commits, you are given a master branch that points to the last commit you made.
• Code Path—Enter the code path of the Git.

Step 4 Click Finish to create the Git repository target.

Getting Started Using the Core Adapter

Use the following process to monitor and manage Core activity instances.

Step 1 Define a Core command activity (see Defining Core Adapter Activities).

Step 2 View the activity results (see Monitoring Operations).

Configuring the Core Function Adapter

The Core Function Adapter provides the basic functionality in Cisco Process Orchestrator. Use the Core Function Adapter Properties dialog box to configure default email settings, diagnostic report location, and Return on Investment calculations.

Configuring Automation Summary Settings

Automation summary reports are generated by activities to provide information about the activity and assist in resolving any issues that may need attention. Use the following steps to specify how the automation summary reports are to be saved and how long the reports are to be retained. The file paths specified indicate the path that will be used when viewing the automation summary reports.

To view automation summary reports, it is recommended that Automation summary reports are saved on a UNC share path.

If the automation summary is set to be saved only on the local computer, then only local users will have access to the automation summary report. The automation summary will not display for users with remote access, such as those accessing Process Orchestrator from the web console or the remote client.

Step 1 Choose Administration > Adapters, right-click Core Functions Adapter and choose Properties.

Step 2 Click the Automation Summary tab to specify where the automation summary reports that are generated by activities are to be saved and how long the reports are to be retained.

The file paths specified indicate the path that will be used when viewing the automation summary reports.

Step 3 Verify or enter the appropriate default file path for the automation summary directory.

• Share path—Enter the UNC path to a share directory. This path will be used when viewing the automation summary reports.

Example:

(\\servername\sharename\path\filename)

Note Verify that the UNC share file path is on a network where the Cisco Process Orchestrator service account has write permissions.

Use the following buttons to modify the share path:

• Browse—Launches the Browse for Share dialog box to query the file path to store the automation summary reports.
• Create share—Launches the Create Share dialog box to create the directory on the Process Orchestrator server where the automation summary reports should be created and stored.

Step 4 Specify the default credentials to be used to access the Orchestrator server on the network share.

• Enable virtual directory mapping—Check this check box to map the file path to an IIS Virtual Directory. If the check box is unchecked, then the automation summary will not be saved to a shared or IIS virtual directory and will not be available for view from the Web Console.
• Virtual directory path—Enter the http://host:(port)/sharefolder that corresponds to a virtual directory in IIS. If necessary, go to IIS Manager to create your Web Sites and your Virtual Directory for the share folder. Use the default settings or change the settings, as necessary.

Click Create to launch the Create Virtual Directory dialog box to update the Virtual Directory name.

The file path to the network share where automations may be created and stored.

– Site name—Name of the IIS virtual directory

– Physical path—Display only. File path that corresponds to the virtual directory

\\host\sharefolder

– Virtual Directory name—Name of the new shared folder

Select the appropriate directory mapping option from the drop-down list to map the automation summary to a shared directory or IIS Virtual Directory to allow end-users easier access to automation summaries using email or the Process Orchestrator Web Console.

Step 5 Configure the automation summary reports grooming settings.

• Delete automation summary reports older than—Check this check box to limit the number of automation summary reports that are retained. Enter the number of days that the reports should be retained in the text field. Reports that have been retained for a period past the specified number of days will be deleted.

Configuring Return on Investment

Process Orchestrator provides the ability to calculate the Return on Investment (ROI) that is achieved by automating your processes. When you create a process, you have the option to enter the equivalent time it would take to run the process manually. This value is calculated against the hourly rate specified on this page to determine your ROI.

Step 1 Choose Administration > Adapters, right-click Core Functions Adapter and choose Properties.

Step 2 Click the ROI tab and specify the hourly rate (in dollars) that it would cost to execute a process manually.

Getting Task XSL Transforms

Each task type has a specific XSL transform that converts the XML into HTML web pages for display in the Web Console. Use the Task tab to display the default XSLT transform file names. The files are located in the Process Orchestrator program Web Console folder under the following file path:

C://Install Directory/Web Console/Task XSL Transforms

You can change the XSL file name for a specific task when modifying the task properties in the Process Editor dialog box.

Step 1 Choose Administration > Adapters, right-click Core Functions Adapter and choose Properties.

Step 2 Click the Task tab, highlight the appropriate task, and right-click and choose Properties.

The Task XSL Transform dialog box displays the default XSL transform file name for the specific task.

Step 3 To view the converted code, use a web browser to launch the appropriate XSLT file that resides in the Process Orchestrator install directory/WebConsole folder.

Publishing Metrics to the Window Management Instrumentation Provider

Use the WMI tab to configure the default settings for publishing metrics into the Windows Management Instrumentation (WMI) provider.

Step 1 Choose Administration > Adapters, right-click Core Functions Adapter and choose Properties.

Step 2 Click the WMI tab.

Step 3 Click Publish Metrics to enable the settings to configure the publishing time frame, then set these values:

• Poll metrics to publish every—Enter the default number of minutes in the text field to indicate when a poll is taken to publish metrics.
• Unpublish metrics older than—Enter the default number of days in the text field to indicate that metrics should be unpublished after a certain number of days.

Defining Core Adapter Activities

Defining the Calculate Date Activity

Use the Calculate Date activity to manipulate the values of a date/time variable.

Step 1 In the Process Editor Toolbox, choose Core Activities > Calculate Date, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Calculate Date tab to specify the properties to be used to adjust the date and time frame.

• Original date—Enter the original date/time of the variable.

Format must be according to the regional settings. (mm/dd/yyyy hh:mm:ss)

• Adjustment—Enter the number of units to increase or decrease the time frame. Enter minus (-) prior to the value to decrease or enter plus (+) prior to the value to increase. (ex. -5)

Step 4 Click the time unit link to change the modified date/time (from seconds up to days).

Step 5 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Calculate Date Time Difference Activity

Use the Calculate Date Time Difference activity to manipulate the values of a date/time variable.

Step 1 In the Process Editor Toolbox, choose Core Activities > Calculate Date Time Difference, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Date Difference tab to specify the properties to be used to adjust the date and time frame.

• Original date—Enter the original date/time of the variable.

Format must be according to the regional settings. (mm/dd/yyyy hh:mm:ss)

• Adjustment—Enter the number of units to increase or decrease the time frame. Enter minus (-) prior to the value in order to decrease or enter plus (+) prior to the value to increase. (ex. -5)

Step 4 Click the time unit link to change the modified date/time (from seconds up to days).

Step 5 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Cast Target Type Activity

Use the Cast Target Type activity to define the target type to cast to.

Step 1 In the Process Editor Toolbox, choose Core Activities > Cast Target Type, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Cast Target Type tab to define the properties specific to the activity.

• Target—Selected target to cast
• Cast to Type—Selected target type for the target to cast to

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Viewing Results

Click the Cast Target Type display-only tab to view the properties used to cast the target type.

• Target—Selected target to cast
• Target Type—Selected target type to cast
• Cast to Type—Selected target type for the target to cast to

Defining the Convert JSON to XML Activity

Use the Convert JSON to XML activity convert JavaScript Object Notation text to XML which makes it easier for users to parse and manipulate XML configuration.

JSON is a text-based open standard designed for human-readable data interchange and is often used for serializing and transmitting structured data over a network connection.

Step 1 In the Process Editor Toolbox, choose Core Activities > Convert JSON to XML, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the JSON Source tab to define the properties specific to the activity.

• Input JSON—Enter the JSON text to be converted to XML. For example:

• Specify the root element name for XML—Check the check box to enter the name of the XML root element that is generated and recognized in an XML document instance in the enabled text field.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Convert XML to JSON Activity

Use the Convert XML to JSON activity convert XML to JavaScript Object Notation text which makes it easier for users to parse and manipulate JSON configuration.

Step 1 In the Process Editor Toolbox, choose Core Activities > Convert XML to JSON, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the XML Source tab to define the properties specific to the activity.

• Input XML—Enter the XML text to be converted to JSON. For example:

• Omit XML root element—Check this check box to indicate XML root element should not be included in the conversion.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Correlate Process Event Activity

Use the Correlate Process Event activity to check whether a process occurred within a certain amount of time of another problem.

Step 1 In the Process Editor Toolbox, choose Core Activities > Correlate Process Event, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Event Criteria tab to define the properties specific to the activity, including:

• Correlate events that occur within—Enter a value and select the time unit to indicate the time period in which the events should correlate before or after the process start time. The process start time is the default object used to correlate events.

– Time unit—Enter the start time value to specify the time period to correlate. Click the time unit link to change the time interval.

– Event occurrence—Click the link to determine whether the process start time is before or after the event occurs.

• Number of events to correlate—Select one of the following radio buttons to specify which events to correlate during the specified time period:

– All events in the above time frame—Select this radio button to correlate all events that occur within the specified time frame.

– Number of events—Select this radio button and then enter the number of events to correlate in the text field.

• Event Severities—The severity level of the event in that must be matched before the process executes (such as Information, Warning, Error, Success audit, or Failure audit).
• Property—Click the Reference tool to launch the Insert Variable Reference dialog box and select the event data to correlate
• Comparison—Select the operator to be used to evaluate the expression.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Viewing Results

The Event Criteria display-only tab specifies the event criteria that must occur before or after the process starts.

• Correlate events that occur within—Value and time unit indicates the time period in which the events should correlate before or after the process start time.
• Number of events to correlate—The selected radio button specifies which events should correlate according to the specified start time.

– All events in the above time frame—Correlates all events during the specified time frame.

– Number of events—Correlates the specified number of events to occur during the specified time frame

• Event Severities—The severity level of the event in that must be matched before the process executes.

– Information

– Warning

– Error

– Success audit

– Failure audit

• Additional Properties to match

– Property—Select event data property to correlate

– Comparison—Selected operator used to evaluate the expression

– Expression—Expression associated with the selected operator

Defining the Create Automation Summary Activity

An automation summary is a record of process execution. The automation summary includes information about the events that trigger processes, activities that were executed, and the data retrieved by the executed activities.

Use the Create Automation Summary activity to specify the activities in the process for which an automation summary should be generated. To generate the data output, select the activity and then specify the section in the automation summary in which to output the data.

The share path specified in the Core Functions Adapter properties will be used when viewing the automation summary reports.

If the automation summary is set to not be shared, then only local users on the Process Orchestrator server computer will have access to the automation summary report. The automation summary will not display for users with remote access, such as those accessing Process Orchestrator from the Web Console or the remote client, unless a UNC share or IIS Virtual directory sharing options have been selected.

Step 1 In the Process Editor Toolbox, choose Core Activities > Create Automation Summary, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Automation Summary tab to define the properties specific to the activity, including:

• Automation summary style sheet—Select the type of template to be used for the automation summary.

– Table of Configuration Properties

– Situation Analysis Report (default)

• Include the following items—Select the activity or trigger/event, since events and triggers can be included into the automation summary as well, and specify the section of the automation summary to include the reporting details and whether the activity is the root cause of any issues that are detected.

– Name—Name of the activities that are included in the process

– Section—Name of the section of the automation summary where the data will be stored

– Root cause—Yes indicates the Is the root cause check box is checked

• Section—Specify the section of the automation summary template in which to export the data:

– SituationAnalysis—After a situation that requires action is identified, the state and diagnostic information is displayed in the Situation Analysis section of the automation summary.

– ContextAnalysis—After a situation is analyzed in context with other situations, the symptom and cause is displayed in the Context Analysis section of the automation summary.

• Is the root cause—List the activity or event at the top of the automation summary, or identified as the root cause of the problem.
• Last instance information only—Indicate that the automation summary must include only information for the latest execution of the activity instance.

This setting is only for activities that are inside the loop of a workflow component (While or For Each). If this setting is not selected, the automation summary will include information about all instances of activity, for all iterations of the loop.

This option is available only when Free up memory before process completes check box in the Environment Properties console is unchecked.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Export Table to HTML Activity

Use the Export Table to HTML activity to export the table variable to HTML with the linked Cascading Style Sheet (CSS) and Java script.

Step 1 In the Process Editor Toolbox, choose Core Activities > Export Table to HTML, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the HTML Export tab to define the properties specific to the activity, including:

• Table—Select the appropriate table to be queried, it can be any global or local table variable reference.
• Caption—Enter the table heading to be displayed above the table and also as a page header head/title tag of the resulting HTML page.

Note This is optional. If not specified, the activity name is used as the table caption.

• Custom CSS file—Select the Custom CSS or Default CSS file from the drop–down list.
• Custom JavaScript file—Select the Custom JavaScript or Default JavaScript file from the drop–down list.

The default folder with default CSS and JavaScripts files gets created the first time the activity runs, the file paths are mentioned below:

You can create the custom folder in the same path as the default folder, in order to create and modify the custom CSS and JavaScripts files:

The files in the custom folders are displayed in their respective drop down lists.

Step 4 Click Save to complete the activity definition.

Viewing Results

Click the View Exported File tab to view the exported HTML table generated by the activity.

You can also view the link to HTML file location displayed in the Property page, the link can be used to view the table in any browser.

For example:

The files are exported to the following path:

The export table to HTML activity displays the Standalone HTML on the activity output, which can be used to work with an embedded version of HTML contents in the workflow. For example, it can be used to manipulate HTML contents as well as to save the contents to a custom file location.

Standalone HTML output does not contain reference to CSS or JavaScript resources. Instead, the contents of the corresponding resources are copied to appropriate locations in HTML during activity operation and the result is stored in Standalone HTML field along with the data.

Note This property is not displayed on the activity instance output pages, but it’s available for use in the consecutive activities in the workflow.

Defining the Find Target Activity

Use the Find Target activity to query a list of defined targets matching specific target attribute criteria.

Step 1 In the Process Editor Toolbox, choose Core Activities > Find Target, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Find Targets tab to define the properties specific to the activity, including:

• Target type—Select the appropriate target type to be queried.
• Choose a target group—Select the appropriate target group to be queried. Only target groups defined in Process Orchestrator in which the user has Use permission will be available.
• Properties to Match—Select the appropriate exposed target criteria to use to query a list of defined targets in Process Orchestrator:

– Property—select the appropriate exposed target property to query.

– Operator—Select the appropriate operator to include to match to the criteria. The displayed operators depend on the selected property. For additional information, see Common Operators

– Expression—Select the appropriate wildcard expression to associate with the selected operator.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Format Date Activity

Use the Format Date activity to convert date and time into a string text format.

Step 1 In the Process Editor Toolbox, choose Core Activities > Format Date, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Format Date tab to define the properties specific to the activity, including:

• Format String—Enter the date or time format string to be formatted. For example:

• Original Date—Click the Reference tool to select the appropriate date/time variable reference, such as the Process > Start Time reference variable, to be used to format the string.
• Use Local Time Zone—Check this check box to use the local time zone for the task.
• Use Specified Culture instead of CPO Server Culture—Check this check box to select a different culture for the task to run on instead of Cisco Process Orchestrator server culture.

To customize the specific date/time of the variable reference, add the Parse activity to the process and use that activity to modify the selected date/time.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Insert Event Activity

Use the Insert Event activity to view or specify the properties that display depending on the selected event.

Step 1 In the Process Editor Toolbox, choose Core Activities > Insert Event, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Event tab to define the properties specific to the activity, including:

• ID—Unique identifier for the process event
• Subject—The subject line of the event message
• Category—The category assigned to the event
• Severity—The severity level of the event (Information, Warning, Error, Success audit, Failure audit)
• Automation Summary (URL)—URL for the related automation summary

Step 4 Click the Parameters tab to define parameters for a specific task.

Step 5 Click the Affects tab to specify the elements that trigger the selected target.

• This event applies to the following target— Specify the affected target to be used in the activity.
• Process target—Use the process target as the affected target in the activity.
• Activity target—specify the affected target for a specific task activity.

– Activity target—Select the activity containing the target that will be used. Only task activities will display in the list.

– Target Reference—Specify the affected target that will be used.

To view the properties for the selected target, click the Properties tool. To create a new target, click New > [Target].

– Specific target group—Specify the affected target group that will be used.

To view the properties for the selected target group, click the Properties tool. To create a new target group, click New > [Target Group].

From the Choose a target using this algorithm drop-down list, specify which target will be chosen from the eligible target group members.

Target Algorithms

– Choose any target that satisfies  the specified criteria—Executes the process on any targets defined by the criteria specified in the Target Selection dialog box.

– Choose the target with the specified name—Executes the process on the member of the group specified in the Name to match text field.

• This event applies to the following configuration item—Specify the configuration item to be used in the activity
• Name—Name of the configuration item (IT component) to which the alert pertains. For example, the name of a database server that failed or the name of a specific job that failed.
• Type—Enter the appropriate configuration item type or select the type of ITIL configuration item (IT component) from the list which the alert describes. For example, the type of the specific application element that failed (Application Server, Database, Host, or User).
• This is a CMDB reference—Indicate that the true source of the CI is in the CMDB, so the configuration item properties reference a CMDB entry.
• Object key—ID for the specific record in the CMDB that contains the configuration item
• Object source—Name for the specific record in the CMDB that contains the target configuration item

Step 6 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Viewing Results

Click the Events display-only tab to view the batch of events generated by the activity in the Reporting database.

• Event ID—Identifier used for the event
• Subject—Name of the event
• Affected Target Configuration Item Type—Type of ITIL configuration item (IT component) or application element which failed such as a server, database, host, or user
• Affected Target Configuration Item Source—Name for the specific record in the CMDB which contains the target configuration item
• Affected Target Configuration Item Object Name—Name of the configuration item (IT component) which failed or the name of a specific job which failed.
• Affected Target Configuration Object Key—ID for the specific record in the CMDB which contains the configuration item
• Configuration Item Type— Type of ITIL configuration item (IT component) which the alert describes.

Example—The type of the specific application element which failed:

– Application Server

– Database

– Host

– User

• Source—Name for the specific record in the CMDB which contains the target configuration item
• Category—Category for the event
• Severity—Severity of the event

– Error

– Warning

– Information

– Success Audit

– Failure Audit

• Automation Summary—File path for the automation summary report
• Description—Brief description of the event
• Parameter [1-10]—Values of the parameter
• Time Generated—Date and time the event was generated

Defining the Match Regular Expression Activity

Use the Match Regular Expression activity to match specified string text against a specified regular expression.

Step 1 In the Process Editor Toolbox, choose Core Activities > Match Regular Expression, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Regular Expression tab to define the properties specific to the activity, including:

• Regular Expression—Specify a fixed string to represent the regular expression to be used in matching

Click the Expression arrow to view frequently used symbols.

• Match case—Check the check box to specify whether regular expression matching should be case-sensitive
• Input string—Enter the input string for text to be parsed and matched against the specified regular expression.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Parse Date Activity

Use the Parse Date activity to convert string text into a date/time format.

Step 1 In the Process Editor Toolbox, choose Core Activities > Parse Date, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Parse Date tab to define the properties specific to the activity, including:

• Format String—Enter the date or time format string to be parsed. For example:

• Input String—Enter the date or time string to be parsed.
• Use Local Time Zone—Check this check box to use the local time zone for the task.
• Use Specified Culture instead of CPO Server Culture—Check this check box to select a different culture for the task to run on instead of Cisco Process Orchestrator server culture.
• For details about other date properties, see Defining the Insert Event Activity

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Ping Hosts Activity

Use the Ping Hosts activity to ping IP address.

Step 1 In the Process Editor Toolbox, choose Core Activities > Ping Hosts, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Ping tab to define the properties specific to the activity, including:

• Hosts—Enter 1 or more IP addresses or name of the servers.

Note For a single entry, you can enter multiple hosts separated by commas.

• Number of echo requests to send—Enter the number of echo request (default is 4).
• Timeout—Enter the time period the activity should wait before failing. Click the time unit link to change the time interval.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Ping Hosts Results

The Results tab displays the Ping results of the Hosts entered in the activity.

Note The activity will stop, when it’s timeout. It will not continue to ping the rest of the hosts.

Note The activity doesn’t stop just because it is not able to reach some of the hosts.

Defining the Publish Metric Activity

Use the Publish Metric activity to define the performance metric properties to be published into the Reporting Database and the Windows Management Instrumentation (WMI) provider.

The metrics are published under the root\Process Orchestrator name space using the WMI class, CPO_PerformanceMetric. Use the Metrics page to define the performance metric properties to be published into the Process Orchestrator Reporting Database and the Windows Management Instrumentation (WMI) provider.

Step 1 In the Process Editor Toolbox, choose Core Activities > Publish Metric, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Metrics tab to define the properties specific to the activity, including:

• Object name—Object name of the metric
• Counter name—Counter name of the metric
• Instance name—Name of the instance
• Value—Performance metric value

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Raise Process Event

Use the Raise Process Event activity to raise an internal event to the Cisco Process Orchestrator server based on specific data.

Step 1 In the Process Editor Toolbox, choose Core Activities > Raise Process Event, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Event tab to define the properties specific to the activity, including:

• ID—The identifier to be used for the event
• Subject—The name of the event
• Category—The category for the event
• Severity—The severity of the event (Error, Warning, Information, Success Audit, Failure Audit)
• Source—Source of the event. For Cisco Process Orchestrator-generated events through Raise Process Event, the source is the Cisco Process Orchestrator: process name that raised the event.
• Description—A brief description of the event.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Set Multiple Variables Activity

Use the Set Multiple Variables activity to update multiple variables in a single activity. This activity will update each defined variable in the activity, one by one, as well as perform the necessary auditing for each updated variable.

Modifying the Value of a Defined Variable).

Step 1 In the Process Editor Toolbox, choose Core Activities > Set Multiple Variables, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Variable tabs to define the properties specific to the activity, including:

• Variable—Click the Reference tool to select the variable reference property to be updated.
• New Value—Enter the new value of the variable. You can also click the Reference tool to select a variable reference property to be used to update the variable.

For a Boolean variable, the text entered in this field (true or false) is case-sensitive and must be entered all lowercase.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Modifying the Value of a Defined Variable

Step 1 In the Process Editor Toolbox, choose Core Activities > Set Variable, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Variable tab to define the properties specific to the activity, including:

• Variable to update—Select the appropriate variable to be modified.
• Variable data type—Data type associated with the selected variable.
• Current value—The current value of the selected variable.
• New value—Enter or select a new value of the variable.

For a Boolean variable, the text entered in this field (true or false) is case-sensitive and must be entered all lowercase.

Formulas can also be included to modify variable values. For example:

– 5+10

– [Activity.Reference1] / [Activity.Reference2] * 100) + [Activity.Reference3]

– [Activity.PropertyName1] [Activity.PropertyName2]

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Sleep Activity

Use the Sleep activity to specify the time period to pause between activities in the workflow.

Step 1 In the Process Editor Toolbox, choose Core Activities > Sleep , then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Result Handlers tab to modify the list of condition branches on the process.

Defining the Test FTP Destination Activity

Use the Credentials tab to specify the runtime user that should be used for execution.

Step 1 In the Process Editor Toolbox, choose Core Activities > Set Variable, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the FTP tab to define the properties specific to the activity, including:

• Use process runtime user—Use the credentials for the runtime user that was specified for the process
• Override process runtime user—Specify different credentials than what are used for the process. The selected runtime user overrides the runtime user that was specified for the process.

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the Update Target Activity

Use the Update Target activity to update the properties of a specific target.

Step 1 In the Process Editor Toolbox, choose Core Activities > Update Target, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the Target tab to define the properties specific to the activity, including:

• Target—Name of the target
• Target Type—Type of target
• Target—Indicates the target will be d
• Properties to update—The target properties available for update

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the XPath Query Activity

Use the XPath Query activity to query information based on XML path expressions, nodes, as well as namespace definitions. If the query matches more than one node in the XML document, an error will be generated.

Step 1 In the Process Editor Toolbox, choose Core Activities > XMPath Query, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the XPath Query tab to define the properties specific to the activity, including the source XML text to be queried.

Step 4 Modify the list of namespace definitions.

Step 5 Click Namespace to display the namespace column descriptions.

Step 6 Click New to add new XPath Queries under the XPath queries column, enter the following information in the Xpath Query definition dialog box.

• XPath Query—Enter the path expression to query.
• Property Name—Enter the property name to display on the Results tab after the activity has run.
• Property Type—Select the data type associated with the path expression to query (String, Numeric, Boolean, or DateTime).
• Error Handling—Select either one of the following option from the drop–down list:

– Fail the activity if this value cannot be found—Select this option to fail the activity if the queried value is not found.

– Specify a default value if this value cannot be found—Enter the default value to be displayed on the activity result, if the queried value is not found.

For example, if the default value is entered as False and the queried value is not found, then the results page displays False in the activity results page.

Step 7 Select the required query row and click Properties , to see or modify the properties of the existing XPath query.

Step 8 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the XSL Transform Activity

Use the XSL Transform activity to apply XSLT transformation to specific XML text. XSLT transformation can transform XML into plain text, HTML, or other XML.

Step 1 In the Process Editor Toolbox, choose Core Activities > XMPath Query, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the XSL Transform tab to define the properties specific to the activity, including:

• Specify XSL document—Select this radio button to transform a specific XSL document, then enter the XSLT style sheet for the XSL document.
• XSL transform—Select this radio button to transform XSL text from a specific file path, then enter the appropriate file path of the XSL file.
• Source XML to transform—Source XML text to be transformed.
• Output Format—Select the radio button to determine the appropriate output in the automation summary and activity instance (HTML, XML).

Step 4 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Defining the JSON Path Query Activity

Use the JSON Path Query activity to query information based on JSON path expressions and nodes. If the query matches more than one node in the JSON document, an error will be generated.

Step 1 In the Process Editor Toolbox, choose Core Activities > JSON Path Query, then drag and drop the activity onto the Workflow pane.

Step 2 Click the General tab and enter the required information.

Step 3 Click the JSON Path Query tab to define the properties specific to the activity, including the source JSON text to be queried.

Step 4 Click New to add new JSON Path Query under the JSON Path queries column, enter the following information in the JSON Path Query definition dialog box:

• JSON Path Query—Enter the path expression to query.
• Property Name—Enter the property name to display on the Results tab after the activity has run.
• Property Type—Select the data type associated with the path expression to query (String, Numeric, Boolean, or DateTime).
• Error Handling—Select either one of the following option from the drop–down list:

– Fail the activity if this value cannot be found—Select this option to fail the activity if the queried value is not found.

– Specify a default value if this value cannot be found—Enter the default value to be displayed on the activity result, if the queried value is not found.

For example, if the default value is entered as False and the queried value is not found, then the results page displays False in the activity results page.

Step 5 Select the required query row and click Properties, to see or modify the properties of the existing JSON Path query.

Step 6 Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

Getting Started Using the Microsoft SQL Server Database Adapter

Use the following process to monitor and manage Microsoft SQL Server database instances.

Step 1 Create a Microsoft SQL Server database target (see Defining an SQL Server Database Target).

Step 2 Define a Microsoft SQL Server database activity.

a. In the Process Editor Toolbox, choose Database > Microsoft SQL Server > [Microsoft SQL Server Database Activity], then drag and drop the activity onto the Workflow pane.

b. Click the General tab and enter the required information.

c. Click the [Activity-Specific] tabs to define the properties specific to the activity.

d. Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

For details about a specific activity, see Automating SQL Queries in the Microsoft SQL Server Database.

Step 3 View the activity results (see Monitoring Operations).

Defining an SQL Server Database Target

Use the SQL Server Database target to specify the connection information for a SQL server target.

Step 1 Choose Definitions > Targets , right-click and choose New > SQL Server Database .

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Connection tab and enter the required information, including:

• Server—Host name or IP address of the database server
• Default runtime user—The default runtime user account that contains the credentials to connect to the target.
• Connection string—The information needed to establish a connection to the database. To connect to a non-default instance, use the (server\instance) format. If your SQL server has a non-default port number, the correct format is to enter the server\instance, then a comma, then the port number. For example:

servername,portnumber

Step 4 Click the Permission tab to define the type of SQL commands that can run on the target.

Step 5 Click OK to close the dialog box and complete the procedure.

Automating SQL Queries in the Microsoft SQL Server Database

Executing a Microsoft SQL Server SQL Script

Use this activity to execute SQL script against a Microsoft SQL Server database.

Step 1 In the Process Editor Toolbox, choose the [ Microsoft SQL Server Database Activity] property page, then click the Execute SQL Server SQL Script tab.

Step 2 Specify the information that describes the script you want to run, including the script text for the selected database. For example:

• To truncate a sample table Employees:

TRUNCATE TABLE Employees

• To execute a stored procedure:

exec master..xp_logininfo

Getting Started Using the Generic (Microsoft OLEDB) Database Adapter

Use the following process to monitor and manage generic Microsoft OLEDB database instances.

Step 1 Create a generic Microsoft OLEDB database target (see Defining a Generic Data Source (OLEDB) Target).

Step 2 Define a generic Microsoft OLEDB database activity.

a. In the Process Editor Toolbox, choose Database > Generic (OLEDB) > [ Generic (OLEDB) Database Activity], then drag and drop the activity onto the Workflow pane.

b. Click the General tab and enter the required information.

c. Click the [Activity-Specific] tabs to define the properties specific to the activity.

d. Enter the information in the remaining tabs as necessary, then click Save to complete the activity definition.

For details about a specific activity, see Automating SQL Queries in the Generic (Microsoft OLEDB) Database.

Step 3 View the activity results (see Monitoring Operations).

Defining a Generic Data Source (OLEDB) Target

Use the Generic Data Source (OLEDB) Database target to specify the connection information for a generic database.

Step 1 Choose Definitions > Targets , right-click and choose New > Generic Data Source OLEDB Database.

Step 2 Click the General tab and enter the appropriate information.

Step 3 Click the Connection tab and enter the required information, including:

• Database Source—Database server name and database name
• Database Owner—Principal owner of the database
• Default runtime user—The default runtime user account that contains the credentials to connect to the target.
• Connection string—Check the check box and enter the information needed to establish a connection to the database.

Step 4 Click the Configuration tab to specify the character restrictions for a database identifier. A distinction is made between simple identifiers and special identifiers.

Step 5 Click the Permission tab to define the type of SQL commands that can run on the target.

Step 6 Click OK to close the dialog box and complete the procedure.

Automating SQL Queries in the Generic (Microsoft OLEDB) Database

Executing a Generic (OLEDB) SQL Script

This script executes an SQL script against a Generic (OLEDB) database.

Step 1 In the Process Editor Toolbox, choose the [Generic (OLEDB) SQL Database Activity] property page, then click the Execute Generic Database SQL Script tab.

Step 2 Specify the information that describes the script you want to run, including the SQL script text for the selected database. For example, to encrypt data using the ODBC ENCRYPT function:

create proc #tfn

as

select { fn USER() } , { fn CURRENT_DATE() },

{ fn CURRENT_TIME() }, { fn CURRENT_TIMESTAMP() }

go

exec #tfn