bc-clijob variables

Job output & properties, command job commands & input, url and mail job subject & message definitions can include one or more variables, enabling the creation of generic jobs.

Usage

{{ variable [options] }}

Variables

dir.tmp Name of the operating system temporary directory. This is the value specified in the Java system property java.io.tmpdir, which on Linux is typically /tmp.
job.name Name of job. Supported options are short & encode.
job.description Description of job.
property Name of a job property.
time Time of execution. Supported options are offset, epoch & format.
Default format = dd/MM/yyyy HH:mm:ss z
trigger.message Message generated by trigger job.
trigger.name Name of job trigger. Supported options are short & encode.
trigger.result Result of job which triggered this job.
trigger.time Time of trigger. Supported options are epoch & format.
Default format = dd/MM/yyyy HH:mm:ss z
trigger.time.next Time trigger job is next scheduled to execute, if it has a schedule. Supported options are epoch & format.
Default format = dd/MM/yyyy HH:mm:ss z
trigger.value Exit value of trigger job.

Options

short

When the short option is used with the job.name & trigger.name variables, only the name of the job rather, than full path name, will be output. e.g. wakeup instead of /examples/wakeup.

encode

When the encode option is used with the job.name & trigger.name variables, any /, : or @ characters within the name will be converted to _ characters, and any leading / character will be removed. e.g. /examples/wakeup becomes examples_wakeup.

offset

The offset option is used adjust the execution date/time before it is formatted using the following format [-+]n[smhdMy], where s = seconds, m = minutes, h = hours, d = days, M = months and y = years.

If both offset & format are specfied, offset must specfied first.

epoch

Format time variables as milliseconds from the Unix epoch of 1970-01-01T00:00:00Z.

format

All date/time based variables support the following format string.

Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
M Month in year Month July; Jul; 07
w Week in year Number 27
W Week in month Number 2
D Day in year Number 189
d Day in month Number 10
F Day of week in month Number 2
E Day name in week Text Tuesday; Tue
u Day number of week (1 = Monday, …, 7 = Sunday) Number 1
a Am/pm marker Text PM
H Hour in day (0-23) Number 0
k Hour in day (1-24) Number 24
K Hour in am/pm (0-11) Number 0
h Hour in am/pm (1-12) Number 12
m Minute in hour Number 30
s Second in minute Number 55
S Millisecond Number 978
z Time zone Time zone Pacific Standard Time; PST; GMT-08:00

For full details of the format string, see SimpleDateFormat

Notes:

  • all date/times are formatted using the timezone of the job, unless overridden by a TZ job property;
  • if an invalid format string is specified, the default for the variable will be used instead.

Examples

Job/trigger name insert

Job {{ job.name }} was triggered by {{ trigger.name }}

Job /examples/wakeup was triggered by /examples/sleepy

Job name and custom time insert

Job {{ job.name short }} was triggered {{ time EEE HH:mm z }}

Job wakeup was triggered Mon 10:15 Antarctica/Casey

Adjust the execution time

Today is {{ time EEEE }}, yesterday was {{ time -1d EEEE }}

Today is Monday, yesterday was Sunday

See also

Reference