- Introduction
- Getting Started
- Managing Automation Packs
- Performing advanced console tasks
- Authoring Processes
- Authoring Categories
- Advanced Authoring
- Monitoring Operations
- Performing Basic Console Tasks
- Performing Administrative Actions
- Working with Events and Triggers
- Using Adapters
- Using the PowerShell Snap-in CLI
- Managing High Availability and Resiliency
- Connecting to Your First Server/Environment
- Understanding the User Interface
Connecting to Your First Server/Environment
This section contains instructions for connecting the console to your first Process Orchestrator server.
There are several user groups assigned to Process Orchestrator’s built-in security roles. Before attempting to access the console, you must be a member of one of these user groups or another group to which your administrator has assigned custom role privileges. If you do not have access or the appropriate rights, please contact your local IT administrator.
Step 1 Choose Start > Programs > Cisco > Cisco Process Orchestrator > Cisco Process Orchestrator Console .
Step 2 In the Select Server dialog, select a server name and click Connect to Server .
Step 3 To configure the console server connection, choose Tools > Options , and update the parameters as necessary.
Understanding the User Interface
Process Orchestrator Console Components
The following topics describe the main components of the Process Orchestrator console:
Console Overview
The Cisco Process Orchestrator Console is the interface used to access and operate the application. The Console displays after completing the license check or updating your license. The default view is the Operations workspace.
After the initial access, the view on the Console is determined by the last item accessed before exiting the Console.
The Console consists of the following areas:
Contains options used to access the tasks associated with the current item selected in the Navigation pane.
Provides shortcuts to general tasks within Cisco Process Orchestrator as well as specific tasks associated with the item currently selected in the Navigation pane.
The Navigation pane, located on the left side of the Console, displays several navigation workspaces, each containing a group of items that enable you to perform specific actions within the application. When a navigation view is selected, the available contents are displayed.
The following is a list of the available views in the Navigation pane.
Console Menus
The Process Orchestrator console menus provide general task items, such as feature customization options. These menus are displayed on the Console menu bar.
The following topics describe the contents of each of the Process Orchestrator Console menus.
Using the File Menu
The File menu contains general actions related to the configuration of Process Orchestrator. The File menu contains the following items:
Opens the Select Server dialog box where you can specify the server to which to connect. The Server drop-down list displays the list of previously connected servers to the Console. You can also enter the specific server address to be connected. |
|
Displays the most recent servers that have been connected to the Console. |
|
Displays the Environment Properties dialog box for the connected Process Orchestrator server. |
|
Launches the Update License Wizard (see Updating the Product License) to enter your product license information. |
|
Using the Edit Menu
The Edit menu contains the following items for modifying the configuration.
Note The items enabled under the Edit menu depend on the objects selected in the navigation and detail panes of the Console.
Using the View Menu
The View menu contains items that determines how the information displays in the results pane. Select one of the following items to adjust the Console display:
Displays icons with the associated name and details in list format |
|
Opens the Choose Columns dialog box, which is used to customize the displayed columns and the order in which they display (see Configuring Columns). |
|
Enables/disables the Navigation pane on the Console. When disabled, the Results pane and the detail pane, if selected, expand the width of the entire window |
|
Determines the toolbars (Standard Toolbar, Advanced Toolbar, Configuring the Appearance of the Console) to display on the Console. The check mark to the left of the toolbar name indicates the toolbar is selected. |
|
Enables/disables the status bar that appears at the bottom of the Console |
Using the Go Menu
The Go menu contains the following shortcuts that allow you to navigate from one view to another on the Console:
Using the Tools Menu
The Tools menu contains the following items that configure the appearance of the Console:
Launches the Customize dialog box. Use this dialog to change the fonts and colors that display in the Console (see Customizing the Fonts and Colors). |
|
Displays the Options dialog box. Use this dialog to modify basic server interface functions. |
Using the Actions Menu
The Actions menu contains items that perform specific actions associated with the selected item in the navigation pane.
The items that are available on the menu depend on the selected item on the Navigation pane. For example, the options available when the Processes view is selected are different from those that are available when Global Variables view is selected.
Understanding the Help Menu
The Help menu contains the following items:
tool to display and remove the Help pane.Toolbars
The Console has three toolbars (Standard Toolbar, Advanced Toolbar, Configuring the Appearance of the Console), which can be used to configure the selected navigation view, provide quick navigation between views, and perform item-specific actions.
To enable or disable a toolbar, choose View > Toolbars , then click the appropriate toolbar.
Standard Toolbar
The Standard toolbar displays shortcuts to general actions and functions. The following icons appear on every view on the Console.
Advanced Toolbar
The Advanced toolbar displays shortcuts to general navigation and Console configuration icons.
Configuring the Appearance of the Console
You can configure options that modify the basic interface behavior of the console.
Step 1 From the Advanced toolbar, select Options to display the Options dialog box provides configuration options that modifies the basic interface behavior.
Step 2 Click the General tab to configure the server connection startup behavior.
- Automatically select the group and item you most recently selected—At console startup, the group and item that are selected are the group and item that were last selected.
- Always select the following group and item—Specify the starting group and item:
– Group—The navigation group that is selected at console startup
– Item—The navigation item that is selected at console startup
Step 3 Click the Windows and Layout tab to specify how the user is to be prompted when a process is launched and what is to be displayed after the process is launched.
- When starting a process—Select one of the following options to determine what action occurs when a process is launched:
– Always Launch Immediately with Default Input Value—Launches the process immediately when the process has specified or default values without confirmation
– Always Prompt to Confirm— Default option launches the Confirm Start Process dialog box to allow you to confirm whether the selected process should be launched or override the process start option
– Only Prompt when Process has Inputs— Launches the Confirm Start Process dialog box if the process has input variables. If the process does not have input variables, starts the process immediately without confirmation.
- After process is started—Choose one of the following options to determine what is displayed after a process begins:
– None—Option does not display any process instances after the process has started
– Show Instances—Displays the processes initiated in the Activities view on the Console
- Reset User Preferences—Click this button to reset the saved settings (size and location of dialog boxes, selected property pages, visibility of toolbars and menu items, etc.) to the system default.
Clicking this button automatically closes the Console and requires the application to restart.
Step 4 Click the Security tab to configure the default owner when creating objects in Cisco Process Orchestrator.
- The current user—Select this radio button to use the user account that is currently logged in to assign the owner on any new objects created.
- The specified user—Select this radio button and then click the browse button to launch the Select User or Group dialog box and specify the default user for objects.
Actions Toolbar
The Actions toolbar displays options that are associated with the selected item in the Navigation pane or Results pane. The available items on the Action toolbar depend on the item selected.
For example, the options available when the Processes item is selected are different from those that are available when Global Variables is selected.
Workspaces
The Console contains the following workspaces. Each workspace contains a group of objects that perform specific actions within the application.
The Operations workspace displays:
For more information, see Chapter8, “Monitoring Operations” |
|
The Definitions workspace displays all of the components that are used in defining and executing processes. The options provided by this workspace include:
From this view, you can view process properties, execute a process ad hoc, edit existing processes, and define new processes. From the Processes View, you can also execute processes and view the status of the process as it in progress. For additional information about monitor and manage processes, see Chapter8, “Monitoring Operations”
For additional information about the Process Editor, see Accessing the Process Editor
For additional information about managing operations, see Chapter8, “Monitoring Operations” |
|
The Administration workspace displays all of the components that are used to manage administrative activities (such as security or database administration tasks). For more information, see Performing Administrative Actions. |
|
The Folder List view displays a list of all the navigation items available from the Console. The items are sorted according to the view displayed on the Console. The Results pane displays the view associated with the selected item. |
|
The Favorites workspace displays shortcuts to user-selected navigation items. This view is used for quickly accessing navigation items that are frequently used. Any item in the Navigation pane can be added to the Favorites view. Click Set Favorites to display the Set Favorites dialog box. Check the appropriate items, then click OK. |
Results Pane
When a navigation item is selected on the Navigation pane, the information associated with that item displays in the Results pane. By default, the information is presented in a details list view format. The columns that display depend on the selected navigation item.
Details Pane
The Details pane provides additional information for a selected item in the Results pane. The links on each of the detail pages launch the property pages for the selected item.
Process Viewer
The Process Viewer displays a graphical view of the process workflow after a process has been launched. The information displayed on this viewer is read-only.
The Process Viewer contains this information:
Process Editor File Menu
Process Editor Edit Menu
The Edit menu contains items to be used for modifying the process in the workflow pane. For information about using this menu, refer to Using the Edit Menu.
Process Editor View Menu
Process Editor Tools Menu
The Tools menu contains the following items that allow you to configure the appearance and behavior of the editor.
Launches the Customize dialog box where users can change the fonts and colors that display in the editor. For information about using this dialog box, refer to Customizing the Fonts and Colors. |
|
Launches the Options dialog box which is used to configure basic Process Orchestrator console behavior. |
|
Launches the Match dialog box where users can match the specified source text against a specified regular expression. |
Process Editor Actions Menu
The Actions menu contains the following items that apply to a selected item in the workflow pane:
Process Editor Help Menu
The Help menu contains information that provides documentation assistance to work in Process Orchestrator. For information about using this menu, refer to Understanding the Help Menu.
Process Editor Toolbar
The toolbar displays icons to be used as shortcuts for performing actions in the workflow pane. To display the toolbar, choose Toolbar from the View menu.
Field Reference Icons
Defining a Target
Targets specify where certain processes, activities, or triggers will run. You can define a target once and then reuse it in multiple processes.
Note Not all targets can be created manually. Some targets are discovered automatically based on the information specified by other targets.
The Definitions > Targets view displays all the existing defined targets. You can also use this view to create new targets, modify the properties of a target, and delete targets.
Step 1 Choose Definitions , right-click Targets , choose New > [Target] , and select a target type from the drop-down list.
Step 2 Run through the wizard, then to validate the target connection, click Test Connection . The following status are displayed based on the connection validity:
- Normal—Status is normal, if the connection is reachable.
- Unreachable—Status is unreachable, if the connection is not reachable or not valid.
Note Testing connection is optional, if you don’t click on test connection the status will be Unknown.
Defining Runtime Users
Runtime users hold the security credentials that are assigned to processes and activities. For more information about runtime users.
Use the Definitions > Runtime Users view to display the configured runtime users, add new runtime users to define new connection credentials, update runtime users such as to update a password, or delete runtime users.
Step 1 Choose Definitions > Runtime Users , right-click and choose New > [Runtime User] for the appropriate runtime user account.
Step 2 Click the General tab and enter the appropriate runtime user-specific information. The property pages displayed depend on the type of runtime user selected.
In the Owner field, you can click the browse button to display the Select Identity dialog box.
From the User Identity tab, click Add to display the Select Identity dialog box.
- Type—From this list, select either User or Group to define the user assignments.
- Location—Specify the user or group location. Click the browse button to display the Select Location dialog box.
- Filter—Filter on the search results
- Search—Click to search for the identity
- Results—Displays search results
Step 3 Search for the identity, select it, then click OK.
The Used By tab displays objects that reference the runtime user. This tab will remain blank until the runtime user is used by an object.
The History tab displays the history of actions taken against the runtime user. This tab remains blank until after the initial creation.
Step 4 To view information about an object, highlight the object, right-click and choose Properties .
Step 5 Click OK to close the property sheet.
Defining a Repository User
Use the following instructions to define the user credentials required to access a repository. Use the Repository User dialog box to specify the credentials for a runtime user record to be used for configuring the repository.
Use the Definitions > Runtime Users view to display the configured runtime users, add new runtime users to define new connection credentials, update runtime users such as to update a password, or delete runtime users.
Step 1 Choose Definitions > Runtime Users , right-click and choose New > [Repository User] for the appropriate runtime user account.
Step 2 Click the General tab and enter the appropriate runtime user-specific information, includes:
- Display Name—Enter the display name for the repository user.
- Owner—The owner of the object. This is typically the creator of the object.
- User name—The user name assigned to the user account.
- Password—Check the check box and then enter the password to be assigned to the user account.
- Email—Enter the valid email Id for the repository user.
In the Owner field, you can click the browse button to display the Select Identity dialog box.
- Type—From this list, select either User or Group or All to define the user assignments.
- Location—Specify the user or group location. Click the browse button to display the Select Location dialog box.
- Filter—Filter on the search results
- Search—Click to search for the identity
- Results—Displays search results
Step 3 Search for the identity, select it, then click OK.
The Used By tab displays objects that reference the runtime user. This tab will remain blank until the runtime user is used by an object.
The History tab displays the history of actions taken against the runtime user. This tab remains blank until after the initial creation.
Step 4 To view information about an object, highlight the object, right-click and choose Properties .
Step 5 Click OK to close the property sheet.
Defining Prime Service Catalog User
Use the following instructions to define the user credentials required to generate a token based authentication to make any API calls to Prime Service Catalog (PSC). Use the PSC dialog box to specify the credentials for a PSC user and to generate token to enable token based authorization.
Use the Definitions > Runtime Users view to display the configured runtime users, add new runtime users to define new connection credentials, update runtime users such as to update a password, or delete runtime users.
Step 1 Choose Definitions > Runtime Users , right-click and choose New > [Prime Service Catalog User] for the appropriate runtime user account.
Step 2 Click the General tab and enter the appropriate PSC user-specific information, includes:
- Display Name—Enter the display name for the Prime Service Catalog user.
- Owner—The owner of the object. This is typically the creator of the object.
In the Owner field, you can click the browse button to display the Select Identity dialog box.
- User name—The user name assigned to the user account.
- Password—Check the check box and then enter the password to be assigned to the user account.
- Enable token based authorization—Check the check box to authenticate the PSC calls using token based authorization. Select either one of the authorization method:
– Allow Persistence token—Check the check box to make use of this persistence (session) token to make PSC API calls.
Once we get the persistence token, the Process Orchestrator uses the token to make any contact with the PSC for the whole session instead of basic authentication, using the authorization header.
– Allow API token—Check the check box to generate token to make PSC API calls.
The Allow API token is a one time token that is generated for each PSC API call.
In a process, if you have four activities such as Create Service Item, Delete Service Item, Find Service Items, and Get Service Item.
- If you enable Allow Session (persistence) token, it uses a single session token for all the four activities in the process.
- If you enable Allow API token, it uses each token for each activity. That is it uses four token in this process.
Note If the Enable token based authorization is not checked, it uses the user name and password for authentication.
Note The token based authorization works only if the Prime Service Catalog is configured to support token.
Step 3 Click OK to close the dialog box.
Selecting a Client Certificate
Use the Select Client Certificate dialog box to select certificate you want to assign to a runtime user.
Step 1 On the Certificate property page, click Browse.
The Select Client Certificate dialog box displays.
Step 2 Click the Certificate tab and specify the following properties about the selected Certificate.
- Issued to—User name or the owner of the certificate
- Issued by—User name of the certificate issuer
- Start date—The date and time the certificate became valid.
- Expiration date—The date and time the certificate will expire.
- Thumbprint—Specified parameters containing the client certificate thumbprint
- Has private key—Select to indicate the certificate is assigned a private key.
Step 3 Browse to the appropriate certificate.
Step 4 Enter the password for the certificate.
Step 5 Click OK to close the dialog box.
Configuring Security
Creating a New Security Role
A security role is a list of permissions that enhances product use through logical groupings of powers and objects for reuse in multiple places. A security permission is a pairing of a scope that defines the objects and powers over those objects.
After a security role has been defined, it is available in a list of available security roles on the Administration > Security view.
Step 1 Choose Administration > Security , right-click and choose New > Role.
Step 2 On the New Role property pages, define the properties.
Step 3 Click the Permissions tab and add permissions as necessary.
Step 4 On the Permissions tab, click Add to display the Permission "All" Over "All" Properties dialog box.
The property pages included in the Power are determined by the specific permission to be created.
Step 5 Click the User Assignments tab and add user assignments as necessary.
Step 6 Click OK . The new security role is displayed on the Administration > Security view.
Assigning Users Or Groups to Security Roles
Step 1 Choose Administration > Security , highlight the appropriate security role (see Predefined Security Roles), right-click and choose Assign .
Step 2 On the Select User or Group dialog box, in the Enter the object name to select text field, enter the user name (domain\user name) or group, then click Check Names .
Note If there is a matching user name or group, it is displayed in the field. If there is not a match, an error message displays.
Step 3 On the Search Results pane, choose the appropriate user or group, then click OK .
Feedback