OPH_TASKS

Description

Type

Metadata Access.

Behaviour

It shows information about executed tasks. Default arguments allow to show all the tasks executed. If a container is given, then only tasks that involve the container are shown. Optional filters on operation and datacube PID can also be used. Any filter can use SQL wildcards (%, _, etc.).

Parameters

  • cube_filter: optional filter on the name of input/output datacubes. The name must be in PID format. Default value is “all”.
  • operator_filter: optional filter on the name of the operators implied in tasks. Default value is “all”.
  • path : optional filter on absolute/relative path. Path is expanded so it can also contain ‘.’ and ‘..’ It is only considered when container_filter is specified.
  • cwd: absolute path corresponding to the current working directory, necessary to correctly parse paths. All resolved paths must be associated to the calling session, so they should contain “/<session-code>”. It is only considered when container_filter is specified.
  • recursive : specifies if the search is done recursively or not. The argument is considered only for the first three levels and may have the following values:
    • no : research only in current path (default)
    • yes : research recursively starting from current path
  • container: optional filter on containers. The argument is considered only inside the specified path. Default is “all”.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1). This operator is not parallel, so the only possible value is 1.
  • 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, tasks => shows a list of tasks submitted previously).

Examples

Show information about all tasks:

[OPH_TERM] >>  oph_tasks cube_filter=all;operator_filter=all;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
cube_filter “string” “no”   “all”  
operator_filter “string” “no”   “all”  
path “string” “no”   “-“  
cwd “string” “yes”      
recursive “string” “no” “yes|no” “no”  
container “string” “no”   “all”  
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|tasks” “all”