OPH_RESUME¶

Description¶

Type

Data and Metadata Access.

Behaviour

Request the list of the commands submitted within a session or the output of a command.

Parameters

• session: identifier of the intended session; by default, it is the working session.
• id: identifier of the intended workflow or marker; by default, no filter is applied.
• id_type: use “workflow” (default) or “marker” to set the filter “id”.
• document_type: document type, “request” or “response”.
• level:
  • use level “0” to ask for submitted commands (short version) or workflow progress ratio;
  • use level “1” to ask for submitted commands (short version) or workflow output;
  • use level “2” to ask for submitted commands (extended version) or the list of workflow tasks;
  • use level “3” to ask for JSON Requests or the list of workflow task outputs;
  • use level “4” to ask for the list of commands associated to tasks of a workflow (valid only for a specific workflow);
  • use level “5” to ask for original JSON Request (valid only for a specific workflow).
• user: filter by name of the submitter; by default, no filter is applied. Valid only for workflow list (“id”=0).
• status_filter: in case of running workflows, filter by job status according to the following bitmaps.
  • 1xxxxxxx : return references to jobs whose status is OPH_STATUS_PENDING
  • x1xxxxxx : return references to jobs whose status is OPH_STATUS_WAITING
  • xx1xxxxx : return references to jobs whose status is OPH_STATUS_RUNNING (or similar)
  • xxx1xxxx : return references to jobs whose status is OPH_STATUS_COMPLETED
  • xxxx1xxx : return references to jobs whose status is OPH_STATUS_ERROR (or similar)
  • xxxxx1xx : return references to jobs whose status is OPH_STATUS_SKIPPED (due to errors)
  • xxxxxx1x : return references to jobs whose status is OPH_STATUS_ABORTED
  • xxxxxxx1 : return references to jobs whose status is OPH_STATUS_UNSELECTED
  • 11111111 : default bitmap.

System parameters

• sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
• objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, resume => shows output).
• save: used to save session identifier on server.

Examples

Get the list of the commands submitted within the working session:

[OPH_TERM] >>  oph_resume

Get the first command of the working session:

[OPH_TERM] >>  oph_resume id=1;

Arguments¶