element <folder>

Namespace:	http://labkey.org/folder/xml
Type:	anonymous complexType
Content:	complex, 13 attributes, 23 elements
Defined:	globally in folder.xsd, see XML source
Includes:	definitions of 13 attributes and 23 elements
Used:	never

XML Representation Summary

<folder

archiveVersion

xs:double

defaultDateFormat

xs:string

defaultDateTimeFormat

xs:string

defaultNumberFormat

xs:string

defaultTimeFormat

xs:string

description

xs:string

extraDateParsingPattern

xs:string

extraDateTimeParsingPattern

xs:string

extraTimeParsingPattern

xs:string

label

xs:string

restrictedColumnsEnabled

xs:boolean

title

xs:string

type

xs:string

Content:

folderType? × searchable? × pages? × categories? × qcStates? × notifications? × groups? × roleAssignments? × reports? × queries? × views? × lists? × missingValueIndicator? × missingValueIndicators? × wikis? × etls? × externalSchemas? × study? × subfolders? × moduleProperties? × xar? × inventory? × fileBrowserConfig?

</folder>

Content model elements (23):

categories (in folder),

etls (in folder),

externalSchemas (in folder),

fileBrowserConfig (in folder),

folderType (in folder),

groups (in folder),

inventory (in folder),

lists (in folder),

missingValueIndicator (in folder),

missingValueIndicators (in folder),

moduleProperties (in folder),

notifications (in folder),

pages (in folder),

qcStates (in folder),

queries (in folder),

reports (in folder),

roleAssignments (in folder),

searchable (in folder),

study (in folder),

subfolders (in folder),

views (in folder),

wikis (in folder),

xar (in folder)

XML Source (see within schema source)

<xs:element name="folder">

<xs:complexType>

<xs:all>

<xs:element maxOccurs="1" minOccurs="0" name="folderType" type="folderType">

<xs:annotation>

<xs:documentation>

The folder type to be used for this container along with which modules should be activated.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="searchable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

The full-text search settings for whether or not to include this folder's content in multi-folder search results.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="pages">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Indicates the "file" (string) that lists the folder pages webpart properties and layout.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

<xs:element minOccurs="0" name="categories">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Indicates the "file" (string) that contains category definitions.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

<xs:element minOccurs="0" name="qcStates">

<xs:complexType>

<xs:attribute name="showPrivateDataByDefault" type="xs:boolean">

<xs:annotation>

<xs:documentation>

This setting determines whether users see non-public data by default. Users can
always explicitly choose to see data in any QC state.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation>

Names the file that stores qc state configuration information.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

<xs:element minOccurs="0" name="notifications" type="notificationsType"/>

<xs:element maxOccurs="1" minOccurs="0" name="groups" type="sec:groupsType"/>

<xs:element maxOccurs="1" minOccurs="0" name="roleAssignments" type="ra:roleAssignmentsType"/>

<xs:element minOccurs="0" name="reports" type="exportDirType"/>

<xs:element minOccurs="0" name="queries" type="exportDirType"/>

<xs:element minOccurs="0" name="views" type="exportDirType"/>

<xs:element minOccurs="0" name="lists" type="exportDirType"/>

<xs:element minOccurs="0" name="missingValueIndicator" type="missingValueIndicatorsType"/>

<xs:element minOccurs="0" name="missingValueIndicators" type="study:missingValueIndicatorsType"/>

<xs:element minOccurs="0" name="wikis" type="exportDirType"/>

<xs:element minOccurs="0" name="etls" type="exportDirType"/>

<xs:element minOccurs="0" name="externalSchemas" type="exportDirType"/>

<xs:element minOccurs="0" name="study" type="exportDirType"/>

<xs:element minOccurs="0" name="subfolders" type="exportDirType"/>

<xs:element minOccurs="0" name="moduleProperties" type="modulePropertiesType"/>

<xs:element minOccurs="0" name="xar" type="exportDirType"/>

<xs:element minOccurs="0" name="inventory" type="exportDirType"/>

<xs:element maxOccurs="1" minOccurs="0" name="fileBrowserConfig">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Names the file that stores file browser admin configuration information.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:all>

<xs:attribute name="archiveVersion" type="xs:double">

<xs:annotation>

<xs:documentation>

The version number of the LabKey Server that produced this archive.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="label" type="xs:string">

<xs:annotation>

<xs:documentation>

The label used for naming the folder.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="type" type="xs:string"/>

<xs:attribute name="title" type="xs:string"/>

<xs:attribute name="description" type="xs:string"/>

<xs:attribute name="restrictedColumnsEnabled" type="xs:boolean"/>

<xs:attribute name="defaultDateTimeFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default date-time format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="defaultDateFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default date format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="defaultTimeFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default time format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="defaultNumberFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default number format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="extraDateParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra date parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="extraDateTimeParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra date-time parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="extraTimeParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra time parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

Attribute Detail

archiveVersion

Type:	xs:double, predefined
Use:	optional
Defined:	locally, within (this) folder element

The version number of the LabKey Server that produced this archive.

XML Source (see within schema source)

<xs:attribute name="archiveVersion" type="xs:double">

