Data: ptp

Namespace: http://genologics.com/ri/processtype
XML Schema File: processtype.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:

process-type
process-types

The following types are members of this namespace:

container-type-link
control-type-link
epp-trigger
field
file
icebucketfield
invocation-type
output-generation-type
parameter
process-input
process-output
process-type
process-type-attribute
process-type-link
process-types
queuefield
reagent-kit-link
step-property
step-setup
style
trigger-point
trigger-status
trigger-type
type-definition
variability-type

Element process-type

Type: process-type

The process-type element contains the XML representation of a type of process configured in the system.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<ptp:process-type xmlns:ptp="http://genologics.com/ri/processtype" 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...-->
  <parameter name="..." uri="...">
    <!--content of type 'parameter'-->
    <file>
      <!--content of type 'string'-->
      ...
    </file>
    <string>
      <!--content of type 'string'-->
      ...
    </string>
    <run-program-per-event>
      <!--content of type 'boolean'-->
      ...
    </run-program-per-event>
    <channel>
      <!--content of type 'string'-->
      ...
    </channel>
    <invocation-type>
      <!--content of type 'invocation-type'-->
      ...
    </invocation-type>
    <file:file xmlns:file="http://genologics.com/ri/file">...</file:file>
    <file:file xmlns:file="http://genologics.com/ri/file">...</file:file>
    <!--...more "file" elements...-->
  </parameter>
  <parameter>
    <!--(another 'parameter' type)-->
  </parameter>
  <!--...more "parameter" elements...-->
  <type-definition name="..." uri="...">
    <!--content of type 'type-definition'-->
  </type-definition>
  <type-definition>
    <!--(another 'type-definition' type)-->
  </type-definition>
  <!--...more "type-definition" elements...-->
  <process-input>
    <!--content of type 'process-input'-->
    <artifact-type>
      <!--content of type 'string'-->
      ...
    </artifact-type>
    <display-name>
      <!--content of type 'string'-->
      ...
    </display-name>
    <remove-working-flag>
      <!--content of type 'boolean'-->
      ...
    </remove-working-flag>
  </process-input>
  <process-input>
    <!--(another 'process-input' type)-->
  </process-input>
  <!--...more "process-input" elements...-->
  <process-output>
    <!--content of type 'process-output'-->
    <artifact-type>
      <!--content of type 'string'-->
      ...
    </artifact-type>
    <display-name>
      <!--content of type 'string'-->
      ...
    </display-name>
    <output-generation-type>
      <!--content of type 'output-generation-type'-->
      ...
    </output-generation-type>
    <variability-type>
      <!--content of type 'variability-type'-->
      ...
    </variability-type>
    <number-of-outputs>
      <!--content of type 'int'-->
      ...
    </number-of-outputs>
    <output-name>
      <!--content of type 'string'-->
      ...
    </output-name>
    <field-definition name="..." uri="...">
      <!--content of type 'field-link'-->
    </field-definition>
    <field-definition>
      <!--(another 'field-link' type)-->
    </field-definition>
    <!--...more "field-definition" elements...-->
    <assign-working-flag>
      <!--content of type 'boolean'-->
      ...
    </assign-working-flag>
  </process-output>
  <process-output>
    <!--(another 'process-output' type)-->
  </process-output>
  <!--...more "process-output" elements...-->
  <process-type-attribute name="...">...</process-type-attribute>
  <process-type-attribute>
    <!--(another 'process-type-attribute' type)-->
  </process-type-attribute>
  <!--...more "process-type-attribute" elements...-->
  <permitted-containers>
    <container-type name="..." uri="...">
      <!--content of type 'container-type-link'-->
    </container-type>
    <container-type>
      <!--(another 'container-type-link' 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>
  <required-reagent-kits>
    <reagent-kit name="..." uri="...">
      <!--content of type 'reagent-kit-link'-->
    </reagent-kit>
    <reagent-kit>
      <!--(another 'reagent-kit-link' type)-->
    </reagent-kit>
    <!--...more "reagent-kit" elements...-->
  </required-reagent-kits>
  <permitted-control-types>
    <control-type name="..." uri="...">
      <!--content of type 'control-type-link'-->
    </control-type>
    <control-type>
      <!--(another 'control-type-link' type)-->
    </control-type>
    <!--...more "control-type" elements...-->
  </permitted-control-types>
  <permitted-instrument-types>
    <instrument-type>
      <!--content of type 'string'-->
      ...
    </instrument-type>
    <instrument-type>
      <!--(another 'string' type)-->
    </instrument-type>
    <!--...more "instrument-type" elements...-->
  </permitted-instrument-types>
  <queue-fields>
    <queue-field detail="..." name="..." attach-to="..." style="...">
      <!--content of type 'queuefield'-->
    </queue-field>
    <queue-field>
      <!--(another 'queuefield' type)-->
    </queue-field>
    <!--...more "queue-field" elements...-->
  </queue-fields>
  <ice-bucket-fields>
    <ice-bucket-field detail="..." name="..." attach-to="..." style="...">
      <!--content of type 'icebucketfield'-->
    </ice-bucket-field>
    <ice-bucket-field>
      <!--(another 'icebucketfield' type)-->
    </ice-bucket-field>
    <!--...more "ice-bucket-field" elements...-->
  </ice-bucket-fields>
  <step-fields>
    <step-field name="..." attach-to="..." style="...">
      <!--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="..." style="...">
      <!--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 enabled="...">
    <!--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>
</ptp:process-type>

Element process-types

Type: process-types

The representation for a list of process type 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"?>
<ptp:process-types xmlns:ptp="http://genologics.com/ri/processtype">
  <process-type name="..." uri="...">
    <!--content of type 'process-type-link'-->
  </process-type>
  <process-type>
    <!--(another 'process-type-link' type)-->
  </process-type>
  <!--...more "process-type" elements...-->
  <previous-page uri="...">
    <!--content of type 'page'-->
  </previous-page>
  <next-page uri="...">
    <!--content of type 'page'-->
  </next-page>
</ptp:process-types>

Type container-type-link

Container-type-link is a child element type of containerTypes and provides a URI linking to the detailed representation of a ContainerType.

Attributes

name	type	description
name	string	The name of the ContainerType. Always returns with GET: Yes
uri	anyURI	The URI of the ContainerType. Always returns with GET: Yes

Type control-type-link

Control-type-link is a child element type of controlTypes and provides a URI linking to the detailed representation of a ControlType.

Attributes

name	type	description
name	string	The name of the ControlType. Always returns with GET: Yes
uri	anyURI	The URI of the ControlType. Always returns with GET: Yes

Type epp-trigger

EPP trigger configuration for the Master Step.

Attributes

name	type	description
name	string	The master step's process parameter name. Always returns with GET: Yes
type	trigger-type	The master step's trigger type. Always returns with GET: Yes
point	trigger-point	The master 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 master 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 User Defined and Built In 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 Field.
attach-to	string	The element that the Field will attach to.
style	style	The style of field, either 'USER_DEFINED' or 'BUILT_IN'. If the style attribute is omitted from a PUT request, the system will act in the same way that it did before the style attribute was available, and give preference to using the built-in field when both a built-in and UDF match the name and attach-to. Always returns with GET: Yes Updatable with PUT: Yes Required for PUT: No

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 icebucketfield

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 ice bucket view

Attributes

name	type	description
detail	boolean	A flag indicating if this field is for detail or not.

Type invocation-type

The available options for epp invocation type.

Possible Values

value	description
PostProcess	The Epp script is invoked after the process is created
PreProcess	The Epp script is invoked before the process is created

Type output-generation-type

The available options for output-type generation.

Possible Values

value	description
PerInput	Output applies to individual Inputs
PerAllInputs	Output applies to all Inputs
PerReagentLabel	Output applies to Inputs per Reagent Label

Type parameter

The parameter element integrates the process with the External Program Integration plug-in (EPP). When a user runs the process, the system automatically issue a command, or submits files and scripts to third-party programs for further processing. The parameter element is a child element of process-type.

Attributes

name	type	description
name	string	The name of the process type parameter. Always returns with GET: Yes
uri	anyURI	The URI linking to the process parameter / automation. Always returns with GET: Yes

Child Elements

name (type)	min/max occurs	description
file (string)	0/1	Deprecated, this property is no longer supported. The file of the parameter. Always returns with GET: No
string (string)	0/1	The value of the parameter. Always returns with GET: No
run-program-per-event (boolean)	0/1	Deprecated, this property is no longer supported. Should the EPP run once for each process related event? Always returns with GET: Yes
channel (string)	0/1	The epp channel of this script. Always returns with GET: No
invocation-type (invocation-type)	0/1	Deprecated, this property is no longer supported. The epp invocation type of this script. Always returns with GET: No
file ()	0/unbounded	Each File provides a URI linking to the detailed representation of a File associated with the Process Parameter. Always returns with GET: No, however if one or more files are attached to a given Process Parameter they will be returned. Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No, files cannot be modified through the Process Parameter resource. Use the Files resource instead.

Type process-input

Process-input is a child element of process type specifying the available input types for the process

Child Elements

name (type)	min/max occurs	description
artifact-type (string)	0/1	The artifact type for the input. Always returns with GET: Yes
display-name (string)	0/1	The display name for the input. Always returns with GET: Yes
remove-working-flag (boolean)	0/1	Deprecated, this property is no longer supported. Whether the working flag should be removed from the input when the process runs. Always returns with GET: No

Type process-output

Process-output is a child element of process type specifying the configured output generation types for the process

Child Elements

name (type)	min/max occurs	description
artifact-type (string)	0/1	Artifact type for this output. Always returns with GET: Yes
display-name (string)	0/1	The display name for the input. Always returns with GET: Yes
output-generation-type (output-generation-type)	0/1	Specifies how the outputs are generated in relation to the inputs (COMPOUND, PER_REAGENT_LABEL, or PER_INPUT). Always returns with GET: Yes
variability-type (variability-type)	0/1	Specifies how the process determines the number of outputs to generated (FIXED, VARIABLE, or VARIABLE_BY_INPUT). Always returns with GET: Yes for FIXED output, No otherwise
number-of-outputs (int)	0/1	Number of outputs to generate (only applies if variabilityType is FIXED). Always returns with GET: Yes
output-name (string)	0/1	Pattern for specifying how the output name is generated. Always returns with GET: Yes
field-definition (field-link)	0/unbounded	Deprecated, these field definitions are ignored as of Clarity LIMS 5.0. Each field definition provides a URI linking to the configuration of a user-defined field for the output type. Always returns with GET: No
assign-working-flag (boolean)	0/1	Deprecated, this property is no longer supported. Whether the working flag should be assigned to the output when the process runs. Always returns with GET: No

Type process-type

The process-type element contains the XML representation of a type of process configured in the system.

Attributes

name	type	description
name	string	The name of the process type. Always returns with GET: Yes
uri	anyURI	The URI of the process type. Always returns with GET: Yes

Child Elements

name (type)	min/max occurs	description
field-definition (field-link)	0/unbounded	Each field definition provides a URI linking to the configuration of a user-defined field for the process type. Always returns with GET: No
parameter (parameter)	0/unbounded	Each parameter is a named value or file for the process type. Always returns with GET: No
type-definition (type-definition)	0/unbounded	Each type definition provides a URI linking to the configuration of a user-defined type for the process type. Always returns with GET: No
process-input (process-input)	0/unbounded	List of enabled inputs for this process type. Always returns with GET: Yes
process-output (process-output)	0/unbounded	List of enabled outputs for this process type. Always returns with GET: No
process-type-attribute (process-type-attribute)	0/unbounded	List of configuration attributes for this process type. Always returns with GET: No
permitted-containers/container-type (container-type-link)	0/unbounded	List of permitted containers for the master step.
permitted-reagent-categories/reagent-category (string)	0/unbounded	List of permitted reagent categories for the master step.
required-reagent-kits/reagent-kit (reagent-kit-link)	0/unbounded	List of required reagent kit tracking for the master step.
permitted-control-types/control-type (control-type-link)	0/unbounded	List of permitted control types for the master step.
permitted-instrument-types/instrument-type (string)	0/unbounded	List of permitted instrument types for the master step
queue-fields/queue-field (queuefield)	0/unbounded	UDF columns that will be displayed on the queue views of child steps
ice-bucket-fields/ice-bucket-field (icebucketfield)	0/unbounded	UDF columns that will be displayed on the ice bucket views of child steps
step-fields/step-field (field)	0/unbounded	Fields that will be displayed on the work view of child step
sample-fields/sample-field (field)	0/unbounded	Editable Fields that will be displayed on the samples contained in the work view of child steps
step-properties/step-property (step-property)	0/unbounded	A list of extra properties relevant to the master step
step-setup (step-setup)	0/1	The step setup details for the master step.
epp-triggers/epp-trigger (epp-trigger)	0/unbounded	A list of EPP triggers for the master step.

Type process-type-attribute

Process-type-attributes is a child element of process type containing key/value pairs for setting specific attributes that can be set for process types. This information contains internally used parameters that will change. These parameters are suitable for use when copying process types, but should not be manipulated.

Attributes

name	type	description
name	string	Specifies which attribute that the value will be set to. Always returns with GET: Yes

Value

Type: string

Value to set for this attribute.
Always returns with GET: Yes

Type process-type-link

Process-type-link is a child element type of process types and provides a URI linking to the detailed representation of a process type.

Attributes

name	type	description
name	string	The name of the process type.
uri	anyURI	The URI of the process type.

Type process-types

The representation for a list of process type 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
process-type (process-type-link)	0/unbounded	Process-type provides a URI linking to the detailed representation of a process type.
previous-page (page)	0/1	When working with large lists of process types, the previous-page element provides a URI that links to the previous page of process types.
next-page (page)	0/1	When working with large lists of process types, the next-page element provides a URI that links to the next page of process types.

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 reagent-kit-link

Reagent-kit-link is a child element type of reagentKits and provides a URI linking to the detailed representation of a ReagentKit.

Attributes

name	type	description
name	string	The name of the ReagentKit. Always returns with GET: Yes
uri	anyURI	The URI of the ReagentKit. Always returns with GET: Yes

Type step-property

Step-property is a child element of master step containing key/value pairs for setting specific attributes of master steps. This information contains internally used properties that will change. These properties are suitable for use when copying master 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.

Attributes

name	type	description
enabled	boolean	A flag indicating if the step-setup view should be enabled or not.

Child Elements

name (type)	min/max occurs	description
files/file (file)	0/unbounded	List of shared result file outputs.

Type style

The different styles of Fields.

Possible Values

value	description
USER_DEFINED	User defined fields
BUILT_IN	Built in fields

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.

Type type-definition

Type-definition is a child element of process type providing a URI linking to the configuration of a user-defined type for the process type.

Attributes

name	type	description
name	string	The name of the user-defined type. Always returns with GET: Yes
uri	anyURI	The URI linking to the configuration of a user-defined type for the process type. Always returns with GET: Yes

Type variability-type

The available options for output-type variability.

Possible Values

value	description
Fixed	Fixed number of Outputs applied to all Inputs (pre-configured)
Variable	Variable number of Outputs applied to all Inputs (entered at run-time)
VariableByInput	Variable number of Outputs per Input (entered at run-time)

REST API

Data: ptp

Example XML

Example XML

Attributes

Attributes

Attributes

Attributes

Attributes

Child Elements

Attributes

Possible Values

Possible Values

Attributes

Child Elements

Child Elements

Child Elements

Attributes

Child Elements

Attributes

Value

Attributes

Child Elements

Attributes

Attributes

Attributes

Attributes

Child Elements

Possible Values

Possible Values

Child Elements

Possible Values

Possible Values

Attributes

Possible Values

Home

REST Endpoints

XML Data Elements

XML Data Types