analytics/schemas/moser/current/prompt.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--
 Licensed Materials - Property of IBM

 IBM Cognos Products: moser

 (C) Copyright IBM Corp. 2015, 2020

 US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="7.4">
	<xsd:include schemaLocation="business.xsd"/>
	<xsd:include schemaLocation="metadata.xsd"/>
	<xsd:element name="parameterValueSet">
		<xsd:annotation>
			<xsd:documentation>A collection of parameter values.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="objectType">
					<xsd:sequence>
						<xsd:element ref="parameterValue" minOccurs="0" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="parameterValue">
		<xsd:annotation>
			<xsd:documentation>A holder for range of parameter value objects.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="parameterName" type="xsd:string">
					<xsd:annotation>
						<xsd:documentation>The name of the parameter, this is what appears between the question marks in an expression. 
E.g. ?p country?</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="dataType" type="parameterDataType">
					<xsd:annotation>
						<xsd:documentation>datatype for the parameter</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="invert" type="xsd:boolean" default="false" minOccurs="0">
					<xsd:annotation>
						<xsd:documentation>If true, negate cumulative result of all simple value operations OR-ed gether to produce final result of this value. E.g. 
NOT ( x = 'a' OR x = 'b')</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="values" type="valueType" minOccurs="0" maxOccurs="unbounded"/>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="parameterFault">
		<xsd:annotation>
			<xsd:documentation>The information that is returned by the server when a parameter is used, but there was no corresponding parameter on the request.	Defined here for completeness sake, not for persisting in the model.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="parameterName" type="xsd:string">
					<xsd:annotation>
						<xsd:documentation>The name of the parameter, this is what appears between the question marks in an expression. 
E.g. ?p country?
use this to provide values on the next data request.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="dataType" type="parameterDataType">
					<xsd:annotation>
						<xsd:documentation>datatype for the parameter</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="modelFilterItem" type="xsd:string" minOccurs="0">
					<xsd:annotation>
						<xsd:documentation>The model item that is closest to the use of the parameter in the expression.
E.g.:
expression:
country.cname = ?country?
Parameter name: country
dataType: string
modelFilterItem: country.cname</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="capabilities" type="parameterCapabilitiesType" minOccurs="0"/>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>
	<xsd:complexType name="parameterCapabilitiesType">
		<xsd:all>
			<xsd:element name="optional" type="xsd:boolean" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Set to true when a filter in the query uses the parameter and the filter is marked as optional.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="multivalued" type="xsd:boolean" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Set to true when multiple values or ranges can be accepted.
col in ?p1?
col in_range ?p2?
col in_range_truncated ?p3?</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="discreteValue" type="xsd:boolean" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Set to true when a single value is expected.
col = ?p1?</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="boundRange" type="xsd:boolean" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Set to true for:
col BETWEEN ?p1? and ?p1?</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="unboundedRange" type="xsd:boolean" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Set to true for:
col GT ?p1?
col GE ?p2?
col LT ?p3?
col LE ?p4?
Use symbol for 2 char oper.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
		</xsd:all>
	</xsd:complexType>
	<xsd:element name="prompt">
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="objectType">
					<xsd:sequence>
						<xsd:element name="parameterName" type="xsd:string">
							<xsd:annotation>
								<xsd:documentation>name of the parameter, use this to provide values on the next data request.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="uiControlReference" type="xsd:string">
							<xsd:annotation>
								<xsd:documentation>Prompt UI control identifier</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="lowerLimit" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Optional attribute indicates cut off lower limit for UI control.
E.g. first date that can be selected - 2018-01-01
# let year = timestampMask( toLocal ( $current_timestamp),
'yyyy');
year + '-01-01' #	</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="upperLimit" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Optional attribute indicates upper cut off limit for UI control.
For example - last date that can be selected, e.g. 2032-12-11
# let year = timestampMask( toLocal ( $current_timestamp), 'yyyy');
year + '-12-31' # </xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:choice>
							<xsd:sequence>
								<xsd:annotation>
									<xsd:documentation>Used for select with value and select with search</xsd:documentation>
								</xsd:annotation>
								<xsd:element name="staticValueSelector" type="valueType" minOccurs="0" maxOccurs="unbounded">
									<xsd:annotation>
										<xsd:documentation>These elements are added to the top of selectable values.
The values from the queryValueSelector will follow the static choices.
The UI controls have freedom to use this field, these are user defined ranges or values that can be used in the selection. For example when defining ranges, the values used in the ranges may not be defined in the database ( ranges: :10, 11-20, 21: , the database may not contain the number 11, but 11 can still be used in defining the range).</xsd:documentation>
									</xsd:annotation>
								</xsd:element>
								<xsd:element ref="queryValueSelector" minOccurs="0"/>
							</xsd:sequence>
							<xsd:element name="refDrillGroup" type="xsd:string">
								<xsd:annotation>
									<xsd:documentation>Used for select with tree.
