Developer Cloud Sandboxes solution

h1. ciop-simjob CLI reference

{{>toc}}

h2. Name

ciop-simjob -- runs a specified node of the application workflow. This is useful to perform unit test for a job.

h2. Synopsis

<pre>

ciop-simjob {node} [option]

</pre>

h2. Options

*node*

p. This must be the id of the node registered in the workflow "sample" in the file ${_CIOP_APPLICATION_PATH}/application.xml

*-i input*

p. directory name or file name containing the input to map to the executable via stdin. This path must be relative to share path ${_CIOP_SHARE_PATH}. 

By default the value is setup to find the best input for your job (more info in the documentation)

*-o output*

p. directory name where to put the output file with the stdout of the execution This directory must not exist (or use -f) and must be relative to share path ${_CIOP_SHARE_PATH}

By default the value is setup to find the best output dir for next job (more info in the documentation)

*-f*

p. delete existing output directory if it exists (default: no)

*-n*

p. list the node ids of the workflow

*-p name value*

p. define a processing parameter for the simulation. If a default value is defined in the application.xml, it will be overwritten (not yet implemented)

h2. Exit codes

@ciop-simjob@ command exits 0 on success, and >0 if an error occurs.

h2. Examples

h3.  Example 1. Get the workflow node IDs

<pre>ciop-simjob -n</pre>

h3. Example 2. First run of a given workflow node

<pre>ciop-simjob node_name</pre>

h3. Example 3. Following runs of a given workflow node (deletes the results of a previous run)

<pre>ciop-simjob -f node_name</pre>

h2. See also

p. [[ciop-simwf]]