OM Service ID
<OMId/>
Return type: String
Returns the OM ID string of the CI as stored in OMi. The OM ID returns different values as follows:
Services: OM ID is the service ID
Nodes: OM ID is the unique ID
Node Groups: OM ID is the node group ID
OM Type
<OMType/>
Return type: String
Returns the OM Type stored in OMi. For OM services, the OM Type is the service type definition. For nodes, the OM Type is set to the constant value “node”.
CMDB Type
<CMDBType/>
Return type: String
Returns the CMDB CI Type ID string of the CI as it is stored in the RTSM. Initially this is returned as null because the CMDB type must initially be set in the Type Mapping. After this is set, the CMDB CI Type ID string should be available.
Caption
<Caption/>
Return type: String
Returns the caption string of the CI in the RTSM or OMi.
OM Attribute
<OMAttribute>[Name]</OMAttribute>
Return type: String
Returns the value of the OM attribute with the given name.
CMDB Attribute
<CMDBAttribute>[Name]</CMDBAttribute>
Return type: String
Returns the value of the CMDB attribute with the given name as it will be written to the RTSM. There are no attributes available until the attribute mapping has been performed.
Replace
<Replace [regExp="true|false"]> <In> <!-- 1st. Operand --> </In> <For> <!-- 2nd. Operand --> </For> <By> <!-- 3rd. Operand --> </By> </Replace>
Return type: String
Replaces the strings in the return value of the first operand for all occurrences of the return value of the second operator by the return value of the third operand. For example, to replace all occurrences of a backslash in the CI caption by an underscore, you must declare the following:
<Replace> <In> <CiCaption/> </In> <For> <Value>\</Value> </For> <By> <Value>_</Value> </By> </Replace>
Optionally, you can use regular expressions for the second operand. You can also use back references in the third operand.
For more information on applicable regular expressions, see:
http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html
This example uses regular expressions to extract part of a domain name:
<Replace regExp="true"> <In> <Attribute>host_dnsname</Attribute> </In> <For> <Value>^[^.]*\.([^.]*).*</Value> </For> <By> <Value>$1</Value> </By> </Replace>
If the attribute host_dnsname contains the value server.rio.example.com, the result of the Replace operand is rio.
XPath Result
<XPathResult>[XPath]</XPathResult>
Return type: String
Returns the value of the XPath expression, which enables you to access data of any CI that is contained in the same hierarchy. The XPath expression must select a string value, if there are multiple matches an arbitrary element is returned.
For more information on XPath, see XPath Navigation.
XPath Result List
<XPathResultList>[XPath]</XPathResultList>
Return type: List
Returns a list of all matched values.
For more information on XPath, see XPath Navigation.
Value
<Value>[String]</Value>
Return type: String
Return the constant value.
List
<List>
<!--Operand-->
<!--Operand-->
<!--...-->
</List>
Return type: List
The list operand is designed for use with operators that accept lists as input parameters, such as the contains operator. The list operand contains a list of other operands, the values of which are to be added to the returned list.
Parent CI
<ParentCI/>
Return type: CI
Returns the parent CI of the current CI. If the current CI is the root CI, null is returned.
Tip To check for the root CI, use the IsRoot operator.
Child CI
<ChildCI>
[Operator]
</ChildCI><ChildCI relationType="[relationType]">
[Operator]
</ChildCI>
Return type: CI
Description: Returns the first child CI of the current CI that matches the enclosed operator.
Optional elements:
relationType: Only follow relations with the specified relation type.
Child CI List
<ChildCIList>
[Operator (Optional)]
</ChildCIList><ChildCIList relationType="[relationType]">
[Operator (Optional)]
</ChildCIList>
Return type: List of CIs
Returns all CI children of the current CI.
Optional elements:
Operator: Only CIs that match the operator will be returned.
relationType: Only follow relations with the specified relation type.
Ancestor CI
<AncestorCI>
[Operator]
</AncestorCI><AncestorCI relationType="[relationType]">
[Operator]
</AncestorCI>
Return type: CI
Returns the first ancestor CI of the current CI that matches the enclosed operator. An ancestor CI is the parent or parent of the parent (and so on) of the current CI.
Optional elements:
relationType: The dependency must have the specified relation type.
Descendant CI
<DescendantCI>
[Operator]
</DescendantCI><DescendantCI relationType="[relationType]">
[Operator]
</DescendantCI>
Return type: CI
Returns the first descendant CI of the current CI that matches the enclosed operator. A descendant CI is the child or child of the child (and so on) of the current CI.
Optional elements:
relationType: Only follow relations with the specified relation type.
Descendant CI List
<DescendantCIList>
[Operator (Optional)]
</DescendantCIList><DescendantCIList relationType="[relationType]">
[Operator (Optional)]
</DescendantCIList>
Return type: List of CIs
Returns the all descendant CIs of the current CI. A descendant CI is the child or child of the child (and so on) of the current CI.
Optional elements:
Operator: Only CIs that match the operator will be returned.
relationType: Only follow relations with the specified relation type.
Dependency CI
<DependencyCI>
[Operator]
</DependencyCI><DependencyCI relationType="[relationType]">
[Operator]
</DependencyCI>
Return type: CI
Returns the first dependency CI that matched the included operator.
Optional elements:
relationType: Only follow relations with the specified relation type.
Dependency CI List
<DependencyCIList>
[Operator (Optional)]
</DependencyCIList><DependencyCIList relationType="[relationType]">
[Operator (Optional)]
</DependencyCIList>
Return type: CI
Returns the list of dependencies.
Optional elements:
Operator: Only CIs that match the operator will be returned.
relationType: The dependency must have the specified relation type.
Dependent CI
<DependentCI>
[Operator]
</DependentCI><DependentCI relationType="[relationType]">
[Operator]
</DependentCI>
Return type: CI
Returns the first dependent CI that matched the included operator.
Example for a dependent CI:
ServiceA > hosted_on > HostB
In this case ServiceA is a dependent CI of HostB. That means if you have HostB and want to have all services that depend on this host, you have to use the <DependentCI> operand. If you have ServiceA and want to have HostB, you have to use the <DependencyCI> operand instead.
Optional elements:
relationType: Only follow relations with the specified relation type.
Dependent CI List
<DependentCIList>
[Operator (Optional)]
</DependentCIList><DependentCIList relationType="[relationType]">
[Operator (Optional)]
</DependentCIList>
Return type: CI
Returns the list of dependent CI.
Example for a dependent CI:
ServiceA > hosted_on > HostB
In this case ServiceA is a dependent CI of HostB. That means if you have HostB and want to have all services that depend on this host, you have to use the <DependentCI> operand. If you have ServiceA and want to have HostB, you have to use the <DependencyCI> operand instead.
Optional elements:
Operator: Only CIs that match the operator will be returned.
relationType: The dependency must have the specified relation type.
From CI Get
<From>
<CI>
[CI Operand]
</CI>
<Get>
[Operand]
</Get>
</From>
Return type: Return type of the second operand.
Using this operand you can get values from another CI. The first operand [CI Operand] must return a CI instance. The second operand operates on that CI instance and the value of this second operand will be returned by this From operand.
Example:
<From>
<CI>
<ParentCI>
</CI>
<Get>
<Caption/>
</Get>
</From>
Returns the caption from the parent CI of the current CI.
Origin Server
<OriginServer/>
Return type: String
This operand returns the hostname of the server that originally received the discovery data before forwarding it to other servers.