complexType "dat:ColumnType"

Namespace:	http://labkey.org/data/xml
Content:	complex, 3+any attributes, 63 elements
Defined:	globally in tableInfo.xsd, see XML source
Includes:	definitions of 3+any attributes and 63 elements
Used:	at 1 location

XML Representation Summary

<...

columnName

xs:string

mvColumnName

xs:string

wrappedColumnName

xs:string

{any attribute with any namespace}

Content:

dat:columnIndex? × dat:datatype? × dat:nullable? × dat:required? × dat:columnTitle? × dat:scale? × dat:precision? × dat:defaultValue? × dat:defaultValueType? × dat:autoFillValue? × dat:isAutoInc? × dat:hasDbSequence? × dat:isDisplayColumn? × dat:isReadOnly? × dat:isUserEditable? × dat:isHidden? × dat:shownInInsertView? × dat:shownInUpdateView? × dat:shownInDetailsView? × dat:shownInLookupView? × dat:measure? × dat:dimension? × dat:keyVariable? × dat:recommendedVariable? × dat:defaultScale? × dat:facetingBehavior? × dat:protected? × dat:excludeFromShifting? × dat:phi? × dat:shouldLog? × dat:isUnselectable? × dat:isMvEnabled? × dat:sortDescending? × dat:inputType? × dat:inputLength? × dat:inputRows? × dat:onChange? × dat:isKeyField? × dat:description? × dat:optionlistQuery? × dat:url? × dat:urlTarget? × dat:displayWidth? × dat:formatString? × dat:conditionalFormats? × dat:validators? × dat:excelFormatString? × dat:tsvFormatString? × dat:textExpression? × dat:textAlign? × dat:propertyURI? × dat:conceptURI? × dat:redactedText? × dat:rangeURI? × dat:sortColumn? × dat:fk? × dat:importAliases? × dat:displayColumnFactory? × dat:principalConceptCode? × dat:ontology? × dat:scannable? × dat:derivationDataScope? × dat:valueExpression?

</...>

Content Model Elements (63):

dat:autoFillValue (in dat:column : dat:ColumnType),

dat:columnIndex (in dat:column : dat:ColumnType),

dat:columnTitle (in dat:column : dat:ColumnType),

dat:conceptURI (in dat:column : dat:ColumnType),

dat:conditionalFormats (in dat:column : dat:ColumnType),

dat:datatype (in dat:column : dat:ColumnType),

dat:defaultScale (in dat:column : dat:ColumnType),

dat:defaultValue (in dat:column : dat:ColumnType),

dat:defaultValueType (in dat:column : dat:ColumnType),

dat:derivationDataScope (in dat:column : dat:ColumnType),

dat:description (type xs:string),

dat:dimension (in dat:column : dat:ColumnType),

dat:displayColumnFactory (in dat:column : dat:ColumnType),

dat:displayWidth (in dat:column : dat:ColumnType),

dat:excelFormatString (in dat:column : dat:ColumnType),

dat:excludeFromShifting (in dat:column : dat:ColumnType),

dat:facetingBehavior (in dat:column : dat:ColumnType),

dat:fk (in dat:column : dat:ColumnType),

dat:formatString (in dat:column : dat:ColumnType),

dat:hasDbSequence (in dat:column : dat:ColumnType),

dat:importAliases (in dat:column : dat:ColumnType),

dat:inputLength (in dat:column : dat:ColumnType),

dat:inputRows (in dat:column : dat:ColumnType),

dat:inputType (in dat:column : dat:ColumnType),

dat:isAutoInc (in dat:column : dat:ColumnType),

dat:isDisplayColumn (in dat:column : dat:ColumnType),

dat:isHidden (in dat:column : dat:ColumnType),

dat:isKeyField (in dat:column : dat:ColumnType),

dat:isMvEnabled (in dat:column : dat:ColumnType),

dat:isReadOnly (in dat:column : dat:ColumnType),

dat:isUnselectable (in dat:column : dat:ColumnType),

dat:isUserEditable (in dat:column : dat:ColumnType),

dat:keyVariable (in dat:column : dat:ColumnType),

dat:measure (in dat:column : dat:ColumnType),

dat:nullable (in dat:column : dat:ColumnType),

dat:onChange (in dat:column : dat:ColumnType),

dat:ontology (in dat:column : dat:ColumnType),

dat:optionlistQuery (in dat:column : dat:ColumnType),

dat:phi (in dat:column : dat:ColumnType),

dat:precision (in dat:column : dat:ColumnType),

dat:principalConceptCode (in dat:column : dat:ColumnType),

dat:propertyURI (in dat:column : dat:ColumnType),

dat:protected (in dat:column : dat:ColumnType),

dat:rangeURI (in dat:column : dat:ColumnType),

dat:redactedText (in dat:column : dat:ColumnType),

dat:required (in dat:column : dat:ColumnType),

dat:scale (in dat:column : dat:ColumnType),

dat:scannable (in dat:column : dat:ColumnType),

dat:shouldLog (in dat:column : dat:ColumnType),

dat:shownInDetailsView (in dat:column : dat:ColumnType),

dat:shownInInsertView (in dat:column : dat:ColumnType),

dat:shownInLookupView (in dat:column : dat:ColumnType),

dat:shownInUpdateView (in dat:column : dat:ColumnType),

dat:sortColumn (in dat:column : dat:ColumnType),

