Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.

Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |

Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
KPI Definitions
Key Performance Indicators (KPIs) provide quantifiable measurements to help you monitor business performance, and assess the business impact of problems in the system. For more information about KPIs, see Service Health Concepts.
The KPI Definitions page includes definitions of all the KPIs that can be used in OMi. Each KPI definition is assigned a default business rule. For a list of out-of-the-box KPI definitions, see List of KPI definitions.
Advanced users can modify the predefined KPI definitions and create new KPI definitions to customize how information is presented. For example, you may want to create new KPI definitions when integrating data from a new external system into OMi.
KPI definitions are categorized as follows:
-
Predefined. Out-of-the-box KPI definitions.
-
Predefined (Customized). Out-of-the-box KPI definitions that have been edited.
-
Custom. New or duplicated KPI definitions.

Administration > Service Health > KPI Definitions
Alternatively, click KPI Definitions.
Learn more

The following table contains a list of available KPI definitions and their descriptions:
KPI (KPI #) |
Description |
---|---|
Application Availability
(7) |
Measures availability of End User CIs (for example, Applications, BTFs, and Business Transactions). |
Application Performance
(6) |
Measures performance on End User CIs (for example, Applications, BTFs, and Business Transactions). |
Backlog
(600) |
Backlog KPI for Business Process Insight Data Displays the backlog information of the business process, business activity or business process monitor, from the Business Process Insight application. |
Backlog KPI for TransactionVision Data Displays information on the number of backlogged (in-process) transactions on the target machine, as determined by TransactionVision. |
|
Business Health
(620) |
Displays the worst status of the following KPIs monitored by the Business Process Insight application, for the process, and its children: Backlog, Business Impact, Business Performance, Value, and Volume. This can be modified in Infrastructure Settings: Administration > Setup and Maintenance > Infrastructure Settings Alternatively, click Infrastructure Settings. Select Applications > Business Process Insight > List of Business KPIs. The Business Health KPI provides a high-level indication of how the business process is currently performing. If the KPI indicates a problem, drill down into the process to locate the underlying problematic KPI. |
Business Impact
(602) |
Displays the health of the process monitored by the Business Process Insight application. |
Business Performance
(631) |
Displays information on the amount of time taken to complete the business process, business activity, or business process duration monitor. |
Delays
(1313) |
Displays information on the delayed (late) transactions on the target machine, as determined by TransactionVision. A transaction is defined as late when its response time exceeds a defined threshold in TransactionVision. |
Duration
(601) |
Displays different information depending on the rule associated with the Duration KPI. A tooltip indicates which metric is involved. |
Efficacy
(630) |
The Efficacy KPI is a custom KPI for measuring the efficiency and capacity of a business process. You can create a custom API rule for the Process Efficacy health indicator, and assign this health indicator to this KPI. For more details, see Service Health Rules API. |
Exceptions
(1310) |
Displays information on transactions that did not follow the expected flow path on the target machine, and are therefore classified as exceptions in TransactionVision. |
Failures
(1312) |
Displays information on the failed transactions on the target machine, as determined by TransactionVision. A transaction is classified as failed when it does not match the attribute or pattern defined as failure in TransactionVision. |
Generic
(1500) |
Displays information calculated by the Generic Formula rule or by the Summary of Values rule. |
Legacy System
(1) |
Displays information relating to SiteScope metrics that are not aligned with existing health indicators, as well as data for SiteScope monitors, measurements, and groups in the System Monitor view. For Siebel CIs, this KPI indicates physical problems with this CI or underlying CIs, provided by SiteScope physical monitors (for example, CPU monitor, disk space monitor, and so on). SiteScope is the source of the data. For SAP CIs, this KPI indicates physical problems with underlying hosts, provided by SiteScope physical monitors (for example, CPU monitor, disk space monitor, and so on). By default, the System KPI does not appear in the view. If you are using a regular SiteScope monitor (which creates the System KPI) and you want to display the System KPI in the view, you must add the System KPI manually to the CI. |
Locations
(303) |
Deprecated. The Locations KPI is a bar that includes up to six colored sections. Each colored section represents the relative amount of Business Process Steps with the end-user experience status (the worst status between Application Performance and Application Availability) that corresponds to the color, at that location. The colors correspond to the Business Process Monitor Application Performance/Application Availability colors. For example, if there are ten SAP Business Process Steps under the Locations container, five with OK end-user experience, two with Minor status, two with Critical status, and one with No Data status, the bar displays: 50% green, 20% yellow, 20% red, and 10% light blue. The KPI's tooltip displays how many locations have each status, and the total number of locations. The tooltip's color represents the worst location status. |
Network Availability
(308) |
Displays information relating to availability of network devices. |
Network Performance
(1077) |
Displays information relating to performance measurements of network devices. |
Number of Open Incidents
(2600) |
Displays the number of incidents that exist in HPE Service Manager, and that currently have the initial status and final status defined in the rule parameter and are associated with the business service. Tickets can have any status between Initial Status and Final Status as long as they had the initial status after the integration and that they are not currently closed. |
Operational Status
(615) |
Displays the worst status of all operational (non-business) KPIs monitored by Business Process Insight, for the process, and its children. The Operational Status KPI provides a high-level indication of how the operational (non-business) KPIs are currently performing. If the KPI indicates a problem, drill down into the process activities and any linked system CIs to locate the underlying problematic KPI. |
OT Impact
(13) |
Displays information relating to the financial loss caused to the organization when an item is unavailable over time. By default, the calculation is based on the Availability KPI. You should attach the Impact Over Time rule to the OT Impact KPI and the Availability KPI to the same CI. The Impact Over Time rule measures the total time the Availability KPI attached to the same CI has the red status, and then calculates the financial loss by using the DollarImpactFactor rule parameter. This parameter represents the amount of dollars lost in an hour if the system is unavailable. At the group level, you should attach the Sum of Values rule to the OT impact KPI. The Sum of Values rule calculates the sum of all of the values of the OverTime Impact KPI of its children. The OT Impact rule calculates financial loss as you add the OT Impact KPI. The calculation has no time limitation. To restart the calculation, you can change the rule's objectives, or delete the OT Impact KPI and add it again. Restarting OMi might restart the financial loss calculation, but because of calculation persistency, the last known financial value might be recovered instead. |
Performance Analytics
(635) |
Displays information collected from Service Health Analyzer (SHA), indicating the severity of an anomaly on the selected CI (and its child CIs), as follows:
Other severities are defined by patterns that SHA has identified as an anomaly type. Note If you encounter a situation where the Performance Analytics KPI is permanently in Critical (red) status in Service Health application components, this may be caused by an unexpected shutdown of the SHA engine. To resolve this, access the menu commands for the corresponding CI and select Show > HIs. From the HI's menu commands, select Operations > Reset Health Indicator. |
RT Impact
(11) |
Displays information relating to the financial loss caused to the organization in real time. The calculation is based on the Availability KPI. You should attach the Real Time Impact rule to the RT impact KPI and the Availability KPI to the same CI. The Real Time Impact rule measures the time the Availability KPI attached to the same CI has the red status, and then calculates the financial loss by using the DollarImpactFactor rule parameter. This parameter represents the amount of dollars lost in an hour if the system is unavailable. If the Availability KPI status is not red, then the Real Time Impact value is 0.0$. At the group level, you should attach the Sum of Values rule to the RT Impact KPI. The Sum of Values rule calculates the sum of all of the values of the Real Time Impact KPI of its children. When availability status returns to green, the value for this KPI reverts to 0. |
Security
(307) |
Displays the status of the security in the Operations Manager. This is an optional KPI. It is displayed when you select Create Network and Security KPIs in the Operations Manager integration definition. For details on the integration with Operations Manager, see the OMi - OM integrations in the Integrations Catalog. |
SiteScope Health
(1003) |
A SiteScope Health KPI is attached to each SiteScope Profile CI. It displays the availability of the SiteScope. SiteScope periodically (every minute) sends a heartbeat to OMi. If the heartbeat is received by OMi, the status of the SiteScope Health KPI is green. If the heartbeat is not received, the status of the KPI is blue (No data). This indicates that there is no communication between SiteScope and OMi. In this case, the status of all the SiteScope monitor and group CIs is also blue. |
Software Availability
(15) |
Displays information relating to availability of software element CIs (for example, databases, J2EE servers, and web servers). |
Software Performance
(1075) |
Displays information relating to performance on software element CIs (for example, databases, J2EE servers, and web servers). |
System Availability
(1001) |
Displays information relating to availability of system element CIs, such as servers and disks. |
System Performance
(1002) |
Displays information relating to performance measurements of monitored system element CIs, such as servers and disks. |
Throughput
(400) |
For SOA. Displays the number of calls to the item per minute. |
Unassigned Events
(10005) |
Displays information relating to the number of unassigned events on the CI, which are not handled in the event lifecycle. Note When there is new information on a CI, Operations Management automatically sends an HI value for this KPI. These HIs are hidden and cannot be deleted. A hidden KPI assignment creates this KPI. To remove this KPI, open KPIs in Views: Administration > Service Health > KPIs in Views Alternatively, click KPIs in Views. Select a view from the drop-down list. The detailed list of the KPIs is displayed for the selected view. Clear the check box corresponding to this KPI in the Include in View column. |
Unresolved Events
(10004) |
Displays information relating to the number of events on the CI whose status in not normal. Note When there is new information on a CI, Operations Management automatically sends an HI value for this KPI. These HIs are hidden and cannot be deleted. A hidden KPI assignment creates this KPI. To remove this KPI, open KPIs in Views: Administration > Service Health > KPIs in Views Alternatively, click KPIs in Views. In the View Explorer pane, select a view. The right pane displays the detailed list of the KPIs in the selected view. Clear the check box corresponding to this KPI in the Include in View column. |
Value
(1311) |
Value KPI for Business Process Insight Data Displays information on the monetary value of the business process, business activity, or business process value monitor. The default rule is Worst Status Rule, which calculates the KPI based on the worst status (or value) of the associated health indicators. Note This KPI does not include predefined objectives, and it displays the Informational (blue) status. To calculate the KPI status, define meaningful objectives for the KPI within Administration > Service Health > CI Customizations. |
Value KPI for TransactionVision Data Displays information on the monetary value of the transactions on the target machine, as determined by TransactionVision. This KPI uses, by default, the In-process Transaction Value for CIs monitored by TV. To see data on completed transactions, change the HI in the KPI assignment for the KPI. For details on KPI assignments, see KPI Assignments. Note This KPI does not include predefined objectives, and it displays the Informational (blue) status. To calculate the KPI status, define meaningful objectives for the KPI within Administration > Service Health > CI Customizations. |
|
Volume
(1050) |
Volume KPI for Business Process Insight Data Displays the value or count of the number of completed instances for the business process, business activity, or business process monitor. The default rule is Worst Status Rule, which calculates the KPI status based on the worst status of the associated health indicators. Note This KPI does not include predefined objectives, and it displays the Informational (blue) status. To calculate the KPI status, define meaningful objectives for the KPI within Administration > Service Health > CI Customizations. |
Volume KPI for Real User Monitor Data Displays information on traffic volume, such as transaction runs, amount of sessions, errors, and events. Note This KPI does not include predefined objectives, and it displays the Informational (blue) status. To calculate the KPI status, define meaningful objectives for the KPI within Administration > Service Health > CI Customizations. |
|
Volume KPI for TransactionVision Data Displays information on the volume of completed transactions on the target machine, as determined by TransactionVision. Note This KPI does not include predefined objectives, and it displays the Informational (blue) status. To calculate the KPI status, define meaningful objectives for the KPI within Administration > Service Health > CI Customizations. |

The following table contains a list of formatting methods that can be used to format the result that is displayed in OMi:
Formatting method |
Description |
---|---|
analyzeSiteScopeMessage |
If, in a message, a long word overlaps the end of the line, the word is truncated. The rest of the word and the rest of the message are wrapped. |
encode |
Inserts a back slash (\) before special characters. |
formatDecimalNumber |
Returns as a formatted decimal number. The number of digits after the decimal point is indicated by numAfterDot. |
formatDateTime |
Returns formatted as date and time: DDMMMYYYY hh:mm:ss. |
formatPnrValue |
Formats the pnr time left in the PNR format. |
getHHMMSS |
Converts a string representing number of seconds to the format HH:MM:SS. |
getIntValue |
Returns an int number as string. |
getMilliAsSec |
Returns a millisecond value as seconds by dividing the value by 1000. |
getMustValue |
Returns ! if there is a value, otherwise returns nothing. |
getRemedyETTR |
Deprecated. |
getRemedyResource |
Deprecated. |
getResourceString |
Returns the corresponding resource string to the given string. |
getStatusString |
Returns the corresponding resource string to the given status string. |
getWeightValue |
Returns the value if there is a value, otherwise returns 1. |
ifEndCheck |
Changes an empty string into a comment line. Inserts --> at the end of the string. |
ifStartCheck |
Changes an empty string into a comment line. Inserts <!-- at the end of the string. |
numberToTime |
Converts a string that can represent a period of time in seconds into a more readable format. |
resourceFromKey |
Used to get the resource of the ticketing sample field. |
returnDateAsString |
Returns the given date in milliseconds in the date format as it appears in the .resources file. |
returnDateAsStringInSec |
Returns the given date in seconds in to the date format as it appears in the .resources file. |
returnNumOfDigitAfter |
Formats the given string and returns a string that shows only 3 digit after the point. |
returnNumOfDigitAfter |
Formats the given string and returns a decimal number. The number of digits after the decimal point is specified in (digits). |
returnNumOfDigitAfter |
Converts the given string into a decimal number with 3 digits after the decimal point preceded by a dollar sign. |
returnNumOfDigitAfter |
Converts the given string into a decimal number with 3 digits after the decimal point followed by a Euro sign. |
returnWithPercentSign |
Converts the given string into a decimal number with 3 digits after the decimal point followed by a percentage sign. |
toLowerCase |
Returns the lowercase of the given string. |
toLowerCase_encode |
Works in the same way as toLowerCase but adds escaping on the return value. |
Tasks

-
In the central KPI Definitions pane, click
New. Alternatively, you can click
New in the right pane.
Note For a list of predefined KPI definitions and their descriptions, see List of KPI definitions.
The Create Key Performance Indicator panel opens.
-
In the General section, enter a display name for a KPI and the domain to which this KPI is assigned. Either select an existing domain, or enter a new domain name for this KPI.
-
In the Rules section, complete the following information:
-
In the Applicable rules field, define which rules can be applied for the KPI.
Important The rule that you define first becomes the default one for this KPI. If you want to change the default rule, hover over the desired rule, and click
.
Note When a KPI is defined for a CI, it is usually added to a parent CI. The parent item uses the group rule to calculate the KPI status.
If you want to delete a rule, click
Delete.
-
Define the trend for the KPI by selecting one of the following:
-
Value decreases. When the value decreases, the KPI is critical.
-
Value increases. When the value increases, the KPI is critical.
-
Value remains constant. When the value remains constant, the KPI is critical.
For details, see KPI Trend and History Calculation.
-
-
-
In the Presentation section, select how you want the KPI result to be displayed. You can choose among the following options:
-
Status Icon. Displays data by using icons. The following image shows the KPI status icons:
-
Status Text. Displays data by using colored text. The following image shows the KPI status text:
-
Value or Status Icon. If you choose the value or status icon format, you can define the method for formatting the value of the KPI by selecting Format using the method, and then choosing a formatting method from the drop-down list of available methods (for details, see List of formatting methods).
The following image shows the KPI value or status icons:
-
-
In the Ordering section, define the following information:
-
Use the Calculation order slider to define the KPI position in the ordered list used by OMi when it calculates the topology. OMi calculates the higher priority KPIs first, and then the lower priority KPIs.
A KPI is dependent on another KPI when the rule that calculates the value of the first KPI uses the results of the second KPI's rule. For example, if the RT Impact KPI and the Availability KPI are attached to a CI, the value of the RT Impact KPI depends on the values of the Availability KPI. These KPIs must therefore be calculated in a specific order.
- Use the Display order slider to define the order in which the KPIs are displayed in OMi.
-
- Click Create.

-
Select a KPI from the central pane, and click
Edit. Alternatively, you can click
Edit in the right pane.
The Edit Key Performance Indicator panel opens.
-
Edit the selected KPI as required. For details on the information that you need to provide in each section, see How to create a KPI definition.
-
Click Save.

-
Select a KPI from the central pane, and click
Duplicate to create a new KPI by using the selected KPI as a template.
Note The original KPI does not change. The new KPI is labeled as Custom.
- Edit the KPI as required. For details on the information that you need to provide in each section, see How to create a KPI definition.
- Click Create.

If you edited predefined KPI definitions, you may want to return them to their default settings. To do so, select the customized KPI definition, and click Revert. The KPI definitions is returned to its default settings and its type reverts to Predefined.
Important Reverting to default is applicable only for KPI definitions whose type is Predefined (Customized).

Select one or more Custom KPI definitions that you want to delete, and click Delete.
Important Predefined (Customized) KPI definitions cannot be deleted, but only restored to default. Predefined KPI definitions cannot be deleted at all.
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: