Versions Compared

Old Version 20

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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


Panel
Table of Contents
maxlevel2

...

Functions are entered using the following formats:
 

<pre> 
${_function}
${_function(arg1, ..., argN)}
</pre>
 Panel
 Html bobswift
 Anchor
Formatting Rules
Formatting Rules
Formatting Rules
...
  • Functions must be written either:
    • In all lower-case 
...
    •  characters.
...
    • Exactly 
...
    •  as 
...
    •  shown 
...
    •  in 
...
    •  the 
...
    •  tables 
...
    •  on 
...
    •  this 
...
    •  page.
...
  • Functions have zero, 
...
  •  one, 
...
  •  or 
...
  •  multiple 
...
  •  parameters.
...
  • Each 
...
  •  function 
...
  •  parameter 
...
  •  is 
...
  •  one 
...
  •  of 
...
  •  three 
...
  •  specific 
...
  •  types:
...
    • String
    • Integer
    • Boolean
  • String parameters must be enclosed in single or double quotation marks.
  • Integer and Boolean parameters can be enclosed in single or double quotation marks.
  • Optional parameters are identified on this page by being enclosed in [square brackets]. When copying a function from the documentation, be sure to remove the square brackets; otherwise, the function will not resolve.
  • If a function has more than one optional parameter, any optional parameters preceding a specified optional parameter must be included in the function's parameter list. For example:
    • For function ${_responseJsonPath('pathExpression'[,'defaultValue','delimiter',prettyPrint])}
...
    • , 
...
    •  usage 
...
    • ${_responseJsonPath('.outputData','','',true)}
...
    •  would 
...
    •  be 
...
    •  valid, 
...
    •  whereas 
...
    • ${_responseJsonPath('.outputData',,,true)}
...
    •  would 
...
    •  not 
...
    •  be 
...
    •  valid.
...
    • For 
...
    •  function 
...
    • ${_formatDate(['date_time', 
...
    •  'format', 
...
    •  day_offset, 
...
    •  use_business_days, 
...
    •  hour_offset, 
...
    •  minute_offset, 
...
    •  timezone])}
...
    • , 
...
    •  usage 
...
    • ${_formatDate('2018-09-01','',0,true)}
...
    •  would 
...
    •  be 
...
    •  valid, 
...
    •  whereas 
...
    • ${_formatDate('2018-09-01','',,true)}
...
    •  would 
...
    •  not 
...
    •  be 
...
    •  valid.
...
  • All functions allow nesting to two levels. That is, a function can be an argument to another function, which itself can be an argument to another function.
    • You must use a double underscore preceding the name of a first-level nested function.
    • You must use a triple underscore preceding the name of a second-level nested function.

    For example, for 2nd day of next month less one Business Day:
 Panel
${_formatDate('${__dayOfMonth(2,'${___dateadv('yyyy-MM-dd',0,1)}')}','',-1,true)}
</pre>
 Anchor
Function Categories
Function Categories
 Function Categories
Functions are listed alphabetically within the following categories on this page:
  • Conditional functions
  • Credential functions
  • Date functions
  • Mathematical functions
  • Output functions
  • Other Task functions
  • SAP Connection functions
  • Script functions
  • SQL/Stored Procedure functions
  • String functions
  • System functions
  • Universal Task functions
  • Web Service Functions
 Anchor
Conditional Functions
Conditional Functions
Conditional Functions
...
     
Description
Returns a conditional value depending on the equality of two string parameters.
 
(Returns if_value if string value1 is equal to string value2; otherwise, else_value is returned.)
Syntax
${_ifEqual('value1', 'value2', 'if_value', 'else_value'[, ignore_case])}
Parameters
  • value1 
    Required; First string.
  • value2 
    Required; Second string.
  • if_value 
    Required; Return value if value1 equals value2.
  • else_value 
    Required; Return value if value1 does not equal value2.
  • ignore_case 
    Optional; Specification (true or false) whether or not to ignore case when comparing value1 and value2. Default is false.
Examples

<pre>

${_ifEqual('abc','def','YES','NO')}
${_ifEqual('abc','ABC','YES','NO',true)}
${_ifEqual('2015-08-15','${__date()}','17:00','18:00')}

</pre>
 Panel
 Html bobswift

Return Conditional Value Depending on Value of Boolean Parameter
     
Description
Returns a conditional value depending on the value of a boolean parameter.
 
Returns if_value if value is true; otherwise, else_value is returned.
Syntax
${_ifTrue(value, 'if_value', 'else_value')}
Parameters
  • value 
    Required; Boolean value (true or false).
  • if_value 
    Required; Return value if value is true.
  • else_value 
    Required; Return value if value is false.
Example

<pre>

${_ifTrue(${__isToday('Mon', 'E')},'20:00','22:00')}

</pre>
 Panel
 Html bobswift
...

 Anchor
Credential Functions
Credential Functions
Credential Functions
...
     
Description
Checks if a date argument is equal to today's date in the specified format.
 
Returns true if date is equal to today's date in the specified format; otherwise, false is returned.
Syntax
${_isToday('date'[, 'format', is_relative])}
Parameters
  • date 
    Required; Date to compare to today's date.
  • format 
    Optional; Format of today's date. Default is yyyy-MM-dd.
  • is_relative 
    Optional; Specification (true or false) for whether today's date is relative to the trigger/launch time of the task instance. Default is false.
Examples

<pre>

${_isToday('Wed', 'E')}
${_isToday('${__dayOfMonth(1,'','',true)}')}

</pre>
 Panel
 Html bobswift

 Anchor
_date
_date
Resolve to Current Date and Time
<ul>
<li> <code>format</code> <br> 
  • format
    Optional; 
 
  •  Date 
 
  •  format. 
 
  •  Default 
 
  •  format 
 
  •  is 
 
  •  yyyy-MM-dd 
 
  •  HH:mm:ss 
 
  •  Z. 
 
  •  For 
 
  •  details 
 
  •  on 
 
  •  the 
 <code>format</code> 
  •  format parameter, 
 see

<li> <code>day_offset</code> <br> 
  • day_offset 
    Optional; 
 
  •  +/- 
 
  •  number 
 
  •  of 
 
  •  days 
 
  •  to 
 
  •  offset.

<li> <code>hour_offset</code> <br> 
  • hour_offset 
    Optional; 
 
  •  +/- 
 
  •  number 
 
  •  of 
 
  •  hours 
 
  •  to 
 
  •  offset.

<li> <code>minute_offset</code> <br> 
  • minute_offset 
    Optional; 
 
  •  +/- 
 
  •  number 
 
  •  of 
 
  •  minutes 
 
  •  to 
 
  •  offset.

</ul>
     
Description
Resolves to the current date and time.
Syntax
${_date(['format', day_offset, hour_offset, minute_offset])}
Parameters
 Html bobswift
 Html bobswift
Examples

<pre>

${_date} --> 2012-07-14 12:43:06 -0400
${_date()} --> 2012-07-14 12:43:06 -0400
${_date('yyyy-MM-dd', 5)} --> 2012-07-19
${_date('yyyy-MM-dd HH:mm:ss', -2, -1)} --> 2012-07-12 11:43:06
${_date('', 0, 0, 10)} --> 2012-07-14 12:53:06 -0400

</pre>
 Panel
 Html bobswift

Resolve to Current Date and Time (Advanced)
<ul>
<li> <code>format</code> <br>Date 
  • format
    Date format. 
 
  •  Default 
 
  •  format 
 
  •  is 
 
  •  yyyy-MM-dd 
 
  •  HH:mm:ss 
 
  •  Z. 
 
  •  For 
 
  •  details 
 
  •  on 
 the <code>format</code> parameter, see 
<li> <code>year_offset</code> <br>Optional; 
  • year_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  years 
 
  •  to 
 
  •  offset.

<li> <code>month_offset</code> <br>Optional; 
  • month_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  months 
 
  •  to 
 
  •  offset.

<li> <code>day_offset</code> <br>Optional; 
  • day_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  days 
 
  •  to 
 
  •  offset.

<li> <code>hour_offset</code> <br>Optional; 
  • hour_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  hours 
 
  •  to 
 
  •  offset.

<li> <code>minute_offset</code> <br>Optional; 
  • minute_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  minutes 
 
  •  to 
 
  •  offset.

</ul>
     
Description
Resolves to the current date and time.
Syntax
${_dateadv(['format', year_offset, month_offset, day_offset, hour_offset, minute_offset])}
Parameters
 Html bobswift
 Html bobswift
Examples

html-bobswift
 Panel
<pre>

${_dateadv} --> 2012-07-29 09:31:42 -0700
${_dateadv('yyyy-MMM', -1)} --> 2011-Jul
${_dateadv('yyyy-MMM', 0, -1)} --> 2012-Jun 
</pre>

Resolve to Current Unix Epoch Time
...
<ul>
<li> <code>date_time</code> <br>Date and time in any of the following formats:
<ul>
<li> 
  • date_time
    Date and time in any of the following formats:
    • yyyy-MM-dd
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
Default is the current date and time.
<li> <code>format</code> <br>Format of returned date. If date_time specifies a time, the default format is 
    Default is the current date and time.
  • format 
    Format of returned date. If date_time specifies a time, the default format is yyyy-MM-dd 
 
  •  HH:mm; 
 
  •  otherwise, 
 
  •  the 
 
  •  default 
 
  •  format 
 
  •  is 
 
  •  yyyy-MM-dd. 
 
  •  For 
 
  •  details 
 
  •  on 
 
  •  the 
 <code>format</code> 
  •  format parameter, 
 
  •  see 
 
<li> <code>day_offset</code> <br>
  • day_offset 
    +/- 
 
  •  number 
 
  •  of 
 
  •  days 
 
  •  to 
 
  •  offset.

<li> <code>use
  • use_business_
days</code> <br>Specification (<code>true</code> or <code>false</code>) for whether <code>day_offset</code> is for business days. Default is false.
<li> <code>hour_offset</code> <br>+/- number of hours to offset.
<li> <code>minute_offset</code> <br>+/- number of minutes to offset. 
<li> <code>timezone</code> <br>Time Zone that the date is formatted in.
</ul><pre>

  • days
    Specification (true or false) for whether day_offset is for business days. Default is false.
  • hour_offset 
    +/- number of hours to offset.
  • minute_offset 
    +/- number of minutes to offset.
  • timezone 
    Time Zone that the date is formatted in.
     
Description
Returns the date after applying offsets. Optionally, can specify the output format.
 
 Note
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property.

Syntax
${_formatDate(['date_time', 'format', day_offset, use_business_days, hour_offset, minute_offset, timezone])}
Parameters
 Html bobswift
 Html bobswift
Example
 Panel
 Html bobswift
Example

 Panel
${_formatDate} --> 2018-08-24 15:37
${_formatDate()} --> 2018-08-24 15:37
${_formatDate('','MMddyyyy',5)} --> 08292018
${_formatDate('2018-09-01','',5)} --> 2018-09-06
${_formatDate('2018-09-01','',-5)} --> 2018-08-27
${_formatDate('2018-10-13 12:13:14 -0400','',5,true,0,0,'Australia/Sydney')} --> 2018-10-14 03:13:14 +1100

</pre>

Return Date with Offsets (Advanced)
<ul>
<li> <code>date_time</code> <br>Date and time in any of the following formats:
<ul>
<li> 
  • date_time
    Date and time in any of the following formats:
    • yyyy-MM-dd
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
Default is the current date and time.
<li> <code>format</code> <br>Format of returned date. If date_time specifies a time, the default format is 
    Default is the current date and time.
  • format 
    Format of returned date. If date_time specifies a time, the default format is yyyy-MM-dd 
 
  •  HH:mm; 
 
  •  otherwise, 
 
  •  the 
 
  •  default 
 
  •  format 
 
  •  is 
 
  •  yyyy-MM-dd. 

 
  •  For 
 
  •  details 
 
  •  on 
 
  •  the 
 <code>format</code> 
  •  format parameter, 
 
  •  see 
 
<li> <code>year_offset</code> <br>Optional; 
  • year_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  years 
 
  •  to 
 
  •  offset.

<li> <code>month_offset</code> <br>Optional; 
  • month_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  months 
 
  •  to 
 
  •  offset.

<li> <code>day_offset</code> <br>Optional; 
  • day_offset 
    Optional; +/- 
 
  •  number 
 
  •  of 
 
  •  days 
 
  •  to 
 
  •  offset.

<li> <code>use
  • use_business_
