XPath functions and operators

The following table identifies the symbols that are supported. The symbol numbers in the first column are found in http://www.w3.org/TR/xpath20/#id-grammar.

Common Base Event predefined data elements:

InboundEventDefinitionRef '/' 'predefinedData' '/' (
'creationTime'|'elapsedTime'|'extensionName'|'globalInstanceId'|
'localInstanceId'|'msg'|'priority'|'repeatCount'|'sequenceNumber'|
'severity'|'version')

Common Base Event context data elements:

InboundEventDefinitionRef '/' 'propertyData' '/' ContextDataElementName

Common Base Event extended data elements:

InboundEventDefinitionRef '/' 'extendedData' '/' ExtendedDataElementName (
'/' ExtendedDataElementName)*

Any event content:

InboundEventDefinitionRef '/' EventPartId '/' Expr

where:

• InboundEventDefinitionRef is a path to an event entry point or exit point in a monitoring context definition hierarchy. The path can include the IDs of nested monitoring context definitions, dot (".") or dot dot (".."). It must have as its last step one and only one ID of an inbound event definition. For example, itemContext/outOfStockEvent.
• ContextDataElementName is the name of a context data element defined by the Common Base Event type of the referenced event entry or exit point. The pertinent Common Base Event event type definition is referenced using the extensionName attribute.
• ExtendedDataElementName is the name of an extended data element defined by the Common Base Event type of the referenced event entry or exit point. The pertinent event type definition is referenced via the extensionName attribute.
• EventPartId is the ID of an event part defined for the referenced event entry or exit point.
• Expr is a path into an inbound or outbound event data structure, which is appended to the path defined for the event part referenced by EventPartId. For paths into inbound events, Table 2 applies. For paths into outbound events (that is, the left sides of assignments to outbound event fields), Table 3 applies. Furthermore, the numeric predicates that are used to construct sequences in outbound events must have no gaps and must be ascending at every nesting level. A step without a numeric predicate is equivalent to one followed by [1].

The following table is applicable to expressions referencing inbound events and their content.

The following table is applicable to expressions referencing outbound events and their content.

The following table identifies the operators that are supported. The row numbers indicate precedence order and are defined in http://www.w3.org/TR/xpath20/#id-precedence-order.

The following table identifies the terminal symbols that are supported. The symbol numbers in the first column are found in http://www.w3.org/TR/xpath20/#lexical-structure.

You can use predicates to refer to elements within a list (also sometimes referred to as array elements). The predicate is an expression enclosed by square brackets that follows the path expression referring to the list. For example, if myEvent/myEventPart/theOrder/item points to a list of items in an order, you can reference an individual item by enclosing a numeric index in square brackets. For example, to access the price of an individual item, say item 12, you would use:

myEvent/myEventPart/theOrder/item[12]/price

Lists can also be used as arguments to aggregate functions. For example, to calculate the sum of the prices in all the orders you would use:

fn:sum(myEvent/myEventPart/theOrder/item/price)

For more information, see Aggregate functions.

The following constructor functions are supported. Constructor functions are the XPath 2.0 mechanism used by Business Monitor to support casting. In XPath 2.0, the semantics of constructor functions are equivalent to the use of the "cast as" operator, but the syntax is different.

• xs:boolean($arg as xs:boolean?) as xs:boolean?
• xs:boolean($arg as xs:integer?) as xs:boolean?
• xs:boolean($arg as xs:decimal?) as xs:boolean?
• xs:boolean($arg as xs:string?) as xs:boolean?
• xs:integer($arg as xs:boolean?) as xs:integer?
• xs:integer($arg as xs:integer?) as xs:integer?
• xs:integer($arg as xs:decimal?) as xs:integer?
• xs:integer($arg as xs:string?) as xs:integer?
• xs:decimal($arg as xs:boolean?) as xs:decimal?
• xs:decimal($arg as xs:integer?) as xs:decimal?
• xs:decimal($arg as xs:decimal?) as xs:decimal?
• xs:decimal($arg as xs:string?) as xs:decimal?
• xs:decimal($arg as xs:duration?) as xs:decimal?
• xs:string($arg as xs:boolean?) as xs:string?
• xs:string($arg as xs:integer?) as xs:string?
• xs:string($arg as xs:decimal?) as xs:string?
• xs:string($arg as xs:string?) as xs:string?
• xs:string($arg as xs:duration?) as xs:string?
• xs:string($arg as xs:dateTime?) as xs:string?
• xs:string($arg as xs:date?) as xs:string?
• xs:string($arg as xs:time?) as xs:string?
• xs:duration($arg as xs:string?) as xs:duration?
• xs:duration($arg as xs:duration?) as xs:duration?
• xs:duration($arg as xs:decimal?) as xs:duration?
• xs:dayTimeDuration($arg as xs:integer?) as xs:dayTimeDuration?
• xs:dayTimeDuration($arg as xs:decimal?) as xs:dayTimeDuration?
• xs:dayTimeDuration($arg as xs:string?) as xs:dayTimeDuration?
• xs:dayTimeDuration($arg as xs:duration?) as xs:dayTimeDuration?
• xs:dateTime($arg as xs:string?) as xs:dateTime?
• xs:dateTime($arg as xs:dateTime?) as xs:dateTime?
• xs:dateTime($arg as xs:date?) as xs:dateTime?
• xs:date($arg as xs:string?) as xs:date?
• xs:date($arg as xs:dateTime?) as xs:date?
• xs:date($arg as xs:date?) as xs:date?
• xs:time($arg as xs:string?) as xs:time?
• xs:time($arg as xs:dateTime?) as xs:time?
• xs:time($arg as xs:time?) as xs:time?