Each segment of the navigation path is a level in the tree.</xsd:documentation>
								</xsd:annotation>
							</xsd:element>
						</xsd:choice>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:element name="queryValueSelector">
		<xsd:annotation>
			<xsd:documentation>Use these items to make a query to load the list of selectable values</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="useExpression" type="xsd:string"/>
				<xsd:element name="displayExpression" type="xsd:string" minOccurs="0"/>
				<xsd:element name="sortExpression" minOccurs="0">
					<xsd:complexType>
						<xsd:sequence>
							<xsd:element name="direction" type="sortOrder" default="ascending" minOccurs="0"/>
							<xsd:element name="nullPlacement" type="sortOrderNullPlacement" minOccurs="0">
								<xsd:annotation>
									<xsd:documentation>Placement of NULLs, either first, last, or depending on the underlying database. For most databases NULLS LAST is the default for ascending order, and NULLS FIRST is the default for descending order.
If the element is not specified then it will not be specified in the native SQL, for Cognos SQL it will be ascending nulls first, descending nulls last.</xsd:documentation>
								</xsd:annotation>
							</xsd:element>
						</xsd:sequence>
					</xsd:complexType>
				</xsd:element>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>
	<xsd:simpleType name="valueOperatorType">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="isNull"/>
			<xsd:enumeration value="greaterThan"/>
			<xsd:enumeration value="greaterEqual"/>
			<xsd:enumeration value="lessThan"/>
			<xsd:enumeration value="lessEqual"/>
			<xsd:enumeration value="notEqual"/>
			<xsd:enumeration value="equal"/>
			<xsd:enumeration value="between"/>
		</xsd:restriction>
	</xsd:simpleType>
	<xsd:simpleType name="parameterDataType">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="boolean"/>
			<xsd:enumeration value="string"/>
			<xsd:enumeration value="integer"/>
			<xsd:enumeration value="decimal"/>
			<xsd:enumeration value="datetime"/>
			<xsd:enumeration value="time"/>
			<xsd:enumeration value="date"/>
			<xsd:enumeration value="interval"/>
			<xsd:enumeration value="memberUniqueName"/>
		</xsd:restriction>
	</xsd:simpleType>
	<xsd:complexType name="valueType">
		<xsd:annotation>
			<xsd:documentation>An individual value, could also be a null value. A null values translates in SQL to an IS NULL condition</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="operator" type="valueOperatorType"/>
			<xsd:element name="use" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>This contains the value to filter on, except when operator is set to isNull</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="display" type="xsd:string" minOccurs="0"/>
			<xsd:element name="use2" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Only used for operation=between as the second operand.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="display2" type="xsd:string" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Only used for operation=between for the second operand</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:element name="parameterFeedbackInfo">
		<xsd:annotation>
			<xsd:documentation>The information that is returned by the server when parameter feedback information is requested.
Defined here for completeness sake, not for persisting in the model.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="parameterName" type="xsd:string">
					<xsd:annotation>
						<xsd:documentation>The name of the parameter, this is what appears between the question marks in an expression. 
E.g. ?p country?
use this to provide values on the next data request.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="dataType" type="parameterDataType">
					<xsd:annotation>
						<xsd:documentation>datatype for the parameter</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="modelFilterItem" type="xsd:string" minOccurs="0">
					<xsd:annotation>
						<xsd:documentation>The model item that is closest to the use of the parameter in the expression.
E.g.:
expression:
country.cname = ?country?
Parameter name: country
dataType: string
modelFilterItem: country.cname</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="capabilities" type="parameterCapabilitiesType" minOccurs="0"/>
				<xsd:element name="invert" type="xsd:boolean" default="false" minOccurs="0">
					<xsd:annotation>
						<xsd:documentation>If true, negate cumulative result of all simple value operations OR-ed gether to produce final result of this value. E.g. 
NOT ( x = 'a' OR x = 'b')</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="values" type="valueType" minOccurs="0" maxOccurs="unbounded"/>
				<xsd:element name="location" type="parameterLocationType" minOccurs="0">
					<xsd:annotation>
						<xsd:documentation>Parameter values that are applied to a request for data can be obtained from various places:
request - supplied by the client on the request
query - defined as part of the query (NYI)
global - global parameters
model - parameter values defined in the data module.
</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>
	<xsd:simpleType name="parameterLocationType">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="request"/>
			<xsd:enumeration value="query"/>
			<xsd:enumeration value="global"/>
			<xsd:enumeration value="module"/>
			<xsd:enumeration value="datasource"/>
		</xsd:restriction>
	</xsd:simpleType>
</xsd:schema>