complexType Query

diagram |
namespace | http://base.api.ec.n2.tibco.com
children | correlate filter requireAllAttributes requiredAttribute sortOrder target
used by |
elements | Query QueryInfo/query QueryPayload/query
annotation |
documentation
Definition of a query to execute on the system, to obtain data from the Event Collector database. Queries can either be executed directly, or registered for later execution (recommended when repeatedly calling the same query).
source | <xs:complexType name="Query"> <xs:annotation> <xs:documentation>Definition of a query to execute on the system, to obtain data from the Event Collector database. Queries can either be executed directly, or registered for later execution (recommended when repeatedly calling the same query).</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="correlate" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this query should be correlated. When this flag is set, the correlation ID of each returned event is examined. Every event that has the same correlation ID is then also returned. Setting this flag can be useful for tracing the events triggered by a specific action. However, it can also result in large amounts of data being returned. It should therefore only be used where necessary.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="filter" type="xs:string" minOccurs="1" maxOccurs="1"> <xs:annotation> <xs:documentation>Filter string to use for this query. See the BPM Developer's Guide for more information about which attributes can be used in the filter and how to specify the filter string.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="requireAllAttributes" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="requiredAttribute" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of attributes that should be returned for each event found by this query.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="sortOrder" type="SortElement" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="target" type="QueryTarget" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType>

element Query/correlate

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Boolean value defining whether this query should be correlated. When this flag is set, the correlation ID of each returned event is examined. Every event that has the same correlation ID is then also returned. Setting this flag can be useful for tracing the events triggered by a specific action. However, it can also result in large amounts of data being returned. It should therefore only be used where necessary.
source | <xs:element name="correlate" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether this query should be correlated. When this flag is set, the correlation ID of each returned event is examined. Every event that has the same correlation ID is then also returned. Setting this flag can be useful for tracing the events triggered by a specific action. However, it can also result in large amounts of data being returned. It should therefore only be used where necessary.</xs:documentation> </xs:annotation> </xs:element>

element Query/filter

diagram |
type | xs:string
properties |
content | simple
annotation |
documentation
Filter string to use for this query. See the BPM Developer's Guide for more information about which attributes can be used in the filter and how to specify the filter string.
source | <xs:element name="filter" type="xs:string" minOccurs="1" maxOccurs="1"> <xs:annotation> <xs:documentation>Filter string to use for this query. See the BPM Developer's Guide for more information about which attributes can be used in the filter and how to specify the filter string.</xs:documentation> </xs:annotation> </xs:element>

element Query/requireAllAttributes

diagram |
type | xs:boolean
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.
source | <xs:element name="requireAllAttributes" type="xs:boolean" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Boolean value defining whether all attributes should be returned. This setting overrides any "requiredAttribute" elements.</xs:documentation> </xs:annotation> </xs:element>

element Query/requiredAttribute

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | unbounded
content | simple
annotation |
documentation
List of attributes that should be returned for each event found by this query.
source | <xs:element name="requiredAttribute" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>List of attributes that should be returned for each event found by this query.</xs:documentation> </xs:annotation> </xs:element>

element Query/sortOrder

diagram |
type | SortElement
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | attribute type
source | <xs:element name="sortOrder" type="SortElement" minOccurs="0" maxOccurs="unbounded"/>

element Query/target

diagram |
type | QueryTarget
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | AUDIT |
enumeration | PROCESS_METRICS |
enumeration | PROCESS_STATS |
enumeration | WORKITEM_STATS |
enumeration | USER_ACTIVITY |
enumeration | REGISTERED_QUERIES |
enumeration | REGISTERED_ENVIRONMENTS |
enumeration | REGISTERED_COMPONENTS |
enumeration | REGISTERED_MESSAGES |
enumeration | REGISTERED_ATTRIBUTES |
enumeration | PROCESS_ACTIVITY |
source | <xs:element name="target" type="QueryTarget" minOccurs="0" maxOccurs="1"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy