analytics/templates/mdsrv/lineage.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.
-->
<!--
	Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
	Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
	
	This is the lineage API specification for the Metadata Service. Contains specifications for both the
	request and response portions of the API.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="lineageRequest">
		<xs:annotation>
			<xs:documentation>The root element of a lineage request.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="service" type="xs:string" minOccurs="0">
					<xs:annotation>
						<xs:documentation>Intended to pertain to a lineageRequest element that appears in the transformation for an object in the response, to indicate to the caller the service that can handle this request. Reserved for future use.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:choice>
					<xs:element name="connection">
						<xs:annotation>
							<xs:documentation>A setting that leads to a source specification against which the objectQuery elements are processed.</xs:documentation>
						</xs:annotation>
						<xs:complexType>
							<xs:sequence>
								<xs:element ref="param" maxOccurs="unbounded"/>
							</xs:sequence>
						</xs:complexType>
					</xs:element>
					<xs:element name="V5QuerySet" type="xs:string">
						<xs:annotation>
							<xs:documentation source="rn_added_10.1.0"/>
							<xs:documentation>Escaped xml that adheres to ..\..\webcontent\schemas\rspec\6.0\V5QuerySet.xsd.  "reportQuerySet" xml is also supported, from which its contaiining "querySet" will be processed.</xs:documentation>
						</xs:annotation>
					</xs:element>
				</xs:choice>
				<xs:element name="objectQuery" minOccurs="0" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>Represents the request for the lineage of a single object in the specification pertaining to the connection. The domain of valiues are service-specific</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element ref="param" maxOccurs="unbounded"/>
						</xs:sequence>
						<xs:attribute name="id" type="xs:string">
							<xs:annotation>
								<xs:documentation>A value that uniquely identifies the objectQuery in the request.  This value is specified as the “objectQueryRef” value of a “queryResult” element in the response. This provides the caller with the ability to match the various queryResult elements in the response with corresponding objectQuery elements in the originating request.</xs:documentation>
								<xs:documentation source="doc_att_id_1"/>
							</xs:annotation>
						</xs:attribute>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
			<xs:attribute name="version" type="xs:string" use="required" fixed="1.0">
				<xs:annotation>
					<xs:documentation>The version of the lineage API being employed. The semantics of its value is specific to the service implementing the request.</xs:documentation>
				</xs:annotation>
			</xs:attribute>
		</xs:complexType>
	</xs:element>
	<xs:element name="lineageResponse">
		<xs:annotation>
			<xs:documentation>Defines the reponse of a lineage request. A lineage response contains a set of objects that are referenced in the query result.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence minOccurs="0">
				<xs:element name="queryResult" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>The "result" of an objectQuery in the originating request. It contains references to the objects in the main object set that represent the "starting points" for traversing the transformations.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element ref="objectRef"/>
							<xs:element name="objectQueryRef" type="xs:string" minOccurs="0">
								<xs:annotation>
									<xs:documentation>The key mechanism that binds the queryResult to the objectQuery in the originating request. Its value must match that of the "id" of an "objectQuery" element in the originating request.</xs:documentation>
								</xs:annotation>
							</xs:element>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element ref="object" maxOccurs="unbounded"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="object">
		<xs:annotation>
			<xs:documentation>Pertains to an object in the source specification against which the lineage request is being processed. It can either be an an object involved in the requested lineage, with the "transformation" element specified accordingly. It can also serve merely to provide context for other objects or as a transformation source with no transformation of its own, in which case no transformation element will exist and only the parentRef and/or the childRef elements may be populated.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="name">
					<xs:annotation>
						<xs:documentation>The name of the object.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="type" type="xs:string">
					<xs:annotation>
						<xs:documentation>A semantic type of the object,</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element ref="property" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="transformation" minOccurs="0">
					<xs:annotation>
						<xs:documentation>Represents the transformation information for a particular object in the source specifiication that the parent object element is based on. Its transsfromation sources are determined by its "objectRef" sub-elements and/or a separate lineage request instance. The value os every objectRef element should match that of the “id” of another object in the main object set. The lienageRequest eleemnt represents a subsequent lineage request that needs to be processed by some other service that can semantically process the transformation source.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="type">
								<xs:annotation>
									<xs:documentation>The semantic type of a transformation, whose domain of values are service-specific.</xs:documentation>
									<xs:documentation source="doc_ele_type_1"/>
								</xs:annotation>
							</xs:element>
							<xs:element ref="property" minOccurs="0" maxOccurs="unbounded">
								<xs:annotation>
									<xs:documentation>A generic name-value pair that contains optional extensions for a "display value'" of the property's name and/or value. Its name must be unique across sibling instances. The domain of names and values service-specific.</xs:documentation>
								</xs:annotation>
							</xs:element>
							<xs:choice>
								<xs:element ref="objectRef"/>
								<xs:element ref="lineageRequest"/>
							</xs:choice>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="parentRef" minOccurs="0">
					<xs:annotation>
						<xs:documentation>A reference to an object in the main object set that represents the current object's contextual “parent”. Its value must match that of the “id” of another object in the main object set.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="childRef" type="xs:string" minOccurs="0" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>A reference to an object in the main object set that represents the current object's contextual “parent”. Its value must match that of the “id” of another object in the main object set.</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
			<xs:attribute name="id" type="xs:string" use="required">
				<xs:annotation>
					<xs:documentation>A unique identfiiier for the object. Its value can by referenced via the childRef of another object, the parentRef of another object or the objectRef of a queryResult or transformation.</xs:documentation>
				</xs:annotation>
			</xs:attribute>
		</xs:complexType>
	</xs:element>
	<xs:element name="property">
		<xs:annotation>
			<xs:documentation>A generic name-value pair, that contains optional extensions for a "display value'" for the property's name and/or value. Its name must be unique across sibling instances. The domain of names and values service-specific.</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:simpleContent>
				<xs:extension base="paramType">
					<xs:attribute name="displayName" type="xs:string" use="optional">
						<xs:annotation>
							<xs:documentation>The "display value" for a property's name.</xs:documentation>
						</xs:annotation>
					</xs:attribute>
					<xs:attribute name="displayValue" type="xs:string" use="optional">
						<xs:annotation>
							<xs:documentation>The "display value" for a property's value.</xs:documentation>
						</xs:annotation>
					</xs:attribute>
				</xs:extension>
			</xs:simpleContent>
		</xs:complexType>
	</xs:element>
	<xs:element name="param" type="paramType">
		<xs:annotation>
			<xs:documentation>A generic name-value parameter, used throughout in both the request and response. Ths name must be unique across sibling instances.</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:element name="objectRef" type="xs:string">
		<xs:annotation>
			<xs:documentation>A reference to an object in the main object set of the response.  Its value must match that of the “id” of another object in the main object set.</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:complexType name="nodeType">
		<xs:sequence>
			<xs:element name="name">
				<xs:annotation>
					<xs:documentation>name does not have to be unique but can be displayed in the UI</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element ref="property" minOccurs="0" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="paramType">
		<xs:annotation>
			<xs:documentation>A generic name-value pair, which pertains to both param and property element types.</xs:documentation>
		</xs:annotation>
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute name="name" type="xs:string" use="required">
					<xs:annotation>
						<xs:documentation>The name of the param or property element.</xs:documentation>
					</xs:annotation>
				</xs:attribute>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
</xs:schema>