dat:sortDescending (in dat:column : dat:ColumnType),

dat:textAlign (in dat:column : dat:ColumnType),

dat:textExpression (in dat:column : dat:ColumnType),

dat:tsvFormatString (in dat:column : dat:ColumnType),

dat:url (in dat:column : dat:ColumnType),

dat:urlTarget (in dat:column : dat:ColumnType),

dat:validators (in dat:column : dat:ColumnType),

dat:valueExpression (in dat:column : dat:ColumnType)

All Direct / Indirect Based Elements (1):

dat:column (type dat:ColumnType)

Known Usage Locations

As direct type of elements (1):

dat:column (type dat:ColumnType)

Annotation

The definition of column within the table, view or result set.

XML Source (see within schema source)

<xs:complexType name="ColumnType">

<xs:annotation>

<xs:documentation>

The definition of column within the table, view or result set.

</xs:documentation>

</xs:annotation>

<xs:all>

<xs:element minOccurs="0" name="columnIndex" type="xs:int">

<xs:annotation>

<xs:documentation>

Not currently in use. Deprecated, will be removed in the future.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="datatype" type="xs:string">

<xs:annotation>

<xs:documentation>

The name of the SQL datatype of this column as would be specified in a CREATE TABLE statement.
See also the <rangeURI> property.
Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="nullable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Whether or not the column accepts NULLs.
Supported for SQL metadata (inferred from database if not specified),
dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="required" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Whether or not the column is required on insert and update.
Supported for SQL metadata (inferred from database if not specified),
dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="columnTitle" type="xs:string">

<xs:annotation>

<xs:documentation>

The column heading for this column in a data region. If not present, the columnName is used.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="scale" type="xs:int">

<xs:annotation>

<xs:documentation>

The defined maximum or fixed length of the data values in this column.
Supported for SQL metadata (inferred from database if not specified).
For string columns, a value of '-1' indicates the max column size.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="precision" type="xs:int">

<xs:annotation>

<xs:documentation>

For numeric columns only, describes the defined number of digits to the right of the decimal
place for values in this column.
Supported for SQL metadata (inferred from database if not specified).

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="defaultValue" type="xs:string">

<xs:annotation>

<xs:documentation>

The value that this column will take on if a value is not specified for
the column in a data insert (add record) operation.
Supported for SQL metadata and import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="defaultValueType" type="dat:DefaultValueEnumType">

<xs:annotation>

<xs:documentation>

The default value behavior of this column.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="autoFillValue" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isAutoInc" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column is assigned an automatically incrementing value by the database for every
new row inserted.
Supported for SQL metadata (if not specified, LabKey looks for "identity" or "serial" columns),
dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="hasDbSequence" type="dat:DbSequenceType">

<xs:annotation>

<xs:documentation>

True if the column is assigned an automatically incrementing value by the Java code for every
new row inserted. Unlike autoInc columns, the value for this column can be available during
insert without requiring additional selection to occur.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isDisplayColumn" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isReadOnly" type="xs:boolean">

<xs:annotation>

<xs:documentation>

If true, column is assumed to be non-editable and is skipped during any update or insert
operations. Used at the system level. Key values that are not auto-generated are described as
isReadOnly=False and isUserEditable=False.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isUserEditable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column should be shown as editable by a user with appropriate permissions.
If the column is readOnly, this property has no effect.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isHidden" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Set to true if the column should not normally be displayed in a grid view,
but is sent with the form data as a hidden attribute. In the Customize View UI, isHidden fields
are only shown if the "Show Hidden" textbox is selected. Supported for SQL metadata, dataset
import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="shownInInsertView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in insert views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="shownInUpdateView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in update views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="shownInDetailsView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in details views.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="shownInLookupView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Set to true if the column should not be shown in lookup views.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="measure" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Measures are fields that contain data subject to charting and other analysis.
Measures are typically numeric results/observations, like weight, or CD4 count.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="dimension" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Data dimensions define logical groupings of measures. For example, 'Gender'
could be a dimension for a dataset containing a 'Height' measure, since it may be desirable
to study height by gender.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="keyVariable" type="xs:boolean">

<xs:annotation>

<xs:documentation>Deprecated. See recommendedVariable.</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="recommendedVariable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Define which fields in this table/query/etc. are important variables.
These variables may be displayed as recommended variables when creating new charts/reports/etc.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="defaultScale" type="dat:DefaultScaleType">

<xs:annotation>

<xs:documentation>

Defaults to 'LINEAR'. For numeric field types, defines whether linear or log scales will be
used by default for this measure.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="facetingBehavior" type="dat:FacetingBehaviorType">

<xs:annotation>

<xs:documentation>

Defaults to 'AUTOMATIC'. Determines when faceted filtering options are displayed for
columns. Other options are 'ALWAYS_ON' and 'ALWAYS_OFF'.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="protected" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Protected columns are those that contain protected or identifiable information
about participants, such as internal participant IDs, transplant dates, birth dates, etc.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="excludeFromShifting" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Participant date columns with this property checked will not be shifted on export/publication when
the "Shift Participant Dates" option is selected.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="phi" type="dat:PHIType">

<xs:annotation>

<xs:documentation>