days</code> <br>Optional; Specification (<b>true</b> or <b>false</b>) for whether <code>day_offset</code> is for business days. Default is false.
<li> <code>hour_offset</code> <br>+/- number of hours to offset.
<li> <code>minute_offset</code> <br>+/- number of minutes to offset. 
<li> <code>timezone</code> <br>Time Zone that the date is formatted in.
</ul><pre>

  • days
    Optional; Specification (true or false) for whether day_offset is for business days. Default is false.
  • hour_offset 
    +/- number of hours to offset.
  • minute_offset 
    +/- number of minutes to offset.
  • timezone 
    Time Zone that the date is formatted in.
     
Description
Returns the date after applying offsets. Optionally, can specify the output format.
 
 Note
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property.

Syntax
${_formatDateAdv(['date_time', 'format', year_offset, month_offset, day_offset, use_business_days, hour_offset, minute_offset, timezone])}
Parameters
 Html bobswift
 Html bobswift
Examples
 Panel
 Html bobswift
Examples

 Panel
${_formatDateAdv} --> 2012-08-24 15:55
${_formatDateAdv()} --> 2012-08-24 15:55
${_formatDateAdv('','MMddyyyy',1)} --> 08242013
${_formatDateAdv('2012-09-01','',0,1)} --> 2012-10-01
${_formatDateAdv('2012-09-01','',0,-1)} --> 2012-08-01
${_formatDateAdv('2012-09-01','',0,0,5,false)} --> 2012-09-06

</pre>

Return Date with Time Zone
<ul>
<li> <code>date_time</code> <br>Date and time in any of the following formats:
<ul>
<li> 
  • date_time
    Date and time in any of the following formats:
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
<li> <code>target
  • target_time_
zone</code> <br>Time zone in which to format the date and time.
<li> <code>output_format</code> <br>Optional; Format of the date and time in the other time zone. 
</ul>
  • zone
    Time zone in which to format the date and time.
  • output_format 
    Optional; Format of the date and time in the other time zone.
     
DescriptionReturns the Date and Time in another time zone.
Syntax
${_formatDateTz('date_time', 'target_time_zone'[, 'output_format'])}
Parameters
 Html bobswift
Examples

<pre>

${_formatDateTz('2018-10-13 01:02:03 -0400', 'Australia/Sydney')} --> 2018-10-13 16:02:03 +1100
${_formatDateTz('2018-10-13 01:02:03 -0400', 'Australia/Sydney','yyyy-MM-dd HH:mm Z')} --> 2018-10-13 16:02 +1100
${_formatDateTz('${ops_launch_time}', '${ops_time_zone}')} = ${_formatDateTz('2018-06-13 15:35:00 -0400', 'Europe/Berlin')} = 2018-06-13 21:35:00 +0200
 
 
</pre>
 Panel
 Html bobswift