<xs:annotation>

<xs:documentation>

The version number of the LabKey Server that produced this archive.

</xs:documentation>

</xs:annotation>

</xs:attribute>

defaultDateFormat

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the default date format. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="defaultDateFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default date format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

defaultDateTimeFormat

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the default date-time format. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="defaultDateTimeFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default date-time format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

defaultNumberFormat

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the default number format. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="defaultNumberFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default number format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

defaultTimeFormat

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the default time format. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="defaultTimeFormat" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the default time format. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

description

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:attribute name="description" type="xs:string"/>

extraDateParsingPattern

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the extra date parsing pattern. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="extraDateParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra date parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

extraDateTimeParsingPattern

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the extra date-time parsing pattern. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="extraDateTimeParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra date-time parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

extraTimeParsingPattern

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

Indicates the extra time parsing pattern. See <a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>.

XML Source (see within schema source)

<xs:attribute name="extraTimeParsingPattern" type="xs:string">

<xs:annotation>

<xs:documentation xmlns="http://www.w3.org/1999/xhtml">

Indicates the extra time parsing pattern. See

<a href="https://www.labkey.org/Documentation/wiki-page.view?name=dateFormats" target="_top">Date and Number Formats</a>

</xs:documentation>

</xs:annotation>

</xs:attribute>

label

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

The label used for naming the folder.

XML Source (see within schema source)

<xs:attribute name="label" type="xs:string">

<xs:annotation>

<xs:documentation>

The label used for naming the folder.

</xs:documentation>

</xs:annotation>

</xs:attribute>

restrictedColumnsEnabled

Type:	xs:boolean, predefined
Use:	optional
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:attribute name="restrictedColumnsEnabled" type="xs:boolean"/>

title

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:attribute name="title" type="xs:string"/>

type

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:attribute name="type" type="xs:string"/>

Content Element Detail

categories

Type:	anonymous, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="categories">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Indicates the "file" (string) that contains category definitions.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

etls

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="etls" type="exportDirType"/>

externalSchemas

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="externalSchemas" type="exportDirType"/>

fileBrowserConfig

Type:	anonymous, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="fileBrowserConfig">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Names the file that stores file browser admin configuration information.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

folderType

Type:	folderType, complex content
Defined:	locally, within (this) folder element

The folder type to be used for this container along with which modules should be activated.

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="folderType" type="folderType">

<xs:annotation>

<xs:documentation>

The folder type to be used for this container along with which modules should be activated.

</xs:documentation>

</xs:annotation>

</xs:element>

groups

Type:	sec:groupsType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="groups" type="sec:groupsType"/>

inventory

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="inventory" type="exportDirType"/>

lists

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="lists" type="exportDirType"/>

missingValueIndicator

Type:	missingValueIndicatorsType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="missingValueIndicator" type="missingValueIndicatorsType"/>

missingValueIndicators

Type:	study:missingValueIndicatorsType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="missingValueIndicators" type="study:missingValueIndicatorsType"/>

moduleProperties

Type:	modulePropertiesType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="moduleProperties" type="modulePropertiesType"/>

notifications

Type:	notificationsType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="notifications" type="notificationsType"/>

pages

Type:	anonymous, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="pages">

<xs:complexType>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="en">

Indicates the "file" (string) that lists the folder pages webpart properties and layout.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

qcStates

Type:	anonymous, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="qcStates">

<xs:complexType>

<xs:attribute name="showPrivateDataByDefault" type="xs:boolean">

<xs:annotation>

<xs:documentation>

This setting determines whether users see non-public data by default. Users can
always explicitly choose to see data in any QC state.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="file" type="xs:string">

<xs:annotation>

<xs:documentation>

Names the file that stores qc state configuration information.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

queries

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="queries" type="exportDirType"/>

reports

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="reports" type="exportDirType"/>

roleAssignments

Type:	ra:roleAssignmentsType, complex content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="roleAssignments" type="ra:roleAssignmentsType"/>

searchable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) folder element

The full-text search settings for whether or not to include this folder's content in multi-folder search results.

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="searchable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

The full-text search settings for whether or not to include this folder's content in multi-folder search results.

</xs:documentation>

</xs:annotation>

</xs:element>

study

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="study" type="exportDirType"/>

subfolders

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="subfolders" type="exportDirType"/>

views

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="views" type="exportDirType"/>

wikis

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="wikis" type="exportDirType"/>

xar

Type:	exportDirType, empty content
Defined:	locally, within (this) folder element

XML Source (see within schema source)

<xs:element minOccurs="0" name="xar" type="exportDirType"/>

This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.

DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.

DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).

A commercial license for "DocFlex/XML XSDDoc" will allow you:

To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
To use certain features disabled in the free mode (such as the full documenting of substitution groups).
To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
To document local element components both globally and locally (similar to attributes).
To enable/disable reproducing of namespace prefixes.
To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
To use the same template to generate the incredible quality RTF documentation.
To document only selected XML schema components specified by name.
To remove this very advertisement text

Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!

But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!

Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!

To buy a license, please follow this link: http://www.filigris.com/shop/