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.
Words and Phrases
| 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. |
Using Boolean Operators
| 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 |
|
Results Generation by the Jython Script
Each Jython script runs on a specific Trigger CI, and ends with results that are returned by the return value of the DiscoveryMain function.
The script result is actually a group of CIs and links that are to be inserted or updated in the . The script returns this group of CIs and links in the format of ObjectStateHolderVector.
The ObjectStateHolder class is a way to represent an object or link defined in the . The ObjectStateHolder object contains the CIT name and a list of attributes and their values. The ObjectStateHolderVector is a vector of ObjectStateHolder instances.
The ObjectStateHolder Syntax
This section explains how to build the DFM results into a model.
Example of Setting Attributes on the CIs:
The ObjectStateHolder class describes the DFM result graph. Each CI and link (relationship) is placed inside an instance of the ObjectStateHolder class as in the following Jython code sample:
Line 1 creates a CI of type siebelappserver.
Line 2 creates an attribute called data_name with a value of sblsvrName which is a Jython variable set with the value discovered for the server name.
Line 3 sets a non-key attribute that is updated in the .
Line 4 is the building of containment (the result is a graph). It specifies that this application server is contained inside a host (another
ObjectStateHolderclass in the scope).
Note: Each CI being reported by the Jython script must include values for all the key attributes of the CI's CI Type.
Example of Relationships (Links):
The following link example explains how the graph is represented:
1 linkOSH = ObjectStateHolder('route') 2 linkOSH.setAttribute('link_end1', gatewayOSH) 3 linkOSH.setAttribute('link_end2', appServerOSH)Line 1 creates the link (that is also of the
ObjectStateHolderclass. The only difference is thatrouteis a link CI Type).Lines 2 and 3 specify the nodes at the end of each link. This is done using the end1 and end2 attributes of the link which must be specified (because they are the minimal key attributes of each link). The attribute values are
ObjectStateHolderinstances. For details on End 1 and End 2, see Link.
Caution: A link is directional. You should verify that End 1 and End 2 nodes correspond to valid CITs at each end. If the nodes are not valid, the result object fails validation and is not reported correctly. For details, see CI Type Relationships.
Example of Vector (Gathering CIs):
After creating objects with attributes, and links with objects at their ends, you must now group them together. You do this by adding them to an ObjectStateHolderVector instance, as follows:
oshvMyResult = ObjectStateHolderVector() oshvMyResult.add(appServerOSH) oshvMyResult.add(linkOSH)
For details on reporting this composite result to the Framework so that it can be sent to the server, see the sendObjects method.
Once the result graph is assembled in an ObjectStateHolderVector instance, it must be returned to the DFM Framework to be inserted into the . This is done by returning the ObjectStateHolderVector instance as the result of the DiscoveryMain() function.
Note: For details on creating OSH for common CITs, see modeling.py.
