LabKey XML Schema Reference
Dec 8, 2023, 3:27:25 PM
Namespace Summary
http://cpas.fhcrc.org/exp/xml
Targeting Schemas (1):
Targeting Components:
http://cpas.fhcrc.org/pipeline/protocol/xml
Targeting Schemas (1):
Targeting Components:
http://labkey.org/clientLibrary/xml/
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml
Targeting Schemas (2):
Targeting Components:
http://labkey.org/data/xml/domainTemplate
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/externalSchema
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/folderType
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/query
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/queryCustomView
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/reportProps
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/view
Targeting Schemas (1):
Targeting Components:
http://labkey.org/data/xml/webpart
Targeting Schemas (1):
Targeting Components:
http://labkey.org/folder/xml
Targeting Schemas (2):
Targeting Components:
http://labkey.org/folder/xml/viewCategory
Targeting Schemas (1):
Targeting Components:
http://labkey.org/list/xml
Targeting Schemas (1):
Targeting Components:
http://labkey.org/moduleProperties/xml/
Targeting Schemas (1):
Targeting Components:
http://labkey.org/query/xml
Targeting Schemas (2):
Targeting Components:
http://labkey.org/security/xml
Targeting Schemas (1):
Targeting Components:
http://labkey.org/security/xml/roleAssignment
Targeting Schemas (1):
Targeting Components:
http://labkey.org/study/assay/xml
Targeting Schemas (1):
Targeting Components:
http://labkey.org/study/xml
Targeting Schemas (5):
Targeting Components:
http://labkey.org/study/xml/participantGroups
Targeting Schemas (1):
Targeting Components:
http://labkey.org/study/xml/qcStates
Targeting Schemas (1):
Targeting Components:
http://labkey.org/study/xml/studyViews
Targeting Schemas (1):
Targeting Components:
http://www.w3.org/1999/02/22-rdf-syntax-ns#
Targeting Schemas (1):
Targeting Components:
Schema Summary
apiTest.xsd LabKey API test data
Target Namespace:
Defined Components:
1 global element, 4 local elements, 1 complexType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\apiTest.xsd, see XML source
assayProvider.xsd Target Namespace:
Defined Components:
2 global elements, 19 local elements, 2 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\assay\schemas\assayProvider.xsd, see XML source
Imports Schema:
clientLibrary.xsd Describes client libraries, which includes JS and CSS files, or packages composed of them.
Target Namespace:
Defined Components:
1 global element, 6 local elements, 7 complexTypes, 1 simpleType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\clientLibrary.xsd, see XML source
cohorts.xsd Describes a study's cohort assignments.
Target Namespace:
Defined Components:
1 global element, 3 local elements
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\cohorts.xsd, see XML source
datasets.xsd Describes the study dataset manifest.
Target Namespace:
Defined Components:
1 global element, 3 local elements
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\datasets.xsd, see XML source
domainTemplate.xsd Describes the module resource domain templates (i.e.
Target Namespace:
Defined Components:
2 global elements, 16 local elements, 17 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\domainTemplate.xsd, see XML source
Imports Schema:
expTypes.xsd Target Namespace:
Version:
10.3
Defined Components:
1 global element, 145 local elements, 34 complexTypes, 4 simpleTypes, 1 element group
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\expTypes.xsd, see XML source
Imports Schemas (2):
Imported by Schemas (2):
externalSchema.xsd Target Namespace:
Defined Components:
3 global elements, 3 local elements, 4 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\externalSchema.xsd, see XML source
Imports Schemas (2):
folder.xsd Describes a folder.
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):
folderType.xsd Target Namespace:
Defined Components:
23 global elements, 5 local elements, 4 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\folderType.xsd, see XML source
Imports Schema:
lists.xsd Describes the list settings, list-specific properties beyond those included in tableInfo.xsd.
Target Namespace:
Defined Components:
1 global element, 1 local element
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\list\schemas\lists.xsd, see XML source
module.xsd Describes module properties.
Target Namespace:
Defined Components:
1 global element, 19 local elements, 8 complexTypes, 1 simpleType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\module.xsd, see XML source
pages.xsd Describes the webpart properties and layout for a folder export archive.
Target Namespace:
Defined Components:
1 global element, 10 local elements
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\pages.xsd, see XML source
participantGroups.xsd Participant Groups
Target Namespace:
Defined Components:
1 global element, 3 local elements, 3 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\participantGroups.xsd, see XML source
pipelineOptions.xsd Pipeline Options
Target Namespace:
Defined Components:
1 global element, 12 local elements, 3 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\pipelineOptions.xsd, see XML source
pipelineProtocolProps.xsd Target Namespace:
Defined Components:
1 global element, 1 local element
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\pipelineProtocolProps.xsd, see XML source
qcStates.xsd Describes the study QC states manifest.
Target Namespace:
Defined Components:
1 global element, 8 local elements, 1 simpleType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\qcStates.xsd, see XML source
query.xsd Target Namespace:
Defined Components:
1 global element, 2 local elements, 1 complexType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\query.xsd, see XML source
queryCustomView.xsd File-based Query Custom View Definition
Target Namespace:
Defined Components:
1 global element, 13 local elements, 15 complexTypes, 3 simpleTypes, 1 element group
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\queryCustomView.xsd, see XML source
Imported by Schemas (2):
rdfTypes.xsd Target Namespace:
Version:
1.1
Defined Components:
1 simpleType, 4 global attributes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\rdfTypes.xsd, see XML source
Imports Schema:
Imported by Schema:
report.xsd Report
Target Namespace:
Defined Components:
1 global element, 22 local elements, 10 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\report.xsd, see XML source
reportProps.xsd Target Namespace:
Defined Components:
3 global elements, 1 complexType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\reportProps.xsd, see XML source
roleAssignments.xsd Target Namespace:
Defined Components:
4 local elements, 3 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\roleAssignments.xsd, see XML source
Imports Schema:
Imported by Schema:
security.xsd Target Namespace:
Defined Components:
5 local elements, 6 complexTypes, 1 simpleType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\security.xsd, see XML source
Imported by Schemas (2):
study.xsd Describes a file-based study.
Target Namespace:
Defined Components:
1 global element, 19 local elements, 2 complexTypes, 4 simpleTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\study.xsd, see XML source
Imported by Schema:
studyDesign.xsd Target Namespace:
Defined Components:
1 global element, 30 local elements, 18 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\studyDesign.xsd, see XML source
studyViews.xsd Study Views Configuration
Target Namespace:
Defined Components:
1 global element, 1 local element
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\studyViews.xsd, see XML source
tableInfo.xsd Describes metadata for any database table in LabKey Server, including lists and datasets.
Target Namespace:
Defined Components:
1 global element, 141 local elements, 30 complexTypes, 10 simpleTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\tableInfo.xsd, see XML source
Imports Schema:
Imported by Schemas (3):
view.xsd File-based View Metadata file
Target Namespace:
Defined Components:
1 global element, 7 local elements, 6 complexTypes, 3 simpleTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\view.xsd, see XML source
viewCategory.xsd View Categories
Target Namespace:
Defined Components:
1 global element, 1 local element, 2 complexTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\viewCategory.xsd, see XML source
visitMap.xsd Describes the study visit map.
Target Namespace:
Defined Components:
1 global element, 9 local elements, 1 simpleType
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\visitMap.xsd, see XML source
webpart.xsd File-based WebPart Definition
Target Namespace:
Defined Components:
1 global element, 6 local elements, 6 complexTypes, 4 simpleTypes
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\dev\labkey\labkeyHome\server\modules\platform\api\schemas\webpart.xsd, see XML source
Imported by 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/