Target Namespace:

<global>

1 global element, 76 local elements, 16 complexTypes, 7 simpleTypes

/data/jenkins-slave/home1/data/workspace/lpjava-10.4.x-dist/repo/Lumis_PortalJava/builder/docflex-xml-kit/../../distribution/tmp/servicedefinition.xsd, see XML source

All Element Summary
automaticAdministration (type xsd:boolean)	Indicates whether the current service interface is displayed by the auto administration service. Type: xsd:boolean Content: simple Defined: locally at 1 location
businessContext (type businessContextType)	This node indicates that the cache should be created by using keys present in the business context. Type: businessContextType Content: complex, 1 element Defined: locally at 1 location
businessContextProperty (type xsd:string)	The value should be the id of the BusinessContext property. Type: xsd:string Content: simple Defined: locally at 1 location
cache (type cache)	Type: cache Content: complex, 1 attribute, 4 elements Defined: locally at 1 location
callerServiceInterfaceMenuItemRequired (type xsd:boolean)	If this configuration is set to true, instances of this interface may only be executed when the caller service interface menu item is identified in the request. Type: xsd:boolean Content: simple Defined: locally at 1 location
className (type xsd:string)	Defines the fully qualified name of the class that implements the lumis.portal.serviceinterfaceinstance.IInterfaceInstanceCacheKeyProvider that will be used to generate a custom cache key. Type: xsd:string Content: simple Defined: locally at 1 location
clock (type clock)	Type: clock Content: complex, 4 attributes, 3 elements Defined: locally at 1 location
clocks (type clocks)	Defines clocks (scheduled tasks) for this service. Type: clocks Content: complex, 1 element Defined: locally at 1 location
contextPath (type xsd:string)	Contains the context path where this service is deployed into. Type: xsd:string Content: simple Defined: locally at 1 location
default (type cacheConfigurationOptions)	Type: cacheConfigurationOptions Content: complex, 4 elements Defined: locally at 1 location
defaultItems (within menu)	This element is to be replaced by the default menu items of the service implementation. Type: embedded complexType Content: empty Defined: locally at 1 location
description (type xsd:string)	Type: xsd:string Content: simple Defined: locally at 3 locations
expiration (type xsd:nonNegativeInteger)	Informs how often the cache should be expired. Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
googleAnalytics (within service)	Type: embedded complexType Content: empty, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
height (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
htmlProcessor (within htmlProcessors)	Defines a HTML processor for this service. Type: embedded complexType Content: empty, 2 attributes Defined: locally at 1 location Includes: definitions of 2 attributes
htmlProcessors (within service)	Defines a list of HTML processors that will be executed when rendering pages. Type: embedded complexType Content: complex, 2 attributes, 1 element Defined: locally at 1 location Includes: definition of 1 element
image (type xsd:string)	Type: xsd:string Content: simple Defined: locally at 1 location
inContextEditSupported (type xsd:boolean)	Indicates whether this interface supports the in-context edit feature. Type: xsd:boolean Content: simple Defined: locally at 1 location
interface (type interface)	Type: interface Content: complex, 5 attributes, 30 elements Defined: locally at 1 location
interfaceId (within item)	Type: anySimpleType Content: simple Defined: locally at 1 location
interfaces (within serviceDefinition)	Type: embedded complexType Content: complex, 1 element Defined: locally at 1 location Includes: definition of 1 element
isAdministration (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
isDetails (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
isList (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
isOpenerWindowRequired (type xsd:boolean)	This configuration indicates whether an opener window is expected to exist for the correct working of this interface. Type: xsd:boolean Content: simple Defined: locally at 1 location
isPrintable (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
isRestEnabled (type xsd:boolean)	Indicates that will be generated automatically a rest interface for the interface. Type: xsd:boolean Content: simple Defined: locally at 1 location
isRuntimeOnly (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
isSocialProfile (type xsd:boolean)	Specifies that this service is a Social Profile Service. Type: xsd:boolean Content: simple Defined: locally at 1 location
isSummary (type xsd:boolean)	Indicates whether this interface's main purpose is to display a summary of the data related to it. Type: xsd:boolean Content: simple Defined: locally at 1 location
isWidget (type xsd:boolean)	Indicates whether this interface may be used as a widget in a personalized page. Type: xsd:boolean Content: simple Defined: locally at 1 location
item (within menu)	Type: embedded complexType Content: complex, 5 attributes, 2 elements Defined: locally at 1 location Includes: definitions of 4 attributes and 2 elements
item (within menu)	Type: embedded complexType Content: complex, 4 attributes, any element Defined: locally at 1 location Includes: definitions of 4 attributes
itemGroup (within menu)	Type: embedded complexType Content: empty, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
level (type cacheLevelTypes)	Type: cacheLevelTypes Content: simple Defined: locally at 1 location
maxRunTime (type xsd:positiveInteger)	Maximum execution time for a clock, in seconds. Type: xsd:positiveInteger Content: simple Defined: locally at 1 location
menu (type menu)	Type: menu Content: complex, 5 attributes, 3 elements Defined: locally at 1 location
menu (type serviceMenu)	Defines the configuration menu for instances of this service. Type: serviceMenu Content: complex, 4 attributes, 3 elements Defined: locally at 1 location
menuLevel (within menuLevels)	The menu level where this item will be available on. Type: embedded complexType Content: complex, 1 attribute, 1 element Defined: locally at 1 location Includes: definition of 1 element
menuLevels (within item)	The menu levels where this item will be available on. Type: embedded complexType Content: complex, 1 attribute, 1 element Defined: locally at 1 location Includes: definition of 1 element
mode (type xsd:string)	A mode an interface supports. Type: xsd:string Content: simple Defined: locally at 1 location
modes (type interfaceModes)	Lists the modes this interface supports. Type: interfaceModes Content: complex, 1 element Defined: locally at 1 location
paddingBottom (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
paddingLeft (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
paddingRight (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
paddingTop (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
permission (within permissions)	Type: embedded complexType Content: empty, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
permission (within permissions)	Type: embedded complexType Content: empty, 4 attributes Defined: locally at 1 location Includes: definitions of 4 attributes
permissions (type interfacePermissions)	Type: interfacePermissions Content: complex, 1 attribute, 1 element Defined: locally at 1 location
permissions (type permissions)	Type: permissions Content: complex, 4 attributes, 1 element Defined: locally at 1 location
permissions (within menuLevel)	The permissions required to access the current menu item at the current menu level. Type: embedded complexType Content: complex, 1 attribute, 2 elements Defined: locally at 1 location Includes: definitions of 2 elements
personalization (type cachePersonalizationTypes)	Type: cachePersonalizationTypes Content: simple Defined: locally at 1 location
popupWindowProperties (type xsd:string)	Type: xsd:string Content: simple Defined: locally at 1 location
previewSupported (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
renderAs (type renderAsTypes)	Type: renderAsTypes Content: simple Defined: locally at 1 location
resource (type resource)	Type: resource Content: complex, 1 element Defined: locally at 1 location
scriptPath (type xsd:string)	Path of a script defining the java class that implements the lumis.portal.serviceinterfaceinstance.IInterfaceInstanceCacheKeyProvider that will be used to generate a custom cache key. Type: xsd:string Content: simple Defined: locally at 1 location
separator (within menu)	Type: anySimpleType Content: simple Defined: locally at 1 location
separator (within menu)	Type: embedded complexType Content: empty Defined: locally at 1 location
serverSideInclude (type xsd:boolean)	Type: xsd:boolean Content: simple Defined: locally at 1 location
service (type service)	Type: service Content: complex, 7 attributes, 12 elements Defined: locally at 1 location
serviceDefinition	Type: embedded complexType Content: complex, 2 elements Includes: definitions of 2 elements Used: never
serviceInstancePermission (within permissions)	A permission of the current service instance. Type: embedded complexType Content: empty, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
serviceInstanceRequired (type xsd:boolean)	If this configuration is set to true, the portal will require a service instance of the same service of the interface to render it. Type: xsd:boolean Content: simple Defined: locally at 1 location
serviceInterfaceInstancePermission (within permissions)	A permission of the current service interface instance. Type: embedded complexType Content: empty, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
smallImage (type xsd:string)	Specifies the small image for this service. Type: xsd:string Content: simple Defined: locally at 1 location
startTime (type xsd:time)	Type: xsd:time Content: simple Defined: locally at 1 location
stringsUrlPrefix (type xsd:string)	Type: xsd:string Content: simple Defined: locally at 1 location
stringsUrlPrefixes (type stringsUrlPrefixes)	Type: stringsUrlPrefixes Content: complex, 1 element Defined: locally at 1 location
style (within styles)	Type: embedded complexType Content: complex, 5 attributes, 1 element Defined: locally at 1 location Includes: definitions of 5 attributes and 1 element
styles (type styles)	Indicates whether this interface's will have one or more styles pre-registered. Type: styles Content: complex, 5 attributes, 1 element Defined: locally at 1 location
tickInterval (within clock)	The interval for executing this clock. Type: embedded (extension of xsd:string) Content: simple, 1 attribute Defined: locally at 1 location Includes: definition of 1 attribute
title (type xsd:string)	Type: xsd:string Content: simple Defined: locally at 1 location
usesSocialProfileInformation (type xsd:boolean)	Indicates whether this intefaces uses information about users' social profile. Type: xsd:boolean Content: simple Defined: locally at 1 location
width (type xsd:nonNegativeInteger)	Type: xsd:nonNegativeInteger Content: simple Defined: locally at 1 location
workflow (type workflow)	Type: workflow Content: empty, 2 attributes Defined: locally at 1 location

Complex Type Summary
businessContextType	Agregates a list of BusinessContext keys to be used in interface caching. Content: complex, 1 element Includes: definition of 1 element Used: at 1 location
cache	Content: complex, 1 attribute, 4 elements Includes: definitions of 1 attribute and 4 elements Used: at 1 location
cacheConfigurationOptions	This represents the Cache tab in the service interface instance edit interface. Content: complex, 4 elements Includes: definitions of 4 elements Used: at 1 location
clock	Content: complex, 4 attributes, 3 elements Includes: definitions of 3 attributes and 3 elements Used: at 1 location
clocks	Content: complex, 1 element Includes: definition of 1 element Used: at 1 location
interface	Content: complex, 5 attributes, 30 elements Includes: definitions of 5 attributes and 30 elements Used: at 1 location
interfaceModes	Contains the modes an interface supports. Content: complex, 1 element Includes: definition of 1 element Used: at 1 location
interfacePermissions	Content: complex, 1 attribute, 1 element Includes: definition of 1 element Used: at 1 location
menu	Content: complex, 5 attributes, 3 elements Includes: definitions of 3 elements Used: at 1 location
permissions	Content: complex, 4 attributes, 1 element Includes: definition of 1 element Used: at 1 location
resource	Content: complex, 1 element Includes: definition of 1 element Used: at 1 location
service	Content: complex, 7 attributes, 12 elements Includes: definitions of 4 attributes and 12 elements Used: at 1 location
serviceMenu	Content: complex, 4 attributes, 3 elements Includes: definitions of 3 elements Used: at 1 location
stringsUrlPrefixes	Content: complex, 1 element Includes: definition of 1 element Used: at 1 location
styles	Content: complex, 5 attributes, 1 element Includes: definition of 1 element Used: at 1 location
workflow	Content: empty, 2 attributes Includes: definitions of 2 attributes Used: at 1 location

Simple Type Summary
cacheLevelTypes	Used: at 1 location
cachePersonalizationTypes	Used: at 1 location
renderAsTypes	Used: at 1 location
serviceInstancePermission	Used: at 4 locations
serviceInterfaceType	Used: at 1 location
serviceMenuItemType	Used: at 1 location
serviceType	Used: at 1 location

XML Source

<?xml version="1.0" encoding="UTF-8"?> <!-- $Revision: 20849 $ $Date: 2017-12-19 13:00:21 +0000 (Tue, 19 Dec 2017) $ --> <xsd:schema xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <xsd:complexType name="service"> <xsd:sequence> <xsd:element minOccurs="0" name="description" type="xsd:string"/> <xsd:element minOccurs="0" name="contextPath" type="xsd:string"> <xsd:annotation> <xsd:documentation> Contains the context path where this service is deployed into. If not specified, the service must be deployed in the same context as the portal framework. The context path must start with a slash, and contain only ascii letters and digits. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element default="false" maxOccurs="1" minOccurs="0" name="isSocialProfile" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Specifies that this service is a Social Profile Service. If this configuration is set to true, this service may be selected as the social profile on the configuration of Private Social Network, on the Configuration module of the Lumis Portal. The default value is false. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="googleAnalytics"> <xsd:complexType> <xsd:attribute fixed="true" name="enabled" type="xsd:boolean" use="required"> <xsd:annotation> <xsd:documentation> Indicates whether Google Analytics integration is enabled for this service. If this configuration is set to <em>true</em> , the default content administration list interfaces will display a button to access Google Analytics. The default value is <em>false</em> . </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:element minOccurs="0" name="image" type="xsd:string"/> <xsd:element minOccurs="0" name="smallImage" type="xsd:string"> <xsd:annotation> <xsd:documentation> Specifies the small image for this service. Its value should be the href for the image to be used as the small image for this service. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="menu" type="serviceMenu"> <xsd:annotation> <xsd:documentation> Defines the configuration menu for instances of this service. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="permissions" type="permissions"/> <xsd:element minOccurs="0" name="clocks" type="clocks"> <xsd:annotation> <xsd:documentation> Defines clocks (scheduled tasks) for this service. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="htmlProcessors"> <xsd:annotation> <xsd:documentation> Defines a list of HTML processors that will be executed when rendering pages. Notice that these processors will only be executed if the page being rendered is in a subtree of some channel that has an instance of this service and the user that requested the page has view permission in this instance. The HTML processors defined in a given service will be executed in the same order they are placed in service's XML definition. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" name="htmlProcessor"> <xsd:annotation> <xsd:documentation> Defines a HTML processor for this service. The class <em>must</em> implement lumis.portal.presentation.IHtmlProcessor. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:attribute name="className"> <xsd:annotation> <xsd:documentation> The class name of the IHtmlProcessor implementation used for this service. This attribute cannot be defined if the "scriptPath" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements IHtmlProcessor used for this service. This attribute cannot be defined if the "className" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element minOccurs="0" name="resource" type="resource"/> <xsd:element minOccurs="0" name="workflow" type="workflow"/> </xsd:sequence> <xsd:attribute name="id" type="xsd:string"/> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="className" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> The class name of the IService implementation used for this service. This attribute cannot be defined if the "scriptPath" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements IService used for this service. This attribute cannot be defined if the "className" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="type" type="serviceType" use="optional"> <xsd:annotation> <xsd:documentation> This attribute defines the type of service, like native portal, content manager and doui. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="isInstantiable" type="xsd:boolean" use="optional"/> </xsd:complexType> <xsd:complexType name="workflow"> <xsd:attribute name="enabled" type="xsd:boolean" use="required"/> <xsd:attribute name="id" type="xsd:string" use="optional"/> </xsd:complexType> <xsd:complexType name="resource"> <xsd:sequence maxOccurs="1"> <xsd:element name="stringsUrlPrefixes" type="stringsUrlPrefixes"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="stringsUrlPrefixes"> <xsd:sequence maxOccurs="unbounded"> <xsd:element name="stringsUrlPrefix" type="xsd:string"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="clocks"> <xsd:sequence maxOccurs="unbounded"> <xsd:element name="clock" type="clock"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="clock"> <xsd:sequence> <xsd:element minOccurs="0" name="startTime" type="xsd:time"/> <xsd:element default="1800" minOccurs="0" name="maxRunTime" type="xsd:positiveInteger"> <xsd:annotation> <xsd:documentation> Maximum execution time for a clock, in seconds. After this time has passed since the clock execution has started, it is considered that is died and it can be executed again by the portal. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="1" name="tickInterval"> <xsd:annotation> <xsd:documentation> The interval for executing this clock. The value of this element is the interval, and the time unit is specified in the interval attribute. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:simpleContent> <xsd:extension base="xsd:string"> <xsd:attribute default="minutes" name="type"> <xsd:annotation> <xsd:documentation>The time unit for the specified interval.</xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="seconds"/> <xsd:enumeration value="minutes"/> <xsd:enumeration value="hours"/> <xsd:enumeration value="days"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="id" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation> The identifier for the clock. The clock's full identifier is "[serviceId].[id]". </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="className" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> The class name of the implementation used for this clock execution. This attribute cannot be defined if the "scriptPath" attribute is defined. <em> Either this attribute or 'scriptPath' must be defined. </em> </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class of the implementation used for this clock execution. This attribute cannot be defined if the "className" attribute is defined. <em> Either this attribute or 'className' must be defined. </em> </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> <xsd:complexType name="serviceMenu"> <xsd:choice maxOccurs="unbounded" minOccurs="0"> <xsd:element name="item"> <xsd:complexType> <xsd:sequence minOccurs="0"> <xsd:any/> </xsd:sequence> <xsd:attribute name="name" type="xsd:string" use="required"> <xsd:annotation> <xsd:documentation> Display name for this menu item. It will be localized using current service string resources. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="type" type="serviceMenuItemType" use="optional"/> <xsd:attribute name="className" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> The class name of the IServiceInstanceMenuItem implementation used for this menu item. This attribute cannot be defined if the "scriptPath" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements IServiceInstanceMenuItem used for this menu item. This attribute cannot be defined if the "className" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:element name="separator"> <xsd:complexType/> </xsd:element> <xsd:element name="defaultItems"> <xsd:annotation> <xsd:documentation> This element is to be replaced by the default menu items of the service implementation. </xsd:documentation> </xsd:annotation> <xsd:complexType/> </xsd:element> </xsd:choice> </xsd:complexType> <xsd:simpleType name="serviceMenuItemType"> <xsd:union> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="lum_categorizationRepository"/> <xsd:enumeration value="lum_documentRepository"/> <xsd:enumeration value="lum_fileManagementProperties"/> <xsd:enumeration value="lum_mediaRepository"/> <xsd:enumeration value="lum_searchProperties"/> <xsd:enumeration value="lum_serviceInstanceWorkflow"/> <xsd:enumeration value="lum_widgetRepository"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType> <xsd:restriction base="xsd:string"/> </xsd:simpleType> </xsd:union> </xsd:simpleType> <xsd:complexType name="permissions"> <xsd:sequence maxOccurs="unbounded"> <xsd:element name="permission"> <xsd:complexType> <xsd:attribute name="id" type="serviceInstancePermission" use="required"/> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="implies" type="serviceInstancePermission" use="optional"/> <xsd:attribute default="false" name="requiredForWorkflowRole" type="xsd:boolean" use="optional"/> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="styles"> <xsd:sequence maxOccurs="unbounded" minOccurs="0"> <xsd:element name="style"> <xsd:complexType> <xsd:sequence> <xsd:element minOccurs="0" name="description" type="xsd:string"/> </xsd:sequence> <xsd:attribute name="id" type="xsd:string" use="required"/> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="path" type="xsd:string" use="required"/> <xsd:attribute default="false" name="isDefault" type="xsd:boolean" use="optional"/> <xsd:attribute default="false" name="isWidgetDefault" type="xsd:boolean" use="optional"> <xsd:annotation> <xsd:documentation> Indicates whether this style is the default style to be used when the interface is rendered as a widget in a personalized page. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="cache"> <xsd:sequence maxOccurs="unbounded"> <xsd:element minOccurs="0" name="level" type="cacheLevelTypes"/> <xsd:element minOccurs="0" name="personalization" type="cachePersonalizationTypes"/> <xsd:element default="false" minOccurs="0" name="serverSideInclude" type="xsd:boolean"/> <xsd:element maxOccurs="1" minOccurs="0" name="default" type="cacheConfigurationOptions"/> </xsd:sequence> <xsd:attribute name="enable" type="xsd:boolean" use="required"/> </xsd:complexType> <xsd:complexType name="menu"> <xsd:sequence maxOccurs="unbounded"> <xsd:element minOccurs="0" name="item"> <xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="1" minOccurs="0" name="menuLevels"> <xsd:annotation> <xsd:documentation> The menu levels where this item will be available on. If not specified, the item is available on the structure level menu. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="1" name="menuLevel"> <xsd:annotation> <xsd:documentation> The menu level where this item will be available on. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element minOccurs="0" name="permissions"> <xsd:annotation> <xsd:documentation> The permissions required to access the current menu item at the current menu level. The user must have at least one of the specified permissions to be granted access. <xhtml:p> If this element is not specified, the default varies with the menu level as follows: </xhtml:p> <ul> <li> structure: serviceInterfaceInstancePermission of UPDATE. </li> <li> shared: serviceInstancePermission of EDIT_SERVICE_INSTANCE_CONTENT. </li> <li> user: serviceInstancePermission of VIEW_SERVICE_INSTANCE. </li> </ul> </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:choice maxOccurs="unbounded" minOccurs="1"> <xsd:element name="serviceInstancePermission"> <xsd:annotation> <xsd:documentation>A permission of the current service instance.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:attribute name="id" type="serviceInstancePermission" use="required"> <xsd:annotation> <xsd:documentation> The identifier of the service instance permission. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:element name="serviceInterfaceInstancePermission"> <xsd:annotation> <xsd:documentation> A permission of the current service interface instance. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:attribute name="id" use="required"> <xsd:annotation> <xsd:documentation> The identifier of the service interface instance permission. </xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="UPDATE"/> <xsd:enumeration value="DELETE"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element> </xsd:choice> </xsd:complexType> <xsd:key name="permissionsServiceInstancePermissionIdKey"> <xsd:selector xpath="serviceInstancePermission"/> <xsd:field xpath="@id"/> </xsd:key> <xsd:key name="permissionsServiceInterfaceInstancePermissionIdKey"> <xsd:selector xpath="serviceInterfaceInstancePermission"/> <xsd:field xpath="@id"/> </xsd:key> </xsd:element> </xsd:sequence> <xsd:attribute name="id" use="required"> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="structure"/> <xsd:enumeration value="shared"/> <xsd:enumeration value="user"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:key name="menuLevelIdKey"> <xsd:selector xpath="menuLevel"/> <xsd:field xpath="@id"/> </xsd:key> </xsd:element> <xsd:element minOccurs="0" name="interfaceId"/> </xsd:sequence> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="type" type="xsd:string" use="optional"/> <xsd:attribute name="className" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> The class name of the IServiceInterfaceMenuItem implementation used for this menu item. This attribute cannot be defined if the "scriptPath" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements IServiceInterfaceMenuItem used for this menu item. This attribute cannot be defined if the "className" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:element minOccurs="0" name="separator"/> <xsd:element minOccurs="0" name="itemGroup"> <xsd:complexType> <xsd:attribute name="type" type="xsd:string" use="required"/> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="interface"> <xsd:all> <xsd:element minOccurs="0" name="description" type="xsd:string"/> <xsd:element minOccurs="0" name="title" type="xsd:string"/> <xsd:element minOccurs="0" name="isRuntimeOnly" type="xsd:boolean"/> <xsd:element default="false" maxOccurs="1" minOccurs="0" name="usesSocialProfileInformation" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates whether this intefaces uses information about users' social profile. If this configuration is set to true, the renderization of DOUI LumisPrincipal type fields will contain the corresponding social profile information. The default value is false. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element default="true" minOccurs="0" name="serviceInstanceRequired" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> If this configuration is set to true, the portal will require a service instance of the same service of the interface to render it. If this configuration is set to false, the portal will not require a service instance to render it. In this case, the portal will not validate the user permissions in a service instance. If some validation should be made, the interface should do it itself. The default value is true. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element default="false" minOccurs="0" name="callerServiceInterfaceMenuItemRequired" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> If this configuration is set to true, instances of this interface may only be executed when the caller service interface menu item is identified in the request. It will be required that the current user has been granted a permission defined in the menu item for the request to be processed. The default value is false. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="isAdministration" type="xsd:boolean"/> <xsd:element minOccurs="0" name="isPrintable" type="xsd:boolean"/> <xsd:element default="true" minOccurs="0" name="isOpenerWindowRequired" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> This configuration indicates whether an opener window is expected to exist for the correct working of this interface. When this configuration is set to <xhtml:i>true</xhtml:i> the portal will try to open this interface, when requested to, in such way that the opener window remain active. Otherwise, the portal may choose to open this interface in such way the opener window may not remain active. By default, this configuration is set to <xhtml:i>true</xhtml:i> . </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="renderAs" type="renderAsTypes"/> <xsd:element minOccurs="0" name="width" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="height" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="paddingLeft" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="paddingRight" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="paddingTop" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="paddingBottom" type="xsd:nonNegativeInteger"/> <xsd:element minOccurs="0" name="popupWindowProperties" type="xsd:string"/> <xsd:element minOccurs="0" name="styles" type="styles"> <xsd:annotation> <xsd:documentation> Indicates whether this interface's will have one or more styles pre-registered. If this tag is not inserted, the system will try to resolve the default interface style based on interface identifier, it will search inside service folders for a 'style' folder, then will search for style archives (*.xsl, *.js, *.groovy) named by interface identifier, if any were found, will use it as interface default style. <xhtml:p>Example:</xhtml:p> <pre> <interface id="list" name="STR_LIST" type="lum_douiList"> <styles> <style id="list" name="STR_LIST" path="style/List.js"/> </styles> </interface> Default style will be "List.js". <interface id="list" name="STR_LIST" type="lum_douiList"> <styles/> </interface> Default style will be the Lumis Portal generic style. <interface id="list" name="STR_LIST" type="lum_douiList"> </interface> Default style, if found in "style" folder inside service folder, will be "list.xsl", "list.js" or "list.groovy". If no such file exists, the Lumis Portal generic style will be used as default. </pre> </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="cache" type="cache"/> <xsd:element minOccurs="0" name="menu" type="menu"/> <xsd:element minOccurs="0" name="isDetails" type="xsd:boolean"/> <xsd:element minOccurs="0" name="isList" type="xsd:boolean"/> <xsd:element minOccurs="0" name="isSummary" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates whether this interface's main purpose is to display a summary of the data related to it. By default, it is true for quick lists and false for other interface types. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="previewSupported" type="xsd:boolean"/> <xsd:element minOccurs="0" name="permissions" type="interfacePermissions"/> <xsd:element minOccurs="0" name="modes" type="interfaceModes"> <xsd:annotation> <xsd:documentation>Lists the modes this interface supports.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="isWidget" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates whether this interface may be used as a widget in a personalized page. By default, it is true for interfaces that are not runtime. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="isRestEnabled" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates that will be generated automatically a rest interface for the interface. By default, it is true for lists and details interfaces and false for other interface types. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element default="true" minOccurs="0" name="inContextEditSupported" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates whether this interface supports the in-context edit feature. This attribute is to be set to false if this interface is not compatible with portal the in-context edit feature. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element maxOccurs="1" minOccurs="0" name="automaticAdministration" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> Indicates whether the current service interface is displayed by the auto administration service. If an interface is considered relevant to the auto administration service, it will be created at runtime when there is an area with the auto administration service instantiated. If this node is not present, the default behavior will be to consider it true if the interface is not runtime and is an administration list interface, false otherwise. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:all> <xsd:attribute name="id" type="xsd:string" use="required"/> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="className" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> The class name of the IServiceInterface implementation used for this service. This attribute cannot be defined if the "scriptPath" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="scriptPath" type="xsd:string" use="optional"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements IServiceInterface used for this service interface. This attribute cannot be defined if the "className" attribute is defined. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="type" type="serviceInterfaceType" use="optional"/> </xsd:complexType> <xsd:complexType name="interfacePermissions"> <xsd:sequence maxOccurs="unbounded"> <xsd:element name="permission"> <xsd:complexType> <xsd:attribute name="id" type="serviceInstancePermission" use="required"/> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="interfaceModes"> <xsd:annotation> <xsd:documentation>Contains the modes an interface supports.</xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0" name="mode" type="xsd:string"> <xsd:annotation> <xsd:documentation> A mode an interface supports. The standard mode values are VIEW, EDIT and HELP. The modes are case insensitive and are converted to lower case. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:element name="serviceDefinition"> <xsd:complexType> <xsd:sequence> <xsd:element name="service" type="service"/> <xsd:element minOccurs="0" name="interfaces"> <xsd:complexType> <xsd:sequence maxOccurs="unbounded" minOccurs="0"> <xsd:element name="interface" type="interface"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:simpleType name="renderAsTypes"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="inline"/> <xsd:enumeration value="clientSideScript"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="cacheLevelTypes"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="local"/> <xsd:enumeration value="pageTemplate"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="cachePersonalizationTypes"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="none"/> <xsd:enumeration value="guestOnly"/> <xsd:enumeration value="perUser"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="serviceType"> <xsd:union> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="lum_content"/> <xsd:enumeration value="lum_doui"/> <xsd:enumeration value="lum_service"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType> <xsd:restriction base="xsd:string"/> </xsd:simpleType> </xsd:union> </xsd:simpleType> <xsd:simpleType name="serviceInstancePermission"> <xsd:union> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="MANAGE_SERVICE_INSTANCE_SECURITY"/> <xsd:enumeration value="MANAGE_SERVICE_INSTANCE"/> <xsd:enumeration value="EDIT_SERVICE_INSTANCE_CONTENT"/> <xsd:enumeration value="VIEW_SERVICE_INSTANCE"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType> <xsd:restriction base="xsd:string"/> </xsd:simpleType> </xsd:union> </xsd:simpleType> <xsd:simpleType name="serviceInterfaceType"> <xsd:union> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="lum_serviceInterface"/> <xsd:enumeration value="lum_styled"/> <xsd:enumeration value="lum_doui"/> <xsd:enumeration value="lum_douiList"/> <xsd:enumeration value="lum_douiQuickList"/> <xsd:enumeration value="lum_douiDetails"/> <xsd:enumeration value="lum_douiAdministrationList"/> <xsd:enumeration value="lum_douiAdministrationPropertyPage"/> <xsd:enumeration value="lum_douiAdministrationAddPropertyPage"/> <xsd:enumeration value="lum_douiAdministrationEmbeddedAddPropertyPage"/> <xsd:enumeration value="lum_douiAdministrationEditPropertyPage"/> <xsd:enumeration value="lum_content"/> <xsd:enumeration value="lum_contentList"/> <xsd:enumeration value="lum_contentQuickList"/> <xsd:enumeration value="lum_contentDetails"/> <xsd:enumeration value="lum_contentAdministrationList"/> <xsd:enumeration value="lum_contentAdministrationPropertyPage"/> <xsd:enumeration value="lum_contentAdministrationAddPropertyPage"/> <xsd:enumeration value="lum_contentAdministrationEmbeddedAddPropertyPage"/> <xsd:enumeration value="lum_contentAdministrationEditPropertyPage"/> </xsd:restriction> </xsd:simpleType> <xsd:simpleType> <xsd:restriction base="xsd:string"/> </xsd:simpleType> </xsd:union> </xsd:simpleType> <xsd:complexType name="cacheConfigurationOptions"> <xsd:annotation> <xsd:documentation> This represents the Cache tab in the service interface instance edit interface. With this node you can configure the advanced cache options for the service interface. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element maxOccurs="1" minOccurs="0" name="expiration" type="xsd:nonNegativeInteger"> <xsd:annotation> <xsd:documentation> Informs how often the cache should be expired. The number expresses the amount of seconds that the portal will wait since the html was stored in cache before it expires. The absence of this node or setting its value to 0 (zero) will be interpreted as non-expiring cache. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:choice> <xsd:element maxOccurs="1" minOccurs="0" name="className" nillable="false" type="xsd:string"> <xsd:annotation> <xsd:documentation> Defines the fully qualified name of the class that implements the lumis.portal.serviceinterfaceinstance.IInterfaceInstanceCacheKeyProvider that will be used to generate a custom cache key. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element maxOccurs="1" minOccurs="0" name="scriptPath" nillable="false" type="xsd:string"> <xsd:annotation> <xsd:documentation> Path of a script defining the java class that implements the lumis.portal.serviceinterfaceinstance.IInterfaceInstanceCacheKeyProvider that will be used to generate a custom cache key. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element minOccurs="0" name="businessContext" type="businessContextType"> <xsd:annotation> <xsd:documentation> This node indicates that the cache should be created by using keys present in the business context. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> </xsd:sequence> </xsd:complexType> <xsd:complexType name="businessContextType"> <xsd:annotation> <xsd:documentation> Agregates a list of BusinessContext keys to be used in interface caching. </xsd:documentation> </xsd:annotation> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="1" name="businessContextProperty" nillable="false" type="xsd:string"> <xsd:annotation> <xsd:documentation> The value should be the id of the BusinessContext property. This value will not be checked when registering the service and will be expected to exist during runtime. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:schema>