Page History

...

JS7 offers an API for jobs that are executed in the Agent's Java Virtual Machine:

Java Jobs
- Such jobs run are operated in the Java Virtual Machine used with the related JS7 Agent.
JavaScript Jobs
- Such jobs require use of the Oracle® GraalVM Java Virtual Machine with the related JS7 Agent.
  - JS7 - Installing Oracle GraalVM
  - JS7 - Installing Oracle GraalVM JavaScript Runtime Packages

...

Object		Purpose
`js7Step`		The built-in object `js7Step` provides a number of methods
Area	Method	Argument	Return Value
Argument	`getAllArguments`	`n/a`	`[object[]] arguments`
	`getAllArgumentsAsNameValueMap`	`n/a`	`[map] argumentMap`
	`getAllDeclaredArguments`	`n/a`	`[object[]] arguments`
	`getDeclaredArgument`	`[string] argumentName`	`[object] argument`
	`getDeclaredArgumentValue`	`[string] argumentName`	`[string\|int\|bool] argumentValue`
	`getJobResourcesArgumentsAsNameDetailValueMap`	`n/a`	`[map] arguments`
	`getOrderArgumentsAsNameValueMap`	`n/a`	`[map] arguments`
Job	`getAgentIdt`	`n/a`	`[string] agentId`
	`getJobEnvironment`	`n/a`	`[object] jobEnvironment`
	`getJobEnvironment().getJobKey`	`n/a`	`[string] jobKey`
	`getJobEnvironment().getEncoding`	`n/a`	`[string] encoding`
	`getJobEnvironment()..getDeclaredArguments`	`n/a`	`[object[]] jobArguments`
	`getJobInstructionLabel`	`n/a`	`[string] label`
	`getJobName`	`n/a`	`[string] jobName`
	`getControllerId`	`n/a`	`[string] controllerId`
	`getOrderId`	`n/a`	`[string] orderId`
	`getWorkflowName`	`n/a`	`[string] workflowName`
	`getWorkflowPosition`	`n/a`	`[string] position`
	`getWorkflowVersionId`	`n/a`	`[string] versionId`
Outcome	`getLastFailedOutcomes`	`n/a`	`[object[]] outcomes`
	`getLastSucceededOutcomes`	`n/a`	`[object[]] outcomes`
	`getOutcome`	`n/a`	`[object] outcome`
	`getOutcome().putVariable`	`[string] name,` `[string\|int\|bool] value`	`n/a`
Utility	`getLogger()`	`[string] message`	`n/a`

...

Users implement a class for arguments with an arbitrary name that creates objects for declared arguments.
Users instantiate the class for arguments in their JS7Job class implementation.

...

Constructor	Argument	Explanation
`js7.JobArgument()`	`[string] argumentName`	Specifies the name of the argument from a string. Argument names are case-sensitive.
	`[bool] isRequired`	Optionally specifies if the argument is required. If required and the argument is not declared with the workflow and no default value is provided then an error will be raised.
	`[string\|int\|bool] defaultValue`	Optionally specifies a default value using one of the indicated data types.
	`[enum] displayMode`	Optionally specifies the `js7.DisplayMode.MASKED` enumeration value that prevents argument values from being logged.

...

Space shortcuts