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	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Administer > RTSM > RTSM Developer Reference > Creating Discovery and Integration Adapters > Viewing KPIs in External Applications > Set Up an Adapter to View KPIs in an External Application

Set Up an Adapter to View KPIs in an External Application

This section explains how to retrieve the status and value of HPE Business Service Management KPIs when working in an external application. You can view the results in your application, or you can use the results in calculations, statistics, and so on.

This task describes how to set up the BACKPIsAdapter.

Create an Adapter Instance
In HPE Business Service Management, in the integration point, create an adapter instance named BACKPIsAdapter. Use the following definitions:
- Adapter. Enter BACKPIsAdapter.
- Is Integration Activated. This check box should be selected.
- Host name and IP. Enter details of the OMi Gateway Server.
- Port. Enter 80.
- Customer ID. Enter 1.
- Is CMS External. Select true if you are working with an external CMS; select false if you are working with the RTSM.
In the second stage, choose the Kpi and KpiObjective CITs.

For details, see Integration Point Pane.
View the Attributes in the CIT Manager
The following attributes are used by the Kpi CIT:
- KpiName. The name of the KPI, for example, Availability, Performance.
- Origin. The origin of the KPIs, for example, HPE Business Service Management.
The following attributes are used by the KpiObjective CIT:
- Origin. The origin of the KPIs, for example, HPE Business Service Management.
- KpiValue. The numeric value of the KPI as calculated by the KPI business logic rule, for example, 0, 100, 3.2. (This value is optional.)
- KpiStatus. The status of the KPI as calculated by the business logic rule (can be one of the following values: ok, warning, minor, major, critical, none).
- KpiUnitOfMeasure. The measurement unit of the NumericValue field, for example, %, $. (This value is optional.)
- LastModifiedTime. The date when the status last changed.
- KpiComparisonOperator. This attribute contains enum operators: na, =, >, <, <=, >=.
- KpiThresholdOk. The range of values that defines the OK KPI status.
- KpiThresholdWarning. The range of values that defines the WARNING KPI status.
- KpiThresholdMinor. The range of values that defines the MINOR KPI status.
- KpiThresholdMajor. The range of values that defines MAJOR KPI status.
- KpiThresholdCritical. The range of values that defines the CRITICAL KPI status.
For details on working with the CIT Manager, see CI Type Manager and CI Type Attributes.

For details on KPI rules, see "Business Rule Repository" in Using Service Health.
Define a TQL

Define a TQL using the Kpi and KpiObjective CITs. For details, see Define a TQL Query.
Consume KPIs in External Application

Using the API of your external application, send a query to run the relevant TQL in HPE Business Service Management, to retrieve the status and value of the federated KPIs.

Send Help Center feedback