XML Schema "folder.xsd"

Target Namespace:

Defined Components:

2 global elements, 31 local elements, 8 complexTypes

Default Namespace-Qualified Form:

Local Elements: qualified; Local Attributes: unqualified

Schema Location:

C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\folder.xsd, see XML source

Imports Schemas (3):

roleAssignments.xsd [src], security.xsd [src], study.xsd [src]

Annotation

Describes a folder. This is the top-level file in a folder archive. It defines the top-level folder settings and points to the other files in the archive.

XML Source

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://labkey.org/folder/xml" xmlns="http://labkey.org/folder/xml" xmlns:ra="http://labkey.org/security/xml/roleAssignment" xmlns:sec="http://labkey.org/security/xml" xmlns:study="http://labkey.org/study/xml" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:import namespace="http://labkey.org/study/xml" schemaLocation="study.xsd"/>

<xs:import namespace="http://labkey.org/security/xml" schemaLocation="security.xsd"/>

<xs:import namespace="http://labkey.org/security/xml/roleAssignment" schemaLocation="roleAssignments.xsd"/>

<xs:annotation>

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

Describes a folder. This is the top-level file in a folder archive. It defines the top-level folder
settings and points to the other files in the archive.

</xs:documentation>

</xs:annotation>

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

<xs:complexType name="exportDirType">

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

<xs:annotation>

<xs:documentation>

Names the directory that contains exported resource.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

<xs:complexType name="folderType">

<xs:all>

<xs:element maxOccurs="1" minOccurs="0" name="defaultModule" type="xs:string"/>

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

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="1" name="moduleName" type="xs:string"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:all>

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

</xs:complexType>

<xs:element name="subfolders" type="subfoldersType"/>

<xs:complexType name="subfoldersType">

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="0" name="subfolder" type="subfolderType"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="subfolderType">

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

<xs:annotation>

<xs:documentation>The subfolder's name</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

<xs:complexType name="notificationsType">

<xs:all>

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

<xs:complexType>

<xs:attribute name="id" type="xs:int">

<xs:annotation>

<xs:documentation>

The email option id for the folder default setting for message board notifications.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The email option label for the folder default setting for message board notifications.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

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

<xs:complexType>

<xs:attribute name="id" type="xs:int">

<xs:annotation>

<xs:documentation>

The email option id for the folder default setting for file content event notifications.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The email option label for the folder default setting for file content event notifications.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:all>

</xs:complexType>

<xs:complexType name="modulePropertiesType">

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="0" name="moduleProperty" type="modulePropertyType"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="modulePropertyType">

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

<xs:annotation>

<xs:documentation>The name of the module</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>The name of the property</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>Container-specific value of the property</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

<xs:complexType name="missingValueIndicatorsType">

<xs:sequence maxOccurs="unbounded" minOccurs="0">

<xs:element name="missingValueIndicator">

<xs:complexType>

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

<xs:annotation>

<xs:documentation>

The indicator to use for a certain type of missing values (e.g., "N").

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The text to use in association with this indicator in the UI
(e.g., "Required field marked by site as 'data not available'.").

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:sequence>

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

<xs:annotation>

<xs:documentation>

The file that contains the list of missing value indicators.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:schema>

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/