Versions Compared

Key

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

...

SettingsDefaultExplanation
agentConfig.forced.controllerId
Forces use of the given ControllerId for all generated agents.
agentConfig.default.controllerId
Specifies the ControllerId to be used for generated agents if no ControllerId is provided in the agentConfig (forced.agent, default.agent, mappings) for a specific agent.
agentConfig.forced.agent

Forces use of the given Agent for all converted jobs.

Agent definition:

  • Expects a JSON value.
  • The JSON can be provided as:
    • JSON text
      or
    • JSON include file (relative to the properties file)
  • JSON elements:
    • NameDefaultExplanation
      platformUNIXForces use of the UNIX or WINDOWS platform.
      subagentClusterId
      Forces use the given subagentClusterId for converted jobs when an agentCluster is used.
      standaloneAgent
      See agent-schema.json.
      agentCluster
      See clusterAgent-schema.json.
  • Examples:
    • {"platform":"UNIX"}
      • Forces use of the UNIX platform for all converted jobs.
    •  {"standaloneAgent":{"url":"http://localhost:4445"}}
      • Forces use of the standalone Agents in all converted jobs with the given url.
    •  {"platform":"UNIX", "standaloneAgent":{"agentName":"forced_agent", "url":"http://localhost:4445"}}
      • Forces use of a standalone Agent forced_agent in all converted jobswith the given url.
agentConfig.default.agent
NameURL
default_agenthttp://localhost:4445

This agent is used when an AutoSys® job does not provide machine information.

The syntax for assignments: see agentConfig.forced.agent Agent definition.

agentConfig.mappings

By default the Converter handles the mapping of Agent Names found in AutoSys® job  machine attribute:


The syntax for mapping includes:

<autosys-agent-name>=<Agent definition>

<autosys-agent-name> is the name of the AutoSys® Agent(machine).
<Agent definition> see agentConfig.forced.agent Agent definition..

Example:

autosys_agent1={"platform":"UNIX", "standaloneAgent":{"agentName":"primaryAgent", "url":"http://unix:4445"}};autosys_agent2={"platform":"WINDOWS", "standaloneAgent":{"agentName":"secondaryAgent", "url":"http://win:4445"}}

  • The machine autosys_agent1 is mapped to the JS7 Agent with the name primaryAgent that is operated for Unix.
  • The machine class autosys_agent2 is mapped to the JS7 Agent with the name secondaryAgent that is operated for Windows.

or

 autosys_agent1=examples/agent_standalone.json; autosys_agent2=examples/cluster_agent.json

  • The machine autosys_agent1 is mapped to the JS7 Agent defined in the examples/agent_standalone.json file.
  • The machine autosys_agent2 is mapped to the JS7 Agent defined in the examples/cluster_agent.json file.

Any number of mappings are specified separated by a semicolon. This setting can be split across a number of lines by use the "\" line continuation character at the end of each line that should be continued.


Configuration of mappings in a file:

  • With each run, the converter creates a report/agent_mapping.config file that lists all machine names on the left and empty mapping values on the right.
  • After manual adjustments, the file can be moved to another location and assigned as a file to the agentConfig.mappings in the next conversion.

Section: Mock

SettingDefaultExplanation
mockConfig.forced.jitl.mockLevel

Mock levels are used for dry runs of the conversion for JS7 - Job Templates (JITL JVM Jobs). If a mock level is specified then JVM Jobs will not be executed but will log and will optionally check arguments only.

The following values can be specified for this setting:

  • INFO: arguments are logged, execution of JVM Jobs is considered successful.
  • ERROR: arguments are logged, required arguments of JVM Jobs are checked and errors are raised in case of missing arguments.

Without this setting being specified the JITL JVM Jobs will be executed from the converted jobs.

mockConfig.forced.shell.unixScript

Mock scripts are used for dry runs of the conversion. The job scripts of converted Shell Jobs are replaced by the call to a mock script for Unix platforms. Consider that mock scripts have to be provided by the user and have to be available for Agents at run-time.

This setting specifies the path to a mock script for Unix, for example, $HOME/MockScript.sh

A mock script for Unix can look like this:

Code Block
languagebash
titleExample for Mock Script on Unix
linenumberstrue
collapsetrue
#!/bin/sh
echo "------------------------------------------------------------"
echo "Start Unix Mock Script: $0"
echo "------------------------------------------------------------"
echo "Arguments: $*"
echo "------------------------------------------------------------"

If no mock script is specified then the original AutoSys® job script is used for the converted JS7 job.

mockConfig.forced.shell.windowsScript

Mock scripts are used for dry runs of the conversion. The job scripts of converted Shell Jobs are replaced by the call to a mock script for Windows platforms. Consider that mock scripts have to be provided by the user and have to be available for Agents at run-time.

Specifies the path to a mock script for Windows, for example, %UserProfile%\MockScript.cmd

A mock script for Windows can look like this: 

Code Block
languagebash
titleExample for Mock Script on Windows
linenumberstrue
collapsetrue
@echo off
@echo ------------------------------------------------------------
@echo Start Windows Mock Script: %0
@echo ------------------------------------------------------------
@echo Arguments: %*
@echo ------------------------------------------------------------

If no mock script is specified then the original AutoSys® job script is used for the converted JS7 job.

...