Versions Compared

Key

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

...

CategoryEnvironment VariableDescriptionAdjustable by ScriptDefault Value
AgentJS7_AGENT_PORTThe number of the port that an Agent is listening to for messages sent from a Controller.Agent Instance Script4445

JS7_AGENT_HTTP_PORTSame as JS7_AGENT_PORT except that a network interface can be specified, e.g. localhost:4445 to limit access to the given network interface. This environment variable will not be available if the Agent is configured not to listen to an HTTP port.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. This environment variable will not be available if the Agent is not configured to listen to an HTTPS port.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 in which the Agent has been installed. For Windows OS this could be e.g. C:\Program Files\sos-berlin.com\js7\agent

For Unix OS environments this could be e.g.
/home/sos/js7/agent

Agent Instance Scriptn/a

JS7_AGENT_DATA

The Agent's data directory with sub-directories for temporary data, configuration data etc. The name of the data directory is created from the prefix var_ followed by the port the Agent is operated for, e.g. var_4445.

For Windows OS this could be e.g. C:\ProgramData\sos-berlin.com\js7\agent_4445

For Unix OS environments this could be e.g.
/home/sos/js7/agent/var_4445

The Agent's home directory JS7_AGENT_HOME includes a symbolic link var_<port> that points to the data directory.

Agent Instance ScriptJS7_AGENT_HOME/var_<JS7_AGENT_HTTP_PORT>

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

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

JS7_AGENT_PID_FILEThe Agent's creates the agent.pid file in the logs directory that contains the process ID of the current Agent being run.Agent Instance ScriptJS7_AGENT_DATA/logs/agent.pid

JS7_AGENT_WORK_DIRThe Agent's working directory.Agent Instance ScriptJS7_AGENT_DATA

JS7_AGENT_TZThe time zone of the Agents' computerAgent Start ScriptEtc/UTC





Run-timeJS7_RETURN_VALUESThe location of a temporary file created by the Agent for the current shell job. This can be used to append pairs of names and values with each pair being added on a separate line. After execution of the shell job the Agent will add order variables with the respective names and values found from this file.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 Script allows the JS7_AGENT_JOB_JAVA_OPTIONS environment variable to be set, e.g. to limit a job's memory consumption with the option -Xmx32m. Therefore this environment variable is populated from the Java job options environment variable.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 in the yade sub-directory 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_YADE_HOME/bin/yade.sh

Windows: JS7_YADE_HOME/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_YADE_HOME/bin/yade4dmz.sh

Windows: JS7_YADE_HOME/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

...