XML Schema "visitMap.xsd"

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

Annotation

Describes the study visit map. It is used to generate the visitMap.xml file, which describes the study's visits and includes all of the information that can be set within the "Manage Visit" UI within "Manage Study."

XML Source

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

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

<xs:annotation>

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

Describes the study visit map. It is used to generate the visitMap.xml file, which
describes the study's visits and includes all of the information that can be set within the "Manage Visit" UI
within "Manage Study."

</xs:documentation>

</xs:annotation>

<xs:element name="visitMap">

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="0" name="visit">

<xs:complexType>

<xs:all minOccurs="0">

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

<xs:complexType>

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

<xs:element name="dataset">

<xs:complexType>

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

<xs:annotation>

<xs:documentation>

The ID of a dataset associated with the visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Indicates whether the
dataset is required or optional for that visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

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

<xs:complexType>

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

<xs:element name="visitTag">

<xs:complexType>

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

<xs:annotation>

<xs:documentation>

The visit tag associated with this visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The cohort associated with this visit tag and visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

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

<xs:annotation>

<xs:documentation>

A short description of the visit, appears as hovertext on visit headers in study navigator and visit column in datasets.

</xs:documentation>

</xs:annotation>

</xs:element>

</xs:all>

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

<xs:annotation>

<xs:documentation>

The visit label used for display in the UI.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="sequenceNum" type="xs:decimal">

<xs:annotation>

<xs:documentation>

The sequence number of the visit, or, if a maxSequenceNum is listed, the first
sequence number in the range of visits

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="maxSequenceNum" type="xs:decimal">

<xs:annotation>

<xs:documentation>

When included, visit sequence numbers can range from sequenceNum to maxSequenceNum, inclusive.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="protocolDay" type="xs:decimal">

<xs:annotation>

<xs:documentation>

The expected day for the visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The order that this visit will be displayed in the list of visits.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The chronological order of the visit, which is used to determine cohort assignments
when your study uses the advanced cohort assignment type.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The cohort associated with the visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The type of the visit.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Indicates whether the visit is shown by default.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute default="-1" name="visitDateDatasetId" type="xs:int">

<xs:annotation>

<xs:documentation>

Indicates the dataset used to provide dates, if one is used.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute default="normal" name="sequenceNumHandling" type="xs:string">

<xs:annotation>

<xs:documentation>

Specifies special handling of sequence numbers on import.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

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

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" minOccurs="1" name="alias">

<xs:complexType>

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

<xs:attribute name="sequenceNum" type="xs:decimal"/>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" name="visitTag">

<xs:complexType>

<xs:all maxOccurs="1" minOccurs="0">

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

<xs:annotation>

<xs:documentation>

The visit tag's description.

</xs:documentation>

</xs:annotation>

</xs:element>

</xs:all>

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

<xs:annotation>

<xs:documentation>

The visit tag's name.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

The visit tag's caption.

</xs:documentation>

</xs:annotation>

</xs:attribute>

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

<xs:annotation>

<xs:documentation>

Whether the visit tag is single use.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:simpleType name="datasetType">

<xs:restriction base="xs:string">

<xs:enumeration value="OPTIONAL"/>

<xs:enumeration value="REQUIRED"/>

</xs:restriction>

</xs:simpleType>

</xs:schema>

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

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

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

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

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

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

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

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

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