complexType "servicesource"

Namespace:	http://www.lumis.com.br/lumisportal/xsd/doui
Content:	complex, 11 attributes, 15 elements
Defined:	globally in douidefinition.xsd, see XML source
Includes:	definitions of 8 attributes and 15 elements
Used:	at 1 location

XML Representation Summary

<...

className

xsd:string

distinct

xsd:boolean : "false"

enabled

xsd:boolean

("lum_objectAdmin" | "lum_objectEndUser")

xsd:boolean : "true"

xsd:string

xsd:string

xsd:string

publishAllAccessibleContents

xsd:boolean : "false"

scriptPath

xsd:string

type

("table" | "view" | "contentTable")

Content:

(dataProviderClassName? | dataProviderScriptPath?)?, (table | view | dependencyType)?, connectionId?, fields, metaData?, bigData?, activityStream?, relations?, administrationInterfaceId?, addInterfaceId?, editInterfaceId?, detailsInterfaceId?

</...>

Content Elements (15):

activityStream (within source),

addInterfaceId (type xsd:string),

administrationInterfaceId (type xsd:string),

bigData (within source),

connectionId (type xsd:string),

dataProviderClassName (type xsd:string),

dataProviderScriptPath (type xsd:string),

dependencyType (type xsd:string),

detailsInterfaceId (type xsd:string),

editInterfaceId (type xsd:string),

fields (type sourceFields),

metaData (type metaData),

relations (type relations),

table (type xsd:string),

view (type xsd:string)

All Direct / Indirect Based Elements (1):

source (type servicesource)

Known Usage Locations

As direct type of elements (1):

source (type servicesource)

XML Source

<xsd:complexType name="servicesource">

<xsd:sequence>

<xsd:choice maxOccurs="1" minOccurs="0">

<xsd:element minOccurs="0" name="dataProviderClassName" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Class name of the dataprovider for the source. If not specified a default data provider used based on the source type definitions registered. The framework by default has the following sourcetypes registered.
<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:element minOccurs="0" name="dataProviderScriptPath" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Path of a script defining the java class 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:choice minOccurs="0">

<xsd:element name="table" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="view" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="dependencyType" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

This is used exclusively by the ServiceInstanceDependencyDataProvider.

<xsd:element minOccurs="0" name="connectionId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Source may require data from another data base other than the primary data base used by the portal. This connectionId identifies the connection of another database. This identifier must be the filename (e.g. conn2.xml) of the hibernate configuration file in the directory \lumisdata\config\connection

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element name="fields" type="sourceFields">

<xsd:annotation>

<xsd:documentation>collection of fields</xsd:documentation>

</xsd:annotation>

<xsd:unique name="uniquePositionField">

<xsd:selector xpath="field"/>

<xsd:field xpath="@isPosition"/>

</xsd:unique>

</xsd:element>

<xsd:element minOccurs="0" name="metaData" type="metaData">

<xsd:annotation>

<xsd:documentation>

If the source type is contentTable, within this node the required metaData that must be associated with the content must be specified. When the service is registered these metadata fields are converted into fields of the given source. Independent of the metadata fields specified here the following fields are always added to contentTable sources.

<xhtml:b>createdDate</xhtml:b>

<xhtml:b>lastModifiedDate</xhtml:b>

<xhtml:b>createdBy</xhtml:b>

and

<xhtml:b>lastModifiedBy</xhtml:b>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="bigData">

<xsd:annotation>

<xsd:documentation>Specifies custom big data configurations.</xsd:documentation>

</xsd:annotation>

<xsd:complexType>

<xsd:attribute name="enabled" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

Used to enable or disable persisting the source to the big data.
By default, it is enabled only if the source has a field with isSearchable="true" or
the source has the bigData element present.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="persisterClassName" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

The full class name of a lumis.doui.bigdata.ISourceBigDataPersister implementation
to be used for this source. If the source is of type contentTable then the class must implement the
lumis.content.bigdata.IContentTableSourceBigDataPersister interface.
If not specified, the default depends on the source implementation class.

<xsd:element minOccurs="0" name="activityStream">

<xsd:annotation>

<xsd:documentation>

Specifies source activity stream default behavior.

<xsd:element minOccurs="0" name="objectType">