Return Day of Week
<ul>
<li> <code>date</code> <br>Date in any of the following formats:
<ul>
<li> 
  • date
    Date in any of the following formats:
    • yyyy-MM-dd
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
Default is the current date.
<li> <code>first_dow</code> <br>Optional; Specification for whether the week starts on Sunday or Monday. Values are <b>sun</b> and <b>mon</b> (not 
    Default is the current date.
  • first_dow 
    Optional; Specification for whether the week starts on Sunday or Monday. Values are sun and mon (not case-sensitive). 
 
  •  Default 
 
  •  is 
 
  •  sun.

<li> <code>first
  • first_dow_
value</code> <br>Optional; Starting value for the first day of week. Value must be a non-negative number. Default is 1. 
</ul>
  • value
    Optional; Starting value for the first day of week. Value must be a non-negative number. Default is 1.
     
Description
Returns the day of week for the specified date as a number.
Syntax
${_dayOfWeek(['date', 'first_dow', first_dow_value])}
Parameters
 Html bobswift
Example

<pre>

${_dayOfWeek} --> 6
${_dayOfWeek()} --> 6
${_dayOfWeek('2012-07-04')} --> 4
${_dayOfWeek('2012-07-04', 'mon')} --> 3

</pre>
 Panel
 Html bobswift

Return Days between Dates
<ul>
<li> <code>date1</code> <br>Required.
<li> <code>date2</code> <br>Required. 
</ul> 
date1 and date2 are specified in any of the following formats:
<ul>
<li> 
  • date1
    Required.
  • date2 
    Required.
date1 and date2 are specified in any of the following formats:
  • yyyy-MM-dd
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm 
 
  •  Z

<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss 
 
  •  Z.
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss.SSS
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss.SSS 
 
  •  Z.
 
</ul>
     
Description
Returns the number of days between date1 and date2.
html-bobswift
<ul>
<li> 
  • If 
 
  •  return 
 
  •  value 
 
  •  is 
 
  •  > 
 
  •  0, 
 
  •  date2 
 
  •  is 
 
  •  after 
 
  •  date1.

<li> 
  • If 
 
  •  return 
 
  •  value 
 
  •  is 
 
  •  < 
 
  •  0, 
 
  •  date2 
 
  •  is 
 
  •  before 
 
  •  date1.

<li> 
  • If 
 
  •  return 
 
  •  value 
 
  •  is 
 
  •  0, 
 
  •  date1 
 
  •  is 
 
  •  equal 
 
  •  to 
 
  •  date2.

</ul>
The start date is inclusive, but the end date is not.
Syntax
${_daysBetween('date1', 'date2')}
Parameters
 Html bobswift
Example

<pre>

${_daysBetween('2012-08-01','2012-09-01')} --> 31

</pre>
 Panel
 Html bobswift

Return Non-Business Day of Month
<ul>
<li> <code>index</code> <br>Required; Nth 
  • index
    Required; Nth non-business 
 
  •  day 
 
  •  of 
 
  •  month.

<li> <code>date</code> <br> 
<ul>
Date 
  • date 
      Date (and 
 
    •  time) 
 
    •  is 
 
    •  specified 
 
    •  in 
 
    •  any 
 
    •  of 
 
    •  the 
 
    •  following 
 
    •  formats:

<ul>
<li> 
      • yyyy-MM-dd
 
<li> 
      • yyyy-MM-dd 
 
      •  HH:mm
 
<li> 
      • yyyy-MM-dd 
 
      •  HH:mm:ss
 
<li> 
      • yyyy-MM-dd 
 
      •  HH:mm 
 
      •  Z

<li> 
      • yyyy-MM-dd 
 
      •  HH:mm:ss 
 
      •  Z.
 
<li> 
      • yyyy-MM-dd 
 
      •  HH:mm:ss.SSS
 
<li> 
      • yyyy-MM-dd 
 
      •  HH:mm:ss.SSS 
 
      •  Z.
 
</ul>
Default is the current date.
<li> <code>format</code> <br>Optional; Format of returned date. Default is 
      Default is the current date.
    • format 
      Optional; Format of returned date. Default is yyyy-MM-dd. 
 
    •  For 
 
    •  details 
 
    •  on 
 
    •  the 
 <code>format</code> 
    •  format parameter, 
 
    •  see 
 

     
Description
Returns the Nth non-business day of month for the month of the date specified. Optionally, can start from the end of the month.
 
 Note
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property.

Syntax
${_nonBusinessDayOfMonth(index, ['date', 'format', reverse])}
Parameters
 Html bobswift
 Html bobswift
<li> <code>reverse</code> <br>Optional; Specification (<b>true</b> or <b>false</b>) for starting from the end of the month. Default is false. 
</ul>
Examples
 Panel Html bobswift<pre>

    • reverse
      Optional; Specification (true or false) for starting from the end of the month. Default is false.
Examples

 Panel
${_nonBusinessDayOfMonth(1)} --> 2012-08-04
${_nonBusinessDayOfMonth(1,'2012-09-01')} --> 2012-09-01
${_nonBusinessDayOfMonth(1,'2012-09-01','',true)} --> 2012-09-30

</pre>

Return Nth Business Day of Month
<ul>
<li> <code>index</code> <br>Required; Nth business day of month.
<li> <code>date</code> <br> 
Date (and time) is specified in any of the following formats:
<ul>
<li> 
  • index
    Required; Nth business day of month.
  • date 
    Date (and time) is specified in any of the following formats:
    • yyyy-MM-dd
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
Default is the current date.
<li> <code>format</code> <br>Optional; Format of returned date. Default is 
    Default is the current date.
  • format 
    Optional; Format of returned date. Default is yyyy-MM-dd. 
 
  •  For 
 
  •  details 
 
  •  on 
 the <code>format parameter</code>, see 
<li> <code>reverse</code> <br>Optional; Specification (<code>true</code> or <code>false</code>) for starting from the end of the month. Default is false. 
</ul>
  • reverse 
    Optional; Specification (true or false) for starting from the end of the month. Default is false.
     
Description
Returns the Nth business day of month for the month of the date specified. Optionally, can start from the end of the month.
 
 Note
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property.

Syntax
${_businessDayOfMonth(index, ['date', 'format', reverse])}
Parameters
 Html bobswift
 Html bobswift
Examples

<pre>

${_businessDayOfMonth(1)} --> 2012-08-01
${_businessDayOfMonth(1,'2012-09-01')} --> 2012-09-04
${_businessDayOfMonth(1,'2012-09-01','',true)} --> 2012-09-
28
</pre>
28
 Panel
 Html bobswift

Return Nth Day of Month
<ul>
<li> <code>index</code> <br>Required; Nth day of month.
<li> <code>date</code> <br> 
Date (and time) is specified in any of the following formats:
<ul>
<li> 
  • index
    Required; Nth day of month.
  • date 
    Date (and time) is specified in any of the following formats:
    • yyyy-MM-dd
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm 
 
    •  Z

<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss 
 
    •  Z.
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS
 
<li> 
    • yyyy-MM-dd 
 
    •  HH:mm:ss.SSS 
 
    •  Z.
 
</ul>
Default is the current date.
<li> <code>format</code> <br>Optional; Format of returned date. Default is 
    Default is the current date.
  • format 
    Optional; Format of returned date. Default is yyyy-MM-dd.

<li> <code>reverse</code> <br>Optional; Specification (<b>true</b> or <b>false</b>) for starting from the end of the month. Default is false. 
</ul><pre>

  • reverse 
    Optional; Specification (true or false) for starting from the end of the month. Default is false.
     
Description
Returns the Nth day of month for the month of the date specified. Optionally, can start from the end of the month.
Syntax
${_dayOfMonth(index, ['date', 'format', reverse])}
Parameters
 Html bobswift
Examples
 Panel
 Html bobswift
Examples

 Panel
${_dayOfMonth(5)} --> 2012-08-05
${_dayOfMonth(15,'2012-09-01','MM/dd/yyyy')} --> 09/15/2012
${_dayOfMonth(1,'2012-09-01','',true)} --> 2012-09-30

</pre>

Return Number of Business Days between Dates
<ul>
<li> <code>date1</code> <br>Required.
<li> <code>date2</code> <br>Required. 
</ul> 
date1 and date2 are specified in any of the following formats:
<ul>
<li> 
  • date1
    Required.
  • date2 
    Required.
date1 and date2 are specified in any of the following formats:
  • yyyy-MM-dd
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm 
 
  •  Z

<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss 
 
  •  Z.
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss.SSS
 
<li> 
  • yyyy-MM-dd 
 
  •  HH:mm:ss.SSS 
 
  •  Z.
 
</ul>
     
Description
Returns the number of business days between date1 and date2.
html-bobswift
<ul>
<li> 
  • If 
 
  •  return 
 
  •  value 
 
  •  is 
 
  •  > 
 
  •  0, 
 <code>date2</code> 
  •  date2 is 
 
  •  after 
 <code>date1</code>.
<li> If return value is < 0, <code>date2</code> is before <code>date1</code>.
<li> If return value is 0, <code>date1</code> is equal to <code>date2</code>.
</ul>
  •  date1.
  • If return value is < 0, date2 is before date1.
  • If return value is 0, date1 is equal to date2.
The start date is inclusive, but the end date is not.
 
 Note
Whether a holiday is treated as a business day or a non-business day is specified by the Exclude Holidays for Business Days Universal Controller system property.

Syntax
${_businessDaysBetween('date1', 'date2')}
Parameters
 Html bobswift
Example

html-bobswift
 Panel
<pre>

${_businessDaysBetween('2012-08-01','2012-09-01')} --> 23

</pre>

 Anchor
Mathematical Functions
Mathematical Functions
Mathematical Functions
...
     
Description
Return the sum of the augend added with the addend.
Syntax
${_add(augend, addend)}
Parameters
  • augend 
    Integer to which the addend is being added.
  • addend 
    Integer being added to the augend.
Example

html-bobswift
 Panel
<pre>

${_add('77', '33')} --> 110

</pre>
 
Using Variables for augend and addend (${augend} = 17, ${addend} = 5):
 
html-bobswift
 Panel
<pre>

${_add('${augend}','${addend}')} --> 22

</pre>

Divide
     
Description
Return the quotient of the dividend divided by divisor.
Syntax
${_divide(dividend, divisor)}
Parameters
  • dividend 
    Integer being divided by the divisor.
  • divisor 
    Integer being used to divide the dividend.
Example

html-bobswift
 Panel
<pre>

${_divide('7','20')} --> 0
${_divide('20','7')} --> 2
${_divide('20','5')} --> 4

</pre>
 
Using Variables for dividend and divisor (${dividend} = 100, ${divisor} = 5)
 
html-bobswift
 Panel
<pre>

${_divide('${dividend}','${divisor}')} --> 20

</pre>

Multiply
     
Description
Return the product of the multiplicand multiplied with the multiplier.
Syntax
${_multiply(multiplicand, multiplier)}
Parameters
  • multiplicand 
    Integer being multiplied by the multiplier.
  • multiplier 
    Integer being used to multiply the multiplicand.
Example

<pre>

${_multiply('7','20')} --> 140

</pre>
 Panel
 Html bobswift
 
Using Variables for multiplicand and multiplier (${multiplicand} = 100, ${multiplier} = 5):
 
html-bobswift
 Panel
<pre>

${_multiply('${multiplicand}','${multiplier}')} --> 500

</pre>

Return Absolute Value
     
Description
Return the absolute value of the parameter.
Syntax
{_abs(parameter)}
Parameters
  • parameter 
    Integer (positive or negative value).
Example

html-bobswift
 Panel
<pre>

${_abs('-1200')} --> 1200
${_abs('1200')} --> 1200

</pre>
 
Using Variables for parameter (${parameter} = -100):
 
html-bobswift
 Panel
<pre>

${_abs('${parameter}')} --> 100

</pre>

Return Modulo
     
Description
Return the modulo (remainder) of the dividend divided by divisor.
Syntax
${_mod(dividend, divisor)}
Parameters
  • dividend 
    Integer being divided by the divisor.
  • divisor 
    Integer being used to divide the dividend.
Example

<pre>

${_mod('10', '2')} --> 0
${_mod('10', '3')} --> 1
${_mod('70', '65')} --> 5

</pre>
 Panel
 Html bobswift
 
Using Variables for dividend and divisor (${dividend} = 23, ${divisor} = 5):
 
html-bobswift
 Panel
<pre>

${_mod('${dividend}','${divisor}')} --> 3
 
</pre>

Subtract
     
Description
Return the difference of the subtrahend subtracted from the minuend.
Syntax
${_subtract(minuend, subtrahend)}
Parameters
  • minuend 
    Integer from which the subtrahend is being subtracted.
  • subtrahend 
    Integer being subtracted from the minuend.
Example

html-bobswift
 Panel
<pre>

${_subtract('77','33')} --> 44
${_subtract('33','77')} --> -44

</pre>
 
Using Variables for minuend and subtrahend (${minuend} = 100, ${subtrahend} = 5):
 
html-bobswift
 Panel
<pre>

${_subtract('${minuend}','${ subtrahend }')} --> 95

</pre>

 Anchor
Other Task Functions
Other Task Functions
Other Task Functions
...
     
Description
Escapes the characters in a variable value using XML entities.
Syntax
${_varEscapeXml('variableName')}
Parameters
  • variableName 
    Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into XML.
Example
Variable Name:
escape_me
 
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
 
<pre>

${_varEscapeXml('escape_me')} --> `1234567890\E-=[]\;
&apos
;,./ ~!@#$%^
&amp
;*()_+{}|:
&quot
;
&lt
;
&gt
;?

</pre>
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
_varEscapeJson
_varEscapeJson
Escape Characters in Variable Using JSON String Rules
     
Description
Escapes the characters in a variable value using JSON string values.
Syntax
${_varEscapeJson('variableName')}
Parameters
  • variableName 
    Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JSON.
Example
Variable Name:
escape_me
 
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
 
<pre>

${_varEscapeJson('escape_me')} --> `1234567890\\E-=[]\\;',.\/ ~!@#$%^&*()_+{}|:\"
<>
?

</pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
_varEscapeJavaScript
_varEscapeJavaScript
Escape Characters in Variable Using JavaScript String Rules
     
Description
Escapes the characters in a variable value using JavaScript String rules.
Syntax
${_varEscapeJavaScript('variableName')}
Parameters
  • variableName 
    Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JavaScript.
Example
Variable Name:
escape_me
 
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
 
html-bobswift
?

</pre>
 Panel
<pre>

${_varEscapeJavaScript('escape_me')} --> `1234567890\\E-=[]\\;\',.\/ ~!@#$%^&*()_+{}|:\"
<>
 Html bobswift

 Anchor
_varEscapeHtml
_varEscapeHtml
Escape Characters in Variable Using HTML Entities
     
Description
Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.)
Syntax
${_varEscapeHtml('variableName')}
Parameters
  • variableName 
    Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into HTML.
Example
Variable Name:
escape_me
 
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
 
<pre>

${_varEscapeHtml('escape_me')} --> `1234567890\E-=[]\;',./ ~!@#$%^
&amp
;*()_+{}|:
&quot
;
&lt
;
&gt
;?

</pre>
 Panel
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift
 Html bobswift

 Anchor
_varLiteralPattern
_varLiteralPattern
Escape Characters in Variable as a Literal Pattern
     
Description
Returns a literal regular expression pattern String for the value of the specified variable.
  
This method produces a String that can be used to create a Pattern that would match the String as if it were a literal pattern.
Syntax
${_varLiteralPattern('variableName')}
Parameters
  • variableName 
    Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into a regular expression as a literal pattern.
Example
Variable Name:
escape_me
 
Variable Value:
`1234567890\E-=[]\;',./ ~!@#$%^&*()_+{}|:"<>?
 
html-bobswift
?\E

</pre>
 Panel
<pre>

${_varLiteralPattern('escape_me')} --> \Q`1234567890\E\\E\Q-=[]\;',./ ~!@#$%^&*()_+{}|:"
<>
 Html bobswift

 Anchor
_randomString
_randomString
Randomly Generate a String
<ul>
<li> <code>length</code><br>

  • length
    Required; 
 
  •  String 
 
  •  length.

<li> <code>excludeCharacters</code><br>

  • excludeCharacters
    Optional; 
 
  •  String 
 
  •  containing 
 
  •  characters 
 
  •  to 
 
  •  exclude 
 
  •  from 
 
  •  the 
 
  •  default 
 
  •  character 
 
  •  set.

<li> <code>defaultCharacters</code><br>

  • defaultCharacters
    Optional; 
  
  •  String 
 
  •  for 
 
  •  overriding 
 
  •  default 
 
  •  character 
 
  •  set.

</ul>
     
Description
Randomly generates a String with a specified length.
Syntax
${_randomString(length[, 'excludeCharacters', 'defaultCharacters'])}
Parameters
 Html bobswift
<br>ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890`
ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz1234567890`-=~!@#$%^&*()_+[]\{}|;':",./
<>
?
 Note
titleNote
The following characters are included in the default character set, in addition to the space character.
 Html bobswift
 Html bobswift

Example

html-bobswift
 Panel
<pre>

${_randomString(24, '', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890@#$%*')} --> 5*L8T1RN#$AQWEKPA@BQ19JD

</pre>

 Anchor
_replaceAll
_replaceAll
Replace Substring of Value with Regular Expression
...
<ul>
<li> <code>value</code> <br>Any string.
<li> <code>str</code> <br>Substring to search for. If the <code>str</code> argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned. 
</ul>
  • value
    Any string.
  • str 
    Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
     
Description
Returns the index within the string value of the first occurrence of the specified substring, str.
Syntax
${_indexOf('value', 'str')}
Parameters
 Html bobswift
 Anchor
_varIndexOf
_varIndexOf
Return Index of Substring in String Variable
<ul>
<li> <code>variableName</code> <br>Required; Name of the variable being passed into the function.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs as a substring within the variable, the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned. 
</ul>
  • variableName
    Required; Name of the variable being passed into the function.
  • str 
    Required; Substring to search for. If the str argument occurs as a substring within the variable, the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
     
Description
Returns the index within the string variable of the first occurrence of the specified substring, str.
Syntax
${_varIndexOf('variableName', 'str')}
Parameters
 Html bobswift
 Anchor
_indexOfWithOffset
_indexOfWithOffset
Return Index of Substring Plus Offset in String Value
<ul>
<li> <code>value</code> <br>Required; Any string.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
<li> <code>offset</code> <br>Required; Number (positive or negative) to offset the found index. 
</ul>
  • value
    Required; Any string.
  • str 
    Required; Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
  • offset 
    Required; Number (positive or negative) to offset the found index.
     
Description
Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest value.
Syntax
${_indexOfWithOffset('value', 'str', offset)}
Parameters
 Html bobswift
 Anchor
_varIndexOfWithOffset
_varIndexOfWithOffset
Return Index of Substring Plus Offset in String Variable
<ul>
<li> <code>variableName</code> <br>Required; Name of the variable being passed into the function.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
<li> <code>offset</code> <br>Required; Number (positive or negative) to offset the found index. 
</ul>
  • variableName
    Required; Name of the variable being passed into the function.
  • str 
    Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
  • offset 
    Required; Number (positive or negative) to offset the found index.
     
Description
Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest variable.
Syntax
${_varIndexOfWithOffset('variableName', 'str', offset)}
Parameters
 Html bobswift
 Anchor
_lastIndexOf
_lastIndexOf
Return Index of Rightmost Occurrence of Substring in String Value
<ul>
<li> <code>value</code> <br>Required; Any string.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs one or more times as a substring within the value, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned. 
</ul>
  • value
    Required; Any string.
  • str 
    Required; Substring to search for. If the str argument occurs one or more times as a substring within the value, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.
     
Description
Returns the index within the string value of the rightmost occurrence of the specified substring, str.
Syntax
${_lastIndexOf('value', 'str')}
Parameters
 Html bobswift
 Anchor
_varLastIndexOf
_varLastIndexOf
Return Index of Rightmost Occurrence of Substring in String Variable
<ul>
<li> <code>variableName</code> <br>Required; Name of the variable being passed into the function.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs one or more times as a substring within the variable, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned. 
</ul>
  • variableName
    Required; Name of the variable being passed into the function.
  • str 
    Required; Substring to search for. If the str argument occurs one or more times as a substring within the variable, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.
     
Description
Returns the index within the string variable of the rightmost occurrence of the specified substring, str.
Syntax
${_varLastIndexOf('variableName', 'str')}
Parameters
 Html bobswift
 Anchor
_lastIndexOfWithOffset
_lastIndexOfWithOffset
Return Index of Rightmost Occurrence of Substring Plus Offset in String Value
<ul>
<li> <code>value</code> <br>Required; Any string.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
<li> <code>offset</code> <br>Required; Number (positive or negative) to offset the found index. 
</ul>
  • value
    Required; Any string.
  • str 
    Required; Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
  • offset 
    Required; Number (positive or negative) to offset the found index.
     
Description
Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest value.
Syntax
${_lastIndexOfWithOffset('value', 'str', offset)}
Parameters
 Html bobswift
 Anchor
_varLastIndexOfWithOffset
_varLastIndexOfWithOffset
Return Index of Rightmost Occurrence of Substring Plus Offset in String Variable
<ul>
<li> <code>variableName</code> <br>Required; Name of the variable being passed into the function.
<li> <code>str</code> <br>Required; Substring to search for. If the <code>str</code> argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
<li> <code>offset</code> <br>Required; Number (positive or negative) to offset the found index. 
</ul>
  • variableName
    Required; Name of the variable being passed into the function.
  • str 
    Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
  • offset 
    Required; Number (positive or negative) to offset the found index.
     
Description
Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest variable.
Syntax
${_varLastIndexOfWithOffset('variableName', 'str', offset)}
Parameters
 Html bobswift
 Anchor
_length
_length
Return Length of Value
...
<ul>
<li> <code>variableName</code> <br> 
Required; Name of the variable being passed into the function. 
<li> <code>useEmptyForUndefined</code> <br>
Optional; Specification (<b>true</b> or <b>false</b>) for the handling of a missing variable name. Default is false. 
<ul>
<li> If <code>useEmptyForUndefined</code> = <b>true</b>, the function will return 0.
<li> If <code>useEmptyForUndefined</code> = <b>false</b>, the function will remain unresolved if the variable name does not exist.
</ul> </ul> 
     
Description
Returns the length of variableName.
Syntax
${_varLength('variableName'[, useEmptyForUndefined])}
Parameters
 Html bobswift
Parameters
  • variableName 
    Required; Name of the variable being passed into the function.
  • useEmptyForUndefined 
    Optional; Specification (true or false) for the handling of a missing variable name. Default is false.
    • If useEmptyForUndefined = true, the function will return 0.
    • If useEmptyForUndefined = false, the function will remain unresolved if the variable name does not exist.
 Anchor
_substring
_substring
Return New String that is Substring of Value
<ul>
<li> <code>value</code> <br>

  • value
    Required; 
 
  •  String 
 
  •  to 
 
  •  make 
 
  •  a 
 
  •  substring 
 
  •  from.

<li> <code>beginIndex</code> <br>

  • beginIndex 
    Required; 
 
  •  Beginning 
 
  •  index, 
 
  •  inclusive.

<li> <code>endIndex</code> <br>

  • endIndex 
    Optional; 
 
  •  Ending 
 
  •  index, 
 
  •  exclusive.

</ul>
     
Description
Returns a new string that is a substring of value. The substring begins at beginIndex and extends to the character at endIndex -1.
Syntax
${_substring('value', beginIndex[, endIndex])}
Parameters
 Html bobswift
Example

html-bobswift
 Panel
<pre>

${_substring('hamburger', 4, 8)} --> urge
${_substring('smiles', 1, 5)} --> mile

</pre>

 Anchor
_varSubstring
_varSubstring
Return New String that is Substring of Variable
<ul>
<li> <code>variableName</code> <br>

  • variableName
    Required; 
 
  •  Name 
 
  •  of 
 
  •  the 
 
  •  variable 
 
  •  being 
 
  •  passed 
 
  •  into 
 
  •  the 
 
  •  function.

<li> <code>beginIndex</code> <br>

  • beginIndex 
    Required; 
 
  •  Beginning 
 
  •  index, 
 
  •  inclusive.

<li> <code>endIndex</code> <br>

  • endIndex 
    Optional; 
 
  •  Ending 
 
  •  index, 
 
  •  exclusive.

</ul>
     
Description
Returns a new string that is a substring of variableName. The substring begins at beginIndex and extends to the character at endIndex -1.
Syntax
${_varSubstring('variableName', beginIndex[, endIndex])}
Parameters
 Html bobswift
Examples
If the value of the food variable is hamburger, and the value of the face variable is smiles:
 
<pre>

${_varSubstring('food', 4, 8)} --> urge
${_varSubstring('face', 1, 5)} --> mile

</pre>
 Panel
 Html bobswift

 Anchor
varEncodeUrl
varEncodeUrl
Return URL-Encoded String
...
     
Description
Displays all the defined and built-in variables associated with the task instance.
Syntax
${_scope}
Parameters
(none)
Example

html-bobswift
 Panel
<pre>

${_scope} --> {ops_workflow_id=, ops_task_type=Unix,
ops_status=DEFINED, ops_retry_interval=60,
ops_exit_code=0, ops_retry_maximum=0, ops_cmd_parms=,
ops_cmd=ls -la; exit ${_random('9')};, ops_retry_count=0,
ops_agent_id=67e4994143d2617201cdf4ba9df9ab0a,
ops_task_id=84880af243d26172019aa1d25988a8f9,
ops_task_name=uc - Linux Ls} 
</pre>

Generate Random Number
     
Description
Generates a random number between max (inclusive) and min (inclusive)
Syntax
${_random([max, min])}
Parameters
  • max 
    Optional; Upper bound (inclusive) on the random number. Default is 9.
  • min 
    Optional; Lower bound (inclusive) on the random number. Default is 0.
...
     
Description
Resolves to the IP address of the machine running the Controller.
Syntax
${_ipaddress}
Parameters
(none)
Resolve to the Sibling SYS_ID
     
Description
Resolves to the sys_id of the first task instance found within the same workflow specified by the sibling name.
Syntax
${_siblingid('sibling_name')}
Parameters
  • sibling_name 
    Required; Sibling name.
Example

<pre>

${_siblingid('Timer 60')} --> 5dbaaab943d26172015e10ab3e894e10 
</pre>
 Panel
 Html bobswift

Resolve to Variable Value
...
     
Description
Given the variable name representing the Array field, generate a String of delimited Array field entry data.
 Note
The function will remain unresolved if the Array field contains unresolved variables or functions.

Syntax
${_convertArrayFieldVariable('arrayFieldVariableName'[,'delimiter', 'separator', 'keyQuote', 'valueQuote'])}
Parameters
  • arrayFieldVariableName 
    Required; Name of the variable for the Array Field; for example, ops_af_p2.
  • delimeter 
    Optional; Value to be used to delimit the Name from the Value. Default is =.
  • separator 
    Optional; Value to be used to separate one entry/row from the next. Default is comma (,).
  • keyQuote 
    Optional; Quoting to be used around the Name. Default is "no quoting."
  • valueQuote 
    Optional; Quoting to be used around the Value. Default is "no quoting."
Example

<pre>


ops_af_p1
----------
P1A=5
P1B=42
----------

ops_af_p2
----------
P2A=Red
P2B=White
P2C=Blue
----------

convertArrayFieldVariable(String arrayFieldVariableName, String delimiter, String separator, String keyQuote, String valueQuote)
================================================================================================================================

${_convertArrayFieldVariable('ops_af_p1')} 
P1A=5,P1B=42 
---------------

${_convertArrayFieldVariable('ops_af_p1', '=')}
P1A=5,P1B=42 
---------------

${_convertArrayFieldVariable('ops_af_p1', ':')}
P1A:5,P1B:42 
---------------

${_convertArrayFieldVariable('ops_af_p1', ':', ';')}
P1A:5;P1B:42 
---------------

${_convertArrayFieldVariable('ops_af_p1', '::', ',', '\'')} 
'P1A'::5,'P1B'::42 
---------------

${_convertArrayFieldVariable('ops_af_p1', '=', ',', '\'', '"')} 
'P1A'="5",'P1B'="42" 
---------------

${_convertArrayFieldVariable('ops_af_p1', "", "", '\'', '\'')}
'P1A'='5','P1B'='42' 
---------------

${_convertArrayFieldVariable('ops_af_p1', ':', '\\n', '\'', '\'')} 
'P1A':'5'
'P1B':'42' 
---------------

${_convertArrayFieldVariable('ops_af_p2')} 
P2A=Red,P2B=White,P2C=Blue 
---------------

${_convertArrayFieldVariable('ops_af_p2', '=')} 
P2A=Red,P2B=White,P2C=Blue 
---------------

${_convertArrayFieldVariable('ops_af_p2', ':')} 
P2A:Red,P2B:White,P2C:Blue 
---------------

${_convertArrayFieldVariable('ops_af_p2', ':', ';')}
P2A:Red;P2B:White;P2C:Blue 
---------------

${_convertArrayFieldVariable('ops_af_p2', '::', ',', '\'')}
'P2A'::Red,'P2B'::White,'P2C'::Blue 
---------------

${_convertArrayFieldVariable('ops_af_p2', '=', ',', '\'', '"')}
'P2A'="Red",'P2B'="White",'P2C'="Blue" 
---------------

${_convertArrayFieldVariable('ops_af_p2', '', '', '\'', '\'')} 
'P2A'='Red','P2B'='White','P2C'='Blue' 
---------------

${_convertArrayFieldVariable('ops_af_p2', ':', '\\n', '\'', '\'')}
'P2A':'Red'
'P2B':'White'
'P2C':'Blue' 
---------------

 </pre>
 Panel
 Html bobswift

Get Array Field Variable Value
     
Description
Given the variable name representing the Array field and the name of an entry in the Array field, return the value for the entry.

Syntax
${_getArrayFieldVariableValue('arrayFieldVariableName', 'name')}
Parameters
  • arrayFieldVariableName 
    Required; Name of the variable for the Array Field; for example, ops_af_p1.
  • name 
    Required; Name of the entry for which the value is to be returned.
Example

<pre>

ops_af_p1
----------
P1A=5
P1B=42
----------

ops_af_p2
----------
P2A=Red
P2B=White
P2C=Blue
----------

getArrayFieldVariableValue(String arrayFieldVariableName, String name)
========================================================

P1A = ${_getArrayFieldVariableValue('ops_af_p1', 'P1A')}
----------
P1A=5
----------

P1B = ${_getArrayFieldVariableValue('ops_af_p1', 'P1B')}
----------
P1B=42
----------

P2A = ${_getArrayFieldVariableValue('ops_af_p2', 'P2A')}
----------
P2A=Red
----------

P2B = ${_getArrayFieldVariableValue('ops_af_p2', 'P2B')}
----------
P2B=White
----------

P2C = ${_getArrayFieldVariableValue('ops_af_p2', 'P2C')}
----------
P2C=Blue
----------
 
</pre>
 Panel
 Html bobswift

 Anchor
Web Service Functions
Web Service Functions
Web Service Functions
...
     
Description
Resolves to the XML output data of the Web Service task instance that is resolving the function, corresponding to the evaluated xPath expression.
  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found, but the path expression does not yield a result, the function will resolve to the default value.
Syntax
${_responseXPath('xPathExpression'[,'defaultValue','delimiter',prettyPrint])}
Parameters
  • xPathExpression 
    Required; xPath expression, https://www.w3schools.com/xml/xpath_intro.asp
  • defaultValue 
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter 
    Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint 
    Optional; Specification (true or false) for whether or not XML output will be pretty printed (indented). Default is false.
Examples
If you want to obtain the info element text from the following Web Service Task XML output, you could use either of two examples for this Function.
 
<pre>
&lt;
<?xml version="1.0" encoding="UTF-8" standalone="yes"?
&gt;
&lt;command-response&gt;
    &lt;type&gt;set_variable&lt;/type&gt;
>
<command-response>
    <type>set_variable</type>
    
&lt;success&gt;true&lt;/success&gt;
<success>true</success>
    
&lt;info&gt;No
<info>No changes detected for variable 
<i>variableName</i>
variableName, ignoring Set Variable command.
&lt;/info&gt;
</info>
    
&lt;errors&gt;&lt;/errors&gt;
&lt;/command-response&gt;
</pre>
<errors></errors>
</command-response>
 Panel
 Html bobswift
 
Example 1
html-bobswift
 Panel
<pre>

${_responseXPath('//info')} 

</pre>
Select the info node in the document no matter where it is.
 
Example 2
<pre>

${_responseXPath('/command-response/info')}

</pre>
 Panel
 Html bobswift
Select the info node from a specific path in the document, starting from the root node.
 
Using either of these examples will resolve to the following: No changes detected for variable variableName, ignoring Set Variable command.
...
     
Description
Resolves to the JSON output data of the Web Service task instance that is resolving the function, corresponding to the evaluated JsonPath expression.
  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.
Syntax
${_responseJsonPath('pathExpression'[,'defaultValue','delimiter',prettyPrint])}
Parameters
  • pathExpression 
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue 
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter 
    Optional; If pathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint 
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
...
     
Description
Resolves to the JSON output data of the Web Service task instance specified by the siblingName, corresponding to the evaluated JsonPath expression.
 
The sibling task instance must be within the same workflow and the Execution User of the task instance that is resolving the function must have Read permission for the sibling task instance.
  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.
Syntax
${_responseJsonPathFromTask('siblingName','pathExpression'[,'defaultValue','delimiter',prettyPrint])}
Parameters
  • siblingName 
    Required; Name of a sibling task instance.
  • pathExpression 
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue 
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter 
    Optional; If pathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint 
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
...
     
Description
Resolves to the JSON output data of the Web Service task instance that is resolving the function, corresponding to the evaluated JsonPath expression.
  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression does not yield a result, the function will resolve to the default value.
Syntax
${_responseJsonPathAsArray('pathExpression'[,'defaultValue',prettyPrint])}
Parameters
  • pathExpression 
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue 
    Optional; Default value to return if the result is not found. Default is empty ('').
  • prettyPrint 
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
...
     
Description
Resolves to the JSON output data of the Web Service task instance specified by the siblingName, corresponding to the evaluated JsonPath expression.
 
The sibling task instance must be within the same workflow and the Execution User of the task instance that is resolving the function must have Read permission for the sibling task instance.
  • If the output record cannot be found, the function will remain unresolved.
  • If the output record is found but the path expression doesn't yield a result, the function will resolve to the default value.
Syntax
${_responseJsonPathAsArrayFromTask('siblingName','pathExpression'[,'defaultValue',prettyPrint])}
Parameters
  • siblingName 
    Required; Name of a sibling task instance.
  • pathExpression 
    Required; JsonPath expression. https://github.com/json-path/Jsonpath
  • defaultValue 
    Optional; Default value to return if the result is not found. Default is empty ('').
  • prettyPrint 
    Optional; Specification (true or false) for whether or not JSON output will be pretty printed (indented). Default is false.
...