Defaults to "Not PHI". Annotates a column with one of four PHI levels (Not PHI, Limited PHI, Full PHI, or Resticted PHI).
Using the Compliance module, administrators can configure the server to control access and logging for PHI annotated fields.
For example, requiring users to have specific PHI security roles and/or to sign terms of use in order to view the annotated fields.
Without additional configuration provided by the Compliance module, LabKey Server ignores this setting.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="shouldLog" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Using the Compliance module, administrators can configure logging behavior for
PHI annotated fields. For example, the server can record the terms of use signed by the user, the PHI level declared
at sign on, the SQL queries invoked, a list of Participant Ids accessed, and the PHI annotated fields accessed.
Without additional configuration provided by the Compliance module, LabKey Server ignores this flag.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isUnselectable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Determines whether the column can be selected in the Query column chooser.
For example, the "Properties" entry cannot be selected.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isMvEnabled" type="xs:boolean">

<xs:annotation>

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

Determines whether the column supports missing value indicators. See the

Missing Value Indicator

</a>

documentation page.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="sortDescending" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column values should normally be sorted in Descending order on first click.
Used for scoring columns where the high-scoring values are most interesting and therefore
should appear first when the column title sort link is clicked.
If sortDescending is false or not present, the first click on the column title sort
link sorts in Ascending order on the column.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="inputType" type="xs:string">

<xs:annotation>

<xs:documentation>

The HTML control type to use for data insert or edit into this column.
Valid values are "select", "hidden", "textarea", "file", "checkbox", and "text".
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="inputLength" type="xs:int">

<xs:annotation>

<xs:documentation>

The width of a text or select input control, in number of characters.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="inputRows" type="xs:int">

<xs:annotation>

<xs:documentation>

The number of rows of text to display if inputType = "textarea".
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="onChange" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="isKeyField" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column is the Primary Key or part of the Primary Key.
Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="description" type="xs:string">

<xs:annotation>

<xs:documentation>

A description of the meaning of the column, appears as hovertext in insert, update, and details views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="optionlistQuery" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="url" type="dat:StringExpressionType">

<xs:annotation>

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

A URL template to use when rendering this column's value. Use the syntax ${ColumnName} to substitute values.
Example: http://www.google.com/search?q=${SearchTerm}.
You may also use an abbreviated syntax for built in urls which omits the context path and folder path.
Example: /wiki/page.view?name=details&id=${Key}
See the full URL documentation for more information:
https://www.labkey.org/Documentation/wiki-page.view?name=propertyFields
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="urlTarget" type="xs:string">

<xs:annotation>

<xs:documentation>

The target attribute for URL links. For example, use "_blank" to open the link in a new window or tab.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="displayWidth" type="xs:string">

<xs:annotation>

<xs:documentation>

The width in pixels to reserve for data values form this column
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="formatString" type="xs:string">

<xs:annotation>

<xs:documentation>

