JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Introduction

  • Environment variables are a means to parameterize jobs.
  • A number of environment variables are available to shell jobs by default.
  • Additional environment variables can be added per job configuration from order variables and node arguments.

Environment Variables automatically available to Shell Jobs

CategoryEnvironment VariableDescriptionAdjustable by ScriptDefault Value
ControllerJS7_CONTROLLER_IDIdentification of a Controller as specified during initial operation.n/an/a





AgentJS7_AGENT_PORTThe number of the port that an Agent is listening to for messages arriving from a Master.Agent Instance Script4445

JS7_AGENT_HTTP_PORTSame as JS7_AGENT_PORT except that a network interface an be specified, e.g. localhost:4445 to limit access to the given network interface.Agent Instance Script4445

JS7_AGENT_HTTPS_PORTThe SSL port used in addition to the HTTP port. A network interface can be specified, e.g. myhost:4447 to limit access to the given network interface.Agent Instance Scriptn/a

JS7_AGENT_USERThe account that the Agent is operated for. For Unix OS the account can be specified from the Agent Instance Script. For Windows OS the service account assigned to the Agent with the Windows Service Panel is provided

Unix: Agent Instance Script

Windows: Service Account

n/a

JS7_AGENT_HOME

The Agent's home directory, i.e. the directory to which the Agent has been installed. For Windows OS this could be e.g. C:\Pogram Files\sos-berlin.com\agentAgent Instance Scriptn/a

JS7_AGENT_DATA

The Agent's data directory with sub-directories for temporary data, configuration data etc. For Windows OS this could be e.g. C:\PogramData\sos-berlin.com\agent

The Agent's home directory JS7_AGENT_HOME includes a symlink var_4445 that points to the data directory.

Agent Instance ScriptJS7_AGENT_HOME/var_4445

JS7_AGENT_CONFIG_DIRThe Agent's configuration directory.Agent Instance ScriptJS7_AGENT_DATA/var_4445/config

JS7_AGENT_LOGSThe Agent's directory for log files.Agent Instance ScriptJS7_AGENT_DATA/var_4445/logs

JS7_AGENT_PID_FILE_DIRThe Agent's directory to hold the file agent.pid that contains the process ID of the current Agent run.Agent Instance ScriptJS7_AGENT_DATA/var_4445/logs

JS7_AGENT_WORK_DIRThe Agent's working directory.Agent Instance ScriptJS7_AGENT_DATA/var_4445

JS7_AGENT_KILL_SCRIPTThe script used by the Agent to kill job processes. Users can implement their own version of this script if required for specific OS.Agent Instance ScriptJS7_AGENT_DATA/var_4445/tmp/kill_task.sh





InventoryJS7_JOB_NAMEThe name of the job as specified with the workflow configuration.n/a

JS7_ORDER_IDThe order identification as specified when creating an order.n/a

JS7_WORKFLOW_NAMEThe name of the workflow.n/a

JS7_WORKFLOW_NODE_LABELThe label assigned the workflow node for the job. Consider that the same job can be used a number of times in a workflow and that it's assignment to a node is specified by a label.n/a

JS7_WORKFLOW_POSITIONThe indicator for the position of the order in the current workflow.n/a





Run-timeJS7_RETURN_VALUES
n/a

JAVA_HOMEThe location of the Java installation directory as used by the Agent.Agent Instance ScriptJAVA_HOME

JAVA_OPTIONSJava options for the Agent loading its JVM are different from Java options used for jobs that run individual Java programs. Therefore the Agent Start Scripts offers to set the JS7_AGENT_JOB_JAVA_OPTIONS environment variable e.g. to limit a job's memory consumption by a value "-Xmx32m"Agent Instance ScriptJS7_AGENT_JOB_JAVA_OPTIONS





File TransferJS7_YADE_HOMEThe home directory of the YADE installation. By default the Agent ships with YADE included with the sub-directory yade of the Agent's home directory.n/aJS7_AGENT_HOME/yade

JS7_YADE_BINThe path to the YADE start script. Usually this is located in the bin sub-directory of the directory specified  by JS7_YADE_HOME.n/a

Unix: JS7_AGENT_HOME/yade/bin/yade.sh

Windows: JS7_AGENT_HOME/yade/bin/yade.cmd


JS7_YADE_DMZ_BINThe location of the start script used to run YADE in a DMZ. By default the directory is the same as JS7_YADE_HOME/bin and the file name is yade4dmz.sh.n/a

Unix: JS7_AGENT_HOME/yade/bin/yade4dmz.sh

Windows: JS7_AGENT_HOME/yade/bin/yade4dmz.cmd


JS7_YADE_CONFIG_DIRThe location of the configuration directory that holds YADE file transfer configuration files (*.xml, *.ini). By default the Agent's configuration directory is used.Agent Instance ScriptJS7_AGENT_CONFIG_DIR





Scheduled DateJS7_SCHEDULED_DATE

The date for which an order originally was scheduled. The date format includes yyyy, MM, dd, hh, mm, ss and the time zone, e.g. 2020-12-03 09:13:59+0100

n/aScheduled Date

JS7_SCHEDULED_YEARThe year of the scheduled date padded by 2 digits, e.g. 2020, 2021, 2022, ...n/aYear of Scheduled Date

JS7_SCHEDULED_MONTHThe month of the scheduled date padded by 2 digits, e.g. 01, ..., 12n/aMonth of Scheduled Date

JS7_SCHEDULED_DAYThe day of the scheduled date padded by 2 digits, e.g. 01, ..., 31n/aDay of Scheduled Date

JS7_SCHEDULED_HOURThe hour of the scheduled date padded by 2 digits, e.g. 00, ..., 24n/aHour of Scheduled Date

JS7_SCHEDULED_MINUTEThe minute of the scheduled date padded by 2 digits, e.g. 01, ..., 59n/aMinute of Scheduled Date

JS7_SCHEDULED_SECONDThe second of the scheduled date padded by 2 digits, e.g. 01, ..., 59n/aSecond of Scheduled Date





Task Start DateJS7_TASKSTART_DATEThe date at which the task was started. The date format includes yyyy, MM, dd, hh, mm, ss and the time zone, e.g. 2020-12-03 09:13:59+0100n/aTask Start Date

JS7_TASKSTART_YEARThe year of the task start date padded by 2 digits, e.g. 2020, 2021, 2022, ...n/aYear of Task Start Date

JS7_TASKSTART_MONTHThe month of the task start date padded by 2 digits, e.g. 01, ..., 12n/aMonth of Task Start Date

JS7_TASKSTART_DAYThe day of the task start date padded by 2 digits, e.g. 01, ..., 31n/aDay of Task Start Date

JS7_TASKSTART_HOURThe hour of the task start date padded by 2 digits, e.g. 00, ..., 24n/aHour of Task Start Date

JS7_TASKSTART_MINUTEThe minute of the task start date padded by 2 digits, e.g. 01, ..., 59n/aMinute of Task Start Date

JS7_TASKSTART_SECONDThe second of the task start date padded by 2 digits, e.g. 01, ..., 59n/aSecond of Task Start Date


Environment Variables available per Job Configuration

  • The job configuration offers to specify environment variables that are forwarded to the job script.
  • The values of such environment variables can be specified from
    • constant string values
    • order variables
    • node arguments


Explanations:

  • Users are free to choose the name of an environment variable.
  • Environment variables can be assigned values from order variables and from node arguments. Such variables are preceded by a $ and consider the spelling of the respective variable or argument.



  • No labels