Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
2
Using
Date: 2019-08-17 21:47
URL: https://docs.bmc.com/docs/x/DhrwM
Developing workflows
To log on to TrueSight Orchestration Operator Control Panel
1. Open a web browser.
2. In the browser's address box, enter the following URL:
http://<hostNameOrIP>:<CDPWebServerPort>/<webContext>
In the URL, <hostNameOrIP> indicates the IP address or host name of the configuration distribution peer (CDP)
installed. The <CDPWebServerPort> is the web server port designated during the CDP installation. The
default <webContext> provided at installation is baoocp.
To log off TrueSight Orchestration Operator Control Panel
In the upper right corner of the main window for the TrueSight Orchestration Operator Control Panel application,
click Logout.
The You've been successfully logged out message appears, and you are logged out of the Operator Control
Panel.
To ensure that a workflow is not displayed again after logging back on to the Operator Control Panel, close the workflow
by clicking the Close Workflow button in the information pane of the workflow canvas.
To log on again, click the Click here link on the log off screen, and re-enter your user name and password.
Workflow Explorer
The Workflow Explorer displays on the left side of the Operator Control Panel window. The Workflow Explorer pane lists
the workflows for which you have read and write access. The workflows in the Workflow Explorer pane are organized by
module and process directory.
The Search field is located in the Workflow Explorer.
Workflow Canvas
The Workflow Canvas displays a graphical representation of the workflow on the right side of the Operator Control Panel
window. The Workflow Canvas displays a maximum of five workflows at a time. Each workflow displays in a separate tab.
When you select a workflow in the Workflow Explorer, it displays in the Workflow Canvas. If a complicated workflow is
selected on the Workflow canvas you can resize the window for optimal display.
• Information pane: The Information pane is displayed when you display a workflow on the Workflow Canvas. Each
workflow contains its own Information pane that includes information on selecting a control to run the workflow in
Step or Run to Completion mode and a description on what inputs are required for the workflow.
• Activity Results pane: The Activity Results pane is displayed when you execute a workflow. It displays the
workflow activity results. The Activity Results pane displays the workflow execution properties and the Activities
Results table. The workflow execution properties section contains a comment defining the workflow execution
state, fields describing who ran the workflow, the status, duration, start time, and end time of the workflow. The
job ID displays when you click the Job ID button. The Activity Results table lists the steps in the workflow with a
summary and details.
The information toggle is a checkbox located above and to the right of the Activity Results table. When you select
the information toggle, information messages will appear in the Activity Results table if the workflow is designed
to emit information messages. Information messages appear with an "I" icon.
This section contains the following topics:
• Screen tips for TrueSight Orchestration Operator Control Panel
• Workflow status indicators
• A workflow requiring user input has a yellow tab with a triangular shaped icon. When you review the
workflow, the activity requiring input is highlighted in yellow and is flashing.
• A workflow that is halted or did not complete successfully has a red octagonal icon .
Workflow execution
In the TrueSight Orchestration Operator Control Panel application, you can control workflow execution using two modes.
Both modes enable you to provide user input when prompted by the workflow and to view workflow execution as it
occurs. However, you use Run to completion to run most workflows, and Step mode to troubleshoot workflows that end
in compensation.
Step mode
This mode enables you to troubleshoot the workflow by stepping over or into activities during workflow execution. As the
workflow runs, TrueSight Orchestration Operator Control Panel pauses at each activity and waits for your input. This input
could be a text value you enter, input you select from the dialog, or a Step comment such as Step over, Step into, or
Return. When you run a workflow in Step mode, you can switch to Run to completion mode at any point during workflow
execution.
The Information pane is replaced with Activity Results pane that records the the operator information, the inputs, and the
responses.
If you need to provide input, a dialog box displays and the workflow pauses until you submit the information.
The workflow executes, and the Results pane replaces the Information pane.
Note
If the workflow requires your input, a dialog box is displayed and the workflow pauses until you provide
the information.
3. When the workflow completes an activity it pauses and the toolbar is highlighted.
• Click the Step icon to skip to the next activity.
• Click the Step Into icon to drill down into the activity. If you select step into, then the Operator Control
Panel pauses for input at all activities in the branches of the workflow.
• Click the Run to Completion icon to run the workflow without further pauses, or until it requires your
input.
Note
This file is located on the CDP computer under
[AO Home]/tomcat/webapps/baoocp
<ops-console-ui-config>
<max-concurrent-processes>*5*</max-concurrent-processes>
</ops-console-ui-config>
Note
This change applies to all instances of the Operator Control Panel connected to the grid, and takes effect
immediately.
Default timeouts
The CDP controls the grid which contains the workflow you execute in the product. The CDP has system timeouts, and the
Operator Control Panel has timeout specifications for idle states and workflow preservation.
• Idle timeout - This timeout specifies that you are logged out of the Operator Control Panel after 20 minutes of
inactivity.
• Workflow timeout - This timeout preserves the state of running workflows for 60 minutes after accidental or
intentional logout. For example, if you accidently closed the web browser, the state of running workflow is
preserved for 60 minutes.
• Health Dashboard
• Value Dashboard
• Where to start
Related topics
If a problem occurs
Health Dashboard
The TrueSight Orchestration Health Dashboard provides TrueSight Orchestration administrators a snapshot view of the
health and configuration status of all TrueSight Orchestration components that make up the solution. The Value
Dashboard provides the ability to customize reports on the value added with TrueSight Orchestration processes (also
called workflows).
TrueSight Orchestration environment can be a complex system that includes a large number of servers, adapters, and
workflows. System administrators need to visualize the architecture and understand how well the components in the
environment are performing. The Health dashboard provides the following overviews of a TrueSight
Orchestration environment and its configuration:
• The health of the host servers in the environment and the peers running on them
• The version of TrueSight Orchestration peers that are running
• The architecture of the machines on which the peers are running
• The adapters, modules, and components associated with the peers and their state
• The adapter instances that are in a fault state and on what peers
• The jobs that are running and how many jobs have been running for a long time
The Health Dashboard is not a replacement for real-time monitoring. It highlights key health and configuration issues
before they impact the solution's performance and availability.
Value Dashboard
The Value Dashboard provides reports related to the impact of process runs. Reports cover the following information:
• How much time is being saved by running a process
• How much money is being saved by running a process
Administrators can use the Value Dashboard to customize Value reports related to TrueSight Orchestration processes (also
known as workflows). Value reports indicate the time or money saved by the process runs that occurred during the
reporting period.
Where to start
To run the dashboards, see Accessing the dashboards.
Authentication is configured using a BMC authentication service. For more details, Managing users, groups, and realms in
Remedy Single Sign-On.
You can access one grid per browser window. To access another grid, open a new browser window and repeat the
previous steps, choosing a different grid in the Grid Server list.
To change the port number
This section provides an overview of how to change the Apache Tomcat server port number and requires some knowledge
of working with the Apache Tomcat product. For more information, consult the Apache documentation.
1. Ensure that the Tomcat server is not running. If it is running, stop it.
2. Navigate to the tomcat/conf directory, locate the server.xml file and open it for editing.
3. Search for the following line:
Server port="18080" shutdown="18050"
and change the port number 18080 to the new port number.
4. Search for the following lines:
<Connector port="18080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort=8443" />
and change 18080 to the new port number that you used in the previous step.
5. Save your changes.
Related topics
Health Dashboard
Value Dashboard
Note
The values shown on the dashboard represent the information that was available at the last data collection. The
values may have changed since that time.
This page provides the following information about your TrueSight Orchestration environment:
Area Description
Grid Summary
This area displays the host servers in your TrueSight Orchestration
environment and provides summary information about the hosts.
Note
This data includes the hosts and peers listed in the gridhosts file
that you configured after the installation (see Configuring your
environment to use TrueSight Orchestration dashboards) and
running in the environment. If a peer is not listed in the gridhosts
file and is not running in the environment, it will not be listed in this
area.
Grid Environment
This area reports on the state of the databases configured in your
environment, the repository and authentication servers.
Jobs
This area displays information about the jobs in your TrueSight Orchestration
environment.
This area provides information about the workflow jobs. It reports any jobs
that have been running for over an hour. This is considered outside the
expected time range. There should be less than one percent of your total jobs
taking this long to run.
Grid Statistics
This area provides the following three main statistics. In each case the
Current value should be 0. If it is a different number, you should investigate
the problem and take action.
The statistics displayed in this area are the values that were available the last
time the data was collected. The values may have changed since that time.
• Elections indicates that the current master component has changed or if
there is a new master, indicating a change in the grid (when Current is
greater than 0).
This value indicates the number of times an election is called on the peer
due to exceptional conditions and it represents all election types,
including missed heartbeats and multiple master-induced elections.
For more information about administering components, see Grid
components and their status.
• Link Failures indicates that there was a link failure between servers,
including intermittent link failures (when Current is greater than 0).
The value is the number of link failures over the last specified time
period. The time period is configurable and the default time period is 60
minutes.
• Peer Disconnects indicates that a server is not running (when Current is
greater than 0).
The value is the number of peer disconnects over the last specified time
period. The time period is configurable and the default time period is 60
minutes.
A peer disconnect is recorded when a component
• Recognizes link failure.
• Receives a shutdown message from a peer.
• Receives a bind message for which a reconnect is needed.
For information about administering servers, see Managing grids and
Managing peers.
You can drill down on a peer for more information about the peer and its components. This page includes the following
information:
• Peer summary information appears across the top. It also includes information about adapters, components, and
logging levels. Click View to access details.
• Health Stats provides metrics about the peer. Click Historical Info for historical information covering the time
period of your choice.
Click on a host to display details about the peers running on the host.
Note
This data includes the hosts and peers listed in the gridhosts file that you configured after the installation
(see Configuring your environment to use TrueSight Orchestration dashboards) and running in the environment.
If a peer is not listed in the gridhosts file and is not running in the environment, it will not be listed in this area.
Viewing adapters
Provides summary information about the adapters in the environment, such as the type, version, run and stop counts, and
fault counts. This page provides the following additional options:
• Expand the arrow to the left of an adapter to display the peer on which the adapter is running.
• Filter information by adapter name or type.
Note
Searches are case-sensitive. Do not add spaces after the adapter name (the search does not work if there
are spaces at the end of the name).
Viewing modules
Provides information about the modules in the environment, such as who last activated or deactivated them. This page
indicates if a module exists in the library (but is not currently used), is activated, or is deactivated.
The following table includes examples of how module versions may appear in the dashboard.
Version 1 was activated at Activated No historical information. This is the only version of
2:09 PM. the module and it is
currently activated.
Version 1 was activated at Version 2 = Activated, Version 1 = Deactivated, Version 2 has the most
2:09 PM. Timestamp = 3:05 PM Timestamp = 3:00 PM recent timestamp and is the
activated version.
At 3:00 PM a user manually Version 1 = Activated,
deactivated version 1. Timestamp = 2:09 PM When a version is manually
deactivated, the event
At 3:05 PM Version 2 was appears in the history.
activated.
If a module is activated or deactivated on the primary configuration distribution peer (CDP) and then the user logs into the
dashboard on the high-availability configuration distribution peer (HA-CDP), there is no historical information for the
module. If the module is activated or deactivated on the HA-CDP and then the user logs into the dashboard on the CDP,
there is no historical information for the module.
Viewing components
Provides summary information about all components for all peers in the environment, including which components are
masters.
Viewing configuration
Provides the following configuration information:
• Peers with excessive logging (more than two components with debug set to ON).
• SSL validation for the CDP.
Viewing jobs
This topic describes the summary of jobs that appear on the Health Dashboard.
On the job list, you can view the details for the jobs running up to the last thirty days only.
You can filter the job list by specifying appropriate values in any of the fields. For example, on the Status column,
enter Completed to view all jobs that are in a completed state.
Note
You can use the filter only for the Status, Module Name, Process Name, Peer Name, and Invocation
Method fields.
From the Duration list, you can choose to view the jobs list for the Today, Last Ten Days, or for the Last Thirty Days.
Note
You can customize the columns to be displayed on the dashboard by using the Columns option.
Job output is displayed when you click the job status. For compensated jobs, the reason for compensation, and error
message with stack trace is displayed.
Note
Job output is mapped to the output parameters defined for the workflow.
The following figure shows more information about a job that is in a compensated state.
For example, if you select Last 10 Days from the Duration list, and then click , jobs data for the last ten days is
exported to a Microsoft Excel file.
Viewing Jobs
Displays a graphical view of the jobs executed on the peer.
The graph displays the total number of jobs in the following states:
• Completed
• Compensated
• Queued
• Running
The following figure shows the jobs executed in the selected duration, in this case, last 10 days.
You can filter the job view by using the Duration list, which provides the following options:
• Today
• Last 5 Days
• Last 10 Days
• Last 30 Days
• Last 90 Days
• Last 180 Days
• Last 365 Days
• All
Health Dashboard
Viewing usage
Displays the number of times an adapter has been invoked, in a graphical form.
The total number of adapter usage count for all actor and monitor adapters enabled on the Grid is displayed on the
dashboard. The bar graph shows the usage by the adapter type.
Note
By default, the adapter name in a graph appears as configured in a file at the following location:
DASHBOARD_HOME/config/adapter-type-name-mapping.properties
For custom adapters, you must update the adapter type name on the config file.
Adapter usage is displayed for the adapters that are enabled on the Grid to which the Health Dashboard is connected. By
default, adapter usage for the last 10 days is displayed on the dashboard. You can select the following options from the
Usage Period list:
• Today
• Last 5 Days
• Last 10 Days
• Last 30 Days
• Last 90 Days
• Last 180 Days
• Last 365 Days
• All
When you select a range, the current period and the usage for the selected period are displayed on the dashboard.
The following figure shows the adapter usage count when Today is selected. The Current Period field shows today's date.
For example, click the SSH adapter bar on the dashboard to view the usage count for all adapters of the type SSH across all
peers on which the adapter is enabled. The following figure displays the number of times the SSH adapter is invoked
across multiple peers on the Grid. Labels such as AP, CDP, and HACDP denote the peers on which the SSH adapter is
enabled and the number of times it is invoked.
Related topics
Troubleshooting the dashboards
Health Dashboard
Value Dashboard
The Dashboard page of the Value Dashboard displays Value reports associated with TrueSight Orchestration processes
(also called workflows). Value reports indicate the time or monetary savings for the process runs that happened over the
reported period. From the Dashboard page, you can access all available Value reports.
Note
Administrators can create value reports and add them to the Dashboard page (see Setting up the Value
Dashboard and reports).
Click All Reports.
You can filter reports in the list by report name in the Report Name column.
You can click on a report in the list to drill down into the report's details.
After viewing a report's details, click Close to return to the Dashboard page.
Related topics
Accessing the dashboards
You can export information in tabular format to a comma-separated value (CSV) format. After exporting to CSV, you can
easily import that information into a spreadsheet.
To export data in CSV format
1. Use one of the following methods:
• On the Health Dashboard page containing the tabular information, click the CSV button .
• On the Value Dashboard, click on the report name to drill down into the report's details and then click
the CSV button .
2. In the dialog, choose one of the following:
a. Open with: Click Browse to select the application you want to use to open the file. Once it opens, you can
save it or take another action.
b. Save File: Saves the file to your Downloads directory.
Date: 2019-08-17 21:47
URL: https://docs.bmc.com/docs/x/DhrwM
BMC, BMC Software, the BMC logo, the BMC Software logo, and other BMC marks are the exclusive properties of BMC
Software, Inc. and are registered or may be registered in the U.S. and in other countries. BladeLogic and other BladeLogic
marks are the exclusive properties of BladeLogic, Inc. and are registered or may be registered in the U.S. and in other
countries. All other trademarks or registered trademarks are the property of their respective owners.
Cisco is a registered trademark of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
AS/400, DB2, IBM, Informix, Netcool, Pointbase, and Tivoli are trademarks or registered trademarks of International
Business Machines Corporation in the United States, other countries, or both.
IT Infrastructure Library® is a registered trade mark of AXELOS Limited.
ITIL® is a registered trade mark of AXELOS Limited.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their
respective owners.
SAP is a trademark or registered trademark of SAP AG in Germany and in several other countries.
UNIX is the registered trademark of The Open Group in the US and other countries.
The information included in this documentation is the proprietary and confidential information of BMC Software, Inc., its
affiliates, or licensors. Your use of this information is subject to the terms and conditions of the applicable End User
License agreement for the product and to the proprietary and restricted rights notices included in the product
documentation.
Click here for the provisions described in the BMC License Agreement and Order related to third party products or
technologies included in the BMC product.