analytics/sdk/MAQuery.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
Licensed Materials - Property of IBM 
IBM Cognos Products: mqp 
(C) Copyright IBM Corp. 2003, 2010 
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">
	<!-- XML XSD must be imported to define xml:space and xml:lang attributes -->
	<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/03/xml.xsd"/>
	<xs:complexType name="FunctionsConstraintType">
		<xs:annotation>
			<xs:documentation>
			Constraints are used to reduce the amount of function information returned to the client. The MA interface supports filtering different function contexts (relational, tabular, CRX) and type(“aggregate”, “operator”, etc.). The Constraint element of the function request has the Condition attribute that is a restricted XPath expression e.g. Condition="FDS[@context='tabular']. 
			</xs:documentation>
		</xs:annotation>
		<xs:attribute name="Condition" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="ActionsConstraintType">
		<xs:annotation>
			<xs:documentation>
			Constraints are used to limit the scope of the actions to be retrieved. The MA interface supports the following constraints  for actions : @contextType, @Coordinate, @DimensionLine.
			</xs:documentation>
		</xs:annotation>
		<xs:attribute name="Condition" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="FunctionsConstraintsType">
		<xs:annotation>
			<xs:documentation>
			The collection of contraints that can be applied for Function information retrieval.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="unbounded">
			<xs:element name="Constraint" type="FunctionsConstraintType">
				<xs:annotation>
					<xs:documentation>
					Constraints are used to limit the amount of function information returned to the client.
					</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ActionsConstraintsType">
		<xs:annotation>
			<xs:documentation>
			The collection of contraints for an action defines the filter that can be applied for Function information retrieval.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="unbounded">
			<xs:element name="Constraint" type="ActionsConstraintType">
				<xs:annotation>
					<xs:documentation>
					Constraints are used to limit the actions to be retrieved. The MA interface supports the following constraints for actions : @contextType, @Coordinate, @DimensionLine.
					</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="FunctionsType">
		<xs:annotation>
			<xs:documentation>
			Supported only for Function information retrieval.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="Properties" type="PropertiesType"/>
			<xs:element name="Constraints" type="FunctionsConstraintsType" minOccurs="0"/>
		</xs:sequence>
		<xs:attribute ref="xml:lang"/>
		<xs:attribute name="start_at" type="xs:string" use="required"/>
		<xs:attribute name="authoringLocale" type="xs:string"/>
		<xs:attribute name="Depth" type="xs:integer" use="optional" default="0"/>
	</xs:complexType>
	<xs:complexType name="MetadataType">
		<xs:annotation>
			<xs:documentation>
			Supported only for Metadata retrieval. Specify either start_atPath (for tree type navigation) or start_atRef (for lookup). The following attributes are deprecated : start_at, _enumLabels, xml:Lang, no_collections.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="Start_at" type="MetadataPath" minOccurs="0"/>
			<xs:element name="Properties" type="PropertiesType"/>
			<xs:element name="Constraints" minOccurs="0">
				<xs:annotation>
					<xs:documentation>
					Note :  Constraints are used to limit the metadata returned to the client.
					</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:choice maxOccurs="unbounded">
						<xs:element name="Constraint" type="MetadataConstraintType"/>
						<xs:element name="BlockConstraint" type="MetadataConstraintsType"/>
					</xs:choice>
				</xs:complexType>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="authoringLocale" type="xs:language" use="required">
			<xs:annotation>
				<xs:documentation>
				 The "authoringLocale" attribute is a runtime locale that is supplied to MA when the connection is open that the end user wants to see the report data in. At runtime it is replaced by effective locale after applying model defaulting rules. Default is a default model locale.
				</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute ref="xml:lang" use="optional">
			<xs:annotation>
				<xs:documentation>
				The "xml:lang" attribute is the same attribute as "authoringLocale". It is deprecated, but is still supported because it is sometimes used in Query Studio queries.
				</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="Depth" type="xs:nonNegativeInteger" use="optional" default="0">
			<xs:annotation>
				<xs:documentation>
				 The "Depth" attribute defines the depth of the sub_tree returned as a result of the Metadata or Function request. If this attribute is not specified, the whole tree will be returned as a result of the Metadata or Function request. Default is 0.Valid values are:0...n Only Depth =2 is used now by the reporting tools for retrieving the item's children.
				 </xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="start_atPath" type="xs:string" use="optional"/>
		<xs:attribute name="start_atRef" type="xs:string" use="optional"/>
		<xs:attribute name="_enumLabels" type="xs:nonNegativeInteger" use="optional" default="1">
			<xs:annotation>
				<xs:documentation>
				 The "_enumLabels"  attribute’s value serves as a flag to switch to return enumeration Labels instead of numeric values for properties such as type, usage…, value “1”- enum Labels  in output. This will be deprecated when use enum Labels are in use. Default is 1- enum Labels in output.
				 </xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="no_collections" type="xs:nonNegativeInteger" use="optional" default="1">
			<xs:annotation>
				<xs:documentation>
				The "no_collections"attribute’s value serves as a flag to switch to no collection in the output. This will be deprecated when the trailing " _Collection" can be stripped from a request. Default value “1” - no collection in the output.
				</xs:documentation> 
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="start_at" type="xs:string" use="optional"/>
		<xs:attribute name="ResultStart" type="xs:nonNegativeInteger" use="optional">
			<xs:annotation>
				<xs:documentation>
				 The "ResultStart" attribute supports chunk retrieval, sets the starting point.
				 </xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="ResultCount" type="xs:nonNegativeInteger" use="optional">
			<xs:annotation>
				<xs:documentation >
				The "ResultCount"attribute supports chunk retrieval, limits the number of return entities.
				</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="OutputXML" type="xs:boolean" use="optional" default="true"/>
	</xs:complexType>
	<xs:complexType name="PropertiesType">
		<xs:annotation>
			<xs:documentation>
			The collection of properties that relate to metadata or function information retrieval.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="unbounded">
			<xs:element name="Property">
				<xs:annotation>
					<xs:documentation>
					Supported for both Metadata and Function information retrieval. Propery could be represented by @ followed by its name, i.e '@usage', '/' is the element separator, i.e. queryItem/@name, '*' is the wildcard, i.e.'queryItem/@* is the set of all attributes for the element,'.' is the current context, i.e. './folder' means all the folders under the model root.See patterns:./className, */className,className/classname, className/@name, */@name,./@name, /@name.
					</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="name" use="required">
						<xs:simpleType>
							<xs:restriction base="xs:string">
								<xs:enumeration value="*/@_path"/>
								<xs:enumeration value="*/@_ref"/>
								<xs:enumeration value="*/@name"/>
								<xs:enumeration value="*/@screenTip"/>
								<xs:enumeration value="*/@dimType"/>
								<xs:enumeration value="*/@caption"/>
								<xs:enumeration value="./calculation"/>
								<xs:enumeration value="./filter"/>
								<xs:enumeration value="./folder"/>
								<xs:enumeration value="./queryItem"/>
								<xs:enumeration value="./queryItemFolder"/>
								<xs:enumeration value="./querySubject"/>
								<xs:enumeration value="./member"/>
								<xs:enumeration value="*/@memberUniqueName"/>
								<xs:enumeration value="*/@memberCaption"/>
								<xs:enumeration value="*/@levelUniqueName"/>
								<xs:enumeration value="*/@levelNumber"/>
								<xs:enumeration value="*/@levelLabel"/>
								<xs:enumeration value="*/@parentUniqueName"/>
								<xs:enumeration value="*/@dimensionUniqueName "/>
								<xs:enumeration value="*/@hierarchyUniqueName"/>
								<xs:enumeration value="./dimension"/>
								<xs:enumeration value="./hierarchy"/>
								<xs:enumeration value="./levelRfe"/>
								<xs:enumeration value="./level"/>
								<xs:enumeration value="*/@datatype"/>
								<xs:enumeration value="*/@displayType"/>
								<xs:enumeration value="*/@promptCascadeOn"/>
								<xs:enumeration value="*/@promptDisplayItems"/>
								<xs:enumeration value="*/@promptFilterItems"/>
								<xs:enumeration value="*/@promptType"/>
								<xs:enumeration value="*/@regularAggregate"/>
								<xs:enumeration value="*/@usage"/>
								<xs:enumeration value="*/@sortOnRef"/>
								<xs:enumeration value="*/@promptCascadeOnRef"/>
								<xs:enumeration value="*/@decimalSeparator"/>
								<xs:enumeration value="*/@listSeparator"/>
								<xs:enumeration value="*/@modelSearchPath"/>
							</xs:restriction>
						</xs:simpleType>
					</xs:attribute>
				</xs:complexType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ActionsPropertiesType">
		<xs:annotation>
			<xs:documentation>
			The collection of properties that relate to metadata or function information retrieval.
			</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="unbounded">
			<xs:element name="Property">
				<xs:annotation>
					<xs:documentation>
					The possible list of action properties :Name, Description, CommandType, Command, CoordinateType,	CoordinateValue.
                   </xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="name" use="required">
						<xs:simpleType>
							<xs:restriction base="xs:string">
								<xs:enumeration value="*/@Name"/>
								<xs:enumeration value="*/@CoordinateValue"/>
								<xs:enumeration value="./@CoordinateType"/>
								<xs:enumeration value="./@Command"/>
								<xs:enumeration value="./@CommandType"/>
								<xs:enumeration value="./@Description"/>
							</xs:restriction>
						</xs:simpleType>
					</xs:attribute>
				</xs:complexType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:element name="request">
		<xs:annotation>
			<xs:documentation>
			Top level request element to make it a valid document. It may be followed by other elements. Only the first Metadata or Functions element will be processed.
			</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:choice>
				<xs:element name="Functions" type="FunctionsType"/>
				<xs:element name="Metadata">
					<xs:complexType>
						<xs:complexContent>
							<xs:extension base="MetadataType"/>
						</xs:complexContent>
					</xs:complexType>
				</xs:element>
				<xs:element name="Actions" type="ActionsType"/>
			</xs:choice>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="MetadataConstraintType">
		<xs:annotation>
			<xs:documentation>
			Note :  The supported constraints are : Starts with ..., Ends with ..., Equal... , Not Equal ..., Contains .... The syntax is based on the xpath expressions, for example : contains('XML','X') ,starts-with('XML','X'), ends-with('XML','L'), price=9.80 , price!=9.80.
			</xs:documentation>
		</xs:annotation>
		<xs:attribute name="Condition" use="required">
			<xs:annotation>
				<xs:documentation>
				The "Condition" attribute is defined as  the XPath expression.
				</xs:documentation> 
			</xs:annotation>
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:pattern value="contains* "/>
					<xs:pattern value="starts-with* "/>
					<xs:pattern value="ends-with* "/>
					<xs:pattern value="="/>
					<xs:pattern value="!="/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
		<xs:attribute name="CaseSensitive" type="xs:boolean" use="optional" default="true"/>
	</xs:complexType>
	<xs:complexType name="MetadataConstraintsType">
		<xs:sequence>
			<xs:choice minOccurs="2" maxOccurs="unbounded">
				<xs:element name="Constraint" type="MetadataConstraintType"/>
				<xs:element name="BlockConstraint">
					<xs:complexType>
						<xs:complexContent>
							<xs:extension base="MetadataConstraintsType"/>
						</xs:complexContent>
					</xs:complexType>
				</xs:element>
			</xs:choice>
		</xs:sequence>
		<xs:attribute name="Operation" type="xs:string" use="optional" default="AND"/>
		<xs:attribute name="Name" type="xs:string" use="optional"/>
		<xs:attribute name="Type" use="optional" default="Block">
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="Block"/>
					<xs:enumeration value="Set"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="MetadataPath">
		<xs:sequence>
			<xs:element name="Path" type="xs:string" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ActionsType">
		<xs:sequence>
			<xs:element name="Properties" type="ActionsPropertiesType"/>
			<xs:element name="Constraints" type="ActionsConstraintsType"/>
		</xs:sequence>
		<xs:attribute name="authoringLocale" type="xs:language" use="required">
			<xs:annotation>
				<xs:documentation> 
				The "authoringLocale" attribute is a runtime locale that is supplied to MA when the connection is open that the end user wants to see the report data in. At runtime it is replaced by effective locale after applying model defaulting rules. Default is a default model locale.
				</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute ref="xml:lang" use="optional">
			<xs:annotation>
				<xs:documentation>
				The "xml:lang" attribute is the same attribute as authoringLocale. It is deprecated, but is still supported because it is sometimes used in Query Studio queries.
				</xs:documentation> 
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
</xs:schema>