<xsd:annotation>

<xsd:documentation>

Specifies properties of the activity stream object type to be used
for activities automatically generated, by default implementations, for this source.
This object type will automatically be created/deleted during service
registration/deregistration.

<xhtml:br/>

The identifier of the object type is [serviceId]#[sourceId].

<xsd:element minOccurs="0" name="displayName">

<xsd:annotation>

<xsd:documentation>

A localizable string for the display name of this object type.
The default value is the name of the source, or if it is not set, "STR_ACTIVITY_OBJECT_TYPE_NAME".

</xsd:documentation>

</xsd:annotation>

<xsd:simpleType>

<xsd:restriction base="xsd:string">

<xsd:minLength value="1"/>

<xsd:maxLength value="50"/>

<xsd:element minOccurs="0" name="targetScopes">

<xsd:annotation>

<xsd:documentation>

Specifies the scopes for which activities will be automatically generated.
If inserted without any scopes, no activity will be automatically generated.
The default value is scope lum_objectAdmin enabled and lum_objectEndUser enabled if this source has a details interface.

<xsd:element maxOccurs="unbounded" minOccurs="0" name="scope">

<xsd:annotation>

</xsd:annotation>

<xsd:complexType>

<xsd:attribute name="id" use="required">

<xsd:annotation>

<xsd:documentation>

Specifies scope for which activities will be automatically generated.
See lumis.portal.activitystream.Activity javadoc for LumisXP standard scopes documentation.

</xsd:documentation>

</xsd:annotation>

<xsd:simpleType>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="lum_objectAdmin"/>

<xsd:enumeration value="lum_objectEndUser"/>

<xsd:attribute name="enabled" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

Used to enable or disable default activities generation for this source.
Actual activities generation depends on the source type and implementation.
By default, it is true if the source does not have a metaDataSourceId attribute set.

<xsd:element minOccurs="0" name="relations" type="relations">

<xsd:annotation>

<xsd:documentation>

if the source is related to another source, the relation details must be specified here.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="administrationInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Each source may specify its administration interface. If not specified this interface is calculated by the first interface that has the isAdministration attribute set to true in the servicedefinition.xml file. This administration interface is used for example during workflow to send a link to the administration interface in an email.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="addInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Each source may specify its add interface. If not specified this interface is calculated by the first interface that is an instance of the
class lumis.doui.service.DouiAdministrationAddPropertyPageServiceInterface or the class lumis.content.service.ContentAdministrationAddPropertyPageServiceInterface and has the current source defined as its first source.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="editInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Each source may specify its edit interface. If not specified this interface is calculated by the first interface that is an instance of the
class lumis.doui.service.DouiAdministrationEditPropertyPageServiceInterface or the class lumis.content.service.ContentAdministrationEditPropertyPageServiceInterface and has the current source defined as its first source.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

<xsd:element minOccurs="0" name="detailsInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Each source may specify its details interface. If not specified this interface is calculated by the first interface that has the isDetails attribute set and has the current source defined as its first source.

<xsd: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:attribute name="type" type="sourceType" use="optional">

<xsd:annotation>

<xsd:documentation>

