Data: protstepcnf
- Namespace: http://genologics.com/ri/stepconfiguration
- XML Schema File: protstepcnf.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 step
- Type: step
Detailed representation of a Step
Steps are the elements that compose protocols. They have various properties regarding different UDFs contained on each view of the step as well as configuration option and filters
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<protstepcnf:step xmlns:protstepcnf="http://genologics.com/ri/stepconfiguration" name="..." uri="..." protocol-uri="...">
<protocol-step-index>
<!--content of type 'int'-->
...
</protocol-step-index>
<process-type uri="...">...</process-type>
<permitted-containers>
<container-type>
<!--content of type 'string'-->
...
</container-type>
<container-type>
<!--(another 'string' type)-->
</container-type>
<!--...more "container-type" elements...-->
</permitted-containers>
<permitted-reagent-categories>
<reagent-category>
<!--content of type 'string'-->
...
</reagent-category>
<reagent-category>
<!--(another 'string' type)-->
</reagent-category>
<!--...more "reagent-category" elements...-->
</permitted-reagent-categories>
<permitted-control-types>
<control-type>
<!--content of type 'string'-->
...
</control-type>
<control-type>
<!--(another 'string' type)-->
</control-type>
<!--...more "control-type" elements...-->
</permitted-control-types>
<transitions>
<transition name="..." sequence="..." next-step-uri="...">
<!--content of type 'next-step'-->
</transition>
<transition>
<!--(another 'next-step' type)-->
</transition>
<!--...more "transition" elements...-->
</transitions>
<queue-fields>
<queue-field detail="..." name="..." attach-to="...">
<!--content of type 'queuefield'-->
</queue-field>
<queue-field>
<!--(another 'queuefield' type)-->
</queue-field>
<!--...more "queue-field" elements...-->
</queue-fields>
<step-fields>
<step-field name="..." attach-to="...">
<!--content of type 'field'-->
</step-field>
<step-field>
<!--(another 'field' type)-->
</step-field>
<!--...more "step-field" elements...-->
</step-fields>
<sample-fields>
<sample-field name="..." attach-to="...">
<!--content of type 'field'-->
</sample-field>
<sample-field>
<!--(another 'field' type)-->
</sample-field>
<!--...more "sample-field" elements...-->
</sample-fields>
<step-properties>
<step-property name="..." value="...">
<!--content of type 'step-property'-->
</step-property>
<step-property>
<!--(another 'step-property' type)-->
</step-property>
<!--...more "step-property" elements...-->
</step-properties>
<step-setup>
<!--content of type 'step-setup'-->
<files>
<file shared-result-file-index="...">
<!--content of type 'file'-->
<message>
<!--content of type 'string'-->
...
</message>
</file>
<file>
<!--(another 'file' type)-->
</file>
<!--...more "file" elements...-->
</files>
</step-setup>
<epp-triggers>
<epp-trigger name="..." type="..." point="..." status="...">
<!--content of type 'epp-trigger'-->
</epp-trigger>
<epp-trigger>
<!--(another 'epp-trigger' type)-->
</epp-trigger>
<!--...more "epp-trigger" elements...-->
</epp-triggers>
</protstepcnf:step>
Type epp-trigger
EPP trigger configuration for the Protocol Step.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The protocol step's process parameter name.
Always returns with GET: Yes |
| type | trigger-type |
The protocol step's trigger type.
Always returns with GET: Yes |
| point | trigger-point |
The protocol step's trigger point.
Always returns with GET: No; if the type is TriggerType.MANUAL or TriggerType.UNUSED, the trigger point will not have a value. |
| status | trigger-status |
The protocol step's trigger status.
Always returns with GET: No; if the type is TriggerType.MANUAL or TriggerType.UNUSED, the trigger status will not have a value. |
Type field
A field has a name and an attach to value, these fields are used to keep track of all the UDF values for samples in queue and work view as well as those on the actual step
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the UDF Field. |
| attach-to | string | The element that the UDF Field will attach to. |
Type file
The file element describes a shared result file output that will be displayed in the step-setup view.
Attributes
| name | type | description |
|---|---|---|
| shared-result-file-index | string | The shared result file output index of the step output. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| message (string) | 0/1 | The message to display for this shared result file in the step-setup view. |
Type next-step
List of step transitions including the URI allowing access to the specific next step
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the next step. |
| sequence | int | The sequence of the next step. |
| next-step-uri | anyURI | The URI of the next step. |
Type process-type
Process-type is a child element that provides a URI linking to the detailed representation of the process type that the step is associated with.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the process type. |
Value
- Type: string
The display name of the process type.
Type queuefield
- Extends: field
A field has a name and an attach to value, these fields are used to keep track of all the UDF values for samples in queue and work view as well as those on the actual step
Attributes
| name | type | description |
|---|---|---|
| detail | boolean | A flag indicating if this field is for detail or not. |
Type step
Detailed representation of a Step
Steps are the elements that compose protocols. They have various properties regarding different UDFs contained on each view of the step as well as configuration option and filters
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the current step |
| uri | anyURI | The URI address of the current step |
| protocol-uri | anyURI | The URI address of the current protocol |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| protocol-step-index (int) | 0/1 | The index of the step within the actual protocol |
| process-type (process-type) | 0/1 |
The type of the Process.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |
| permitted-containers/container-type (string) | 0/unbounded | List of permitted containers for this specific protocol step |
| permitted-reagent-categories/reagent-category (string) | 0/unbounded | List of permitted reagent categories for this specific protocol step |
| permitted-control-types/control-type (string) | 0/unbounded | List of permitted control types for this specific protocol step |
| transitions/transition (next-step) | 0/unbounded | List of available transitions to next steps upon completion of this current step |
| queue-fields/queue-field (queuefield) | 0/unbounded | UDF columns that will be displayed on the queue view |
| step-fields/step-field (field) | 0/unbounded | Fields that will be displayed on the work view of the step |
| sample-fields/sample-field (field) | 0/unbounded | Editable Fields that will be displayed on the samples contained in the work view |
| step-properties/step-property (step-property) | 0/unbounded | A list of extra properties relevant to the step |
| step-setup (step-setup) | 0/1 | The step setup details. |
| epp-triggers/epp-trigger (epp-trigger) | 0/unbounded | A list of EPP triggers for the step. |
Type step-property
Step-property is a child element of protocol step containing key/value pairs for setting specific attributes of protocol steps. This information contains internally used properties that will change. These properties are suitable for use when copying protocol steps, but should not be manipulated.
Attributes
| name | type | description |
|---|---|---|
| name | string | The property name. |
| value | string | The property value. |
Type step-setup
Step-setup is a child element that describes the shared result file placeholder information for the step-setup view.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| files/file (file) | 0/unbounded | List of shared result file outputs. |
Type trigger-point
The trigger-point enumeration lists the possible values of the EPP Trigger point attribute.
Possible Values
| value | description |
|---|---|
| BEFORE | BEFORE indicates prior to the specified TriggerStatus. |
| AFTER | AFTER indicates following the specified TriggerStatus. |
Type trigger-status
The trigger-status enumeration lists the possible values of the EPP Trigger status attribute.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| workStatus (string) | 0/1 | The work status name. |
Possible Values
| value | description |
|---|---|
| STARTED | STARTED indicates on begin step. |
| STEP_SETUP | STEP_SETUP indicates on step setup. |
| POOLING | POOLING indicates on step pooling. |
| PLACEMENT | PLACEMENT indicates on step placement. |
| ADD_REAGENT | ADD_REAGENT indicates on an add reagent step. |
| RECORD_DETAILS | RECORD_DETAILS indicates on step record details. |
| COMPLETE | COMPLETE indicates on step complete. |
Type trigger-type
The trigger-type enumeration lists the possible values of the EPP Trigger type attribute.
Possible Values
| value | description |
|---|---|
| MANUAL | MANUAL indicates the trigger is activated manually on record details. |
| AUTOMATIC | AUTOMATIC indicates trigger is activated automatically based on the specified TriggerPoint and TriggerStatus. |
| UNUSED | UNUSED indicates the trigger is not used. |