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 |
|
Service Health Database Query API
You can use the Service Health API to query the database and return a list of views in XML format.
Tip You can use XSLT to convert the XML output into any other format (commonly text or HTML). For example, using basic XSLT transformations, you can produce HTML reports that are formatted to fit on mobile devices. These reports can be served via a mobile portal to display critical Operations Manager i views on users' mobile phones.
The basic syntax of the query is as follows:
https://<Gateway Server>/topaz/bam/BAMOpenApi?customerId=<customer ID>&userName=<user name>&password=<password>&command=<command parameter>
Depending on the command parameter defined, additional parameters may also be included.
The following table lists the parameters that must be defined in the query.
Parameter |
Description |
---|---|
customerID |
OMi customers should specify 1. |
userName |
Specify a user name defined in OMi. The query does not encrypt the login credentials. |
password |
Specify the password for the user name provided. The query does not encrypt the login credentials. |
command |
Specify one of the following values: getViews – Specify to retrieve all views from the Run-time Service Model (RTSM). No other parameters are required. getNodes – Specify to retrieve all child nodes of a specified view (you must also specify the view for which to retrieve child nodes in the viewName parameter); if using this command parameter you can also set the following parameters: showTooltip, depth, layout, xsltURL, responseContentType |
viewName |
If the getNodes command parameter is defined, include this parameter in the query and specify the view to retrieve. You can set the value to ticker_all_views to retrieve all views and their nodes. |
showTooltip |
If the getNodes command parameter is defined, you can include this parameter in the query to specify whether to display Service Health's KPI tooltip data, either true to display data or false to not. The default value is false. |
depth |
If the getNodes command parameter is defined, you can include this parameter in the query to specify the number of levels in the view to display. The default value is 1. |
layout |
If the getNodes command parameter is defined, you can include this parameter in the query to specify the layout for the query results, either hierarchical or flat. In flat mode all nodes are retrieved in a flat list, and in hierarchical mode nodes are retrieved in the same hierarchy as in the view. The default value is flat. |
xsltURL |
If the getNodes command parameter is defined, you can include this parameter in the query to specify a URL to an .xslt file that transforms the .xml-format result of the query. |
responseContentType |
If the getNodes command parameter is defined, and the xsltURL parameter is included in the query, you can include this parameter in the query to specify the response MIME type. |
Below are examples of queries and the data they return.
The following query returns a flat list of all views in the Run-time Service Model (RTSM):
https://myserver/topaz/bam/BAMOpenApi?customerId=1 &userName=admin&password=admin&command=getViews
The following query returns a hierarchical tree showing KPI status and tooltip information for the Service Measurements view, to a depth of three child nodes:
https://myserver/topaz/bam/BAMOpenApi?customerId=1&userName= admin&password=admin&command=getNodes&viewName=Service%20 Measurements&showTooltip=true&depth=3&layout=hierarchical
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: