XML Schema "douidefinition.xsd"
Target Namespace:
http://www.lumis.com.br/lumisportal/xsd/doui
Components:
global element, 95 local elements, 33 complexTypes, 13 simpleTypes
Schema Location:
/home/opc/workspace/lpjava-17.0.x-dist/Lumis_PortalJava/builder/docflex-xml-kit/../../distribution/tmp/douidefinition.xsd, see XML source
Imports Schema:
douicontrolsdefinition.xsd [src]
All Element Summary
activityStream (within source) Specifies source activity stream default behavior.
Type:
embedded complexType
Content:
complex, 2 attributes, 2 elements
Defined:
locally at 1 location
Includes:
definitions of 1 attribute and 2 elements
addInterfaceId (type xsd:string) Each source may specify its add interface.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
administrationInterfaceId (type xsd:string) Each source may specify its administration interface.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
association (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
bigData (within field) Allows configuration about how the field is stored in portal big data repostory.
Type:
embedded complexType
Content:
empty, 1 attribute
Defined:
locally at 1 location
Includes:
definition of 1 attribute
bigData (within source) Specifies custom big data configurations.
Type:
embedded complexType
Content:
empty, 2 attributes
Defined:
locally at 1 location
Includes:
definitions of 2 attributes
categorization (type metaDataProperty) If specified, the content will be able to be filtered by categories and will be able to render associated categories.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
comments (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
connectionId (type xsd:string) Source may require data from another data base other than the primary data base used by the portal.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
controls (type control:lum_controls) The layout of an interface is determined by a collection of controls specified here.
Type:
Content:
complex, 1 attribute, 109 elements
Defined:
locally at 1 location
dataProviderClassName (type xsd:string) Class name of the dataprovider for the source.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
defaultInputControl (within field) Overrides the default input control to be used for this field.
Type:
embedded complexType
Content:
complex, 109 elements
Defined:
locally at 1 location
defaultInputControl (within filter) Overrides the default input control to be used for this filter.
Type:
embedded complexType
Content:
complex, 109 elements
Defined:
locally at 1 location
defaultValue (type xsd:string) The default value for this field.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
dependencyType (type xsd:string) This is used exclusively by the ServiceInstanceDependencyDataProvider.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
destPageId (type xsd:string) Used when the response type is doui_popupInterface.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
detailsInterfaceId (type xsd:string) Each source may specify its details interface.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
displayName (within objectType) A localizable string for the display name of this object type.
Type:
embedded (restriction of xsd:string)
Content:
simple
Defined:
locally at 1 location
douiDefinition
Type:
embedded complexType
Content:
complex, 3 attributes, 3 elements
Includes:
definitions of 1 attribute and 3 elements
Used:
never
editInterfaceId (type xsd:string) Each source may specify its edit interface.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
field (type sourceField) Specifies the details of the fields returned by the data provider.
Type:
Content:
complex, 45 attributes, 4 elements
Defined:
locally at 2 locations
field (within orderBy)
Type:
embedded complexType
Content:
empty, 3 attributes
Defined:
locally at 1 location
Includes:
definitions of 3 attributes
field (within selectFields)
Type:
embedded complexType
Content:
empty, 2 attributes
Defined:
locally at 1 location
Includes:
definitions of 2 attributes
fieldValue (within fieldValues) Allows customization of one parameter that will be available to this process action.
Type:
embedded complexType
Content:
empty, 2 attributes
Defined:
locally at 1 location
Includes:
definitions of 2 attributes
fieldValues (type fieldValues) Allows customization of the parameters that will be available to this process action (through the standard ProcessActionHandler.getParameter method).
Type:
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
fields (type interfaceFields)
Type:
Content:
complex, 1 attribute, 1 element
Defined:
locally at 1 location
fields (type sourceFields) collection of fields
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
filter (type filter)
Type:
Content:
complex, 22 attributes, 5 elements
Defined:
locally at 1 location
filters (type filters)
Type:
Content:
complex, 2 attributes, 2 elements
Defined:
locally at 2 locations
highlight (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
highlightEndDate (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
hyperLink (type hyperLink) Requests the portal for a url to another page of the portal.
Type:
Content:
complex, 8 attributes, 3 elements
Defined:
locally at 1 location
hyperLinks (type hyperLinks) specifies one or more hyperlinks that may be used in the interface.
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
inputControlClientEvents (within filter) Any client side events may be placed here.
Type:
embedded complexType
Content:
complex, any element
Defined:
locally at 1 location
interface (type interface) Details of an interface are specified here.
Type:
Content:
complex, 1 attribute, 5 elements
Defined:
locally at 1 location
interfaceId (type xsd:string) Used when the response type is doui_hyperLink.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
interfaces (type interfaces)
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
lock (type metaDataProperty) Specifies that the content will make use of locking to avoid simultaneous editing.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
maxNumberOfRowsAllowed (type xsd:integer) Define the maximum number of records that will be permitted when doui_maxRows is passed in a as source parameter.
Type:
xsd:integer
Content:
simple
Defined:
locally at 1 location
maxRows (type anyType)
Type:
anySimpleType
Content:
simple
Defined:
locally at 1 location
maxRows (type xsd:string) The maxRows element contains the maximum number of elements that may be inserted into the filter.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
metaData (type metaData) If the source type is contentTable, within this node the required metaData that must be associated with the content must be specified.
Type:
Content:
complex, 19 elements
Defined:
locally at 1 location
multiLanguage (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
objectType (within activityStream) Specifies properties of the activity stream object type to be used for activities automatically generated, by default implementations, for this source.
Type:
embedded complexType
Content:
complex, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
onClick (within hyperLink)
Type:
embedded complexType
Content:
complex, 3 attributes, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
operator (within operators)
Type:
embedded complexType
Content:
empty, 3 attributes
Defined:
locally at 1 location
Includes:
definitions of 3 attributes
operators (type filterOperators)
Type:
Content:
complex, 3 attributes, 1 element
Defined:
locally at 1 location
option (within options)
Type:
embedded (extension of xsd:string)
Content:
simple, 3 attributes
Defined:
locally at 1 location
Includes:
definitions of 3 attributes
options (type sourceFieldOptions) Possible values of the field may be explicitly specified here.
Type:
Content:
complex, 3 attributes, 1 element
Defined:
locally at 1 location
orderBy (type embedded)
Type:
embedded complexType
Content:
complex, 4 attributes, 1 element
Defined:
locally at 1 location
Includes:
definitions of 1 attribute and 1 element
parameter (type hyperLinkParameter)
Type:
Content:
empty, 2 attributes
Defined:
locally at 1 location
parameter (within parameters) Used when the response type is doui_setResponseParameters or doui_hyperLink.
Type:
embedded complexType
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
Includes:
definitions of 1 attribute and 1 element
parameters (type hyperLinkParameters)
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
parameters (within response)
Type:
embedded complexType
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
postLoadProcessor (type postLoadProcessor)
Type:
Content:
complex, 1 attribute, any element
Defined:
locally at 1 location
postLoadProcessors (type postLoadProcessors)
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
primaryContent (type metaDataProperty) Specifies that the content is a Primary Content
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
processAction (type processAction)
Type:
Content:
complex, 4+any attributes, 2+any elements
Defined:
locally at 1 location
processActions (type processActions) When the user interacts with an interface to make changes to the state of the application/service, one or more process actions are called that must be specified here.
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
publishEndDate (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
publishStartDate (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
publishToPrincipals (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
publishToServiceInstances (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
publishToSocialNetwork (type metaDataProperty) Specifies that the content may be published to social networks.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
relation (type relation) specifies a relation between the current source and another source in the doui definition.
Type:
Content:
complex, 6 attributes, 1 element
Defined:
locally at 1 location
relationField (within relation) specifies the fields between the curent source and the foreign source that are related.
Type:
embedded complexType
Content:
empty, 2 attributes
Defined:
locally at 1 location
Includes:
definitions of 2 attributes
relations (type relations) if the source is related to another source, the relation details must be specified here.
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
renderAction (within renderActions)
Type:
embedded complexType
Content:
complex, any attribute, any element
Defined:
locally at 1 location
renderActions (type renderActions) When the user interacts with an interface that do not make permanent changes to the application/service state render actions may be called.
Type:
Content:
complex, any attribute, 1 element
Defined:
locally at 1 location
response (type response)
Type:
Content:
complex, 3 attributes, 5 elements
Defined:
locally at 1 location
restInterface (type restInterface) Details of an rest interface are specified here.
Type:
Content:
complex, 1 attribute, 1 element
Defined:
locally at 1 location
restInterfaces (type restInterfaces)
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
scope (within targetScopes)
Type:
embedded complexType
Content:
empty, 1 attribute
Defined:
locally at 1 location
Includes:
definition of 1 attribute
script (type xsd:string) Must be specified if the type of the response is doui_runJavascript.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
selectFields (within filter) If the selectField attribute is set to true, this element must contain the list of fields to be included in the drop down list.
Type:
embedded complexType
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
seo (type metaDataProperty) Specifies that the content provides SEO specific fields.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
service (within douiDefinition)
Type:
embedded complexType
Content:
complex, 2 attributes, 1 element
Defined:
locally at 1 location
Includes:
definitions of 2 attributes and 1 element
serviceInstanceIsolation (type metaDataProperty) specifies that the content must be isolated between service instances.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
setControlValues (within onClick)
Type:
embedded complexType
Content:
complex, 3 attributes, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
slug (type metaDataProperty) Specifies that the content may have a slug to ease its identification.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
source (type interfaceSource)
Type:
Content:
complex, 7 attributes, 6 elements
Defined:
locally at 1 location
source (type interfaceSourceRest)
Type:
Content:
complex, 7 attributes, 6 elements
Defined:
locally at 1 location
source (type servicesource)
Type:
Content:
complex, 11 attributes, 14 elements
Defined:
locally at 1 location
sources (type interfaceSources) specifies one or more sources that must be used in the interface.
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
sources (type interfaceSourcesRest) specifies one or more sources that must be used in the rest interface.
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
sources (type sources)
Type:
Content:
complex, 1 element
Defined:
locally at 1 location
table (type xsd:string) Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
tag (type metaDataProperty) Specifies that the repository allows tagging contents.
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
target (within hyperLink) Specifies the target for the hyperlink parameters.
Type:
embedded complexType
Content:
empty, 2 attributes
Defined:
locally at 1 location
Includes:
definitions of 2 attributes
targetScopes (within activityStream) Specifies the scopes for which activities will be automatically generated.
Type:
embedded complexType
Content:
complex, 1 attribute, 1 element
Defined:
locally at 1 location
Includes:
definition of 1 element
url (type xsd:string) Used when the response type is doui_hyperLink.
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
value (within parameter) value of the parameter.
Type:
embedded complexType
Content:
empty, 1 attribute
Defined:
locally at 1 location
Includes:
definition of 1 attribute
value (within setControlValues)
Type:
embedded complexType
Content:
empty, 3 attributes
Defined:
locally at 1 location
Includes:
definitions of 3 attributes
versioning (type versioningMetaDataProperty)
Type:
Content:
empty, 2 attributes
Defined:
locally at 1 location
view (type xsd:string) Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes
Type:
xsd:string
Content:
simple
Defined:
locally at 1 location
workflow (type metaDataProperty)
Type:
Content:
empty, 1 attribute
Defined:
locally at 1 location
Complex Type Summary
fieldValues
Content:
complex, 2 attributes, 1 element
Includes:
definition of 1 element
Used:
filter
Content:
complex, 22 attributes, 5 elements
Includes:
definitions of 20 attributes and 5 elements
Used:
filterOperators
Content:
complex, 3 attributes, 1 element
Includes:
definition of 1 element
Used:
filters
Content:
complex, 2 attributes, 2 elements
Includes:
definitions of 2 attributes and 2 elements
Used:
hyperLink Requests the portal for a url to another page of the portal.
Content:
complex, 8 attributes, 3 elements
Includes:
definitions of 4 attributes and 3 elements
Used:
hyperLinkParameter
Content:
empty, 2 attributes
Includes:
definitions of 2 attributes
Used:
hyperLinkParameters
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
hyperLinks
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
interface
Content:
complex, 1 attribute, 5 elements
Includes:
definitions of 1 attribute and 5 elements
Used:
interfaceFields
Content:
complex, 1 attribute, 1 element
Includes:
definitions of 1 attribute and 1 element
Used:
interfaces
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
interfaceSource
Content:
complex, 7 attributes, 6 elements
Includes:
definitions of 3 attributes and 6 elements
Used:
interfaceSourceRest
Content:
complex, 7 attributes, 6 elements
Used:
interfaceSources
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
interfaceSourcesRest
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
metaData
Content:
complex, 19 elements
Includes:
definitions of 19 elements
Used:
metaDataProperty
Content:
empty, 1 attribute
Includes:
definition of 1 attribute
Used:
at 19 locations
postLoadProcessor
Content:
complex, 1 attribute, any element
Includes:
definition of 1 attribute
Used:
postLoadProcessors
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
processAction
Content:
complex, 4+any attributes, 2+any elements
Includes:
definitions of 4 attributes and 2 elements
Used:
processActions
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
relation
Content:
complex, 6 attributes, 1 element
Includes:
definitions of 4 attributes and 1 element
Used:
relations
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
renderActions
Content:
complex, any attribute, 1 element
Includes:
definition of 1 element
Used:
response
Content:
complex, 3 attributes, 5 elements
Includes:
definitions of 1 attribute and 5 elements
Used:
restInterface
Content:
complex, 1 attribute, 1 element
Includes:
definitions of 1 attribute and 1 element
Used:
restInterfaces
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
servicesource
Content:
complex, 11 attributes, 14 elements
Includes:
definitions of 8 attributes and 14 elements
Used:
sourceField
Content:
complex, 45 attributes, 4 elements
Includes:
definitions of 44 attributes and 4 elements
Used:
sourceFieldOptions
Content:
complex, 3 attributes, 1 element
Includes:
definition of 1 element
Used:
sourceFields
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
sources
Content:
complex, 1 element
Includes:
definition of 1 element
Used:
versioningMetaDataProperty
Content:
empty, 2 attributes
Includes:
definition of 1 attribute
Used:
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ $Date$ -->
<xsd:schema attributeFormDefault="unqualified" elementFormDefault="unqualified" targetNamespace="http://www.lumis.com.br/lumisportal/xsd/doui" xmlns="http://www.lumis.com.br/lumisportal/xsd/doui" xmlns:control="http://www.lumis.com.br/douicontrols" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:simpleType name="sourceType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="table"/>
<xsd:enumeration value="view"/>
<xsd:enumeration value="contentTable"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="dataType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="string"/>
<xsd:enumeration value="number"/>
<xsd:enumeration value="email">
<xsd:annotation>
<xsd:documentation>
This data type accepts e-mail as its value. Example: myname@myhost.com
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="integer"/>
<xsd:enumeration value="long">
<xsd:annotation>
<xsd:documentation>
Identifier for long integer data type. This data type accepts integer values from -2^63 to 2^63-1.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="double"/>
<xsd:enumeration value="date"/>
<xsd:enumeration value="dateTime"/>
<xsd:enumeration value="time"/>
<xsd:enumeration value="guid"/>
<xsd:enumeration value="html"/>
<xsd:enumeration value="text"/>
<xsd:enumeration value="boolean"/>
<xsd:enumeration value="file"/>
<xsd:enumeration value="files"/>
<xsd:enumeration value="media"/>
<xsd:enumeration value="document"/>
<xsd:enumeration value="lumisContentParentContent">
<xsd:annotation>
<xsd:documentation>Maps relation based on lumis content identifier.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="lumisParentContent">
<xsd:annotation>
<xsd:documentation>
Maps relation based on main table primary key identifier.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="lumisChannel"/>
<xsd:enumeration value="lumisPage"/>
<xsd:enumeration value="lumisPageTemplate"/>
<xsd:enumeration value="lumisPageOrPageTemplate"/>
<xsd:enumeration value="lumisPrincipal"/>
<xsd:enumeration value="tag">
<xsd:annotation>
<xsd:documentation>Content tag data type.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="readTypes">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="never">
<xsd:annotation>
<xsd:documentation>
Signifies that the source by default must not be loaded. Certain controls like a list control may programatically force a source to be read independent of its readType attribute.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="always">
<xsd:annotation>
<xsd:documentation>Signifies that the source must always be loaded.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="filterShowItemsType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="all">
<xsd:annotation>
<xsd:documentation>
Signifies that the drop down list must display all possible options including those that may return no rows. This is the forced behaviour when the options are explicitly specified in the filter.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="referenced">
<xsd:annotation>
<xsd:documentation>
Signifies that the drop down list must display only options that have been used and will always return rows in the source. This is not applicable when the options are explicitly specified in the filter.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="sources">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="source" type="servicesource"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="servicesource">
<xsd:sequence>
<xsd:choice maxOccurs="1" minOccurs="0">
<xsd:element minOccurs="0" name="dataProviderClassName" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Class name of the dataprovider for the source. If not specified a default data provider used based on the source type definitions registered. The framework by default has the following sourcetypes registered.
&lt;pre&gt;
&lt;source&gt;
&lt;type&gt;table&lt;/type&gt;
&lt;className&gt;lumis.doui.table.TableSource&lt;/className&gt;
&lt;dataProviderClassName&gt;lumis.doui.table.TableDataProvider&lt;/dataProviderClassName&gt;
&lt;/source&gt;

&lt;source&gt;
&lt;type&gt;contentTable&lt;/type&gt;
&lt;className&gt;lumis.content.table.ContentTableSource&lt;/className&gt;
&lt;dataProviderClassName&gt;lumis.content.table.ContentTableDataProvider&lt;/dataProviderClassName&gt;
&lt;/source&gt;

&lt;source&gt;
&lt;type&gt;search&lt;/type&gt;
&lt;className&gt;lumis.doui.search.SearchSource&lt;/className&gt;
&lt;dataProviderClassName&gt;lumis.doui.search.SearchDataProvider&lt;/dataProviderClassName&gt;
&lt;/source&gt;
&lt;/pre&gt;
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:element name="table" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="view" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dependencyType" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This is used exclusively by the ServiceInstanceDependencyDataProvider.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
<xsd:element minOccurs="0" name="connectionId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Source may require data from another data base other than the primary data base used by the portal. This connectionId identifies the connection of another database. This identifier must be the filename (e.g. conn2.xml) of the hibernate configuration file in the directory \lumisdata\config\connection
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="fields" type="sourceFields">
<xsd:annotation>
<xsd:documentation>collection of fields</xsd:documentation>
</xsd:annotation>
<xsd:unique name="uniquePositionField">
<xsd:selector xpath="field"/>
<xsd:field xpath="@isPosition"/>
</xsd:unique>
</xsd:element>
<xsd:element minOccurs="0" name="metaData" type="metaData">
<xsd:annotation>
<xsd:documentation>
If the source type is contentTable, within this node the required metaData that must be associated with the content must be specified. When the service is registered these metadata fields are converted into fields of the given source. Independent of the metadata fields specified here the following fields are always added to contentTable sources.
<xhtml:b>createdDate</xhtml:b>
,
<xhtml:b>lastModifiedDate</xhtml:b>
,
<xhtml:b>createdBy</xhtml:b>
and
<xhtml:b>lastModifiedBy</xhtml:b>
.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="bigData">
<xsd:annotation>
<xsd:documentation>Specifies custom big data configurations.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="enabled" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to enable or disable persisting the source to the big data.
By default, it is enabled only if the source has a field with isSearchable="true" or
the source has the bigData element present.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="persisterClassName" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The full class name of a lumis.doui.bigdata.ISourceBigDataPersister implementation
to be used for this source. If the source is of type contentTable then the class must implement the
lumis.content.bigdata.IContentTableSourceBigDataPersister interface.
If not specified, the default depends on the source implementation class.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="activityStream">
<xsd:annotation>
<xsd:documentation>
Specifies source activity stream default behavior.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="objectType">
<xsd:annotation>
<xsd:documentation>
Specifies properties of the activity stream object type to be used
for activities automatically generated, by default implementations, for this source.
This object type will automatically be created/deleted during service
registration/deregistration.
<xhtml:br/>
The identifier of the object type is [serviceId]#[sourceId].
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="displayName">
<xsd:annotation>
<xsd:documentation>
A localizable string for the display name of this object type.
The default value is the name of the source, or if it is not set, "STR_ACTIVITY_OBJECT_TYPE_NAME".
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="1"/>
<xsd:maxLength value="50"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="targetScopes">
<xsd:annotation>
<xsd:documentation>
Specifies the scopes for which activities will be automatically generated.
If inserted without any scopes, no activity will be automatically generated.
The default value is scope lum_objectAdmin enabled and lum_objectEndUser enabled if this source has a details interface.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="scope">
<xsd:annotation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" use="required">
<xsd:annotation>
<xsd:documentation>
Specifies scope for which activities will be automatically generated.
See lumis.portal.activitystream.Activity javadoc for LumisXP standard scopes documentation.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="lum_objectAdmin"/>
<xsd:enumeration value="lum_objectEndUser"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="enabled" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to enable or disable default activities generation for this source.
Actual activities generation depends on the source type and implementation.
By default, it is true if the source does not have a metaDataSourceId attribute set.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="relations" type="relations">
<xsd:annotation>
<xsd:documentation>
if the source is related to another source, the relation details must be specified here.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="administrationInterfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Each source may specify its administration interface. If not specified this interface is calculated by the first interface that has the isAdministration attribute set to true in the servicedefinition.xml file. This administration interface is used for example during workflow to send a link to the administration interface in an email.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="addInterfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Each source may specify its add interface. If not specified this interface is calculated by the first interface that is an instance of the
class lumis.doui.service.DouiAdministrationAddPropertyPageServiceInterface or the class lumis.content.service.ContentAdministrationAddPropertyPageServiceInterface and has the current source defined as its first source.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="editInterfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Each source may specify its edit interface. If not specified this interface is calculated by the first interface that is an instance of the
class lumis.doui.service.DouiAdministrationEditPropertyPageServiceInterface or the class lumis.content.service.ContentAdministrationEditPropertyPageServiceInterface and has the current source defined as its first source.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="detailsInterfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Each source may specify its details interface. If not specified this interface is calculated by the first interface that has the isDetails attribute set and has the current source defined as its first source.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" use="required">
<xsd:annotation>
<xsd:documentation>
Identifier of the source. Must be unique among all sources within the service.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="100"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="type" type="sourceType" use="optional">
<xsd:annotation>
<xsd:documentation>
Specifies one of the registered source types. The framework automatically registers source types "table" and "contentTable".
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="name" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Display name of the source. The value is a localizable (using service's string resources) string.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="className" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Instead of specifying a source type one may specify a class name that extends Source class.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="metaDataSourceId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
If you have two content sources that are related, each of them must be joined with the metadata table independently. To do this the metadataId must be different for each of the sources. If not specified a default value is assumed for the source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="publishAllAccessibleContents" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates if contents that are not published to the current service instance, but are accessible by the current user, should also be published. Affects the query generated for the source in publication interfaces.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="distinct" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If set to true, the DISTINCT keyword is used in the generated SQL for retrieving the data for this source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="true" name="isDetails" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If set to false the source even in a details interface is not treated as a details source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isCloneDataSupported" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates if contents that are published can be cloned.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="sourceFields">
<xsd:sequence maxOccurs="unbounded">
<xsd:element minOccurs="0" name="field" type="sourceField">
<xsd:annotation>
<xsd:documentation>
Specifies the details of the fields returned by the data provider.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="metaData">
<xsd:all>
<xsd:element minOccurs="0" name="publishToServiceInstances" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="publishToPrincipals" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="publishToSocialNetwork" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
Specifies that the content may be published to social networks.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="publishStartDate" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="publishEndDate" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="highlight" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="highlightEndDate" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="comments" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="versioning" type="versioningMetaDataProperty"/>
<xsd:element minOccurs="0" name="multiLanguage" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="workflow" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="association" type="metaDataProperty"/>
<xsd:element minOccurs="0" name="lock" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
Specifies that the content will make use of locking to avoid simultaneous editing.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="serviceInstanceIsolation" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
specifies that the content must be isolated between service instances. If a content is added in one service instance, it must not be visible in the list of contents of another instance of the same service. This property is implied if publishToServiceInstances property is specified.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="categorization" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
If specified, the content will be able to be filtered by categories and will be able to render associated categories.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="tag" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
Specifies that the repository allows tagging contents.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="seo" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
Specifies that the content provides SEO specific fields.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="slug" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>
Specifies that the content may have a slug to ease its identification.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="primaryContent" type="metaDataProperty">
<xsd:annotation>
<xsd:documentation>Specifies that the content is a Primary Content</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="versioningMetaDataProperty">
<xsd:complexContent>
<xsd:extension base="metaDataProperty">
<xsd:attribute name="maxVersions" type="xsd:integer" use="optional">
<xsd:annotation>
<xsd:documentation>
Sets the number of content versions to keep. The latest changed versions will be kept. The cleaning process never removes neither the active version nor the published version (if it exists).
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="metaDataProperty">
<xsd:attribute name="id" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
if specified the field that this metadata property is converted to inheirts this identifier. The following are the default field Ids if not specified: createdDate, lastModifiedDate, createdBy, lastModifiedBy, publishStartDate, publishEndDate, highlight, highlightEndDate, serviceInstanceId, comments, publishToServiceInstances, publishToPrincipals, language, languageContentId, versionActive, versionNumber, versionContentId, workflowState, workflowAssignedTo, association
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="sourceField">
<xsd:sequence maxOccurs="1">
<xsd:element minOccurs="0" name="defaultValue" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The default value for this field. The attribute defaultValue has priority over this element value.
The way to specify the value depends on its dataType. Below are some example for common dataTypes present in the LumisXP:
<ul>
<li>
For dateTime, date and time use XML Schema 1.1 format. Examples: "2000-01-05T13:05:32", "2000-01-05", "13:05:32".
</li>
<li>
For integer and long: do not use grouping separator.
</li>
<li>
For double: do not use grouping separator, and use '.' as decimal separator if necessary.
</li>
</ul>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="options" type="sourceFieldOptions">
<xsd:annotation>
<xsd:documentation>
Possible values of the field may be explicitly specified here.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="defaultInputControl">
<xsd:annotation>
<xsd:documentation>
Overrides the default input control to be used for this field. Inside this node insert the control's definition node.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:group ref="control:lum_anyControl"/>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="bigData">
<xsd:annotation>
<xsd:documentation>
Allows configuration about how the field is stored in portal big data repostory.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="enabled" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Attributes defines whether this field will be included in the big data for this source.
Default value is true if the field does not have externalData="true" or getData="false".
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" use="required">
<xsd:annotation>
<xsd:documentation>
Identifier for the field. This must be unique among all fields of this source.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="100"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute default="string" name="dataType" type="dataType" use="optional">
<xsd:annotation>
<xsd:documentation>
Data type of the field. If not specified, the data type is assumed to be string.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="name" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Display name of the field. This attribute will be used for the field label in forms as well as for the column name in tabular lists.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isPrimaryKey" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Identifies this row uniquely among all rows of the source. Only one field may have this attribute set to true.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isIntroduction" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the field represents an introduction to the current row data. This is generally used in lists and search results to show an introduction to the details of the content.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isKeywords" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the field represents keywords to the current row data. This is used to set meta-tags of the page rendering the content.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isIntroductionImage" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the field is of type image and the field represents an image of the introduction to the current row data.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="isSearchable" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true if the value of the field is to be indexed as part of the big data that is searched when using a simple search (search without specifying on which fields).
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isPrimaryName" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the field represents a name of the current row data. This is generally used in lists and search results to show the name of the content.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isPublishStartDate" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the field represents the start of the publish period of the data. This is generally used in lists and search results to show the publish date-time of the data. A content publishStartDate metadata field automatically has this property set.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isParentId" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Set to true when the content is hierarchical. This field represents the identifier of the parent row of the current row.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isDetail" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Identifies this field as a detail field. A source can have only one detail field. The detail field is displayed in a custom way in a standard detail interface using the standard style.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isDetailMedia" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Identifies this field as a detail media field. A source can have only one detail media field. The detail media field is displayed in a custom way in a standard detail interface using the standard style.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="display" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If set to true, this field will be displayed either in a column in list views or in the form when adding or editing data.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="lookupRelationId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Represents the identifier of the relation that this field has. The relations to a source are specified within a sibling
<xhtml:b>relations</xhtml:b>
node to the
<xhtml:b>fields</xhtml:b>
node.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="lookupFieldId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Represents the identifier of the field in the foreign source that should be returned as the value of the current field when doing a lookup.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="doLookup" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Applicable when
<xhtml:b>lookupRelationId</xhtml:b>
and
<xhtml:b>lookupFieldId</xhtml:b>
are specified. This attribute must be set to true for the lookup to take place.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="doOptionLookup" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Applicable when options are specified withing the field. The value that is set for the field is the option display string that corresponds to the actual field value.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="required" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Used primarily in forms for adding or updating row data. This attribute is generally read by the control rendering data and automatically places a required validator on the control value.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="minLength" type="xsd:integer" use="optional">
<xsd:annotation>
<xsd:documentation>
Used generally for data types of type string, text or html. Forces a minimum length for the field value. Controls automatically add minLength validators for client side validation.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="maxLength" type="xsd:integer" use="optional">
<xsd:annotation>
<xsd:documentation>
Used generally for data types of type string, text or html. Forces a maximum length for the field value. Controls automatically add maxLength validators for client side validation.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="minSize" type="xsd:integer" use="optional">
<xsd:annotation>
<xsd:documentation>
Used for file data types. Defines the minimum size accepted for uploaded files.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="maxSize" type="xsd:integer" use="optional">
<xsd:annotation>
<xsd:documentation>
Used for file data types. Defines the maximum size accepted for uploaded files.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="localize" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Used for string, text and html data types. If set to true the framework will try and localize the field value to the user's locale.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="localizeResourceColumn" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
When localizing the default resource that the framework uses is the resource specified in the service definition. However, if the default resource to localize data is specified as a column that column is used as the resource for localizing.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isSortable" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute is used to indicate whether the field may be used to sort a query in its source. If there are some fields that you do not want the end user to be able to sort, set this attribute to false. The default value for this attribute is false for external fields or data types based on text query data types, and true elsewhere.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isPriority" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this attribute is set to true, and no options are specified in the field, options of 1-5 are automatically set on the field upon registering the service.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isPosition" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates if this field is a special position field, used for specifying the order
that data will be displayed. If this attribute is set to true, by default administration list interfaces
display a order button that allows the user to specify the order of existing data, updating the value
of this field.
<xhtml:p>
The button used to open the order interface automatically included by default administration list interfaces
is the
<em>lum_positionFieldOrderButton</em>
. When overriding the buttons present at a interface,
this control may be used to include the access to this feature.
</xhtml:p>
<xhtml:p>
Optionally this field may also contain the attribute
<em>positionGroupedBy</em>
specifying the identifier
of fields the ordering is grouped by. The
<em>lum_positionFieldOrderButton</em>
by default uses the value
of the bound source parameter with name equals to the field identifiers in
<em>positionGroupedBy</em>
attribute value
and sends it as parameter to the order interface for using it to filter the data it will display.
</xhtml:p>
<xhtml:p>
When a position field exists in a source, the default data ordering it uses is the
the
<em>positionGroupedBy</em>
fields (if specified and present), followed by the position field.
</xhtml:p>
<xhtml:p>
The use of this position feature has the following limitations:
</xhtml:p>
<ul>
<li>
There must not be too many data to be ordered, since all of them will be shown at the same
time to the user. This feature is not designed for being used in scenarios where the number of data to be
ordered would turn a single drag-and-drop screen unfriendly.
</li>
<li>
The source must be a
<em>table</em>
or
<em>contentTable</em>
source. It is possible that some
customization on the source will be incompatible with this feature.
</li>
<li>
The source must have a primary key and a primary name field.
</li>
<li>
The source's data provider, if customized, must not depend on DouiContext and must be able to
filter by the fields specified in
<em>positionGroupedBy</em>
attribute (if set) if a parameter with name
of those fields identifiers are present on the source during
<em>loadData</em>
.
</li>
<li>
On the order interface, for content, all active versions will be shown, ignoring any workflow or
scheduled publication. Note that workflow permissions will also be ignored.
</li>
<li>
When applying the ordering, this field value will be updated. For content, all versions will have
the value of this field updated, including older versions. Other fields will not be updated by the
ordering operation, such as
<em>last modified time</em>
or
<em>last modified by</em>
.
</li>
<li>
To access the order interface, the user must have edit content permission on the corresponding
service instance.
</li>
</ul>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="true"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="positionGroupedBy" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
List of fields identifiers, separated by comma, of the fields that the
position feature will use for grouping data to be ordered. This attribute is optional and used only if
this field has
<em>isPosition="true"</em>
.
For more information about the position feature, see documentation for the isPosition attribute.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="groupBy" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this attribute is set to true, the field will be included on the group by SQL clause.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="includeAlways" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this attribute is set to true, all interfaces will always have this field available independent of what fields were placed in their source definition.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="defaultValue" type="control:controlDefaultValueType" use="optional">
<xsd:annotation>
<xsd:documentation>
The default value for this field.
The way to specify the value depends on its dataType. Below are some example for common dataTypes present in the LumisXP:
<ul>
<li>
For dateTime, date and time use XML Schema 1.1 format. Examples: "2000-01-05T13:05:32", "2000-01-05", "13:05:32".
</li>
<li>
For integer and long: do not use grouping separator.
</li>
<li>
For double: do not use grouping separator, and use '.' as decimal separator if necessary.
</li>
</ul>
The following special default values are converted during execution to the value they represent:
lum_currentChannel, lum_currentPage, lum_currentServiceInstanceId, lum_currentServiceInstanceChannelId, lum_currentUser, lum_currentUserLocale, lum_currentUserName, lum_callerInterfaceInstanceId, lum_callerInterfaceId, lum_currentDateTime, lum_currentMonth, lum_currentYear, lum_newGuid.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="requiredWhenVisible" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Setting this attribute to true automatically places a required when visible validator when rendering forms for add or update of the content. The validator detects if the control is visible to the end user and performs required value validation only if visible.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="columnName" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
If the identifier of the field is not the same as the column name of the table that it represents, this attribute must be filled with the correct column name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="externalData" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If the field does not represent data from the source table, this attribute must be set to true. Usually a post load processor fills in the field value after the source is loaded.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="true" name="getData" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If you do not want to display the field, you may set the display attribute to false. However this causes that the xml data not contain the field value. If you want the value of the field in the xml, set this attribute to true.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isRowNumber" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute is used when returning data that represents multiple rows. The field that represents the row number has this attribute set to true.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="pattern" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
If specified this attribute will cause the input control for the field place a Pattern Validator on the field. The pattern to be applied must be specified as the attribute value.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="minimumValue" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The minimum value for this field. Refer to field defaultValue attribute for more information about specifying values.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="maximumValue" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The maximum value for this field. Refer to field defaultValue attribute for more information about specifying values.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="readOnly" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates if the field is read-only and should not be rendered editable. The default is false. If this attribute is set to true the add and edit process actions should ignore this field.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="className" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates the ISourceField implementation to be used for this field. Must be a full qualified class name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="isMetaInformation" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates that this field contains some kind of meta information about the content. This attribute has no functional effect, being only a hint for generic visual implementations. The standard LumisXP visual implementation uses this hint to render such fields in a specific style.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="isTag" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>Indicates that this field is a content tag field.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="sourceFieldOptions">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="option">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="value" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
value of the option. Must be compatible with the field data type.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute fixed="1" name="selected" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Specifies if the option by default must be selected when adding data.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="insertLocation" type="optionInsertLocation" use="optional">
<xsd:annotation>
<xsd:documentation>
Specified to choose where static options should be included. It can be before or after the dynamic options. This information has it relevance in the control.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="optionInsertLocation">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="before"/>
<xsd:enumeration value="after"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="interfaceFields">
<xsd:sequence maxOccurs="unbounded">
<xsd:element minOccurs="0" name="field" type="sourceField">
<xsd:annotation>
<xsd:documentation>
properties of the field specified here will override the properties specified in the global source definition.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="inherit" type="inheritFieldsType" use="optional">
<xsd:annotation>
<xsd:documentation>
If not specified, none of the fields are inherited from the source.
<xhtml:p>
If "all" is specified, all fields from the global source definition are copied during runtime to the scope of the interface definition.
</xhtml:p>
<xhtml:p>
If "default" is specified, the same fields that would be copied if no "fields" element were present, will be copied. This varies according to the interface type.
</xhtml:p>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:simpleType name="inheritFieldsType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="all">
<xsd:annotation>
<xsd:documentation>
Selecting 'all' will make that all the fields from the global source definition to be copied here.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="default">
<xsd:annotation>
<xsd:documentation>
Selecting 'default' will cause some fields to be automatically added, according to the interface type. It follows the same rules as when the &lt;fields&gt; element is not specified.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="relations">
<xsd:sequence maxOccurs="unbounded">
<xsd:element minOccurs="0" name="relation" type="relation">
<xsd:annotation>
<xsd:documentation>
specifies a relation between the current source and another source in the doui definition.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="joinType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="inner"/>
<xsd:enumeration value="outer"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="relation">
<xsd:sequence>
<xsd:element name="relationField">
<xsd:annotation>
<xsd:documentation>
specifies the fields between the curent source and the foreign source that are related.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="fieldId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>identifier of the field in the current source.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="foreignFieldId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
identifier of the field in the foreign source that the relation specifies
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
identifier of the relation. This is the relation id that is referenced in the source field definition.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="foreignSourceId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
identifier of the foreign source that this relation maps to. If the foreign source Id is not specified, a foreign source id equal to the relation id is assumed.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="outer" name="foreignSourceJoinType" type="joinType" use="optional">
<xsd:annotation>
<xsd:documentation>
By default the foreign sources are joined by an outer join. However this may be modified via this attribute to be either an inner or outer join.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="cascadeOnDelete" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Specifies if the deletion should be cascaded through this relation and cause a deletion on the foreign source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="processActions">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="processAction" type="processAction"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="processAction">
<xsd:sequence minOccurs="0">
<xsd:any maxOccurs="unbounded" processContents="skip"/>
<xsd:element maxOccurs="1" minOccurs="0" name="fieldValues" type="fieldValues">
<xsd:annotation>
<xsd:documentation>
Allows customization of the parameters that will be available to this process action (through the standard ProcessActionHandler.getParameter method).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="response" type="response"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>Identifier of the process action.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="actionId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Action identifier of the process action. If not specified the id attribute is assumed. This is the value that is used by controls like buttons to indicate the process action handlers to execute.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="type" type="processActionType" use="optional">
<xsd:annotation>
<xsd:documentation>
This may be one of the standard processActionTypes provided by the framework.
<ul>
<li>
generic: does not perform any action. May be used to simply execute a specific response.
</li>
<li>
contentTableDeleteData: Deletes one or more contents
</li>
<li>contentTableAddData: Adds a single content</li>
<li>contentTableUpdateData: Updates a single content</li>
<li>
contentTableAddFileMultiRowData: Adds multiple contents
</li>
<li>
tableDeleteData: Deletes one or more data rows from a table
</li>
<li>tableAddData: Adds a data row to a table</li>
<li>tableUpdateData: Updates a data row in a table</li>
<li>
tableAddMultiRowData: Adds multiple data rows in a table. Used by a data grid control for instance.
</li>
<li>
tableAddFileMultiRowData: Adds multiple files data rows in a table. Used by MultiFileUpload control
</li>
<li>
tableUpdateMultiRowData: Updates and or deletes multiple data rows in a table. Used by a data grid control for instance.
</li>
<li>
commitAndPreview: Executes the
<xhtml:i>commit</xhtml:i>
process actions and opens a preview of the content in a popup window. The identifier of the process actions to be executed may be configured by specifying it in a
<xhtml:i>commitProcessActionId</xhtml:i>
element inside
<xhtml:i>processAction</xhtml:i>
.
</li>
<li>
lumCloneData: Adds a copy of the current selected content discarding metadata except locale, keeping content language.
</li>
</ul>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="className" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates the IProcessActionHandler implementation to execute this action.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:anyAttribute processContents="skip"/>
</xsd:complexType>
<xsd:simpleType name="processActionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="generic"/>
<xsd:enumeration value="contentTableDeleteData"/>
<xsd:enumeration value="contentTableAddData"/>
<xsd:enumeration value="contentTableUpdateData"/>
<xsd:enumeration value="contentTableAddFileMultiRowData"/>
<xsd:enumeration value="tableDeleteData"/>
<xsd:enumeration value="tableAddData"/>
<xsd:enumeration value="tableAddMultiRowData"/>
<xsd:enumeration value="tableUpdateData"/>
<xsd:enumeration value="tableAddFileMultiRowData"/>
<xsd:enumeration value="tableUpdateMultiRowData"/>
<xsd:enumeration value="commitAndPreview"/>
<xsd:enumeration value="lumCloneData"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="fieldValues">
<xsd:sequence maxOccurs="1" minOccurs="0">
<xsd:element maxOccurs="unbounded" minOccurs="1" name="fieldValue">
<xsd:annotation>
<xsd:documentation>
Allows customization of one parameter that will be available to this process action.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Parameter identifier.
<xhtml:br/>
If the id is filled with the especial value "PAGE_PARAMETER_ITEMID" the parameter will be the itemId from the content recently added.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="default" name="type" type="fieldValueType" use="optional">
<xsd:annotation>
<xsd:documentation>
This may be one of the standard types provided by the framework.
<ul>
<li>
default: Gets the parameter value from the text of this fieldValue element.
</li>
<li>
parameter: Gets the parameter value from the process action parameter with name equals to
the text of this fieldValue element if specified, otherwise equals to the fieldValue id attribute.
</li>
<li>
attribute: Gets the parameter from the request attribute with name equals to
the text of this fieldValue element if specified, otherwise equals to the fieldValue id attribute.
</li>
</ul>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="fieldValueType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="default"/>
<xsd:enumeration value="parameter"/>
<xsd:enumeration value="attribute"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="response">
<xsd:sequence maxOccurs="1" minOccurs="0">
<xsd:element minOccurs="0" name="script" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Must be specified if the type of the response is doui_runJavascript.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Identifies the interface id (id may be relative to the current service) of the destination interface that the user must be taken to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="destPageId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_popupInterface. Identifies the pageId that the popup will be opened in. If specified this value usually is LumisBlankPage.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="url" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the response type is doui_hyperLink. Specifies the url that the user must be redirected to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="parameters">
<xsd:complexType>
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element maxOccurs="unbounded" minOccurs="0" name="parameter">
<xsd:annotation>
<xsd:documentation>
Used when the response type is
<xhtml:b>doui_setResponseParameters</xhtml:b>
or
<xhtml:b>doui_hyperLink</xhtml:b>
. Each parameter node represents a response parameter name/value pair. If no value node is specified, the text value of this node is used as the parameter value.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value">
<xsd:annotation>
<xsd:documentation>
value of the parameter. If not specified the text value of the parameter node is used.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="type">
<xsd:annotation>
<xsd:documentation>
If not specified, the value is considered the text value of the value node.
<xhtml:br/>
If specified, the possible values are
<xhtml:br/>
<xhtml:br/>
<xhtml:b>parameterValue</xhtml:b>
: the value is taken from the request parameters passed to the process action. The text value of the value node represents the parameter name.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>attributeValue</xhtml:b>
: the value is taken from the current request attributes. The text value of the value node represents the attribute name.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="parameterValue"/>
<xsd:enumeration value="attributeValue"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>name of the parameter</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="type" type="responseType" use="required">
<xsd:annotation>
<xsd:documentation>
Possible response types.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_closeWindow</xhtml:b>
: Closes the current window.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_hyperLink</xhtml:b>
: Used to redirect the browser to another page / url after the process action. In addition parameters may be passed to the destination page.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_message</xhtml:b>
: Displays a message to the end user. This type requires a
<xhtml:b>message</xhtml:b>
attribute to be specified. This message will be translated to the users current language.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_popupInterface</xhtml:b>
: Used to popup an interface after the process action. In addition parameters may be passed to the popped up interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_preview</xhtml:b>
: Displays another window with the preview of the data being edited.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_refreshParent</xhtml:b>
: Refreshes the parent window.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_runJavascript</xhtml:b>
: Runs the javascript specified in the
<xhtml:b>script</xhtml:b>
node within the reponse.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setRequestAttributes</xhtml:b>
: Used primarily to share data between different process actions. Sets parameter values in the request attributes. These attributes may be read by subsequent process actions with the same id.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setRequestParameters</xhtml:b>
: Sets all the current parameters values to the following render request to the current interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_setResponseParameters</xhtml:b>
: Sets the specified parameters to the following render request to the current interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardCommit</xhtml:b>
: Used in standard add and edit administration interfaces. This response detects whether the current interface is a popup or an embedded interface. If popup, this response is equivalent to a doui_refreshParent response followed by a doui_closeWindow response. If embedded, this response detects where the administration list interface is located and redirects the portal to the page that contains that interface.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardEmbedded</xhtml:b>
: Used in interfaces that are embedded within portal pages. This is equivalent to a doui_setRequestParameters response.
<xhtml:br/>
<xhtml:br/>
<xhtml:b>doui_standardPopup</xhtml:b>
: Used interfaces that are within popup windows. This internally is converted to two responses. One doui_refreshParent response followed by one doui_closeWindow response.
<xhtml:br/>
<xhtml:br/>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="message" type="xsd:string"/>
</xsd:complexType>
<xsd:simpleType name="responseType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="doui_closeWindow"/>
<xsd:enumeration value="doui_hyperLink"/>
<xsd:enumeration value="doui_message"/>
<xsd:enumeration value="doui_popupInterface"/>
<xsd:enumeration value="doui_preview"/>
<xsd:enumeration value="doui_refreshParent"/>
<xsd:enumeration value="doui_runJavascript"/>
<xsd:enumeration value="doui_setRequestAttributes"/>
<xsd:enumeration value="doui_setRequestParameters"/>
<xsd:enumeration value="doui_setResponseParameters"/>
<xsd:enumeration value="doui_standardCommit"/>
<xsd:enumeration value="doui_standardEmbedded"/>
<xsd:enumeration value="doui_standardPopup"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="renderActions">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="renderAction">
<xsd:complexType>
<xsd:sequence minOccurs="0">
<xsd:any maxOccurs="unbounded" processContents="skip"/>
</xsd:sequence>
<xsd:anyAttribute processContents="skip"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="interfaceSources">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="source" type="interfaceSource"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="interfaceSource">
<xsd:sequence minOccurs="0">
<xsd:element minOccurs="0" name="fields" type="interfaceFields"/>
<xsd:element minOccurs="0" name="filters" type="filters"/>
<xsd:element minOccurs="0" name="orderBy">
<xsd:complexType>
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="field">
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="required"/>
<xsd:attribute name="direction" type="orderByDirection" use="required"/>
<xsd:attribute name="applyAlways" use="optional">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="before"/>
<xsd:enumeration value="after"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="enabled" type="xsd:boolean" use="optional"/>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="maxRows"/>
<xsd:element default="500" minOccurs="0" name="maxNumberOfRowsAllowed" type="xsd:integer">
<xsd:annotation>
<xsd:documentation>
Define the maximum number of records that will be permitted when doui_maxRows is passed in a as source parameter.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="postLoadProcessors" type="postLoadProcessors"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required"/>
<xsd:attribute name="readData" type="readTypes" use="optional"/>
<xsd:attribute default="false" name="distinct" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If set to true, the DISTINCT keyword is used in the generated SQL for retrieving the data for this source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="true" name="isDetails" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If set to false the source even in a details interface is not treated as a details source.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="interfaceSourcesRest">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="source" type="interfaceSourceRest"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="interfaceSourceRest">
<xsd:complexContent>
<xsd:extension base="interfaceSource">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="postLoadProcessors">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="postLoadProcessor" type="postLoadProcessor"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="postLoadProcessor">
<xsd:sequence>
<xsd:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/>
</xsd:sequence>
<xsd:attribute name="className" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
class name of the postLoadProcessor. This class must implement the IPostLoadProcessor interface.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:simpleType name="orderByDirection">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ascending"/>
<xsd:enumeration value="descending"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="filters">
<xsd:choice maxOccurs="unbounded">
<xsd:element minOccurs="0" name="filter" type="filter"/>
<xsd:element minOccurs="0" name="filters" type="filters"/>
</xsd:choice>
<xsd:attribute name="className" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The full class name of the class that will be used for this filter. Depending on the source type, the class must implement a specific interface that extends ISourceFilter. For example, TableSource requires that its filters implement lumis.doui.source.table.filter.ITableSourceFilter.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="concatenationType" type="filtersConcatenationType"/>
</xsd:complexType>
<xsd:simpleType name="filtersConcatenationType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="and"/>
<xsd:enumeration value="or"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="filter">
<xsd:sequence>
<xsd:element minOccurs="0" name="operators" type="filterOperators"/>
<xsd:element minOccurs="0" name="maxRows" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
The maxRows element contains the maximum number of elements that may be inserted into the filter. This is aplicable only when the filter has the showItems attribute specified. If not specified, the default value is 999.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="inputControlClientEvents">
<xsd:annotation>
<xsd:documentation>
Any client side events may be placed here. They will be passed on to the input contorl for the filter.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence minOccurs="0">
<xsd:any maxOccurs="unbounded" processContents="skip"/>
</xsd:sequence>
<!-- xsd:sequence>
<xsd:element name="onClick" minOccurs="0" type="lum_base:onClientEvent"/>
<xsd:element name="onChange" minOccurs="0" maxOccurs="unbounded" type="lum_base:onClientEvent"/>
<xsd:element name="onKeyUp" minOccurs="0" maxOccurs="unbounded" type="lum_base:onClientEvent"/>
<xsd:element name="onKeyDown" minOccurs="0" maxOccurs="unbounded" type="lum_base:onClientEvent"/>
</xsd:sequence
-->
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="selectFields">
<xsd:annotation>
<xsd:documentation>
If the selectField attribute is set to true, this element must contain the list of fields to be included in the drop down list.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence minOccurs="0">
<xsd:element maxOccurs="unbounded" minOccurs="1" name="field">
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="required"/>
<xsd:attribute name="name" type="xsd:string" use="optional"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="defaultInputControl">
<xsd:annotation>
<xsd:documentation>
Overrides the default input control to be used for this filter. Inside this node insert the control's definition node.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:group ref="control:lum_anyControl"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required"/>
<xsd:attribute name="className" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The full class name of the class that will be used for this filter. Depending on the source type, the class must implement a specific interface that extends ISourceFilter. For example, TableSource requires that its filters implement lumis.doui.source.table.filter.ITableSourceFilter.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute fixed="true" name="hidden" type="xsd:boolean" use="optional"/>
<xsd:attribute fixed="true" name="required" type="xsd:boolean" use="optional"/>
<xsd:attribute name="fieldId" type="xsd:string" use="optional"/>
<xsd:attribute name="value" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Refer to field defaultValue attribute for more information about specifying values.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="type" type="xsd:string" use="optional"/>
<xsd:attribute name="defaultValue" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Refer to field defaultValue attribute for more information about specifying values.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="operator" type="filterOperatorValues" use="optional"/>
<xsd:attribute name="name" type="xsd:string" use="optional"/>
<xsd:attribute name="requestParameterName" type="xsd:string" use="optional"/>
<xsd:attribute name="showItems" type="filterShowItemsType" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates that the possible filter values
should be shown for the user to select the filter value
from this list.
The 'referenced' value will not work for fields with a
fixed explicit options list; use 'all' instead in this case.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="dependentOnFilter" type="xsd:string" use="optional"/>
<xsd:attribute fixed="true" name="nullIfNotSpecified" type="xsd:boolean" use="optional"/>
<xsd:attribute name="valueInLookup" type="xsd:boolean" use="optional"/>
<xsd:attribute name="orNull" type="xsd:boolean" use="optional"/>
<xsd:attribute name="renderBlankOption" type="xsd:boolean" use="optional"/>
<xsd:attribute name="doLookup" type="xsd:boolean" use="optional"/>
<xsd:attribute name="inputControlType" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to override the default input control type calculated for the filter
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="dataType" type="dataType" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to override the default data type type calculated for the filter
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="pattern" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to override the default pattern / mask used for the filter
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="selectField" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Used to allow the end user to select one of many fields to filter within a drop down list
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="filterOperators">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="operator">
<xsd:complexType>
<xsd:attribute name="name" type="xsd:string" use="required"/>
<xsd:attribute name="value" type="filterOperatorValues" use="required">
<xsd:annotation>
<xsd:documentation>
Specifies the operator type. The 'like' operator by default sets UPPER on the data before performing the sql LIKE operation. the 'likeCaseSensitive' operator however, does not set the data to UPPER before performing the sql LIKE operation.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="isDefault" type="xsd:boolean" use="optional"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="filterOperatorValues">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="equal"/>
<xsd:enumeration value="notEqual"/>
<xsd:enumeration value="greaterThan"/>
<xsd:enumeration value="greaterThanOrEqual"/>
<xsd:enumeration value="lessThan"/>
<xsd:enumeration value="lessThanOrEqual"/>
<xsd:enumeration value="like"/>
<xsd:enumeration value="likeCaseSensitive"/>
<xsd:enumeration value="in"/>
<xsd:enumeration value="isNull"/>
<xsd:enumeration value="isNotNull"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="interface">
<xsd:sequence>
<xsd:element minOccurs="0" name="sources" type="interfaceSources">
<xsd:annotation>
<xsd:documentation>
specifies one or more sources that must be used in the interface. If a source has a relation that is being used in this interface, the source implied by the relation must be included in the list of interface sources as well.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="hyperLinks" type="hyperLinks">
<xsd:annotation>
<xsd:documentation>
specifies one or more hyperlinks that may be used in the interface. Hyperlinks are used to redirect users to other pages in the portal passing parameters via a query string.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="controls" type="control:lum_controls">
<xsd:annotation>
<xsd:documentation>
The layout of an interface is determined by a collection of controls specified here.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="processActions" type="processActions">
<xsd:annotation>
<xsd:documentation>
When the user interacts with an interface to make changes to the state of the application/service, one or more process actions are called that must be specified here.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="renderActions" type="renderActions">
<xsd:annotation>
<xsd:documentation>
When the user interacts with an interface that do not make permanent changes to the application/service state render actions may be called.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
Identifier of the interface. This must be a registered identifier specified in the servicedefinition.xml file.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="interfaces">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="interface" type="interface">
<xsd:annotation>
<xsd:documentation>
Details of an interface are specified here. This includes sources, hyperLinks, controls, processActions and renderActions
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="restInterface">
<xsd:sequence>
<xsd:element minOccurs="0" name="sources" type="interfaceSourcesRest">
<xsd:annotation>
<xsd:documentation>
specifies one or more sources that must be used in the rest interface. If a source has a relation that is being used in this rest interface, the source implied by the relation must be included in the list of interface sources as well.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>Identifier of the Rest interface.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:complexType name="restInterfaces">
<xsd:sequence maxOccurs="unbounded">
<xsd:element name="restInterface" type="restInterface">
<xsd:annotation>
<xsd:documentation>
Details of an rest interface are specified here. This includes only sources.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="hyperLinks">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="hyperLink" type="hyperLink">
<xsd:annotation>
<xsd:documentation>
Requests the portal for a url to another page of the portal.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="hyperLink">
<xsd:annotation>
<xsd:documentation>
Requests the portal for a url to another page of the portal.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element minOccurs="0" name="target">
<xsd:annotation>
<xsd:documentation>
Specifies the target for the hyperlink parameters. Only interfaces corresponding to this target definition will receive the parameters.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="type" use="required">
<xsd:annotation>
<xsd:documentation>
Specifies the type of theh target for the hyperlink parameters. Possible options are:
<ul>
<li>
interface: only interface instances of the specified interface.
</li>
<li>
interfaceInstance: only the specified interface instance.
</li>
<li>
serviceInstance: only interfaces of the specified service instance.
</li>
<li>
service: only interfaces of the specified service.
</li>
<li>page: all interfaces on the destination page.</li>
</ul>
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="interface"/>
<xsd:enumeration value="interfaceInstance"/>
<xsd:enumeration value="serviceInstance"/>
<xsd:enumeration value="service"/>
<xsd:enumeration value="page"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="id" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Depending on the type attribute, this value is either an interfaceId, interfaceInstanceId, serviceInstanceId or serviceId. If not specified, this value may be calculated automatically based on the current interface instance.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="parameters" type="hyperLinkParameters"/>
<xsd:element minOccurs="0" name="onClick">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="setControlValues">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="value">
<xsd:complexType>
<xsd:attribute default="fieldValue" name="type" type="xsd:string"/>
<xsd:attribute name="fieldId" type="xsd:string"/>
<xsd:attribute name="controlId" type="xsd:string"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute default="renderAction" name="type" type="xsd:string"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Interface Id may be relative (without a dot) or absolute (serviceId.interfaceId). This id is used to calculate the destination page of the hyperlink
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="sourceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Identifier of the source where this hyperlink applies. If not specified, the default source is used.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="target" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Specifies the window target identifier for this hyperlink. The html link will use this target value as its target. If not specified, the target will be the current window, except if popup attribute is true.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="popup" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Specifies if the hyperlink destination should be opened in another window.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="fieldId" type="xsd:string" use="optional"/>
</xsd:complexType>
<xsd:complexType name="hyperLinkParameters">
<xsd:sequence maxOccurs="unbounded" minOccurs="0">
<xsd:element name="parameter" type="hyperLinkParameter"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="hyperLinkParameter">
<xsd:attribute name="name" type="xsd:string" use="required"/>
<xsd:attribute name="dataId" type="xsd:string" use="optional"/>
</xsd:complexType>
<xsd:element name="douiDefinition">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="service">
<xsd:complexType>
<xsd:sequence>
<xsd:element minOccurs="0" name="sources" type="sources"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string"/>
<xsd:attribute name="usesPublicFileStorage" type="xsd:boolean" use="optional"/>
</xsd:complexType>
</xsd:element>
<xsd:element minOccurs="0" name="restInterfaces" type="restInterfaces"/>
<xsd:element minOccurs="0" name="interfaces" type="interfaces"/>
</xsd:sequence>
<xsd:attribute default="false" name="isElIgnored" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this attribute is set to true, EL expressions in this douidefinition will not be evaluated.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
</xsd:schema>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2
DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!
Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!
Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com

Lumisportal  17.0.1.241031 - Copyright © 2006–2024 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.