Specifies one of the registered source types. The framework automatically registers source types "table" and "contentTable".

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="name" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Display name of the source. The value is a localizable (using service's string resources) string.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="className" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Instead of specifying a source type one may specify a class name that extends Source class.
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 a java class that extends Source class. When specified the java class defined by this script takes precedence over the class associated with the source type.
This attribute cannot be defined if the "className" attribute is defined.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute name="metaDataSourceId" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

If you have two content sources that are related, each of them must be joined with the metadata table independently. To do this the metadataId must be different for each of the sources. If not specified a default value is assumed for the source.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="publishAllAccessibleContents" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

Indicates if contents that are not published to the current service instance, but are accessible by the current user, should also be published. Affects the query generated for the source in publication interfaces.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="false" name="distinct" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

If set to true, the DISTINCT keyword is used in the generated SQL for retrieving the data for this source.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

<xsd:attribute default="true" name="isDetails" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

If set to false the source even in a details interface is not treated as a details source.

Attribute Detail (defined in this component only)

className

Instead of specifying a source type one may specify a class name that extends Source class. This attribute cannot be defined if the "scriptPath" attribute is defined.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="className" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Instead of specifying a source type one may specify a class name that extends Source class.
This attribute cannot be defined if the "scriptPath" attribute is defined.

If set to true, the DISTINCT keyword is used in the generated SQL for retrieving the data for this source.

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="false" name="distinct" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

If set to true, the DISTINCT keyword is used in the generated SQL for retrieving the data for this source.

If set to false the source even in a details interface is not treated as a details source.

Type:	xsd:boolean
Use:	optional
Default:	"true"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="true" name="isDetails" type="xsd:boolean" use="optional">

<xsd:annotation>

<xsd:documentation>

If set to false the source even in a details interface is not treated as a details source.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="metaDataSourceId" type="xsd:string" use="optional">

Display name of the source. The value is a localizable (using service's string resources) string.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="name" type="xsd:string" use="optional">

<xsd:annotation>

<xsd:documentation>

Display name of the source. The value is a localizable (using service's string resources) string.

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

publishAllAccessibleContents

Type:	xsd:boolean
Use:	optional
Default:	"false"
Defined:	locally, within this complexType

XML Source

<xsd:attribute default="false" name="publishAllAccessibleContents" type="xsd:boolean" use="optional">

Path of a script defining a java class that extends Source class. When specified the java class defined by this script takes precedence over the class associated with the source type. This attribute cannot be defined if the "className" attribute is defined.

Type:	xsd:string
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="scriptPath" type="xsd:string" use="optional">

Specifies one of the registered source types. The framework automatically registers source types "table" and "contentTable".

Type:	sourceType
Use:	optional
Defined:	locally, within this complexType

XML Source

<xsd:attribute name="type" type="sourceType" use="optional">

<xsd:annotation>

<xsd:documentation>

Specifies one of the registered source types. The framework automatically registers source types "table" and "contentTable".

</xsd:documentation>

</xsd:annotation>

</xsd:attribute>

Content Element Detail

activityStream

Specifies source activity stream default behavior.

Type:	embedded, complex content
Defined:	locally, within this complexType

addInterfaceId

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.

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="addInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

administrationInterfaceId

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="administrationInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

bigData

Specifies custom big data configurations.

Type:	embedded, empty content
Defined:	locally, within this complexType

connectionId

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="connectionId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

dataProviderClassName

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>

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="dataProviderClassName" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

dataProviderScriptPath

Path of a script defining the java class 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>

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="dataProviderScriptPath" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

dependencyType

This is used exclusively by the ServiceInstanceDependencyDataProvider.

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element name="dependencyType" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

This is used exclusively by the ServiceInstanceDependencyDataProvider.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

detailsInterfaceId

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="detailsInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

editInterfaceId

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.

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="editInterfaceId" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

</xsd:documentation>

</xsd:annotation>

</xsd:element>

fields

collection of fields

Type:	sourceFields, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element name="fields" type="sourceFields">

<xsd:annotation>

<xsd:documentation>collection of fields</xsd:documentation>

</xsd:annotation>

<xsd:unique name="uniquePositionField">

<xsd:selector xpath="field"/>

<xsd:field xpath="@isPosition"/>

</xsd:unique>

</xsd:element>

metaData

Type:	metaData, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="metaData" type="metaData">

<xsd:annotation>

<xsd:documentation>

<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>

relations

if the source is related to another source, the relation details must be specified here.

Type:	relations, complex content
Defined:	locally, within this complexType

XML Source

<xsd:element minOccurs="0" name="relations" type="relations">

<xsd:annotation>

<xsd:documentation>

if the source is related to another source, the relation details must be specified here.

</xsd:documentation>

</xsd:annotation>

</xsd:element>

table

Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element name="table" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Name of the table of the source. used by the TableDataProvider and ContentTableDataProvider classes

</xsd:documentation>

</xsd:annotation>

</xsd:element>

view

Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes

Type:	xsd:string, simple content
Defined:	locally, within this complexType

XML Source

<xsd:element name="view" type="xsd:string">

<xsd:annotation>

<xsd:documentation>

Name of the view of the source. used by the TableDataProvider and ContentTableDataProvider classes

</xsd:documentation>

</xsd:annotation>

</xsd:element>

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