analytics/webapps/p2pd/WEB-INF/classes/eventSpecification.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    
    BI and PM: JSM
    
    (c) Copyright IBM Corp. 2003, 2013.
    
    US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="queryEventSpecification">
		<xs:annotation>
			<xs:documentation>The specification schema for querying events in either the Monitor Service of the Event Management Service.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="sort" minOccurs="0">
					<xs:annotation>
						<xs:documentation>The sort element is used to sort the results returned from the service.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="order" type="orderEnum">
								<xs:annotation>
									<xs:documentation>The order to sort the result in see orderEnum.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="sortItem" type="sortEnum">
								<xs:annotation>
									<xs:documentation>The item to sort the result by in see sortEnum</xs:documentation>
								</xs:annotation>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="subSort" minOccurs="0">
					<xs:annotation>
						<xs:documentation>The subSort element is used to apply a sub level sort to the results returned from the service.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="order" type="orderEnum">
								<xs:annotation>
									<xs:documentation>The order to sub sort the result in - see orderEnum.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="sortItem" type="subSortEnum">
								<xs:annotation>
									<xs:documentation source="doc_ele_sortItem_subSort"/>
									<xs:documentation>The item to sub sort the result by - see subSortEnum</xs:documentation>
								</xs:annotation>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="scope" minOccurs="0">
					<xs:annotation>
						<xs:documentation>The scope allows the caller to filter the result set or the scope of the request.  If no scope is specified then the default behaviour is to set the scope to the searchPath /content </xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:choice>
							<xs:element name="searchPaths" type="searchPathsDef">
								<xs:annotation>
									<xs:documentation>A list of searchPaths to restrict the search to.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="eventID" type="eventIDDef">
								<xs:annotation>
									<xs:documentation>Will return data about this specified task only.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="parentEventID" type="eventIDDef">
								<xs:annotation>
									<xs:documentation>Will return data about tasks that have this id as their parent, used to return information about child steps for jobs and agents.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="restartEventID" type="eventIDDef">
								<xs:annotation>
									<xs:documentation>Will return information about whether the specific task is restartable.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="restartParentEventID" type="eventIDDef">
								<xs:annotation>
									<xs:documentation>Will return information about whether there are restartable tasks for this given parent id.</xs:documentation>
								</xs:annotation>
							</xs:element>
						</xs:choice>
					</xs:complexType>
				</xs:element>
				<xs:element name="display" minOccurs="0">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="start" type="xs:integer" minOccurs="0"/>
							<xs:element name="end" type="xs:integer" minOccurs="0"/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="filters">
					<xs:annotation>
						<xs:documentation>Use this element to apply filters to the scope of the query.  This is not required for restart scope requests.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="startTime" type="xs:dateTime" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Start time which is optional for the monitor Service.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="endTime" type="xs:dateTime" minOccurs="0">
								<xs:annotation>
									<xs:documentation>End time which is optional for the monitor Service.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="owner" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Which user owns the task.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="user" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Which user is running the task.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="scheduleTrigger" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>The schedule trigger name that was used to initiate the run of this task.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="scheduleType" type="scheduleTypeEnum" minOccurs="0">
								<xs:annotation>
									<xs:documentation>The type of schedule was to initiate this run see scheduleTypeEnum.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="objectClass" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Which object model objectClass of task to filter by.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="priority" type="priorityEnum" minOccurs="0">
								<xs:annotation>
									<xs:documentation>The priority of the task.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="status" type="statusEnum" minOccurs="0">
								<xs:annotation>
									<xs:documentation>The status of the task to filter by.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="dispatcherID" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Which dispatcher is the executing task being run on.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="detailSeverity" type="detailSeverityEnum" minOccurs="0">
								<xs:annotation>
									<xs:documentation>Which history obects should be returned based on the detail's severity property.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="tenantID" type="xs:string" minOccurs="0">
                                <xs:annotation>
                                    <xs:documentation>Which tenantID is running the task.</xs:documentation>
                                </xs:annotation>
                            </xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="summary" minOccurs="0">
					<xs:annotation>
						<xs:documentation>Use this element to define the summary query.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="startTime" type="xs:dateTime">
								<xs:annotation>
									<xs:documentation>The summary start time, which may be different to the filter start time.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="endTime" type="xs:dateTime">
								<xs:annotation>
									<xs:documentation>The summary end time, which may be different to the filter end time.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:element name="groupBy" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>This element controls the granularity of the summary. The default is hour. See the groupBy enum</xs:documentation>
								</xs:annotation>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:annotation>
		<xs:documentation>Enumeration for the direction to order the results in.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="orderEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="ascending">
				<xs:annotation>
					<xs:documentation>Return the results in ascending order.</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="descending">
				<xs:annotation>
					<xs:documentation>Return the results in descending order.</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration for grouping the summary results</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="groupBy">
		<xs:restriction base="xs:string">
			<xs:enumeration value="hour">
				<xs:annotation>
					<xs:documentation>group by hour</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="day">
				<xs:annotation>
					<xs:documentation>group by day</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="none">
				<xs:annotation>
					<xs:documentation>no grouping</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration for the filter properties that sorts can apply to.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="sortEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="startTime">
				<xs:annotation>
					<xs:documentation>Apply the sorting to the startTime property</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="status">
				<xs:annotation>
					<xs:documentation>Apply the sorting to the status property</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="scheduleType">
				<xs:annotation>
					<xs:documentation>Apply the sorting to the scheduleType property</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="priority">
				<xs:annotation>
					<xs:documentation>Apply the sorting to the priority property</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration for the filter properties that subSorts can apply to.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="subSortEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="historyDetails.detailTime">
				<xs:annotation>
					<xs:documentation>Apply the sorting to the historyDetail(s) detailTime property</xs:documentation>
				</xs:annotation>
			</xs:enumeration>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration of valid priority values.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="priorityEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="any">
				<xs:annotation>
					<xs:documentation source="doc_enum_priorityEnum_any"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="1"/>
			<xs:enumeration value="2"/>
			<xs:enumeration value="3"/>
			<xs:enumeration value="4"/>
			<xs:enumeration value="5"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration of valid status values.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="statusEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="all"/>
			<xs:enumeration value="cancelled"/>
			<xs:enumeration value="executing"/>
			<xs:enumeration value="failed"/>
			<xs:enumeration value="pending"/>
			<xs:enumeration value="purged"/>
			<xs:enumeration value="scheduled"/>
			<xs:enumeration value="succeeded"/>
			<xs:enumeration value="suspended"/>
			<xs:enumeration value="terminated"/>
			<xs:enumeration value="inactive"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration of valid detail severity values.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="detailSeverityEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="any">
				<xs:annotation>
					<xs:documentation source="doc_enum_detailSeverityEnum_any"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="debug"/>
			<xs:enumeration value="info"/>
			<xs:enumeration value="warn"/>
			<xs:enumeration value="error"/>
			<xs:enumeration value="fatal"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>Enumeration of valid schedule type values.</xs:documentation>
	</xs:annotation>
	<xs:simpleType name="scheduleTypeEnum">
		<xs:restriction base="xs:string">
			<xs:enumeration value="any">
				<xs:annotation>
					<xs:documentation source="doc_enum_scheduleTypeEnum_any"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="by day">
				<xs:annotation>
					<xs:documentation source="doc_enum_byday"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="by week">
				<xs:annotation>
					<xs:documentation source="doc_enum_byweek"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="by month">
				<xs:annotation>
					<xs:documentation source="doc_enum_bymonth"/>
				</xs:annotation>
			</xs:enumeration>
			<xs:enumeration value="by year">
				<xs:annotation>
					<xs:documentation source="doc_enum_byyear"/>
				</xs:annotation>
			</xs:enumeration>			
			<xs:enumeration value="by trigger">
				<xs:annotation>
					<xs:documentation source="doc_enum_bytrigger"/>
				</xs:annotation>
			</xs:enumeration>	
			<xs:enumeration value="manual"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:annotation>
		<xs:documentation>The definition for listing one or more searchPaths for the searchPath scope.</xs:documentation>
	</xs:annotation>
	<xs:complexType name="searchPathsDef">
		<xs:sequence>
			<xs:element name="searchPath" type="xs:string" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="eventIDDef">
		<xs:annotation>
			<xs:documentation>Must contain exactly 45 ASCII letters or digits; the letters can be uppercase or lowercase.</xs:documentation>
		</xs:annotation>
		<xs:restriction base="xs:string">
			<xs:pattern value="[a-zA-Z0-9]{45}"/>
		</xs:restriction>
	</xs:simpleType>
</xs:schema>