Data: prx

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

The following types are members of this namespace:

artifactbase
input
input-output-map
instrument
output
parameter
process
qc-flag
technician

Element process

Type: process

The process element defines the XML needed to run a process.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<prx:process xmlns:prx="http://genologics.com/ri/processexecution">
  <type>
    <!--content of type 'string'-->
    ...
  </type>
  <technician uri="...">
    <!--content of type 'technician'-->
  </technician>
  <date-run>
    <!--content of type 'string'-->
    ...
  </date-run>
  <input-output-map shared="...">
    <!--content of type 'input-output-map'-->
    <input uri="...">
      <!--content of type 'input'-->
      <qc-flag>
        <!--content of type 'qc-flag'-->
        ...
      </qc-flag>
    </input>
    <input>
      <!--(another 'input' type)-->
    </input>
    <!--...more "input" elements...-->
    <output type="...">
      <!--content of type 'output'-->
      <location>
        <!--content of type 'location'-->
        <container limsid="..." uri="...">
          <!--content of type 'container'-->
        </container>
        <value>
          <!--content of type 'string'-->
          ...
        </value>
      </location>
      <qc-flag>
        <!--content of type 'qc-flag'-->
        ...
      </qc-flag>
    </output>
  </input-output-map>
  <input-output-map>
    <!--(another 'input-output-map' type)-->
  </input-output-map>
  <!--...more "input-output-map" elements...-->
  <udf:type xmlns:udf="http://genologics.com/ri/userdefined">...</udf:type>
  <udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
  <udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
  <!--...more "field" elements...-->
  <instrument uri="...">
    <!--content of type 'instrument'-->
  </instrument>
  <process-parameter name="...">
    <!--content of type 'parameter'-->
  </process-parameter>
</prx:process>

Type artifactbase

The base representation of an Artifact in the context of Process execution, defining common elements for both input and output Artifacts.

Child Elements

name (type)	min/max occurs	description
qc-flag (qc-flag)	0/1	The QC flag for the Artifact being created. You can apply a QC flag to any Artifact in the system. This is an optional element. Creatable with POST: Yes Required for POST: No

Type input

Extends: artifactbase

The input element provides URIs to one or more Artifacts that will be used by the Process. Input is a child element of input-output-map.

Attributes

name	type	description
uri	anyURI	A URI that identifies and links to further information about the input Artifact. Creatable with POST: Yes Required for POST: Yes

Type input-output-map

Processes link inputs to outputs and this relationship is called an input-output map. Input-output-map is a child element of the Process element.

When a Process creates multiple outputs per input, there is a distinct input-output map for each input to output relationship. When a Process produces a shared output, there is a single input-output map for the shared output and all its related inputs.

In situations where a Process is used to affect the properties of inputs only and therefore, does not create outputs, you can omit the output element.

Attributes

name	type	description
shared	boolean	A value that specifies whether the input-output map applies to a single or shared output. To define a shared input-output map, use true. To define a single input-output map, use false. If the value is omitted, the system will default to false. Creatable with POST: Yes Required for POST: No

Child Elements

name (type)	min/max occurs	description
input (input)	0/unbounded	This element provides a URI for input Artifacts in the input-output map. There may be cases where multiple inputs are associated with a single output, such as when working with a shared output. Creatable with POST: Yes Required for POST: Yes
output (output)	0/1	This element provides information about the output Artifact that will be created by the Process. Creatable with POST: Yes Required for POST: No

Type instrument

The instrument element provides a URI to the instrument that is responsible for running the process. This instrument must have a single software defined to be valid for process execution.

Attributes

name	type	description
uri	anyURI	A URI that identifies and links to the desired Instrument. Creatable with POST: Yes Required for POST: No

Type output

Extends: artifactbase

The output element provides information about the Artifacts that will be created by the Process. Output is a child element of the input-output-map element.

Attributes

name	type	description
type	string	The type of output the system is creating. This value is case sensitive. Valid values are: ResultFile, SearchResultFile, Analyte, Gel 1D, Gel 2D, Gel Spot, and Image. Creatable with POST: Yes Required for POST: Yes

Child Elements

name (type)	min/max occurs	description
location (location)	0/1	The container where the output Artifact will be placed. This child element is only used when working with Analyte or ResultFile outputs. Creatable with POST: Yes Required for POST: Yes for Analyte, No for ResultFile outputs.

Type parameter

The parameter is a child element of process execution that integrates the Process with the External Program Integration plug-in (EPP). When a user runs the Process, the system automatically issues a command configured in the process parameter this element represents.

Attributes

name	type	description
name	string	The name of the process type parameter. Must match a parameter declared in the corresponding process type.

Type process

The process element defines the XML needed to run a process.

Child Elements

name (type)	min/max occurs	description
type (string)	0/1	The name of the Process (process type) that you want to run. Creatable with POST: Yes Required for POST: Yes
technician (technician)	0/1	The Technician element provides a URI to the user that is responsible for the Process. Once the Process completes, this user is listed as the Technician that ran the Process. Creatable with POST: Yes Required for POST: Yes
date-run (string)	0/1	The date associated with the running of the Process, in YYYY-MM-DD format. If omitted, the current date will be used. Creatable with POST: Yes Required for POST: No , will default to the current date.
input-output-map (input-output-map)	0/unbounded	The relationship of Process inputs to Process outputs. Creatable with POST: Yes Required for POST: Yes
type ()	0/1	A UDT to apply to the Process. This is an optional element. Creatable with POST: Yes Required for POST: No, unless the UDT has been configured as required.
field ()	0/unbounded	UDFs to apply to the Process, if any. Creatable with POST: Yes Required for POST: No , unless the UDF has been configured as required.
instrument (instrument)	0/1	Instrument provides a URI linking to the detailed representation of the instrument that ran the Process. This instrument must have a single software defined to be valid for process execution. Creatable with POST: Yes Required for POST: No
process-parameter (parameter)	0/1	The process parameter configured for EPP for the Process Type of the Process Creatable with POST: Yes Required for POST: No

Type qc-flag

The qc-flag element defines a QC value to apply to the input or output of the Process.

Possible Values

value	description
UNKNOWN	This value indicates that the qc-flag is unknown for the input or output of the Process. The qc-flag can be unknown if no quality control (QC) step has been performed in your lab.
PASSED	This value indicates that the input or output has successfully passed a QC step performed in your lab.
FAILED	This value indicates that the input or output has failed a QC step performed in your lab.
CONTINUE	This value is a legacy system value. Do not use the CONTINUE value.

Type technician

The technician element provides a URI to the user that is responsible for the Process. Once the Process completes, this user is listed as the technician that ran the Process.

Attributes

name	type	description
uri	anyURI	A URI that identifies and links to the desired technician. Creatable with POST: Yes Required for POST: Yes

REST API

Data: prx

Element process

Example XML

Type artifactbase

Child Elements

Type input

Attributes

Type input-output-map

Attributes

Child Elements

Type instrument

Attributes

Type output

Attributes

Child Elements

Type parameter

Attributes

Type process

Child Elements

Type qc-flag

Possible Values

Type technician

Attributes

Home

REST Endpoints

XML Data Elements

XML Data Types