analytics/templates/mdsrv/PersonalDataCommands.xsd

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

 IBM Cognos Products: mdsrv

 (C) Copyright IBM Corp. 2008, 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" attributeFormDefault="unqualified">
	<xs:element name="commands">
		<xs:annotation>
			<xs:documentation>Commands used for personal data merge feature</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:choice>
				<xs:element name="processPersonalData">
					<xs:annotation>
						<xs:documentation>Passed some personal data, this commands converts the data into a standard form, which is then cached for the duration of the session. The output contains metadata information about the personal data.  </xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="input">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="baseModelSearchPath" minOccurs="0">
											<xs:annotation>
												<xs:documentation>The base model that should be used to determine the restrictions governing the physical characterisics (size, row count etc.) of personal data. If not specified, the default values will be nforced.</xs:documentation>
											</xs:annotation>
										</xs:element>
										<xs:element name="dataSet">
											<xs:complexType>
												<xs:complexContent>
													<xs:extension base="dataSetType">
														<xs:sequence>
															<xs:element name="content" type="xs:base64Binary">
																<xs:annotation>
																	<xs:documentation>Content of the personal data  uploaded to the server</xs:documentation>
																</xs:annotation>
															</xs:element>
														</xs:sequence>
													</xs:extension>
												</xs:complexContent>
											</xs:complexType>
										</xs:element>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="output">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="pdSpec" type="basePersonalDataType"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="addPersonalData">
					<xs:annotation>
						<xs:documentation>Given one or more personal data specification this command creates/replaces a personalized package that augments the base model with query subjects that represent individual personal data sources.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="input">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="pdCollection">
											<xs:complexType>
												<xs:complexContent>
													<xs:extension base="personalDataCollectionType">
														<xs:sequence minOccurs="0">
															<xs:annotation>
																<xs:documentation>Specifies where the target package should be saved. If left unspecified, the package will be saved under user's My Folders using the same name as the first personal data</xs:documentation>
															</xs:annotation>
															<xs:element name="targetPath"/>
															<xs:element name="targetName"/>
														</xs:sequence>
													</xs:extension>
												</xs:complexContent>
											</xs:complexType>
										</xs:element>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="output">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="personalPackagePath"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="getPersonalData">
					<xs:annotation>
						<xs:documentation>Retrieves any personal data specification defined for a given model.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="input">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="modelSearchPath"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="output">
								<xs:complexType>
									<xs:sequence minOccurs="0">
										<xs:element name="pdCollection" type="personalDataCollectionType"/>
										<xs:element name="governors" minOccurs="0">
											<xs:annotation>
												<xs:documentation>Governor settings in effect, as spcified in the base model.</xs:documentation>
											</xs:annotation>
											<xs:complexType>
												<xs:sequence minOccurs="0" maxOccurs="unbounded">
													<xs:element name="governor">
														<xs:complexType>
															<xs:simpleContent>
																<xs:extension base="xs:int">
																	<xs:attribute name="name">
																		<xs:simpleType>
																			<xs:restriction base="xs:token">
																				<xs:enumeration value="maxPersonalDataSources"/>
																				<xs:enumeration value="maxPersonalDataFileSize"/>
																				<xs:enumeration value="maxPersonalDataRowCount"/>
																			</xs:restriction>
																		</xs:simpleType>
																	</xs:attribute>
																</xs:extension>
															</xs:simpleContent>
														</xs:complexType>
													</xs:element>
												</xs:sequence>
											</xs:complexType>
										</xs:element>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="getQuerySubjectData">
					<xs:annotation>
						<xs:documentation>Retrieves detailed query item information for a given query subject within the model.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="input">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="modelSearchPath"/>
										<xs:element name="querySubject" type="MQPquerySubjectType"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="output">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="querySubject" type="MQPquerySubjectType"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="processExtractReport">
					<xs:annotation>
						<xs:documentation>Executes the specified report and stores the result, as Cognos XML, in the session. The result metadata is returned.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="input">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="reportSearchPath"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="output">
								<xs:complexType>
									<xs:sequence>
										<xs:element ref="reportExtract"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:choice>
		</xs:complexType>
	</xs:element>
	<xs:element name="item">
		<xs:complexType>
			<xs:attribute name="name" use="required"/>
			<xs:attribute name="ID" use="required"/>
			<xs:attribute name="datatype" default="unknown">
				<xs:simpleType>
					<xs:restriction base="xs:NMTOKEN">
						<xs:enumeration value="unknown"/>
						<xs:enumeration value="characterLength16"/>
						<xs:enumeration value="boolean"/>
						<xs:enumeration value="decimal"/>
						<xs:enumeration value="float32"/>
						<xs:enumeration value="float64"/>
						<xs:enumeration value="timeInterval"/>
						<xs:enumeration value="dateTime"/>
						<xs:enumeration value="date"/>
						<xs:enumeration value="time"/>
						<xs:enumeration value="int16"/>
						<xs:enumeration value="int32"/>
						<xs:enumeration value="int64"/>
						<xs:enumeration value="blob"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:attribute>
			<xs:attribute name="length" type="xs:int"/>
			<xs:attribute name="scale"/>
			<xs:attribute name="precision" type="xs:int"/>
			<xs:attribute name="usage" default="unknown">
				<xs:simpleType>
					<xs:restriction base="xs:NMTOKEN">
						<xs:enumeration value="attribute"/>
						<xs:enumeration value="fact"/>
						<xs:enumeration value="identifier"/>
						<xs:enumeration value="unknown"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:attribute>
			<xs:attribute name="regularAggregate" type="aggregateType"/>
			<xs:attribute name="semiAggregate" type="aggregateType"/>
			<xs:attribute name="hidden" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="MQPquerySubjectType">
		<xs:sequence>
			<xs:element name="queryItem" type="MQPqueryItemType" minOccurs="0"/>
		</xs:sequence>
		<xs:attribute name="name" use="required"/>
		<xs:attribute name="_ref" use="required"/>
	</xs:complexType>
	<xs:complexType name="MQPqueryItemType">
		<xs:attribute name="name" use="required"/>
		<xs:attribute name="_ref" use="required"/>
		<xs:attribute name="linkable" type="xs:boolean">
			<xs:annotation>
				<xs:documentation>When true, the item may be used in a relationship, otherwise not</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="dataSetType">
		<xs:annotation>
			<xs:documentation>Represents the personal data set. Note type and name, if left unspecified, will be defaulted based on source file extension and name.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="name" minOccurs="0"/>
			<xs:element name="sourcePath">
				<xs:annotation>
					<xs:documentation>The path to the file originally used.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="accessDirectly" type="xs:boolean" default="false" minOccurs="0">
				<xs:annotation>
					<xs:documentation>When set to true, the server will attempt to access the file (using the specified sourcePath) if content is not already cached in the session. It is up to the client to ensure the file is accessible.</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="type" default="XML">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="CSV"/>
					<xs:enumeration value="Excel2003"/>
					<xs:enumeration value="XML"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="querySubjType">
		<xs:annotation>
			<xs:documentation>Represents query subject metadata</xs:documentation>
		</xs:annotation>
		<xs:sequence maxOccurs="unbounded">
			<xs:element ref="item"/>
		</xs:sequence>
		<xs:attribute name="name" use="required"/>
		<xs:attribute name="ID" use="required"/>
	</xs:complexType>
	<xs:complexType name="basePersonalDataType">
		<xs:sequence>
			<xs:element name="dataSet">
				<xs:complexType>
					<xs:complexContent>
						<xs:extension base="dataSetType"/>
					</xs:complexContent>
				</xs:complexType>
			</xs:element>
			<xs:element name="personalData" type="querySubjType"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="cardinality">
		<xs:sequence>
			<xs:element name="minCard" default="one">
				<xs:simpleType>
					<xs:restriction base="xs:NMTOKEN">
						<xs:enumeration value="zero"/>
						<xs:enumeration value="one"/>
						<xs:enumeration value="many"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="maxCard" default="zero">
				<xs:simpleType>
					<xs:restriction base="xs:NMTOKEN">
						<xs:enumeration value="zero"/>
						<xs:enumeration value="one"/>
						<xs:enumeration value="many"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:element name="relationship">
		<xs:annotation>
			<xs:documentation>How personal data object is related to an object in the base model or to a tabular extract.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="targetModelPath" minOccurs="0">
					<xs:annotation>
						<xs:documentation>When dealing with base model targets, this property is used by the client to locate the target object in the package (using MQP's path protocol).  </xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="sourceCardinality" type="cardinality">
					<xs:annotation>
						<xs:documentation>Cardinality on the side of the personal data object</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="targetCardinality" type="cardinality">
					<xs:annotation>
						<xs:documentation>Cardinality on the side of the target</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="expression">
					<xs:complexType>
						<xs:sequence maxOccurs="unbounded">
							<xs:element name="relPart">
								<xs:complexType>
									<xs:sequence>
										<xs:element name="itemRef"/>
										<xs:element name="compOpr">
											<xs:simpleType>
												<xs:restriction base="xs:NMTOKEN">
													<xs:enumeration value="eq"/>
													<xs:enumeration value="ne"/>
													<xs:enumeration value="gt"/>
													<xs:enumeration value="lt"/>
													<xs:enumeration value="ge"/>
													<xs:enumeration value="le"/>
												</xs:restriction>
											</xs:simpleType>
										</xs:element>
										<xs:element name="itemRef"/>
									</xs:sequence>
								</xs:complexType>
							</xs:element>
							<xs:element name="logicalOpr" default="and" minOccurs="0">
								<xs:simpleType>
									<xs:restriction base="xs:NMTOKEN">
										<xs:enumeration value="and"/>
										<xs:enumeration value="or"/>
									</xs:restriction>
								</xs:simpleType>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
			<xs:attribute name="target" default="baseModel">
				<xs:annotation>
					<xs:documentation>Whether this relationship links personal data to an object in the base model or the tabular extract?</xs:documentation>
				</xs:annotation>
				<xs:simpleType>
					<xs:restriction base="xs:NMTOKEN">
						<xs:enumeration value="baseModel"/>
						<xs:enumeration value="reportExtract"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:attribute>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="personalDataType">
		<xs:complexContent>
			<xs:extension base="basePersonalDataType">
				<xs:sequence>
					<xs:element ref="reportExtract" minOccurs="0">
						<xs:annotation>
							<xs:documentation>Represents a report and its output which is used in joining personal data with DMP/OLAP objects</xs:documentation>
						</xs:annotation>
					</xs:element>
					<xs:element ref="relationship" minOccurs="0"/>
					<xs:element name="containerID" minOccurs="0">
						<xs:annotation>
							<xs:documentation>The ID of the container, namespace for example, under which the personal query sibject and the tabular extrat and other information appear. This value is populated by get command and is used primarily during update.</xs:documentation>
						</xs:annotation>
					</xs:element>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="personalDataCollectionType">
		<xs:sequence>
			<xs:element name="baseModelSearchPath">
				<xs:annotation>
					<xs:documentation>Search path to the model in the base package</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:sequence>
				<xs:element name="pdSpec" type="personalDataType" maxOccurs="unbounded"/>
			</xs:sequence>
		</xs:sequence>
	</xs:complexType>
	<xs:element name="reportExtract">
		<xs:annotation>
			<xs:documentation>Represents the a report and its output which is used in joining personal data with DMP/OLAP objects</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="reportSearchPath"/>
				<xs:element name="reportSubject" type="querySubjType">
					<xs:annotation>
						<xs:documentation>The metadata representing report projection items</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:simpleType name="aggregateType">
		<xs:restriction base="xs:NMTOKEN">
			<xs:enumeration value="average"/>
			<xs:enumeration value="automatic"/>
			<xs:enumeration value="count"/>
			<xs:enumeration value="countDistinct"/>
			<xs:enumeration value="countNonZero"/>
			<xs:enumeration value="maximum"/>
			<xs:enumeration value="median"/>
			<xs:enumeration value="minimum"/>
			<xs:enumeration value="standardDeviation"/>
			<xs:enumeration value="sum"/>
			<xs:enumeration value="variance"/>
			<xs:enumeration value="unsupported"/>
		</xs:restriction>
	</xs:simpleType>
</xs:schema>