The following subset of available XPath 2.0 functions are supported. The namespace declarations used are xmlns:xs="http://www.w3.org/2001/XMLSchema" and xmlns:fn="http://www.w3.org/2005/xpath-functions", as in http://www.w3.org/TR/xpath-functions/.

• fn:abs($arg as xs:integer?) as xs:integer?
• fn:abs($arg as xs:decimal?) as xs:decimal?
• fn:round($arg as xs:decimal?) as xs:decimal?
• fn:round($arg as xs:integer?) as xs:integer?
• fn:concat($arg1 as xs:anyAtomicType?, $arg2 as xs:anyAtomicType?, ... ) as xs:string
• fn:compare($comparand1 as xs:string?, $comparand2 as xs:string?) as xs:integer?
• fn:substring($sourceString as xs:string?, $startingLoc as xs:integer) as xs:string
• fn:substring($sourceString as xs:string?, $startingLoc as xs:decimal) as xs:string
• fn:substring($sourceString as xs:string?, $startingLoc as xs:integer, $length as xs:integer) as xs:string
• fn:substring($sourceString as xs:string?, $startingLoc as xs:integer, $length as xs:decimal) as xs:string
• fn:substring($sourceString as xs:string?, $startingLoc as xs:decimal, $length as xs:integer) as xs:string
• fn:substring($sourceString as xs:string?, $startingLoc as xs:decimal, $length as xs:decimal) as xs:string
• fn:string-length($arg as xs:string?) as xs:integer?
• fn:upper-case($arg as xs:string?) as xs:string
• fn:lower-case($arg as xs:string?) as xs:string
• fn:contains($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
• fn:starts-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
• fn:ends-with($arg1 as xs:string?, $arg2 as xs:string?) as xs:boolean
• fn:true() as xs:boolean
• fn:false() as xs:boolean
• fn:not($arg as xs:boolean?) as xs:boolean
• fn:not($arg as xs:integer?) as xs:boolean
• fn:not($arg as xs:decimal?) as xs:boolean
• fn:not($arg as xs:string?) as xs:boolean
• fn:empty($arg as xs:anyAtomicType?) as xs:boolean
• fn:exists($arg as xs:anyAtomicType?) as xs:boolean
• fn:current-dateTime() as xs:dateTime
• fn:current-date() as xs:date
• fn:current-time() as xs:time
• fn:days-from-duration($arg as xs:duration?) as xs:integer?
• fn:hours-from-duration($arg as xs:duration?) as xs:integer?
• fn:minutes-from-duration($arg as xs:duration?) as xs:integer?
• fn:seconds-from-duration($arg as xs:duration?) as xs:decimal?
• fn:year-from-dateTime($arg as xs:dateTime?) as xs:integer?
• fn:month-from-dateTime($arg as xs:dateTime?) as xs:integer?
• fn:day-from-dateTime($arg as xs:dateTime?) as xs:integer?
• fn:hours-from-dateTime($arg as xs:dateTime?) as xs:integer?
• fn:minutes-from-dateTime($arg as xs:dateTime?) as xs:integer?
• fn:seconds-from-dateTime($arg as xs:dateTime?) as xs:decimal?
• fn:timezone-from-dateTime($arg as xs:dateTime?) as xs:dayTimeDuration?
• fn:year-from-date($arg as xs:date?) as xs:integer?
• fn:month-from-date($arg as xs:date?) as xs:integer?
• fn:day-from-date($arg as xs:date?) as xs:integer?
• fn:timezone-from-date($arg as xs:date?) as xs:dayTimeDuration?
• fn:hours-from-time($arg as xs:time?) as xs:integer?
• fn:minutes-from-time($arg as xs:time?) as xs:integer?
• fn:seconds-from-time($arg as xs:time?) as xs:decimal?
• fn:timezone-from-time($arg as xs:time?) as xs:dayTimeDuration?
• fn:adjust-dateTime-to-timezone($arg as xs:dateTime?) as xs:dateTime?
• fn:adjust-dateTime-to-timezone($arg as xs:dateTime?, $timezone as xs:dayTimeDuration?) as xs:dateTime?
• fn:adjust-date-to-timezone($arg as xs:date?) as xs:date?
• fn:adjust-date-to-timezone($arg as xs:date?, $timezone as xs:dayTimeDuration?) as xs:date?
• fn:adjust-time-to-timezone($arg as xs:time?) as xs:time?
• fn:adjust-time-to-timezone($arg as xs:time?, $timezone as xs:dayTimeDuration?) as xs:time?
• fn:count($arg as item()*) as xs:integer
• fn:avg($arg as xs:integer*) as xs:decimal?
• fn:avg($arg as xs:decimal*) as xs:decimal?
• fn:max($arg as xs:integer*) as xs:integer?
• fn:max($arg as xs:decimal*) as xs:decimal?
• fn:min($arg as xs:integer*) as xs:integer?
• fn:min($arg as xs:decimal*) as xs:decimal?
• fn:sum($arg as xs:integer*) as xs:integer?
• fn:sum($arg as xs:decimal*) as xs:decimal?

Metrics with a data type of date, time, or dateTime can have a value that is either adjusted for a time zone or a value that is not adjusted for a time zone. When you compare metrics with a data type of date, time, or dateTime:

• Both values must be associated with a time zone, OR
• Both values must not be associated with a time zone

Otherwise, an error will occur at run time when the comparison takes place.