analytics/schemas/moser/current/module.xsd

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

 IBM Cognos Products: moser

 (C) Copyright IBM Corp. 2015, 2021

 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="metadata.xsd"/>
	<xsd:include schemaLocation="physical.xsd"/>
	<xsd:include schemaLocation="business.xsd"/>
	<xsd:include schemaLocation="view.xsd"/>
	<xsd:include schemaLocation="resource.xsd"/>
	<xsd:include schemaLocation="prompt.xsd"/>
	<xsd:element name="module">
		<xsd:annotation>
			<xsd:documentation>The Titan module.</xsd:documentation>
		</xsd:annotation>
		<xsd:complexType>
			<xsd:complexContent>
				<xsd:extension base="objectType">
					<xsd:sequence>
						<!--
							History:
								3.0 : Helios R6
								4.0 : Helios R7
								5.0 : Helios R8+
								6.0 : Endor R1
								7.0 : Endor R3
								8.0 : Endor R4
								9.0 : Endor R5
								10.0 : Endor R6
								11.0 : Endor R7
						-->
						<xsd:element name="version" type="xsd:string" default="11.1">
							<xsd:annotation>
								<xsd:documentation>An explicit modeling version number, to detect modified definition or software. Note that the directory should change for major version changes, i.e. once per release.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="container" type="xsd:string">
							<xsd:annotation>
								<xsd:documentation>Specifies the location where the module resides.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:sequence>
							<xsd:element name="use" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
								<xsd:annotation>
									<xsd:documentation>Specifies the imported module. The implementation should be able to resolve macros containing session parameters. This will give the ability to dynamically load the resource modules based on the current runLocal session parameter.</xsd:documentation>
								</xsd:annotation>
							</xsd:element>
						</xsd:sequence>
						<xsd:sequence>
							<xsd:element name="useSpec" minOccurs="0" maxOccurs="unbounded">
								<xsd:annotation>
									<xsd:documentation>This is the replacement for the use elements that were defined in earlier versions.</xsd:documentation>
								</xsd:annotation>
								<xsd:complexType>
									<xsd:sequence>
										<xsd:element name="identifier" type="xsd:string">
											<xsd:annotation>
												<xsd:documentation>The identifier/alias to use in multi-part identifiers. (LETTER | "_") (LETTER | DIGIT | "_")* </xsd:documentation>
											</xsd:annotation>
										</xsd:element>
										<xsd:element name="type" type="useSpecType" minOccurs="0"/>
										<xsd:element name="storeID" type="xsd:string" minOccurs="0"/>
										<xsd:element name="searchPath" type="xsd:string" minOccurs="0"/>
										<xsd:element name="imports" type="xsd:string" minOccurs="0"/>
										<xsd:element name="ancestors" minOccurs="0" maxOccurs="unbounded">
											<xsd:annotation>
												<xsd:documentation>All ancestors of the useSpec element, ordered from the top most ancestor to the parent. This field is not intended to be persisted.</xsd:documentation>
											</xsd:annotation>
											<xsd:complexType>
												<xsd:sequence>
													<xsd:element name="defaultName" type="xsd:string" minOccurs="0">
														<xsd:annotation>
															<xsd:documentation>The localized name of the ancestor.</xsd:documentation>
														</xsd:annotation>
													</xsd:element>
													<xsd:element name="storeID" type="xsd:string" minOccurs="0">
														<xsd:annotation>
															<xsd:documentation>The storeId of the ancestor.</xsd:documentation>
														</xsd:annotation>
													</xsd:element>
												</xsd:sequence>
											</xsd:complexType>
										</xsd:element>
										<xsd:element name="dataCacheExpiry" type="xsd:string" minOccurs="0">
											<xsd:annotation>
												<xsd:documentation>Specifies the data cache expiration time in seconds. A value of 0 signifies a data cache will not be used.  The value can also be a macro expression.  If the property is missing then automatic is assumed (i.e. computed from other settings)</xsd:documentation>
											</xsd:annotation>
										</xsd:element>
										<xsd:element name="property" type="propertyType" minOccurs="0" maxOccurs="unbounded">
											<xsd:annotation>
												<xsd:documentation>Generic property container.</xsd:documentation>
											</xsd:annotation>
										</xsd:element>
									</xsd:sequence>
								</xsd:complexType>
							</xsd:element>
						</xsd:sequence>
						<xsd:element name="expressionLocale" type="xsd:language" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Specifies the expression locale for the module.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:element name="fmModel" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>Specifies the FM modelPath to use when querying this module in a V5 Query.</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
						<xsd:choice>
							<xsd:annotation>
								<xsd:documentation>
									Please note minOccurs="0" maxOccurs="unbounded" is defined on each element, not on "choice". 
									This ensures the generated JAXB class can marshal / unmarshal the module in XML/JSON format correctly.
								</xsd:documentation>
							</xsd:annotation>
							<!-- physical object -->
							<xsd:element ref="dataSource" minOccurs="0" maxOccurs="unbounded"/>
							<!-- business objects -->
							<xsd:element ref="querySubject" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="filter" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="calculation" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="relationship" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="parameterMap" minOccurs="0" maxOccurs="unbounded"/>
							<!-- view objects -->
							<xsd:element name="metadataTreeView" type="folderType" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element name="metadataTreeViewFocus" type="focus" minOccurs="0"/>
							<!-- text resource objects -->
							<xsd:element name="textResource" type="textResource" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="drillGroup" minOccurs="0" maxOccurs="unbounded">
								<xsd:annotation>
									<xsd:documentation>drill Information.</xsd:documentation>
								</xsd:annotation>
							</xsd:element>
							<xsd:element ref="namedSet" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="parameterValueSet" minOccurs="0" maxOccurs="unbounded"/>
							<xsd:element ref="prompt" minOccurs="0" maxOccurs="unbounded"/>
						</xsd:choice>
						<!-- Snapshot feature was deprecated as of 11.0.4 (Helios R4) -->
						<xsd:element name="dataRetrievalMode" default="liveConnection" minOccurs="0">
							<xsd:simpleType>
								<xsd:restriction base="xsd:NMTOKEN">
									<xsd:enumeration value="liveConnection"/>
									<xsd:enumeration value="snapShot"/>
								</xsd:restriction>
							</xsd:simpleType>
						</xsd:element>
						<xsd:element name="refActiveParameterValueSet" type="xsd:string" minOccurs="0">
							<xsd:annotation>
								<xsd:documentation>The identifer of the parameterSet that is designated as active. It will be used as a last resort to find a parameter values.
Priority of finding parameters: request, global parameter, active parameter set.
</xsd:documentation>
							</xsd:annotation>
						</xsd:element>
					</xsd:sequence>
				</xsd:extension>
			</xsd:complexContent>
		</xsd:complexType>
	</xsd:element>
	<xsd:simpleType name="useSpecType">
		<xsd:restriction base="xsd:string">
			<xsd:enumeration value="database"/>
			<xsd:enumeration value="file"/>
			<xsd:enumeration value="module"/>
			<xsd:enumeration value="dataset"/>
			<xsd:enumeration value="package"/>
			<xsd:enumeration value="wa_data_asset"/>
			<xsd:enumeration value="lwOLAP"/>
			<xsd:enumeration value="url"/>
			<xsd:enumeration value="report"/>
		</xsd:restriction>
	</xsd:simpleType>
</xsd:schema>