All Element Summary | ||||||||||
activityStream (within source) | Specifies source activity stream default behavior. | |||||||||
addInterfaceId (type xsd:string) | Each source may specify its add interface.
|
|||||||||
administrationInterfaceId (type xsd:string) | Each source may specify its administration interface.
|
|||||||||
association (type metaDataProperty) |
|
|||||||||
bigData (within field) | Allows configuration about how the field is stored in portal big data repostory. | |||||||||
bigData (within source) | Specifies custom big data configurations.
|
|||||||||
categorization (type metaDataProperty) | If specified, the content will be able to be filtered by categories and will be able to render associated categories.
|
|||||||||
comments (type metaDataProperty) |
|
|||||||||
connectionId (type xsd:string) | Source may require data from another data base other than the primary data base used by the portal.
|
|||||||||
controls (type control:lum_controls) | The layout of an interface is determined by a collection of controls specified here.
|
|||||||||
dataProviderClassName (type xsd:string) | Class name of the dataprovider for the source.
|
|||||||||
defaultInputControl (within field) | Overrides the default input control to be used for this field.
|
|||||||||
defaultInputControl (within filter) | Overrides the default input control to be used for this filter.
|
|||||||||
defaultValue (type xsd:string) | The default value for this field.
|
|||||||||
dependencyType (type xsd:string) | This is used exclusively by the ServiceInstanceDependencyDataProvider.
|
|||||||||
destPageId (type xsd:string) | Used when the response type is doui_popupInterface.
|
|||||||||
detailsInterfaceId (type xsd:string) | Each source may specify its details interface.
|
|||||||||
displayName (within objectType) | A localizable string for the display name of this object type. | |||||||||
douiDefinition |
|
|||||||||
editInterfaceId (type xsd:string) | Each source may specify its edit interface.
|
|||||||||
field (type sourceField) | Specifies the details of the fields returned by the data provider.
|
|||||||||
field (within orderBy) |
|
|||||||||
field (within selectFields) |
|
|||||||||
fieldValue (within fieldValues) | Allows customization of one parameter that will be available to this process action.
|
|||||||||
fieldValues (type fieldValues) | Allows customization of the parameters that will be available to this process action (through the standard ProcessActionHandler.getParameter method).
|
|||||||||
fields (type interfaceFields) |
|
|||||||||
fields (type sourceFields) | collection of fields
|
|||||||||
filter (type filter) |
|
|||||||||
filters (type filters) |
|
|||||||||
highlight (type metaDataProperty) |
|
|||||||||
highlightEndDate (type metaDataProperty) |
|
|||||||||
hyperLink (type hyperLink) | Requests the portal for a url to another page of the portal. | |||||||||
hyperLinks (type hyperLinks) | specifies one or more hyperlinks that may be used in the interface.
|
|||||||||
inputControlClientEvents (within filter) | Any client side events may be placed here.
|
|||||||||
interface (type interface) | Details of an interface are specified here. | |||||||||
interfaceId (type xsd:string) | Used when the response type is doui_hyperLink.
|
|||||||||
interfaces (type interfaces) |
|
|||||||||
lock (type metaDataProperty) | Specifies that the content will make use of locking to avoid simultaneous editing.
|
|||||||||
maxNumberOfRowsAllowed (type xsd:integer) | Define the maximum number of records that will be permitted when doui_maxRows is passed in a as source parameter.
|
|||||||||
maxRows (type anyType) |
|
|||||||||
maxRows (type xsd:string) | The maxRows element contains the maximum number of elements that may be inserted into the filter.
|
|||||||||
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. | |||||||||
multiLanguage (type metaDataProperty) |
|
|||||||||
objectType (within activityStream) | Specifies properties of the activity stream object type to be used for activities automatically generated, by default implementations, for this source. | |||||||||
onClick (within hyperLink) |
|
|||||||||
operator (within operators) |
|
|||||||||
operators (type filterOperators) |
|
|||||||||
option (within options) |
|
|||||||||
options (type sourceFieldOptions) | Possible values of the field may be explicitly specified here.
|
|||||||||
orderBy (type embedded) |
|
|||||||||
parameter (type hyperLinkParameter) |
|
|||||||||
parameter (within parameters) | Used when the response type is doui_setResponseParameters or doui_hyperLink. | |||||||||
parameters (type hyperLinkParameters) |
|
|||||||||
parameters (within response) |
|
|||||||||
postLoadProcessor (type postLoadProcessor) |
|
|||||||||
postLoadProcessors (type postLoadProcessors) |
|
|||||||||
primaryContent (type metaDataProperty) | Specifies that the content is a Primary Content
|
|||||||||
processAction (type processAction) |
|
|||||||||
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.
|
|||||||||
publishEndDate (type metaDataProperty) |
|
|||||||||
publishStartDate (type metaDataProperty) |
|
|||||||||
publishToPrincipals (type metaDataProperty) |
|
|||||||||
publishToServiceInstances (type metaDataProperty) |
|
|||||||||
publishToSocialNetwork (type metaDataProperty) | Specifies that the content may be published to social networks.
|
|||||||||
relation (type relation) | specifies a relation between the current source and another source in the doui definition. | |||||||||
relationField (within relation) | specifies the fields between the curent source and the foreign source that are related.
|
|||||||||
relations (type relations) | if the source is related to another source, the relation details must be specified here. | |||||||||
renderAction (within renderActions) |
|
|||||||||
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.
|
|||||||||
response (type response) |
|
|||||||||
restInterface (type restInterface) | Details of an rest interface are specified here.
|
|||||||||
restInterfaces (type restInterfaces) |
|
|||||||||
scope (within targetScopes) |
|
|||||||||
script (type xsd:string) | Must be specified if the type of the response is doui_runJavascript.
|
|||||||||
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. | |||||||||
seo (type metaDataProperty) | Specifies that the content provides SEO specific fields.
|
|||||||||
service (within douiDefinition) |
|
|||||||||
serviceInstanceIsolation (type metaDataProperty) | specifies that the content must be isolated between service instances.
|
|||||||||
setControlValues (within onClick) |
|
|||||||||
slug (type metaDataProperty) | Specifies that the content may have a slug to ease its identification.
|
|||||||||
source (type interfaceSource) |
|
|||||||||
source (type interfaceSourceRest) |
|
|||||||||
source (type servicesource) |
|
|||||||||
sources (type interfaceSources) | specifies one or more sources that must be used in the interface.
|
|||||||||
sources (type interfaceSourcesRest) | specifies one or more sources that must be used in the rest interface.
|
|||||||||
sources (type sources) |
|
|||||||||
table (type xsd:string) | Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes
|
|||||||||
tag (type metaDataProperty) | Specifies that the repository allows tagging contents.
|
|||||||||
target (within hyperLink) | Specifies the target for the hyperlink parameters.
|
|||||||||
targetScopes (within activityStream) | Specifies the scopes for which activities will be automatically generated. | |||||||||
url (type xsd:string) | Used when the response type is doui_hyperLink.
|
|||||||||
value (within parameter) | value of the parameter. | |||||||||
value (within setControlValues) |
|
|||||||||
versioning (type versioningMetaDataProperty) |
|
|||||||||
view (type xsd:string) | Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes
|
|||||||||
workflow (type metaDataProperty) |
|
Complex Type Summary | ||||||||
fieldValues |
|
|||||||
filter |
|
|||||||
filterOperators |
|
|||||||
filters |
|
|||||||
hyperLink | Requests the portal for a url to another page of the portal.
|
|||||||
hyperLinkParameter |
|
|||||||
hyperLinkParameters |
|
|||||||
hyperLinks |
|
|||||||
interface |
|
|||||||
interfaceFields |
|
|||||||
interfaces |
|
|||||||
interfaceSource |
|
|||||||
interfaceSourceRest |
|
|||||||
interfaceSources |
|
|||||||
interfaceSourcesRest |
|
|||||||
metaData |
|
|||||||
metaDataProperty |
|
|||||||
postLoadProcessor |
|
|||||||
postLoadProcessors |
|
|||||||
processAction |
|
|||||||
processActions |
|
|||||||
relation |
|
|||||||
relations |
|
|||||||
renderActions |
|
|||||||
response |
|
|||||||
restInterface |
|
|||||||
restInterfaces |
|
|||||||
servicesource |
|
|||||||
sourceField |
|
|||||||
sourceFieldOptions |
|
|||||||
sourceFields |
|
|||||||
sources |
|
|||||||
versioningMetaDataProperty |
|
Simple Type Summary | ||||
dataType |
|
|||
fieldValueType |
|
|||
filterOperatorValues |
|
|||
filtersConcatenationType |
|
|||
filterShowItemsType |
|
|||
inheritFieldsType |
|
|||
joinType |
|
|||
optionInsertLocation |
|
|||
orderByDirection |
|
|||
processActionType |
|
|||
readTypes |
|
|||
responseType |
|
|||
sourceType |
|
<?xml version="1.0" encoding="UTF-8"?> <!-- $Revision: 25270 $ $Date: 2022-10-04 11:58:27 -0300 (Tue, 04 Oct 2022) $ --> <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:import namespace="http://www.lumis.com.br/douicontrols" schemaLocation="control/douicontrolsdefinition.xsd"/> <xsd:restriction base="xsd:string"> <xsd:enumeration value="table"/> <xsd:enumeration value="view"/> <xsd:enumeration value="contentTable"/> </xsd:restriction> </xsd:simpleType> <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: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: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:sequence maxOccurs="unbounded"> </xsd:sequence> </xsd:complexType> <xsd:sequence> <xsd:choice maxOccurs="1" minOccurs="0"> <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. <pre> <source> <type>table</type> <className>lumis.doui.table.TableSource</className> <dataProviderClassName>lumis.doui.table.TableDataProvider</dataProviderClassName> </source> <source> <type>contentTable</type> <className>lumis.content.table.ContentTableSource</className> <dataProviderClassName>lumis.content.table.ContentTableDataProvider</dataProviderClassName> </source> <source> <type>search</type> <className>lumis.doui.search.SearchSource</className> <dataProviderClassName>lumis.doui.search.SearchDataProvider</dataProviderClassName> </source> </pre> </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> <xsd:choice minOccurs="0"> <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:annotation> <xsd:documentation> Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> This is used exclusively by the ServiceInstanceDependencyDataProvider. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> <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: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: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:annotation> <xsd:documentation>Specifies custom big data configurations.</xsd:documentation> </xsd:annotation> <xsd:complexType> <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: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:annotation> <xsd:documentation> Specifies source activity stream default behavior. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <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: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: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:annotation> </xsd:annotation> <xsd:complexType> <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: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: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: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: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: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: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" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation> Identifier of the source. Must be unique among all sources within the service. </xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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: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: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: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: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:sequence maxOccurs="unbounded"> <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:all> <xsd:annotation> <xsd:documentation> Specifies that the content may be published to social networks. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Specifies that the content will make use of locking to avoid simultaneous editing. </xsd:documentation> </xsd:annotation> </xsd:element> <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: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:annotation> <xsd:documentation> Specifies that the repository allows tagging contents. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Specifies that the content provides SEO specific fields. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation> Specifies that the content may have a slug to ease its identification. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:annotation> <xsd:documentation>Specifies that the content is a Primary Content</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:all> </xsd:complexType> <xsd:complexContent> <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: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:sequence maxOccurs="1"> <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:annotation> <xsd:documentation> Possible values of the field may be explicitly specified here. </xsd:documentation> </xsd:annotation> </xsd:element> <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:complexType> </xsd:element> <xsd:annotation> <xsd:documentation> Allows configuration about how the field is stored in portal big data repostory. </xsd:documentation> </xsd:annotation> <xsd:complexType> <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:annotation> <xsd:documentation> Identifier for the field. This must be unique among all fields of this source. </xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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:annotation> <xsd:documentation> Used for file data types. Defines the minimum size accepted for uploaded files. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Used for file data types. Defines the maximum size accepted for uploaded files. </xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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: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:annotation> <xsd:documentation>Indicates that this field is a content tag field.</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> <xsd:sequence maxOccurs="unbounded"> <xsd:complexType> <xsd:simpleContent> <xsd:extension base="xsd:string"> <xsd:annotation> <xsd:documentation> value of the option. Must be compatible with the field data type. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Specifies if the option by default must be selected when adding data. </xsd:documentation> </xsd:annotation> </xsd:attribute> <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:restriction base="xsd:string"> <xsd:enumeration value="before"/> <xsd:enumeration value="after"/> </xsd:restriction> </xsd:simpleType> <xsd:sequence maxOccurs="unbounded"> <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: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: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 <fields> element is not specified. </xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> <xsd:sequence maxOccurs="unbounded"> <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:restriction base="xsd:string"> <xsd:enumeration value="inner"/> <xsd:enumeration value="outer"/> </xsd:restriction> </xsd:simpleType> <xsd:sequence> <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:annotation> <xsd:documentation>identifier of the field in the current source.</xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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: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: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: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:sequence maxOccurs="unbounded" minOccurs="0"> </xsd:sequence> </xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:any maxOccurs="unbounded" processContents="skip"/> <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:sequence> <xsd:annotation> <xsd:documentation>Identifier of the process action.</xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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> </ul> </xsd:documentation> </xsd:annotation> </xsd:attribute> <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: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:restriction> </xsd:simpleType> <xsd:sequence maxOccurs="1" minOccurs="0"> <xsd:annotation> <xsd:documentation> Allows customization of one parameter that will be available to this process action. </xsd:documentation> </xsd:annotation> <xsd:complexType> <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: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:restriction base="xsd:string"> <xsd:enumeration value="default"/> <xsd:enumeration value="parameter"/> <xsd:enumeration value="attribute"/> </xsd:restriction> </xsd:simpleType> <xsd:sequence maxOccurs="1" minOccurs="0"> <xsd:annotation> <xsd:documentation> Must be specified if the type of the response is doui_runJavascript. </xsd:documentation> </xsd:annotation> </xsd:element> <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: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: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:complexType> <xsd:sequence maxOccurs="unbounded" minOccurs="0"> <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: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: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: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: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:complexType> <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:sequence maxOccurs="unbounded"> <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:sequence maxOccurs="unbounded" minOccurs="0"> </xsd:sequence> </xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:complexType> <xsd:sequence maxOccurs="unbounded" minOccurs="0"> <xsd:complexType> <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:complexType> </xsd:element> <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:sequence> <xsd:attribute name="id" type="xsd:string" use="required"/> <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: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:sequence maxOccurs="unbounded" minOccurs="0"> </xsd:sequence> </xsd:complexType> <xsd:complexContent> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:sequence maxOccurs="unbounded"> </xsd:sequence> </xsd:complexType> <xsd:sequence> <xsd:any maxOccurs="unbounded" minOccurs="0" processContents="skip"/> </xsd:sequence> <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:restriction base="xsd:string"> <xsd:enumeration value="ascending"/> <xsd:enumeration value="descending"/> </xsd:restriction> </xsd:simpleType> <xsd:choice maxOccurs="unbounded"> </xsd:choice> <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:complexType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="and"/> <xsd:enumeration value="or"/> </xsd:restriction> </xsd:simpleType> <xsd:sequence> <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: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="onClientEvent"/> <xsd:element name="onChange" minOccurs="0" maxOccurs="unbounded" type="onClientEvent"/> <xsd:element name="onKeyUp" minOccurs="0" maxOccurs="unbounded" type="onClientEvent"/> <xsd:element name="onKeyDown" minOccurs="0" maxOccurs="unbounded" type="onClientEvent"/> </xsd:sequence --> </xsd:complexType> </xsd:element> <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:complexType> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <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:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="id" type="xsd:string" use="required"/> <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:annotation> <xsd:documentation> Refer to field defaultValue attribute for more information about specifying values. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Refer to field defaultValue attribute for more information about specifying values. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="name" type="xsd:string" 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:annotation> <xsd:documentation> Used to override the default input control type calculated for the filter </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Used to override the default data type type calculated for the filter </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:annotation> <xsd:documentation> Used to override the default pattern / mask used for the filter </xsd:documentation> </xsd:annotation> </xsd:attribute> <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:sequence maxOccurs="unbounded"> <xsd:complexType> <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:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <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:sequence> <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: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:annotation> <xsd:documentation> The layout of an interface is determined by a collection of controls specified here. </xsd:documentation> </xsd:annotation> </xsd:element> <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: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: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:sequence maxOccurs="unbounded"> <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:sequence> <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:annotation> <xsd:documentation>Identifier of the Rest interface.</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> <xsd:sequence maxOccurs="unbounded"> <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:sequence maxOccurs="unbounded" minOccurs="0"> <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:annotation> <xsd:documentation> Requests the portal for a url to another page of the portal. </xsd:documentation> </xsd:annotation> <xsd:sequence> <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: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: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:complexType> <xsd:sequence> <xsd:complexType> <xsd:sequence> <xsd:complexType> </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: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: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: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: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:sequence maxOccurs="unbounded" minOccurs="0"> </xsd:sequence> </xsd:complexType> </xsd:complexType> <xsd:complexType> <xsd:sequence> <xsd:complexType> <xsd:sequence> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <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 16.0.2.240429 - Copyright © 2006–2024 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.