element <dataset>

Namespace:	http://labkey.org/study/xml
Type:	anonymous complexType
Content:	complex, 9 attributes, 1 element
Defined:	locally within element datasets in datasets.xsd, see XML source
Includes:	definitions of 9 attributes and 1 element

XML Representation Summary

<dataset

category

xs:string

cohort

xs:string

demographicData

xs:boolean : "false"

xs:int

xs:string

xs:boolean : "true"

xs:string

xs:string

xs:boolean

Content:

tags?

</dataset>

Content model elements (1):

tags (in dataset in datasets in datasets)

Included in content model of elements (1):

datasets (in datasets)

Definition Locations

Within anonymous complexTypes of elements (1):
datasets (in datasets) [def]

XML Source (see within schema source)

<xs:element name="dataset">

<xs:complexType>

<xs:all>

<xs:element maxOccurs="1" minOccurs="0" name="tags" type="props:propertyList">

<xs:annotation>

<xs:documentation>

Properties associated with this dataset.

</xs:documentation>

</xs:annotation>

</xs:element>

</xs:all>

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

<xs:annotation>

<xs:documentation>

The name of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The integer identifier of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Each dataset can belong to one category. Datasets are grouped together
by category in the UI.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

This dataset-wide cohort setting will specify a cohort if the dataset
is used exclusively with one cohort.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute default="true" name="showByDefault" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Determines whether the dataset is displayed in the UI by default.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute default="false" name="demographicData" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Indicates whether this dataset contains demographic data.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Specifies the type of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Provides additional user-defined categorization.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Use the time portion of the date field as a key field.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

Attribute Detail

category

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

Each dataset can belong to one category. Datasets are grouped together by category in the UI.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

Each dataset can belong to one category. Datasets are grouped together
by category in the UI.

</xs:documentation>

</xs:annotation>

</xs:attribute>

cohort

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

This dataset-wide cohort setting will specify a cohort if the dataset is used exclusively with one cohort.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

This dataset-wide cohort setting will specify a cohort if the dataset
is used exclusively with one cohort.

</xs:documentation>

</xs:annotation>

</xs:attribute>

demographicData

Type:	xs:boolean, predefined
Use:	optional
Default:	"false"
Defined:	locally, within (this) dataset element

Indicates whether this dataset contains demographic data.

XML Source (see within schema source)

<xs:attribute default="false" name="demographicData" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Indicates whether this dataset contains demographic data.

</xs:documentation>

</xs:annotation>

</xs:attribute>

Type:	xs:int, predefined
Use:	required
Defined:	locally, within (this) dataset element

The integer identifier of the dataset.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

The integer identifier of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

name

Type:	xs:string, predefined
Use:	required
Defined:	locally, within (this) dataset element

The name of the dataset.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

The name of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

showByDefault

Type:	xs:boolean, predefined
Use:	optional
Default:	"true"
Defined:	locally, within (this) dataset element

Determines whether the dataset is displayed in the UI by default.

XML Source (see within schema source)

<xs:attribute default="true" name="showByDefault" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Determines whether the dataset is displayed in the UI by default.

</xs:documentation>

</xs:annotation>

</xs:attribute>

tag

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

Provides additional user-defined categorization.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

Provides additional user-defined categorization.

</xs:documentation>

</xs:annotation>

</xs:attribute>

type

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

Specifies the type of the dataset.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

Specifies the type of the dataset.

</xs:documentation>

</xs:annotation>

</xs:attribute>

useTimeKeyField

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

Use the time portion of the date field as a key field.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

Use the time portion of the date field as a key field.

</xs:documentation>

</xs:annotation>

</xs:attribute>

Content Element Detail

tags

Type:	props:propertyList, complex content
Defined:	locally, within (this) dataset element

Properties associated with this dataset.

XML Source (see within schema source)

<xs:element maxOccurs="1" minOccurs="0" name="tags" type="props:propertyList">

<xs:annotation>

<xs:documentation>

Properties associated with this dataset.

</xs:documentation>

</xs:annotation>

</xs:element>

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/