Data: cnf
- Namespace: http://genologics.com/ri/configuration
- XML Schema File: configuration.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element field
- Type: field
The detailed representation of the configuration of a user-defined field.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:field xmlns:cnf="http://genologics.com/ri/configuration" type="..." uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<attach-to-name>
<!--content of type 'string'-->
...
</attach-to-name>
<precision>
<!--content of type 'int'-->
...
</precision>
<unit>
<!--content of type 'string'-->
...
</unit>
<type-definition name="..." uri="...">
<!--content of type 'type-definition'-->
</type-definition>
<show-in-lablink>
<!--content of type 'boolean'-->
...
</show-in-lablink>
<allow-non-preset-values>
<!--content of type 'boolean'-->
...
</allow-non-preset-values>
<first-preset-is-default-value>
<!--content of type 'boolean'-->
...
</first-preset-is-default-value>
<show-in-tables>
<!--content of type 'boolean'-->
...
</show-in-tables>
<is-editable>
<!--content of type 'boolean'-->
...
</is-editable>
<is-deviation>
<!--content of type 'boolean'-->
...
</is-deviation>
<is-controlled-vocabulary>
<!--content of type 'boolean'-->
...
</is-controlled-vocabulary>
<parent-uri>
<!--content of type 'anyURI'-->
...
</parent-uri>
<child-uri>
<!--content of type 'string'-->
...
</child-uri>
<child-uri>
<!--(another 'string' type)-->
</child-uri>
<!--...more "child-uri" elements...-->
<preset>
<!--content of type 'string'-->
...
</preset>
<preset>
<!--(another 'string' type)-->
</preset>
<!--...more "preset" elements...-->
<min-value>
<!--content of type 'double'-->
...
</min-value>
<max-value>
<!--content of type 'double'-->
...
</max-value>
<is-required>
<!--content of type 'boolean'-->
...
</is-required>
<attach-to-category>
<!--content of type 'string'-->
...
</attach-to-category>
</cnf:field>
Element type
- Type: type
The detailed representation of the configuration of a user defined type.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:type xmlns:cnf="http://genologics.com/ri/configuration" name="..." uri="...">
<field-definition name="..." uri="...">
<!--content of type 'field-link'-->
</field-definition>
<field-definition>
<!--(another 'field-link' type)-->
</field-definition>
<!--...more "field-definition" elements...-->
<attach-to-name>
<!--content of type 'string'-->
...
</attach-to-name>
<attach-to-category>
<!--content of type 'string'-->
...
</attach-to-category>
</cnf:type>
Element udfconfig-link
- Type: udfconfig-link
Udfconfig-link is a child element type of udfs and provides a URI linking to the detailed representation of the configuration for a user defined field.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:udfconfig-link xmlns:cnf="http://genologics.com/ri/configuration" uri="..." attach-to-name="..." name="..." attach-to-category="..." />
Element udfs
- Type: udfs
The representation of a list of user defined field configuration links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:udfs xmlns:cnf="http://genologics.com/ri/configuration">
<udfconfig uri="..." attach-to-name="..." name="..." attach-to-category="...">
<!--content of type 'udfconfig-link'-->
</udfconfig>
<udfconfig>
<!--(another 'udfconfig-link' type)-->
</udfconfig>
<!--...more "udfconfig" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</cnf:udfs>
Element udtconfig-link
- Type: udtconfig-link
Udtconfig-link is a child element type of udts and provides a URI linking to the detailed representation of the configuration for a user defined type.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:udtconfig-link xmlns:cnf="http://genologics.com/ri/configuration" uri="..." name="..." attach-to-name="..." attach-to-category="..." />
Element udts
- Type: udts
The representation of a list of user defined type configuration links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<cnf:udts xmlns:cnf="http://genologics.com/ri/configuration">
<udtconfig uri="..." name="..." attach-to-name="..." attach-to-category="...">
<!--content of type 'udtconfig-link'-->
</udtconfig>
<udtconfig>
<!--(another 'udtconfig-link' type)-->
</udtconfig>
<!--...more "udtconfig" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</cnf:udts>
Type field
The detailed representation of the configuration of a user-defined field.
Attributes
| name | type | description |
|---|---|---|
| type | field-type | The type of user-defined field. |
| uri | anyURI | The URI of the user-defined field. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the user-defined field. |
| attach-to-name (string) | 0/1 |
The item in the system that the User-Defined Field can be used with such as Sample, Project, Container
or the name of a process.
Values for this element can be divided into three categories: predefined values, dynamic values and unsupported/deprecated values. Predefined values - predefined values are supported in the API and describe the kind of resource associated with the user-defined field. The currently supported values are: Project, Sample, Analyte, ResultFile and Container. Dynamic values - a dynamic value is used for user-defined fields configured on process types, and correspond to the process type name. When working with user-defined fields on process types, the attach-to-category element must be specified with a value of 'ProcessType'. Unsupported values - there are other values which associate user-defined fields with other items in the data model. These values may or may not correspond to the resources provided in the API. These values should not be relied on and may change in the future. |
| precision (int) | 0/1 |
The number of decimal places used when displaying numeric values. Only numeric user-defined fields support precision. |
| unit (string) | 0/1 |
The unit of measurement associated with the user-defined field. Only numeric user-defined fields support units. |
| type-definition (type-definition) | 0/1 | Type-definition provides a URI linking to the user-defined type associated with the User-Defined Field. This will only be populated if the UDF has been configured for a UDT. |
| show-in-lablink (boolean) | 0/1 | Specifies whether the user-defined field is displayed in LabLink. |
| allow-non-preset-values (boolean) | 0/1 | Specifies whether the User-Defined Field can accept manually-entered values or preset values. |
| first-preset-is-default-value (boolean) | 0/1 | Specifies that when multiple preset values are entered for a User-Defined Field, the first preset value is selected by default. |
| show-in-tables (boolean) | 0/1 | Specifies whether the user-defined field is added to a column when information is displayed in a table in the LIMS. |
| is-editable (boolean) | 0/1 | When working with user-defined field associated with the outputs of a process, this option allows users to manually change UDF values. |
| is-deviation (boolean) | 0/1 |
Specifies whether the User-Defined Field contains a deviation value. When working with deviations, two values are collected for the user-defined field (parent-uri and child-uri). Only numeric user-defined fields support deviation. |
| is-controlled-vocabulary (boolean) | 0/1 | Specifies whether the user-defined field contains preset values that adhere to a hierarchical set of terms. |
| parent-uri (anyURI) | 0/1 |
Parent-uri provides a URI linking to the parent user-defined field for the UDF. Parent-uri is used to support standard deviation for numeric user-defined fields With standard deviation, the numeric value will be stored in the parent user-defined field, and the deviation value will be stored in the child user-defined field. The child user-defined field's is-deviation flag will be true. |
| child-uri (string) | 0/unbounded |
Child-uri provides a URI linking to any child user-defined fields for the user-defined field. Child-uri is used to support standard deviation for numeric user-defined fields. With standard deviation, the numeric value will be stored in the parent user-defined field, and the deviation value will be in the child user-defined field. The child user-defined field's is-deviation flag will be true. |
| preset (string) | 0/unbounded | Displays preset values associated with the user-defined field. |
| min-value (double) | 0/1 |
The minimum value for the user-defined field. This is the lowest value that can be recorded for the UDF. Only numeric user-defined fields support minValue. |
| max-value (double) | 0/1 |
The maximum value for the user-defined field. This is the highest value that can be recorded for the UDF. Only numeric type user-defined fields support minValue. |
| is-required (boolean) | 0/1 | Specifies whether the user-defined field is a mandatory field. |
| attach-to-category (string) | 0/1 | Specifies whether the User-Defined Field can be used with processes. If you want the UDF applied to a process, specify a value of ProcessType, and for the attach-to-name element, specify the name of the process. For all other UDFs, do not specify an attach-to-category value. |
Type field-link
Field definition represents a user-defined field configured in the parent entity. It includes the name and a URI linking to the detailed representation of the configuration of a user defined field.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the user-defined field. |
| uri | anyURI | The URI linking to the configuration of the user-defined field. |
Type field-type
The data types available for a user-defined field.
Possible Values
| value | description |
|---|---|
| String | A single-line text field. |
| Text | A multi-line text field. |
| Boolean | A boolean (true/false) field. This field appears as a check box in the GenoLogics LIMS client. |
| Numeric | A numeric field. API displays only the significant decimal digits. |
| Date | A date field. |
| URI | A hyperlink text field. |
Type type
The detailed representation of the configuration of a user defined type.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the user defined type. |
| uri | string | The URI of the user defined type. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| field-definition (field-link) | 0/unbounded | Each field definition provides a URI linking to the detailed representation of the configuration of a user defined field for the user defined type. |
| attach-to-name (string) | 0/1 |
The item in the system that the User-Defined Type can be used with such as Sample, Project, Container
or the name of a process.
Values for this element can be divided into three categories: predefined values, dynamic values and unsupported/deprecated values. Predefined values - predefined values are supported in the API and describe the kind of resource associated with the user-defined type. The currently supported values are: Project, Sample, and Container. Dynamic values - a dynamic value is used for user-defined types configured on process types, and correspond to the process type name. When working with user-defined types on process types, the attach-to-category element must be specified with a value of 'ProcessType'. Unsupported values - there are other values which associate user-defined types with other items in the data model. These values may or may not correspond to the resources provided in the API. These values should not be relied on and may change in the future. |
| attach-to-category (string) | 0/1 | Specifies whether the User-Defined Type can be used with processes. If you want the UDT applied to a process, specify a value of ProcessType, and for the attach-to-name element, specify the name of the process. For all other UDTs, do not specify an attach-to-category value. |
Type type-definition
Type-definition provides a URI linking to the user defined type associated with the user-defined field, if applicable.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the user defined type. |
| uri | anyURI | The URI of the user defined type. |
Type udfconfig-link
Udfconfig-link is a child element type of udfs and provides a URI linking to the detailed representation of the configuration for a user defined field.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the user defined field configuration. |
| attach-to-name | string | The attach to name for the user defined field. |
| name | string | The name of the user defined field. |
| attach-to-category | string | Specifies whether the User-Defined Field can be used with processes. If you want the UDF applied to a process, specify a value of ProcessType, and for the attach-to-name element, specify the name of the process. For all other UDFs, do not specify an attach-to-category value. |
Type udfs
The representation of a list of user defined field configuration links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| udfconfig (udfconfig-link) | 0/unbounded | Udfconfig provides a URI linking to the detailed representation of the configuration for a user defined field. |
| previous-page (page) | 0/1 | Previous-page provides a URI linking to the previous page of user defined field configuration links. |
| next-page (page) | 0/1 | Next-page provides a URI linking to the next page of user defined field configuration links. |
Type udtconfig-link
Udtconfig-link is a child element type of udts and provides a URI linking to the detailed representation of the configuration for a user defined type.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the user defined type configuration. |
| name | string | The name of the user defined type. |
| attach-to-name | string | The attach to name for the user defined field. |
| attach-to-category | string | Specifies whether the User-Defined Type can be used with processes. If you want the UDT applied to a process, specify a value of ProcessType, and for the attach-to-name element, specify the name of the process. For all other UDTs, do not specify an attach-to-category value. |
Type udts
The representation of a list of user defined type configuration links.
The system enforces a maximum number of elements when generating the list of links. When the size of
the request result set is larger than the system maximum, the list represents a paged view of the overall
results, and the previous-page and next-page elements provide URIs linking to the previous or next page
of links in the overall results.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| udtconfig (udtconfig-link) | 0/unbounded | Udtconfig provides a URI linking to the detailed representation of the configuration for a user defined type. |
| previous-page (page) | 0/1 | Previous-page provides a URI linking to the previous page of user defined type configuration links. |
| next-page (page) | 0/1 | Next-page provides a URI linking to the next page of user defined type configuration links. |