analytics/configuration/qfs_config.xsd

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

Licensed Materials - Property of IBM 



BI and PM: QFW

© Copyright IBM Corp. 2005, 2010

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. 
 

-->

<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:annotation>
		<xs:documentation>Common QFS configuration elements</xs:documentation>
	</xs:annotation>
	<xs:element name="QFSConfiguration">
		<xs:complexType>
			<xs:sequence>
				<xs:group ref="properties"/>
				<xs:element name="providerList">
					<xs:complexType>
						<xs:sequence>
							<xs:element name="provider" type="providerType" maxOccurs="unbounded"/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element ref="operationSupport"/>
			</xs:sequence>
			<xs:attribute name="version" type="xs:string" use="required">
				<xs:annotation>
					<xs:documentation>Version of the configuration file</xs:documentation>
				</xs:annotation>
			</xs:attribute>
		</xs:complexType>
	</xs:element>
	<xs:group name="properties">
		<xs:all>
			<xs:element name="logCommands" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Defines whether to log commands through QF API logging facility. 'logs' folder must exist on the same level as 'bin' folder. Log file 'qfs_commands.xml' will be created. It can later be replayed using QFS Test Tool. Also, a command file for every provider that was involved in the planning or execution of a QF Command will be saved in the logs folder.  Levesl 0, 1, 2 are the appropriate logging levels.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="0"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="captureCommandsOnly" minOccurs="0" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Only supported on CSTD_PLATFORM_WIN32. Instructs QF to not execute commands but to log the command only and then fail the command.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:boolean" use="mandatory" default="false"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="threadSleepInterval" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds the cleanup thread that does cleanup of unused connections should sleep between passes.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="15000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="connectionPoolSize" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Max number of open connections allowed (“–1” means “no limit”). Connections to providers can be limited using this parameter; when the threshold is reached request to open a new connection will block for period of time configured through 'requestExpirationThreshold'.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:integer" default="-1"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="connectionExpirationThreshold" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds that must pass before connection can be considered “expired”. Once the internal connection to the data source is no longer used it remains available for this period of time and then deleted.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="300000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="connectionTotalUseCountThreshold" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of times that a connection can be reused, excluding "metadata" commands. Once the threshold is met, the connection is cleaned up.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="1000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="connectionMetadataTotalUseCountThreshold" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of times that a connection can be reused for "metadata" commands only. Once the threshold is met, the connection is cleaned up.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="10000000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="connectionCleanupInterval" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds between cleaning the connection pool. After this period of time passes the cleanup thread will identify and remove unused connections.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="15000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="highLevelPoolLingerTime" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds for which the high-level resource pool is available for reuse after having been released.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="30000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="requestExpirationThreshold" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds after which QFS gives up when trying to open a new connection (e.g. when connection pool is limited in size and QFS waits for a new connection "slot" to become available).</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="60000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="metadataPoolSize" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Max number of elements in the metadata query pool (“–1” means “no limit”). This is the maximum allowed number of metadata queries per connection.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:integer" default="-1"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="metadataExpirationThreshold" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds that must pass before metadata query object can be considered “expired” (and can be deleted).</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="60000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="metadataCleanupInterval" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of milliseconds between cleaning the metadata query pools.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:nonNegativeInteger" default="15000"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="maxTuplesPerEdge" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Max number of tuples that is allowed on a single edge (“–1” means “no limit”). This limit allows providers to refuse to execute certain queries that will otherwise result in memory over-consumption.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:integer" default="-1"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="maxCellsPerQuery" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Max number of data cells that are allowed in a single query (“–1” means “no limit”). This limit allows providers to refuse to execute certain queries that will otherwise result in memory over-consumption.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:integer" default="-1"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="defaultProvider" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider to accept the query sent to the query framework service.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:string"/>
				</xs:complexType>
			</xs:element>
			<xs:element name="defaultFmCommandProvider" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider to accept the FM command sent to the query framework service.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:attribute name="value" type="xs:string"/>
				</xs:complexType>
			</xs:element>
		</xs:all>
	</xs:group>
	<xs:complexType name="providerType">
		<xs:all>
			<xs:element name="connectionExpirationThreshold" type="nonNegativeIntegerType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Planner-specific number of milliseconds that must pass before connection can be considered “expired”. Once the internal connection to the data source is no longer used it remains available for this period of time and then deleted.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="connectionTotalUseCountThreshold" type="nonNegativeIntegerType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of times that a connection can be reused, excluding "metadata" commands. Once the threshold is met, the connection is cleaned up.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="connectionMetadataTotalUseCountThreshold" type="nonNegativeIntegerType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Number of times that a connection can be reused for "metadata" commands only. Once the threshold is met, the connection is cleaned up.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="metadataPoolSize" type="integerPropertyType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider-specific max number of elements in the metadata query pool (“–1” means “no limit”). This is the maximum allowed number of metadata queries per connection.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="metadataExpirationThreshold" type="nonNegativeIntegerType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider-specific number of milliseconds that must pass before metadata query object can be considered “expired” (and can be deleted).</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="metadataCleanupInterval" type="nonNegativeIntegerType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider-specific number of milliseconds between cleaning the metadata query pools.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="maxTuplesPerEdge" type="integerPropertyType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Provider-specific max number of tuples that is allowed on a single edge (“–1” means “no limit”). This limit allows providers to refuse to execute certain queries that will otherwise result in memory over-consumption.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="maxCellsPerQuery" type="integerPropertyType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Max number of data cells that are allowed in a single query (“–1” means “no limit”). This limit allows providers to refuse to execute certain queries that will otherwise result in memory over-consumption.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="providerDetails" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Information specific for this provider.</xs:documentation>
				</xs:annotation>
				<xs:complexType>
					<xs:choice>
						<xs:any namespace="##any">
							<xs:annotation>
								<xs:documentation>An arbitrary provider specific informaion.</xs:documentation>
							</xs:annotation>
						</xs:any>
					</xs:choice>
				</xs:complexType>
			</xs:element>
		</xs:all>
		<xs:attribute name="name" type="xs:string" use="required">
			<xs:annotation>
				<xs:documentation>Symbolic name of the provider that will be passed inside "dataSourceType" QS API connection property</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="libraryName" type="xs:string" use="required">
			<xs:annotation>
				<xs:documentation>Physical name of the provider shared library (appropriate suffix will be added on each platform)</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="serviceProvider" type="xs:boolean" use="optional" default="false">
			<xs:annotation>
				<xs:documentation>Indicates if this is a service provider</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="connectionCode" type="xs:string" use="optional"/>
	</xs:complexType>
	<xs:complexType name="propertyType">
		<xs:sequence>
			<xs:element name="operator" type="xs:string">
				<xs:annotation>
					<xs:documentation>Specifies element name</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="name" type="xs:string">
				<xs:annotation>
					<xs:documentation>Specifies attribute name</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="value" type="xs:string" minOccurs="0">
				<xs:annotation>
					<xs:documentation>Specifies attribute value</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="nonNegativeIntegerType">
		<xs:attribute name="value" type="xs:nonNegativeInteger" use="required"/>
	</xs:complexType>
	<xs:complexType name="integerPropertyType">
		<xs:attribute name="value" type="xs:integer" use="required"/>
	</xs:complexType>
	<xs:complexType name="booleanPropertyType">
		<xs:attribute name="value" type="xs:boolean" use="required"/>
	</xs:complexType>
	<xs:annotation>
		<xs:documentation>Coordination Planner elements</xs:documentation>
	</xs:annotation>
	<xs:element name="queryProcessingSequence">
		<xs:complexType>
			<xs:choice>
				<xs:element name="providerCall" minOccurs="0" maxOccurs="unbounded">
					<xs:complexType>
						<xs:attribute name="provider"/>
						<xs:attribute name="systemOptional" type="xs:boolean" use="optional" default="false"/>
					</xs:complexType>
				</xs:element>
			</xs:choice>
		</xs:complexType>
	</xs:element>
	<xs:element name="parameters">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="parameter" maxOccurs="unbounded">
					<xs:complexType>
						<xs:attribute name="name" type="xs:string" use="required"/>
						<xs:attribute name="value" type="xs:string" use="required"/>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="operationGroup">
		<xs:complexType>
			<xs:choice minOccurs="0" maxOccurs="unbounded">
				<xs:element ref="operationGroup"/>
				<xs:element ref="operation"/>
			</xs:choice>
			<xs:attribute name="name" type="xs:string"/>
			<xs:attribute name="supported" type="xs:boolean"/>
			<xs:attribute name="overrideBase" type="xs:boolean"/>
			<xs:attribute name="fdsForProvider" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="dataSources">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="dataSource" minOccurs="0" maxOccurs="unbounded"/>
			</xs:sequence>
			<xs:attribute name="supported" type="xs:boolean"/>
			<xs:attribute name="overrideBase" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="operation">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="dataSources" minOccurs="0"/>
				<xs:element name="pattern" minOccurs="0" maxOccurs="unbounded">
					<xs:complexType>
						<xs:attribute name="test" type="xs:string"/>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
			<xs:attribute name="type" type="xs:string"/>
			<xs:attribute name="supported" type="xs:boolean"/>
			<xs:attribute name="overrideBase" type="xs:string"/>
		</xs:complexType>
	</xs:element>
	<xs:element name="operationSupport">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="operationSupportTable" maxOccurs="unbounded">
					<xs:complexType>
						<xs:sequence>
							<xs:element ref="dataSources" minOccurs="0"/>
							<xs:element ref="operationGroup" maxOccurs="unbounded"/>
						</xs:sequence>
						<xs:attribute name="scope" type="xs:string" use="required"/>
					</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="dataSource">
		<xs:complexType>
			<xs:attribute name="type" type="xs:string"/>
			<xs:attribute name="supported" type="xs:boolean"/>
		</xs:complexType>
	</xs:element>
</xs:schema>