A template that specifies how to format a value from the column on display output (or on export
if the corresponding excel- and tsvFormatString values are not set. Follows the same format
patterns as the following objects in the java.text package: DecimalFormat DateFormat. In
addition to these standard java format patterns, boolean values can be formatted using a template
of the form positive;negative;null, where "positive" is the string to display when true, "negative"
is the string to display when false, and "null" is the string to display when null. For date and
datetime columns the values Date and DateTime can be used to display as
either date or date and time with the currently configured display formats for this folder.
For file and attachment columns, "attachment" to save files as a download, overriding the
default behavior of displaying files like PDFs and images in the browser .
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="conditionalFormats" type="dat:ConditionalFormatsType">

<xs:annotation>

<xs:documentation>

Conditional formats apply formatting options, such text and background colors, or bold text,
selectively based on the value of the cell.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="validators" type="dat:ValidatorsType">

<xs:annotation>

<xs:documentation>

Validators are tested at insert and update time.
Supported for SQL metadata and import/export of datasets, lists, and SND.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="excelFormatString" type="xs:string">

<xs:annotation>

<xs:documentation>

Format string for the column, used when exporting to Excel.
If not present the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="tsvFormatString" type="xs:string">

<xs:annotation>

<xs:documentation>

Format string for the column, used when exporting in TSV format.
If not present, the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="textExpression" type="dat:StringExpressionType">

<xs:annotation>

<xs:documentation>

Expression string for the column used when rendering the column value for display.
If not present, the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="textAlign" type="xs:string">

<xs:annotation>

<xs:documentation>

The horizontal alignment of a data value from this column in a grid.
Valid values are "left", "center" and "right". By default, text values are left-aligned and numeric columns are right-aligned.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="propertyURI" type="xs:string">

<xs:annotation>

<xs:documentation>

An internal identifier for the definition of this column. Valid within the context of the server.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="conceptURI" type="xs:string">

<xs:annotation>

<xs:documentation>

An internal identifier for the concept of this column. Concepts extend the column's type to identify columns that are
participant IDs, user IDs, etc. Valid within the context of the server.
Supported for dataset import/export and list import/export.
Note, this field is not directly related to more recent ontology support in LabKey server.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="redactedText" type="xs:string">

<xs:annotation>

<xs:documentation>

Replacement string for redacted text. Supported for SND import.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="rangeURI" type="xs:string">

<xs:annotation>

<xs:documentation>

The rangeURI identifies the range of values that this column can accept which
can be more specific than the <datatype> property.
For example, a file attachment column has a rangeURI of "http://www.labkey.org/exp/xml#attachment"
and implies a datatype of VARCHAR.
Not all possible sql types can be expressed via rangeURI -- for example, the sql REAL type.
See PropertyType for set of the allowed rangeURI values.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="sortColumn" type="xs:string">

<xs:annotation>

<xs:documentation>

If provided, the value of the provided column will be used when sorting this column instead of the actual value

</xs:documentation>

</xs:annotation>

</xs:element>

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

<xs:annotation>

<xs:documentation>

A structure that describes a foreign key relationship between a column in the current table and
a target column in another table.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:all>

<xs:element minOccurs="0" name="fkFolderPath" type="xs:string">

<xs:annotation>

<xs:documentation>

Absolute path to the folder containing the target table of the relationship.
Example: /Home/support/lists.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="fkTable" type="xs:string">

<xs:annotation>

<xs:documentation>

The name of the target table of the relationship, the "one" side of the many-to-one
relationship.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkColumnName" type="xs:string">

<xs:annotation>

<xs:documentation>

The name of the target column in the target table of the fk relationship. If not
specified, defaults to primary key of the target.
Must be a column that contains 0 or 1 row for any particular value (usually
a primary key or column with a UNIQUE constraint) to prevent row multiplication
when joining.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkDbSchema" type="xs:string">

<xs:annotation>

<xs:documentation>

The name of the schema in which the foreign key target is defined. If empty, the
target ("one" side) table is assumed to exist in the same schema as the "many" side
table.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkMultiValued" type="xs:string">

<xs:annotation>

<xs:documentation>

Use to specify a multi-valued column. Currently, "junction" is the only legal value.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkJunctionLookup" type="xs:string">

<xs:annotation>

<xs:documentation>

Specify the junction lookup column in a many-to-many relationship.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkDisplayColumnName" type="dat:FkDisplayColumnNameType">

<xs:annotation>

<xs:documentation>

The name of the column in the lookup's target that should be shown as the value.
If not specified, defaults to the lookup target's title column.

</xs:documentation>

</xs:annotation>

</xs:element>

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

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="0" name="filterGroup" type="dat:FilterGroupType"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:all>

</xs:complexType>

</xs:element>

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

<xs:annotation>

<xs:documentation>

A collection of aliases by which this column may be named when importing from external files.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

<xs:complexType>

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

<xs:element name="importAlias" type="xs:string"/>

</xs:sequence>

</xs:complexType>

</xs:element>

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

<xs:annotation>

<xs:documentation>

Fully qualified class name and properties for the org.labkey.api.data.DisplayColumnFactory that
this column uses. It needs to have a no-arg constructor as it will be created via reflection.
The following special className values can also be used: 'NOWRAP' (prevents a value from
line-wrapping in the HTML UI), 'NOLOOKUP' (for lookup columns, show the raw FK value instead of
the title column of the lookup's target, and 'DEFAULT' (the standard display behavior).

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

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

<xs:element maxOccurs="1" minOccurs="0" name="properties" type="dat:PropertiesType"/>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element minOccurs="0" name="principalConceptCode" type="xs:string">

<xs:annotation>

<xs:documentation>

Ontology concept code associated with this column.

</xs:documentation>

</xs:annotation>

</xs:element>

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

<xs:annotation>

<xs:documentation>

This is a parent element for ontology related metadata. This includes the description of what this column "measures", as well as
additional information specific to concept-valued columns.

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:all>

<xs:element maxOccurs="1" minOccurs="0" name="concept" type="dat:ConceptType"/>

</xs:all>

</xs:complexType>

</xs:element>

<xs:element minOccurs="0" name="scannable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Indicates that column is used as a searchable value within the application contexts.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element default="ParentOnly" maxOccurs="1" minOccurs="0" name="derivationDataScope" type="dat:DerivationDataScopeTypes">

<xs:annotation>

<xs:documentation>

Field editing scope for aliquots. ParentOnly: Field editable in parent and inherited by aliquot,
ChildOnly: Only editable by aliquot, All: Both parent and aliquot are editable. Default is ParentOnly.

</xs:documentation>

</xs:annotation>

</xs:element>

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

</xs:all>

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

<xs:annotation>

<xs:documentation>

The columnName attribute is required and corresponds in a case-insensitive way to the name of the
underlying column in the table or view.
Required, and supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="mvColumnName" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

DEPRECATED: Do not use this attribute; use isMvEnabled element instead.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="wrappedColumnName" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

The name of the column to wrap. This allows, for example, adding a new, user-specified
lookup based on the value of an existing column without replacing the existing lookup.
DEPRECATED: Do not use this attribute; use expression element instead.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:anyAttribute namespace="##any" processContents="lax"/>

</xs:complexType>

Attribute Detail

columnName

Type:	xs:string, predefined
Use:	required
Defined:	locally, within (this) dat:ColumnType complexType

The columnName attribute is required and corresponds in a case-insensitive way to the name of the underlying column in the table or view. Required, and supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:attribute>

mvColumnName

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) dat:ColumnType complexType

DEPRECATED: Do not use this attribute; use isMvEnabled element instead.

XML Source (see within schema source)

<xs:attribute name="mvColumnName" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

DEPRECATED: Do not use this attribute; use isMvEnabled element instead.

</xs:documentation>

</xs:annotation>

</xs:attribute>

wrappedColumnName

Type:	xs:string, predefined
Use:	optional
Defined:	locally, within (this) dat:ColumnType complexType

The name of the column to wrap. This allows, for example, adding a new, user-specified lookup based on the value of an existing column without replacing the existing lookup. DEPRECATED: Do not use this attribute; use expression element instead.

XML Source (see within schema source)

<xs:attribute name="wrappedColumnName" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:attribute>

{any attribute with any namespace}

Defined:

within (this) dat:ColumnType complexType

XML Source (see within schema source)

<xs:anyAttribute namespace="##any" processContents="lax"/>

Content Element Detail

dat:autoFillValue

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Not currently in use.

XML Source (see within schema source)

<xs:element minOccurs="0" name="autoFillValue" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:columnIndex

Type:	xs:int, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Not currently in use. Deprecated, will be removed in the future.

XML Source (see within schema source)

<xs:element minOccurs="0" name="columnIndex" type="xs:int">

<xs:annotation>

<xs:documentation>

Not currently in use. Deprecated, will be removed in the future.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:columnTitle

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The column heading for this column in a data region. If not present, the columnName is used. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="columnTitle" type="xs:string">

<xs:annotation>

<xs:documentation>

The column heading for this column in a data region. If not present, the columnName is used.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:conceptURI

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

An internal identifier for the concept of this column. Concepts extend the column's type to identify columns that are participant IDs, user IDs, etc. Valid within the context of the server. Supported for dataset import/export and list import/export. Note, this field is not directly related to more recent ontology support in LabKey server.

XML Source (see within schema source)

<xs:element minOccurs="0" name="conceptURI" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:conditionalFormats

Type:	dat:ConditionalFormatsType, complex content
Defined:	locally, within (this) dat:ColumnType complexType

Conditional formats apply formatting options, such text and background colors, or bold text, selectively based on the value of the cell. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="conditionalFormats" type="dat:ConditionalFormatsType">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:datatype

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The name of the SQL datatype of this column as would be specified in a CREATE TABLE statement. See also the <rangeURI> property. Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="datatype" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:defaultScale

Type:	dat:DefaultScaleType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to 'LINEAR'. For numeric field types, defines whether linear or log scales will be used by default for this measure.

XML Source (see within schema source)

<xs:element minOccurs="0" name="defaultScale" type="dat:DefaultScaleType">

<xs:annotation>

<xs:documentation>

Defaults to 'LINEAR'. For numeric field types, defines whether linear or log scales will be
used by default for this measure.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:defaultValue

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The value that this column will take on if a value is not specified for the column in a data insert (add record) operation. Supported for SQL metadata and import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="defaultValue" type="xs:string">

<xs:annotation>

<xs:documentation>

The value that this column will take on if a value is not specified for
the column in a data insert (add record) operation.
Supported for SQL metadata and import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:defaultValueType

Type:	dat:DefaultValueEnumType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The default value behavior of this column.

XML Source (see within schema source)

<xs:element minOccurs="0" name="defaultValueType" type="dat:DefaultValueEnumType">

<xs:annotation>

<xs:documentation>

The default value behavior of this column.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:derivationDataScope

Type:	dat:DerivationDataScopeTypes, simple content
Default:	"ParentOnly"
Defined:	locally, within (this) dat:ColumnType complexType

Field editing scope for aliquots. ParentOnly: Field editable in parent and inherited by aliquot, ChildOnly: Only editable by aliquot, All: Both parent and aliquot are editable. Default is ParentOnly.

XML Source (see within schema source)

<xs:element default="ParentOnly" maxOccurs="1" minOccurs="0" name="derivationDataScope" type="dat:DerivationDataScopeTypes">

<xs:annotation>

<xs:documentation>

Field editing scope for aliquots. ParentOnly: Field editable in parent and inherited by aliquot,
ChildOnly: Only editable by aliquot, All: Both parent and aliquot are editable. Default is ParentOnly.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:description

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

A description of the meaning of the column, appears as hovertext in insert, update, and details views. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="description" type="xs:string">

<xs:annotation>

<xs:documentation>

A description of the meaning of the column, appears as hovertext in insert, update, and details views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:dimension

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Data dimensions define logical groupings of measures. For example, 'Gender' could be a dimension for a dataset containing a 'Height' measure, since it may be desirable to study height by gender.

XML Source (see within schema source)

<xs:element minOccurs="0" name="dimension" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:displayColumnFactory

Type:	anonymous, complex content
Defined:	locally, within (this) dat:ColumnType complexType

Fully qualified class name and properties for the org.labkey.api.data.DisplayColumnFactory that this column uses. It needs to have a no-arg constructor as it will be created via reflection. The following special className values can also be used: 'NOWRAP' (prevents a value from line-wrapping in the HTML UI), 'NOLOOKUP' (for lookup columns, show the raw FK value instead of the title column of the lookup's target, and 'DEFAULT' (the standard display behavior).

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

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

<xs:element maxOccurs="1" minOccurs="0" name="properties" type="dat:PropertiesType"/>

</xs:sequence>

</xs:complexType>

</xs:element>

dat:displayWidth

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The width in pixels to reserve for data values form this column Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="displayWidth" type="xs:string">

<xs:annotation>

<xs:documentation>

The width in pixels to reserve for data values form this column
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:excelFormatString

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Format string for the column, used when exporting to Excel. If not present the formatString is used, if present. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="excelFormatString" type="xs:string">

<xs:annotation>

<xs:documentation>

Format string for the column, used when exporting to Excel.
If not present the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:excludeFromShifting

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Participant date columns with this property checked will not be shifted on export/publication when the "Shift Participant Dates" option is selected.

XML Source (see within schema source)

<xs:element minOccurs="0" name="excludeFromShifting" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Participant date columns with this property checked will not be shifted on export/publication when
the "Shift Participant Dates" option is selected.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:facetingBehavior

Type:	dat:FacetingBehaviorType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to 'AUTOMATIC'. Determines when faceted filtering options are displayed for columns. Other options are 'ALWAYS_ON' and 'ALWAYS_OFF'.

XML Source (see within schema source)

<xs:element minOccurs="0" name="facetingBehavior" type="dat:FacetingBehaviorType">

<xs:annotation>

<xs:documentation>

Defaults to 'AUTOMATIC'. Determines when faceted filtering options are displayed for
columns. Other options are 'ALWAYS_ON' and 'ALWAYS_OFF'.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:fk

Type:	anonymous, complex content
Defined:	locally, within (this) dat:ColumnType complexType

A structure that describes a foreign key relationship between a column in the current table and a target column in another table. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:all>

<xs:element minOccurs="0" name="fkFolderPath" type="xs:string">

<xs:annotation>

<xs:documentation>

Absolute path to the folder containing the target table of the relationship.
Example: /Home/support/lists.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="fkTable" type="xs:string">

<xs:annotation>

<xs:documentation>

The name of the target table of the relationship, the "one" side of the many-to-one
relationship.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkColumnName" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkDbSchema" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkMultiValued" type="xs:string">

<xs:annotation>

<xs:documentation>

Use to specify a multi-valued column. Currently, "junction" is the only legal value.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkJunctionLookup" type="xs:string">

<xs:annotation>

<xs:documentation>

Specify the junction lookup column in a many-to-many relationship.

</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element minOccurs="0" name="fkDisplayColumnName" type="dat:FkDisplayColumnNameType">

<xs:annotation>

<xs:documentation>

The name of the column in the lookup's target that should be shown as the value.
If not specified, defaults to the lookup target's title column.

</xs:documentation>

</xs:annotation>

</xs:element>

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

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="0" name="filterGroup" type="dat:FilterGroupType"/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:all>

</xs:complexType>

</xs:element>

dat:formatString

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

A template that specifies how to format a value from the column on display output (or on export if the corresponding excel- and tsvFormatString values are not set. Follows the same format patterns as the following objects in the java.text package: DecimalFormat DateFormat. In addition to these standard java format patterns, boolean values can be formatted using a template of the form positive;negative;null, where "positive" is the string to display when true, "negative" is the string to display when false, and "null" is the string to display when null. For date and datetime columns the values Date and DateTime can be used to display as either date or date and time with the currently configured display formats for this folder. For file and attachment columns, "attachment" to save files as a download, overriding the default behavior of displaying files like PDFs and images in the browser . Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="formatString" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:hasDbSequence

Type:	dat:DbSequenceType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

True if the column is assigned an automatically incrementing value by the Java code for every new row inserted. Unlike autoInc columns, the value for this column can be available during insert without requiring additional selection to occur.

XML Source (see within schema source)

<xs:element minOccurs="0" name="hasDbSequence" type="dat:DbSequenceType">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:importAliases

Type:	anonymous, complex content
Defined:	locally, within (this) dat:ColumnType complexType

A collection of aliases by which this column may be named when importing from external files. Supported for dataset import/export and list import/export.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

A collection of aliases by which this column may be named when importing from external files.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

<xs:complexType>

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

<xs:element name="importAlias" type="xs:string"/>

</xs:sequence>

</xs:complexType>

</xs:element>

dat:inputLength

Type:	xs:int, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The width of a text or select input control, in number of characters. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="inputLength" type="xs:int">

<xs:annotation>

<xs:documentation>

The width of a text or select input control, in number of characters.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:inputRows

Type:	xs:int, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The number of rows of text to display if inputType = "textarea". Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="inputRows" type="xs:int">

<xs:annotation>

<xs:documentation>

The number of rows of text to display if inputType = "textarea".
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:inputType

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The HTML control type to use for data insert or edit into this column. Valid values are "select", "hidden", "textarea", "file", "checkbox", and "text". Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="inputType" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isAutoInc

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

True if the column is assigned an automatically incrementing value by the database for every new row inserted. Supported for SQL metadata (if not specified, LabKey looks for "identity" or "serial" columns), dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isAutoInc" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isDisplayColumn

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Not currently in use.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isDisplayColumn" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isHidden

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Set to true if the column should not normally be displayed in a grid view, but is sent with the form data as a hidden attribute. In the Customize View UI, isHidden fields are only shown if the "Show Hidden" textbox is selected. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isHidden" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isKeyField

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

True if the column is the Primary Key or part of the Primary Key. Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isKeyField" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column is the Primary Key or part of the Primary Key.
Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isMvEnabled

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Determines whether the column supports missing value indicators. See the <a href="https://www.labkey.org/Documentation/wiki-page.view?name=manageMissing" target="_top"> Missing Value Indicator</a> documentation page. Supported for dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isMvEnabled" type="xs:boolean">

<xs:annotation>

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

Determines whether the column supports missing value indicators. See the

Missing Value Indicator

</a>

documentation page.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isReadOnly

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

If true, column is assumed to be non-editable and is skipped during any update or insert operations. Used at the system level. Key values that are not auto-generated are described as isReadOnly=False and isUserEditable=False. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isReadOnly" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isUnselectable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Determines whether the column can be selected in the Query column chooser. For example, the "Properties" entry cannot be selected. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isUnselectable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Determines whether the column can be selected in the Query column chooser.
For example, the "Properties" entry cannot be selected.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:isUserEditable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

True if the column should be shown as editable by a user with appropriate permissions. If the column is readOnly, this property has no effect. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="isUserEditable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

True if the column should be shown as editable by a user with appropriate permissions.
If the column is readOnly, this property has no effect.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:keyVariable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Deprecated. See recommendedVariable.

XML Source (see within schema source)

<xs:element minOccurs="0" name="keyVariable" type="xs:boolean">

<xs:annotation>

<xs:documentation>Deprecated. See recommendedVariable.</xs:documentation>

</xs:annotation>

</xs:element>

dat:measure

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Measures are fields that contain data subject to charting and other analysis. Measures are typically numeric results/observations, like weight, or CD4 count.

XML Source (see within schema source)

<xs:element minOccurs="0" name="measure" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Measures are fields that contain data subject to charting and other analysis.
Measures are typically numeric results/observations, like weight, or CD4 count.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:nullable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Whether or not the column accepts NULLs. Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="nullable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Whether or not the column accepts NULLs.
Supported for SQL metadata (inferred from database if not specified),
dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:onChange

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Not currently in use.

XML Source (see within schema source)

<xs:element minOccurs="0" name="onChange" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:ontology

Type:	anonymous, complex content
Defined:	locally, within (this) dat:ColumnType complexType

This is a parent element for ontology related metadata. This includes the description of what this column "measures", as well as additional information specific to concept-valued columns.

XML Source (see within schema source)

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

<xs:annotation>

<xs:documentation>

This is a parent element for ontology related metadata. This includes the description of what this column "measures", as well as
additional information specific to concept-valued columns.

</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:all>

<xs:element maxOccurs="1" minOccurs="0" name="concept" type="dat:ConceptType"/>

</xs:all>

</xs:complexType>

</xs:element>

dat:optionlistQuery

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Not currently in use.

XML Source (see within schema source)

<xs:element minOccurs="0" name="optionlistQuery" type="xs:string">

<xs:annotation>

<xs:documentation>

Not currently in use.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:phi

Type:	dat:PHIType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to "Not PHI". Annotates a column with one of four PHI levels (Not PHI, Limited PHI, Full PHI, or Resticted PHI). Using the Compliance module, administrators can configure the server to control access and logging for PHI annotated fields. For example, requiring users to have specific PHI security roles and/or to sign terms of use in order to view the annotated fields. Without additional configuration provided by the Compliance module, LabKey Server ignores this setting.

XML Source (see within schema source)

<xs:element minOccurs="0" name="phi" type="dat:PHIType">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:precision

Type:	xs:int, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

For numeric columns only, describes the defined number of digits to the right of the decimal place for values in this column. Supported for SQL metadata (inferred from database if not specified).

XML Source (see within schema source)

<xs:element minOccurs="0" name="precision" type="xs:int">

<xs:annotation>

<xs:documentation>

For numeric columns only, describes the defined number of digits to the right of the decimal
place for values in this column.
Supported for SQL metadata (inferred from database if not specified).

</xs:documentation>

</xs:annotation>

</xs:element>

dat:principalConceptCode

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Ontology concept code associated with this column.

XML Source (see within schema source)

<xs:element minOccurs="0" name="principalConceptCode" type="xs:string">

<xs:annotation>

<xs:documentation>

Ontology concept code associated with this column.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:propertyURI

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

An internal identifier for the definition of this column. Valid within the context of the server. Supported for dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="propertyURI" type="xs:string">

<xs:annotation>

<xs:documentation>

An internal identifier for the definition of this column. Valid within the context of the server.
Supported for dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:protected

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Protected columns are those that contain protected or identifiable information about participants, such as internal participant IDs, transplant dates, birth dates, etc.

XML Source (see within schema source)

<xs:element minOccurs="0" name="protected" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Protected columns are those that contain protected or identifiable information
about participants, such as internal participant IDs, transplant dates, birth dates, etc.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:rangeURI

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The rangeURI identifies the range of values that this column can accept which can be more specific than the <datatype> property. For example, a file attachment column has a rangeURI of "http://www.labkey.org/exp/xml#attachment" and implies a datatype of VARCHAR. Not all possible sql types can be expressed via rangeURI -- for example, the sql REAL type. See PropertyType for set of the allowed rangeURI values. Supported for dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="rangeURI" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:recommendedVariable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Define which fields in this table/query/etc. are important variables. These variables may be displayed as recommended variables when creating new charts/reports/etc.

XML Source (see within schema source)

<xs:element minOccurs="0" name="recommendedVariable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Define which fields in this table/query/etc. are important variables.
These variables may be displayed as recommended variables when creating new charts/reports/etc.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:redactedText

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Replacement string for redacted text. Supported for SND import.

XML Source (see within schema source)

<xs:element minOccurs="0" name="redactedText" type="xs:string">

<xs:annotation>

<xs:documentation>

Replacement string for redacted text. Supported for SND import.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:required

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Whether or not the column is required on insert and update. Supported for SQL metadata (inferred from database if not specified), dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="required" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Whether or not the column is required on insert and update.
Supported for SQL metadata (inferred from database if not specified),
dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:scale

Type:	xs:int, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The defined maximum or fixed length of the data values in this column. Supported for SQL metadata (inferred from database if not specified). For string columns, a value of '-1' indicates the max column size.

XML Source (see within schema source)

<xs:element minOccurs="0" name="scale" type="xs:int">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:scannable

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Indicates that column is used as a searchable value within the application contexts.

XML Source (see within schema source)

<xs:element minOccurs="0" name="scannable" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Indicates that column is used as a searchable value within the application contexts.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:shouldLog

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to true. Using the Compliance module, administrators can configure logging behavior for PHI annotated fields. For example, the server can record the terms of use signed by the user, the PHI level declared at sign on, the SQL queries invoked, a list of Participant Ids accessed, and the PHI annotated fields accessed. Without additional configuration provided by the Compliance module, LabKey Server ignores this flag.

XML Source (see within schema source)

<xs:element minOccurs="0" name="shouldLog" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:shownInDetailsView

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to true. Set to false if the column should not be shown in details views.

XML Source (see within schema source)

<xs:element minOccurs="0" name="shownInDetailsView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in details views.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:shownInInsertView

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to true. Set to false if the column should not be shown in insert views. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="shownInInsertView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in insert views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:shownInLookupView

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to false. Set to true if the column should not be shown in lookup views.

XML Source (see within schema source)

<xs:element minOccurs="0" name="shownInLookupView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to false. Set to true if the column should not be shown in lookup views.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:shownInUpdateView

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Defaults to true. Set to false if the column should not be shown in update views. Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="shownInUpdateView" type="xs:boolean">

<xs:annotation>

<xs:documentation>

Defaults to true. Set to false if the column should not be shown in update views.
Supported for SQL metadata, dataset import/export and list import/export.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:sortColumn

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

If provided, the value of the provided column will be used when sorting this column instead of the actual value

XML Source (see within schema source)

<xs:element minOccurs="0" name="sortColumn" type="xs:string">

<xs:annotation>

<xs:documentation>

If provided, the value of the provided column will be used when sorting this column instead of the actual value

</xs:documentation>

</xs:annotation>

</xs:element>

dat:sortDescending

Type:	xs:boolean, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

True if the column values should normally be sorted in Descending order on first click. Used for scoring columns where the high-scoring values are most interesting and therefore should appear first when the column title sort link is clicked. If sortDescending is false or not present, the first click on the column title sort link sorts in Ascending order on the column. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="sortDescending" type="xs:boolean">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:textAlign

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The horizontal alignment of a data value from this column in a grid. Valid values are "left", "center" and "right". By default, text values are left-aligned and numeric columns are right-aligned. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="textAlign" type="xs:string">

<xs:annotation>

<xs:documentation>

</xs:documentation>

</xs:annotation>

</xs:element>

dat:textExpression

Type:	dat:StringExpressionType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Expression string for the column used when rendering the column value for display. If not present, the formatString is used, if present. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="textExpression" type="dat:StringExpressionType">

<xs:annotation>

<xs:documentation>

Expression string for the column used when rendering the column value for display.
If not present, the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:tsvFormatString

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

Format string for the column, used when exporting in TSV format. If not present, the formatString is used, if present. Supported for SQL metadata.

XML Source (see within schema source)

<xs:element minOccurs="0" name="tsvFormatString" type="xs:string">

<xs:annotation>

<xs:documentation>

Format string for the column, used when exporting in TSV format.
If not present, the formatString is used, if present.
Supported for SQL metadata.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:url

Type:	dat:StringExpressionType, simple content
Defined:	locally, within (this) dat:ColumnType complexType

A URL template to use when rendering this column's value. Use the syntax ${ColumnName} to substitute values. Example: http://www.google.com/search?q=${SearchTerm}. You may also use an abbreviated syntax for built in urls which omits the context path and folder path. Example: /wiki/page.view?name=details&id=${Key} See the full URL documentation for more information: https://www.labkey.org/Documentation/wiki-page.view?name=propertyFields Supported for SQL metadata, dataset import/export and list import/export.

XML Source (see within schema source)

<xs:element minOccurs="0" name="url" type="dat:StringExpressionType">

<xs:annotation>

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

</xs:documentation>

</xs:annotation>

</xs:element>

dat:urlTarget

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

The target attribute for URL links. For example, use "_blank" to open the link in a new window or tab.

XML Source (see within schema source)

<xs:element minOccurs="0" name="urlTarget" type="xs:string">

<xs:annotation>

<xs:documentation>

The target attribute for URL links. For example, use "_blank" to open the link in a new window or tab.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:validators

Type:	dat:ValidatorsType, complex content
Defined:	locally, within (this) dat:ColumnType complexType

Validators are tested at insert and update time. Supported for SQL metadata and import/export of datasets, lists, and SND.

XML Source (see within schema source)

<xs:element minOccurs="0" name="validators" type="dat:ValidatorsType">

<xs:annotation>

<xs:documentation>

Validators are tested at insert and update time.
Supported for SQL metadata and import/export of datasets, lists, and SND.

</xs:documentation>

</xs:annotation>

</xs:element>

dat:valueExpression

Type:	xs:string, predefined, simple content
Defined:	locally, within (this) dat:ColumnType complexType

XML Source (see within schema source)

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

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/