Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameRequiredDefault ValuePurpose
statesyesn/a

Possible values: pending, scheduled, failed, suspended, waiting, inprogress, prompting. Values can be specified in uppercase, lowercase or mixed letters.

Values can be specified from a semicolon separated list. Each state in the list is handled separately, for example

  • the transition continue for prompting orders will move orders to the IN PROGRESS and possibly to the RUNNING state,
  • the same transition for suspended orders will put orders to the state they had before being suspended.

Example: failed;suspended

transition

yesn/a

Possible values are one of:

  • cancel: execute cancel operation on related orders
  • continue: execute resume operation on failed and suspended orders. Execute confirm operation on prompting orders.
  • suspend: execute suspend operation on orders that are not failed, not finished and not suspended.
workflow_foldersno/*A list of folders that hold workflows for which orders should be transitioned.

If more than one folder is specified then folders are separated by semicolon. When used with the trailing characters /* then the folder will be looked up recursively. By default all folders will be looked up recursively.

Example: /folder/sub1;/another_folder/sub2/*

workflow_search_patternsnon/a

A list of search patterns for names of workflow for which orders should be transitioned. The wildcard characters * (zero or more characters) and ? (a single character) can be used. If more than one search pattern is used then they are separated by semicolon.

Example: *myWorkflow*;my?orkflow

order_search_patternsno/n/a

A list of search patterns for order names. If more than one search pattern is used then they are separated by semicolon.

Examples: *myWorkflow*;/folder/sub1/my?orkflow

persist_durationnon/a

This argument is available for FAILED orders. It specifies the minimum duration for which the order is in the failed state.

  • A format for the duration relative to the current time, e.g. 6h, 12h, 1d, 1w that specifies the quantity followed by a qualifier.
  • Example:  
      • 2d
  • Possible qualifiers are:
    • s (seconds)
    • m (minutes)
    • h (hours)
    • d (days)
    • w (weeks)
    • M (months)
    • y (years)
controller_idnoCurrent Controller IDThe identifier of a Controller can be specified to limit the resulting list of orders to the indicated Controller.
batch_sizeno10000

The maximum number of orders that are processed in a single request.

Orders are transitioned in a single transaction. This includes that either all orders in a transaction are transitioned or none. If the number of orders exceeds the batch size then a further transaction is executed.

If the value 1 is used for the batch_size is used then each order is transitioned individually with a successful or failed result.

The batch size should not exceed a value of approx. 15000 in order to limit the size of requests to the Controller to approx. 4 MB which is a frequently applied limit of Proxy Servers that might be in place between the Agent running the job and JOC Cockpit.

...