analytics/templates/bmt/BMESDK/mdp.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
 IBM Confidential

 OCO Source Materials

 IBM Cognos Products: bme

 (C) Copyright IBM Corp. 2003, 2010

 The source code for this program is not published or otherwise
 divested of its trade secrets, irrespective of what has been
 deposited with the U.S. Copyright Office.
--> 
<xs:schema targetNamespace="http://www.developer.cognos.com/schemas/bmt/mdp/0" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mdp="http://www.developer.cognos.com/schemas/bmt/mdp/0">
	<xs:annotation>
		<xs:documentation xml:lang="en">Metadata Provider (Automation) Schema</xs:documentation>
	</xs:annotation>
	<!--<xs:include schemaLocation=".\mdp-actions.xsd" namespace="http://www.developer.cognos.com/schemas/bmt/mdp/0 "/>-->
	<!-- 
      All MDP request must comply with BI Bus architecture. This pertains especially to the header format. Please refer to GL007 for 
      the general information. Similarly, MDP response format is that of BI Bus (including faults). 
      This schema only describes portion that is MDP specific - request/response payloads.
      -->
	<xs:element name="request" type="mdp:MDPRequest">
		<xs:annotation>
			<xs:documentation>The Cognos 10 SDK wrapper element defining the contents as a metadata provider request (mdprovider). There are two metadata provider request types: an action request, and a generic request.</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:element name="response" type="mdp:MDPResponse">
		<xs:annotation>
			<xs:documentation source="doc_ele_response_mdp"/>
			<xs:documentation>The Cognos 10 SDK wrapper element that defines the contents of the element as the response from the metadata provider request.</xs:documentation>
		</xs:annotation>
	</xs:element>
	<!--  *************** MDP Request ******************
       Four types of MDP provider requests are described here. Each request is encapsulated in the body of the SOAP message. Please note
       that by far the most complex requests are of type FmAPIRequest. FmAPIRequests are described by a separate schema.
      -->
	<xs:complexType name="MDPRequest">
		<xs:choice>
			<xs:element name="mdprovider" type="mdp:FmAPIRequest">
				<xs:annotation>
					<xs:documentation source="doc_ele_mdprovider_fmapi"/>
					<xs:documentation xml:lang="en">Action request. Defines a request sent to the metadata provider service. Represents a Framework Manager API (updateMetadata) request that executes an action or series of actions against the model.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="mdprovider" type="mdp:GenericRequest">
				<xs:annotation>
					<xs:documentation source="doc_ele_mdprovider_generic"/>
					<xs:documentation xml:lang="en">Generic request. Defines a request sent to the metadata provider service. Represents a generic request whose purpose can be to: open or close a client session, or create and save a model. Note: Only single file models and project-based models can be created and saved with a generic request.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="mdprovider" type="mdp:StylesheetRequest">
				<xs:annotation>
				    <xs:documentation source="deprecated"/>
					<xs:documentation source="doc_ele_mdprovider_stylesheet"/>
					<xs:documentation xml:lang="en">Stylesheet request. Defines a request sent to the metadata provider service. Represents an XSLT (queryMetadata) request that applies a stylesheet against a specified model, using the XSLT processor.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="mdprovider" type="mdp:MARequest">
				<xs:annotation>
					<xs:documentation source="deprecated"/>
					<xs:documentation xml:lang="en">MA (queryMetadata) request. Do not use - deprecated.</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:choice>
	</xs:complexType>
	<xs:complexType name="FmAPIRequest">
		<xs:sequence>
			<xs:element name="transaction" type="mdp:Transaction">
				<xs:annotation>
					<xs:documentation>Container element that groups an action request or series of action requests (updateMetadata) submitted to the metadata provider service to execute against a model.</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="model" type="mdp:ConnectString" use="required">
			<xs:annotation>
				<xs:documentation source="doc_att_model_fmapi"/>
				<xs:documentation>Specifies the model against which to execute the request.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="type" type="xs:NMTOKEN" use="required" fixed="action">
			<xs:annotation>
				<xs:documentation source="doc_att_type_fmapi"/>
				<xs:documentation>Specifies the type of the request. For an action request, the type is always set to action.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="action" type="xs:NMTOKEN" use="required" fixed="execute">
			<xs:annotation>
				<xs:documentation source="doc_att_action_fmapi"/>
				<xs:documentation>Specifies the action for this request. For an updateMetadata request, the action is always set to execute.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="Transaction">
		<xs:sequence>
			<xs:element name="action" type="mdp:Action">
				<xs:annotation>
					<xs:documentation>Contains an individual task to be executed by the underlying metadata provider service, that will either succeed or fail. Each action element may contain several input parameters. Action elements are described in more detail in the Actions Reference in this guide.</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="seq" type="xs:positiveInteger" use="required">
			<xs:annotation>
				<xs:documentation>Specifies a numeric sequence for the transaction.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="commit" type="xs:NMTOKEN" fixed="y">
			<xs:annotation>
				<xs:documentation>An optional attribute that, if specified and set to y, causes the model to be saved after the transaction executes successfully.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="GenericRequest">
		<xs:attribute name="model" type="mdp:ConnectString" use="required">
			<xs:annotation>
				<xs:documentation source="doc_att_model_generic"/>
				<xs:documentation>Specifies the model against which to execute the request.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="type" type="xs:NMTOKEN" use="required" fixed="generic">
			<xs:annotation>
				<xs:documentation source="doc_att_type_generic"/>
				<xs:documentation>Specifies the type of the request. For a generic request, the type is always set to generic.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="action" use="required">
			<xs:annotation>
				<xs:documentation>Specifies the required action to be executed by the request.</xs:documentation>
				<xs:documentation source="doc_att_action_generic"/>
			</xs:annotation>
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="openModel">
						<xs:annotation>
							<xs:documentation>Specifies a request to open the model.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
					<xs:enumeration value="closeModel">
						<xs:annotation>
							<xs:documentation>Specifies a request to close the model.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
					<xs:enumeration value="saveModel">
						<xs:annotation>
							<xs:documentation>Specifies a request to save the model.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
					<xs:enumeration value="createModel">
						<xs:annotation>
							<xs:documentation>Specifies a request to create the model.</xs:documentation>
						</xs:annotation>
					</xs:enumeration>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="MARequest">
		<xs:sequence>
			<xs:element name="Metadata" type="mdp:MASpec">
				<xs:annotation>
					<xs:documentation source="deprecated"/>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="model" type="mdp:ConnectString" use="required"/>
		<xs:attribute name="type" type="xs:NMTOKEN" use="required" fixed="MA"/>
		<xs:attribute name="action" type="xs:NMTOKEN" use="required" fixed="query"/>
	</xs:complexType>
	<xs:complexType name="MASpec">
		<!-- See Cognos spec for MA, the schema will start with something like this   -->
	</xs:complexType>
	<xs:complexType name="StylesheetRequest">
		<xs:sequence>
			<xs:element name="mdprovider" type="mdp:SSSpec">
				<xs:annotation>
					<xs:documentation source="deprecated"/>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
		<xs:attribute name="model" type="mdp:ConnectString" use="required">
			<xs:annotation>
			   <xs:documentation source="deprecated"/>
				<xs:documentation source="doc_att_model_stylesheet"/>
				<xs:documentation>Specifies the model against which to execute the request.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="type" type="xs:NMTOKEN" use="required" fixed="stylesheet">
			<xs:annotation>
			   <xs:documentation source="deprecated"/>
				<xs:documentation source="doc_att_type_stylesheet"/>
				<xs:documentation>Specifies the type of the request. For an XSLT request, the type is always set to stylesheet.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="action" type="xs:NMTOKEN" use="required" fixed="apply">
			<xs:annotation>
				<xs:documentation source="deprecated"/>
				<xs:documentation source="doc_att_action_stylesheet"/>
				<xs:documentation>Specifies the action for this request. For an XSLT request, the action is always set to apply.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="SSSpec">
		<xs:sequence>
			<xs:any namespace="http://www.w3.org/1999/XSL/Transform" processContents="skip"/>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="ConnectString">
		<xs:restriction base="xs:string">
			<!-- one of:
	      1.  project path e.g y:\models\proj1\proj1.cpf, or/home/proj1/proj1.cpf
	      2. CM package specification (example: cm:///content/package[@defaultName="KPackage"]/model[last()])
	         Note: CM package specification can contain user credentials 
	         (example: cm:///content/package[@defaultName="KPackage"]/model[last()]&user=xyz&password=zyx)
	 -->
		</xs:restriction>
	</xs:simpleType>
	<!--	 **************** MDP response ******************* -->
	<xs:complexType name="MDPResponse">
		<xs:choice>
			<xs:element name="Fault">
				<xs:annotation>
					<xs:documentation xml:lang="en">Contains information regarding any condition other than success resulting from the request, as returned by the metadata provider service. This information is converted to a SOAP fault and returned to the client.</xs:documentation>
					<xs:documentation xml:lang="en">List of MDP specific faults will be provided separately</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="response">
				<xs:annotation>
					<xs:documentation source="doc_ele_response_generic"/>
					<xs:documentation>Defines the response to a generic metadata provider service request. It contains only the status of the submitted request.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:sequence>
						<xs:element name="status">
							<xs:annotation>
								<xs:documentation>Defines the status of the submitted generic metadata provider service request.</xs:documentation>
							</xs:annotation>
							<xs:complexType>
								<xs:attribute name="success" type="xs:boolean" use="required">
									<xs:annotation>
										<xs:documentation>Defines the execution of the submitted request as successful.</xs:documentation>
									</xs:annotation>
								</xs:attribute>
							</xs:complexType>
						</xs:element>
						<xs:any processContents="skip">
							<xs:annotation>
								<xs:documentation xml:lang="en">Response content is specific to request type. For example, response to StylesheetRequest will contain result of the
			  stylesheet processing.  Response to FmAPIRequest is action specific and will be described by action documentation. In case of multiple actions inside a transaction
     			  response contains catenation of all responses - it is up to the client to relate output parameters to individual actions.
     			  <!--  An example (response to two Create FmAPIRequests):
           		   <response>
                	    <status success="true" /> 
                	     <outputparams seq="1" type="handle" value="[GoSales].[Dummy]" /> 
                         <outputparams seq="2" type="integer" value="1" /> 
          	            <outputparams seq="1" type="handle" value="[GoSales].[Dummy2]" /> 
                         <outputparams seq="2" type="integer" value="1" /> 
                     </response> 
                     -->
								</xs:documentation>
							</xs:annotation>
						</xs:any>
					</xs:sequence>
				</xs:complexType>
			</xs:element>
		</xs:choice>
	</xs:complexType>
</xs:schema>