Versions Compared

Key

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

...

List of Environment Variables available with Job Streams

Environment Variable ExampleDescription
SCHEDULER_JOBSTREAM_INSTANCE_IDc3f88b94-fd4e-4365-9593-0cf34d575f6eThe instance id of the actual running job stream
SCHEDULER_JOBSTREAM_JOBSTREAMmyStreamThe name of the job stream
SCHEDULER_JOBSTREAM_TIME2017-12-01 09:13:59The actual time in the format HH:mm:ss
SCHEDULER_JOBSTREAM_CENTURY31
The actual day
Day of task start time dd
SCHEDULER_JOBSTREAM_DAY2012
The actual year
Year of task start time YYYY
SCHEDULER_JOBSTREAM_YEAR2017
The actual year
Year of task start time YYYY
SCHEDULER_JOBSTREAM_YEAR_YY21
The actual year
Year of task start time YY
SCHEDULER_JOBSTREAM_MONTH12
The actual month mm
Month of task start time mm
SCHEDULER_JOBSTREAM_MONTH_NAMEApril
The actual month
Month name of task start time display name UK
SCHEDULER_JOBSTREAM_DATE20171201
The actual date yyyyMMdd
Date of task start time yyyyMMdd
SCHEDULER_JOBSTREAM_DATE_YY17-12-01
The actual date
Dateof task start time yyMMdd
SCHEDULER_JOBSTREAM_DATE_YYYY2017-12-01
The actual date
Dateof task start time yyyyMMdd
SCHEDULER_JOBSTREAM_FOLDER/jobsThe folder for the actual running job
SCHEDULER_JOBSTREAM_JOBNAMEjobs/myJobThe name of the job

Explanations

  1. For job parameters the default setting is to be prefixed with SCHEDULER_PARAM_, e.g. the parameter hostname will become SCHEDULER_PARAM_HOSTNAME.
    • You can modify this behavior by specifying job parameters to be used without any prefix. This can be achieved by adding the following parameter configuration to your ./config/scheduler.xml file and by restarting JobScheduler:

      Code Block
      languagexml
      <params>
      	<param name="scheduler.variable_name_prefix" value="*NONE"/>
      </params>

      With this setting a parameter hostname will be provided with the environment variable HOSTNAME.

    • You can use an arbitrary prefix by specifying:

      Code Block
      languagexml
      <params>
      	<param name="scheduler.variable_name_prefix" value="MY_SCHEDULER_PARAM_"/>
      </params>

      With this setting a parameter hostname will be provided with the environment variable MY_SCHEDULER_PARAM_HOSTNAME.

       
    • The default value is provided by the implicit setting:

      Code Block
      languagexml
      <params>
      	<param name="scheduler.variable_name_prefix" value="SCHEDULER_PARAM_"/>
      </params>

      With this setting a parameter hostname will be provided with the environment variable SCHEDULER_PARAM_HOSTNAME.

...