complexType "ap:ProviderType"
Namespace:
http://labkey.org/study/assay/xml
Content:
complex, 2 attributes, 9 elements
Defined:
globally in assayProvider.xsd, see XML source
Includes:
definitions of 2 attributes and 9 elements
Used:
at 1 location
XML Representation Summary
<...
    canCopyToStudy
 = 
 xs:boolean : "true"
    plateBased
 = 
 xs:boolean : "false"
    >
   
Content: 
 ap:name?, ap:description?, ap:requiredModules?, ap:inputDataFileSuffix*, ap:primaryDataFileType?, ap:relatedDataFileType*, ap:fieldKeys?, ap:transformScripts?, ap:saveHandler?
</...>
Content Model Elements (9):
ap:description (in ap:provider),
ap:fieldKeys (in ap:provider),
ap:inputDataFileSuffix (in ap:provider),
ap:name (in ap:provider),
ap:primaryDataFileType (in ap:provider),
ap:relatedDataFileType (in ap:provider),
ap:requiredModules (in ap:provider),
ap:saveHandler (in ap:provider),
ap:transformScripts (in ap:provider)
All Direct / Indirect Based Elements (1):
ap:provider
Known Usage Locations
XML Source (see within schema source)
<xs:complexType name="ProviderType">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" name="name" type="xs:string"/>
<xs:element maxOccurs="1" minOccurs="0" name="description" type="xs:string"/>
<xs:element maxOccurs="1" minOccurs="0" name="requiredModules">
<xs:annotation>
<xs:documentation>
If provided, this set of modules will always be active in a given folder when an instance of this assay is present.
This could be useful if the assay depends on a user schema or other resources present in the module.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="moduleName" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="inputDataFileSuffix" type="xs:string">
<xs:annotation>
<xs:documentation>
Deprecated (use inputDataFile/fileSuffixes instead). File extension that should be offered the option to import into designs of this type
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="primaryDataFileType" type="ap:AssayDataType">
<xs:annotation>
<xs:documentation>
Information about the files to be used as inputs to this assay.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="relatedDataFileType" type="ap:AssayDataType">
<xs:annotation>
<xs:documentation>
If there are related data files available on the server's file system
(ones that share the same base file name, with different suffixes/file extensions), they are
attached to the run at import time. If they happen to match up with a &lt;relatedDataFile&gt;
element, they will be added using the associated namespace prefix and role.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="fieldKeys">
<xs:annotation>
<xs:documentation>
Contains field keys (column names, potentially with lookups) used to resolve various values
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" name="participantId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the ParticipantID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="visitId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the VisitID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="date" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the date for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="specimenId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the SpecimenID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="transformScripts">
<xs:annotation>
<xs:documentation>
Ordered list of transformation/validation scripts that must be run as data is
imported. The scripts themselves should be in the assay's ./scripts subdirectory.
Scripts will be executed in the order given here. Any scripts in the ./script subdirectory
that are not listed here will be executed in alphabetical order after all of the scripts
listed here.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="transformScript">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="fileName" type="xs:string">
<xs:annotation>
<xs:documentation>
Simple file name (no path) of the script. If a script engine associated
with the script's file extension isn't registered in the Admin Console,
the import attempt will fail.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="saveHandler" type="xs:string">
<xs:annotation>
<xs:documentation>
Class name of the custom save handler for this assay type.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="false" name="plateBased" type="xs:boolean">
<xs:annotation>
<xs:documentation>Not used.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="true" name="canCopyToStudy" type="xs:boolean">
<xs:annotation>
<xs:documentation>Deprecated. Not used anymore.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
Attribute Detail
canCopyToStudy
Type:
xs:boolean, predefined
Use:
optional
Default:
"true"
Defined:
locally, within (this) ap:ProviderType complexType
Deprecated. Not used anymore.
XML Source (see within schema source)
<xs:attribute default="true" name="canCopyToStudy" type="xs:boolean">
<xs:annotation>
<xs:documentation>Deprecated. Not used anymore.</xs:documentation>
</xs:annotation>
</xs:attribute>
plateBased
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Defined:
locally, within (this) ap:ProviderType complexType
Not used.
XML Source (see within schema source)
<xs:attribute default="false" name="plateBased" type="xs:boolean">
<xs:annotation>
<xs:documentation>Not used.</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail
ap:description
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) ap:ProviderType complexType
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="description" type="xs:string"/>
ap:fieldKeys
Type:
anonymous, complex content
Defined:
locally, within (this) ap:ProviderType complexType
Contains field keys (column names, potentially with lookups) used to resolve various values
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="fieldKeys">
<xs:annotation>
<xs:documentation>
Contains field keys (column names, potentially with lookups) used to resolve various values
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" name="participantId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the ParticipantID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="visitId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the VisitID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="date" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the date for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="specimenId" type="xs:string">
<xs:annotation>
<xs:documentation>
Field key relative to the data/results table that gives the SpecimenID for a given row of data
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
ap:inputDataFileSuffix
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) ap:ProviderType complexType
Deprecated (use inputDataFile/fileSuffixes instead). File extension that should be offered the option to import into designs of this type
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="inputDataFileSuffix" type="xs:string">
<xs:annotation>
<xs:documentation>
Deprecated (use inputDataFile/fileSuffixes instead). File extension that should be offered the option to import into designs of this type
</xs:documentation>
</xs:annotation>
</xs:element>
ap:name
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) ap:ProviderType complexType
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="name" type="xs:string"/>
ap:primaryDataFileType
Type:
ap:AssayDataType, complex content
Defined:
locally, within (this) ap:ProviderType complexType
Information about the files to be used as inputs to this assay.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="primaryDataFileType" type="ap:AssayDataType">
<xs:annotation>
<xs:documentation>
Information about the files to be used as inputs to this assay.
</xs:documentation>
</xs:annotation>
</xs:element>
ap:relatedDataFileType
Type:
ap:AssayDataType, complex content
Defined:
locally, within (this) ap:ProviderType complexType
If there are related data files available on the server's file system (ones that share the same base file name, with different suffixes/file extensions), they are attached to the run at import time. If they happen to match up with a <relatedDataFile> element, they will be added using the associated namespace prefix and role.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="relatedDataFileType" type="ap:AssayDataType">
<xs:annotation>
<xs:documentation>
If there are related data files available on the server's file system
(ones that share the same base file name, with different suffixes/file extensions), they are
attached to the run at import time. If they happen to match up with a &lt;relatedDataFile&gt;
element, they will be added using the associated namespace prefix and role.
</xs:documentation>
</xs:annotation>
</xs:element>
ap:requiredModules
Type:
anonymous, complex content
Defined:
locally, within (this) ap:ProviderType complexType
If provided, this set of modules will always be active in a given folder when an instance of this assay is present. This could be useful if the assay depends on a user schema or other resources present in the module.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="requiredModules">
<xs:annotation>
<xs:documentation>
If provided, this set of modules will always be active in a given folder when an instance of this assay is present.
This could be useful if the assay depends on a user schema or other resources present in the module.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="moduleName" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
ap:saveHandler
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) ap:ProviderType complexType
Class name of the custom save handler for this assay type.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="saveHandler" type="xs:string">
<xs:annotation>
<xs:documentation>
Class name of the custom save handler for this assay type.
</xs:documentation>
</xs:annotation>
</xs:element>
ap:transformScripts
Type:
anonymous, complex content
Defined:
locally, within (this) ap:ProviderType complexType
Ordered list of transformation/validation scripts that must be run as data is imported. The scripts themselves should be in the assay's ./scripts subdirectory. Scripts will be executed in the order given here. Any scripts in the ./script subdirectory that are not listed here will be executed in alphabetical order after all of the scripts listed here.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="transformScripts">
<xs:annotation>
<xs:documentation>
Ordered list of transformation/validation scripts that must be run as data is
imported. The scripts themselves should be in the assay's ./scripts subdirectory.
Scripts will be executed in the order given here. Any scripts in the ./script subdirectory
that are not listed here will be executed in alphabetical order after all of the scripts
listed here.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="transformScript">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="fileName" type="xs:string">
<xs:annotation>
<xs:documentation>
Simple file name (no path) of the script. If a script engine associated
with the script's file extension isn't registered in the Admin Console,
the import attempt will fail.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</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/