Page History
Table of Contents |
---|
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
...
available to Shell Jobs
Category | Environment Variable | Description | Adjustable by Script | Default Value |
---|---|---|---|---|
Controller | JS7_CONTROLLER_ID | Identification of a Controller as specified during initial operation. | n/a | n/a |
Agent | JS7_AGENT_PORT | The number of the port that an Agent is listening to for messages arriving from a Master. | Agent Instance Script | 4445 |
JS7_AGENT_HTTP_PORT | Same 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 Script | 4445 | |
JS7_AGENT_HTTPS_PORT | The 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 Script | n/a | |
JS7_AGENT_USER | The 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 | |
| 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\agent | Agent Instance Script | n/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. The Agent's home directory JS7_AGENT_HOME includes a symlink | Agent Instance Script | JS7_AGENT_HOME/var_4445 | |
JS7_AGENT_CONFIG_DIR | The Agent's configuration directory. | Agent Instance Script | JS7_AGENT_DATA/var_4445/config | |
JS7_AGENT_LOGS | The Agent's directory for log files. | Agent Instance Script | JS7_AGENT_DATA/var_4445/logs | |
JS7_AGENT_PID_FILE_DIR | The Agent's directory to hold the file agent.pid that contains the process ID of the current Agent run. | Agent Instance Script | JS7_AGENT_DATA/var_4445/logs | |
JS7_AGENT_WORK_DIR | The Agent's working directory. | Agent Instance Script | JS7_AGENT_DATA/var_4445 | |
JS7_AGENT_KILL_SCRIPT | The 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 Script | JS7_AGENT_DATA/var_4445/tmp/kill_task.sh | |
Inventory | JS7_JOB_NAME | The name of the job as specified with the workflow configuration. | n/a | |
JS7_ORDER_ID | The order identification as specified when creating an order. | n/a | ||
JS7_WORKFLOW_NAME | The name of the workflow. | n/a | ||
JS7_WORKFLOW_NODE_LABEL | The 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_POSITION | The indicator for the position of the order in the current workflow. | n/a | ||
Run-time | JS7_RETURN_VALUES | n/a | ||
JAVA_HOME | The location of the Java installation directory as used by the Agent. | Agent Instance Script | JAVA_HOME | |
JAVA_OPTIONS | Java options for jobs the Agent loading a 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 Script | JS7_AGENT_JOB_JAVA_OPTIONS | |
File Transfer | JS7_YADE_HOME | The home directory of the YADE installation. By default the Agent ships with YADE included in with the sub-directory "yade " of the Agent's home directory. | n/a | JS7_AGENT_HOME/yade |
JS7_YADE_BIN | The 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: Windows: | |
JS7_YADE_DMZ_BIN | The 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 yadeyade4dmz.sh . | n/a | Unix: Windows: | |
JS7_YADE_CONFIG_DIR | The 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 Script | JS7_AGENT_CONFIG_DIR | |
Scheduled Date | JS7_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/a | Scheduled Date |
JS7_SCHEDULED_YEAR | The year of the scheduled date padded by 2 digits, e.g. 2020, 2021, 2022, ... | n/a | Year of Scheduled Date | |
JS7_SCHEDULED_MONTH | The month of the scheduled date padded by 2 digits, e.g. 01, ..., 12 | n/a | Month of Scheduled Date | |
JS7_SCHEDULED_DAY | The day of the scheduled date padded by 2 digits, e.g. 01, ..., 31 | n/a | Day of Scheduled Date | |
JS7_SCHEDULED_HOUR | The hour of the scheduled date padded by 2 digits, e.g. 00, ..., 24 | n/a | Hour of Scheduled Date | |
JS7_SCHEDULED_MINUTE | The minute of the scheduled date padded by 2 digits, e.g. 01, ..., 59 | n/a | Minute of Scheduled Date | |
JS7_SCHEDULED_SECOND | The second of the scheduled date padded by 2 digits, e.g. 01, ..., 59 | n/a | Second of Scheduled Date | |
Task Start Date | JS7_TASKSTART_DATE | The 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+0100 | n/a | Task Start Date |
JS7_TASKSTART_YEAR | The year of the task start date padded by 2 digits, e.g. 2020, 2021, 2022, ... | n/a | Year of Task Start Date | |
JS7_TASKSTART_MONTH | The month of the task start date padded by 2 digits, e.g. 01, ..., 12 | n/a | Month of Task Start Date | |
JS7_TASKSTART_DAY | The day of the task start date padded by 2 digits, e.g. 01, ..., 31 | n/a | Day of Task Start Date | |
JS7_TASKSTART_HOUR | The hour of the task start date padded by 2 digits, e.g. 00, ..., 24 | n/a | Hour of Task Start Date | |
JS7_TASKSTART_MINUTE | The minute of the task start date padded by 2 digits, e.g. 01, ..., 59 | n/a | Minute of Task Start Date | |
JS7_TASKSTART_SECOND | The second of the task start date padded by 2 digits, e.g. 01, ..., 59 | n/a | Second 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