analytics/webapps/p2pd/WEB-INF/fragments/schemas/producer.xsd

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

    IBM Cognos Products: cpscrn


    (C) Copyright IBM Corp. 2005, 2011

    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).
-->
<!-- $Header: //cps4/blacksea/main/src/java/etc/webapps/cps/WEB-INF/fragments/schemas/producer.xsd#1 $ -->
<!-- $DateTime: 2007/12/05 10:46:07 $ -->
<!-- $Change: 21142 $ -->
<!--W3C Schema generated by XMLSpy v2007 (http://www.altova.com)-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://developer.cognos.com/fragments/producer/1/" targetNamespace="http://developer.cognos.com/fragments/producer/1/" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="producer">
		<xs:annotation>
			<xs:documentation>A XML document that defines a producer's fragments endpoints.  This information will be added to the routing.xml file to autoregister the fragments. There are two types of producers: CPS producer and custom producer</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="message" minOccurs="0">
					<xs:complexType>
						<xs:attribute name="source" type="xs:string" use="required"/>
					</xs:complexType>
				</xs:element>
				<xs:element name="name" type="LocalizedStringType"/>
				<xs:element name="portalPackage" type="xs:string" minOccurs="0">
					<xs:annotation>
						<xs:documentation>The portalPackage that these fragments will be added to during auto-registration. The default value is Connection. Portlets added to Connection will be visible to the user. Portlets added to Administration would not be visible to the user. The portalPackage must already exist in CM. Available since BlueSea.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="handle" type="xs:string">
					<xs:annotation>
						<xs:documentation>This root handle identifies the producer.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="href" type="xs:string" minOccurs="0">
					<xs:annotation>
						<xs:documentation>This is an end point to a custom producer.  The default end point for the CPS producer is /fragmentproducer </xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="plugin" type="PluginType" minOccurs="0" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>A class that implementents the interface 'com.cognos.portal.fragment.autoregistration.IAutoRegistrationPlugin". This class will be called when the producer is regisrtered. There is also an option to call it when the producer is being updated.</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="fragment" type="FragmentType" maxOccurs="unbounded"/>
			</xs:sequence>
			<xs:attribute name="version" use="required"/>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="FragmentType">
		<xs:sequence>
			<xs:element name="title" type="LocalizedStringType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>For a custom producer fragment, the name given to the resource. For CPS producer, it can be picked up from the fragment's implementation.xml.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="description" type="LocalizedStringType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>For a custom producer fragment, a textual description of the content of the resource.  For CPS producer,  the description is automatically picked up from the implementation.xml.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="modes" type="xs:QName" minOccurs="0" maxOccurs="unbounded">
				<xs:annotation>
					<xs:documentation>For a custom producer fragment, supported modes (e.g. view, edit, cps:config). For CPS producer, it is picked up from the fragment's implementation.xml.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="windowStates" type="xs:QName" minOccurs="0" maxOccurs="unbounded">
				<xs:annotation>
					<xs:documentation>For a custom producer fragment, supported window states (e.g. normal, maximized, minimized). For CPS producer, it is picked up from the fragment's implementation.xml.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="requiredCapabilities" type="xs:string" minOccurs="0">
				<xs:annotation>
					<xs:documentation>For a custom producer fragment, capabilities required to execute this fragment. For CPS producer, it is picked up from the fragment's implementation.xml.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="handle" type="xs:string">
				<xs:annotation>
					<xs:documentation>This handle is a unique identifier for the fragment within this producer.</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:choice>
				<xs:sequence>
					<xs:element name="implementation" type="xs:string">
						<xs:annotation>
							<xs:documentation>This is used by a CPS Producer.  It is the path of the implementation.xml file starting from the /WEB-INF/fragments/producers directory.</xs:documentation>
						</xs:annotation>
					</xs:element>
					<xs:element name="extraInfo" type="xs:string" minOccurs="0">
						<xs:annotation>
							<xs:documentation>extraInfo is appended to the implementation url and is added to the routing url - example of an extraInfo: ?mode=admin&amp;page=two. Note if you have several fragments using the same implementation file but with different extraInfo strings be sure to add a unique title to these fragments in this file in order to have unique portlet names. Available since BlueSea.</xs:documentation>
						</xs:annotation>
					</xs:element>
				</xs:sequence>
				<xs:element name="href" type="xs:string">
					<xs:annotation>
						<xs:documentation>The segment that will be appended to the producer's endpoint to create the physical endpoint.</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:choice>
			<xs:element name="custom" type="CustomType" minOccurs="0">
				<xs:annotation>
					<xs:documentation>The custom values that will be used to initialize the fragment.</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<!-- localizedString base -->
	<xs:complexType name="LocalizedStringType">
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute name="resourceName" type="xs:NMTOKEN" use="optional">
					<xs:annotation>
						<xs:documentation>The name assigned to this localized string for dereferencing into a ResourceList for values from other locales. When the resourceName is not supplied, there are no values for additional locales available in the ResourceList.</xs:documentation>
					</xs:annotation>
				</xs:attribute>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
	<xs:complexType name="CustomType">
		<xs:sequence>
			<xs:element name="param" type="ParamType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ParamType">
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute name="name" type="xs:NMTOKEN" use="required"/>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
	<xs:complexType name="PluginType">
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute name="executeOnUpdate" type="xs:boolean" use="optional"/>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
</xs:schema>