Versions Compared

Key

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

...

  • accessing arguments available to the job from various sources such as JS7 - Order Variables, job and node arguments, JS7 - Job Resources,
  • allowing to specify the outcome of a job including return values that are passed to subsequent jobs from order variables.

The Job API 

Support for Java Jobs and JavaScript Jobs is available starting from the following releases:

...

ObjectPurpose
js7StepThe built-in object js7Step provides a number of methods
AreaMethodArgumentReturn Value
ArgumentgetAllArgumentsn/a[object[]] arguments

getAllArgumentsAsNameValueMapn/a[map] argumentMap

getAllDeclaredArgumentsn/a[object[]] arguments

getDeclaredArgument[string] argumentName[object] argument

getDeclaredArgumentValue[string] argumentName[string|int|bool] argumentValue

getJobResourcesArgumentsAsNameDetailValueMapn/a[map] arguments

getOrderArgumentsAsNameValueMapn/a[map] arguments
JobgetAgentIdtn/a[string] agentId

getJobEnvironmentn/a[object] jobEnvironment

getJobEnvironment().getJobKeyn/a[string] jobKey

getJobEnvironment().getEncodingn/a[string] encoding

getJobEnvironment()..getDeclaredArgumentsn/a[object[]] jobArguments

getJobInstructionLabeln/a[string] label

getJobNamen/a[string] jobName

getControllerIdn/a[string] controllerId

getOrderIdn/a[string] orderId

getWorkflowNamen/a[string] workflowName

getWorkflowPositionn/a[string] position

getWorkflowVersionIdn/a[string] versionId
OutcomegetLastFailedOutcomesn/a[object[]] outcomes

getLastSucceededOutcomesn/a[object[]] outcomes

getOutcomen/a

[object] outcome


getOutcome().putVariable[string] name,
[string|int|bool] value
n/a
UtilitygetLogger()[string] messagen/a

...