Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 8


Panel
Table of Contents
maxlevel2

...

Functions are listed alphabetically within the following categories on this page:

Anchor
Conditional Functions
Conditional Functions

Conditional Functions

Return Conditional Value Depending on Equality of String Parameters

...

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


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


Anchor
Credential Functions
Credential Functions

Credential Functions

Anchor
Return Key Location
Return Key Location
Return Key Location of a Credential

Description

Returns a token representing the Resolvable Credential Credentials#Resolvable Credentials Key Location that you want to embed.

Syntax

${_credentialKeyLoc('<credential_name>')}

Parameters

  • credential_name
    Required; Name of the Credential.
Example


Panel

${_credentialKeyLoc('RCredentialXYZ')} → $(ops_unv_cred_key_loc_c89e7b2caf4247909bc46041df8a2643)


...

Description

Returns a token representing the Resolvable Credential Credentials#Resolvable Credentials Passphrase that you want to embed.

Syntax

${_credentialPassphrase('<credential_name>')}

Parameters

  • credential_name
    Required; Name of the Credential.
Example


Panel
${_credentialPassphrase('RCredentialXYZ')} → $(ops_unv_cred_passphrase_c89e7b2caf4247909bc46041df8a2643)


...

Description

Returns a token representing the Resolvable Credential Credentials#Resolvable Credentials Token that you want to embed.

Syntax

${_credentialToken('<credential_name>')}

Parameters

  • credential_name
    Required; Name of the Credential.
Example


Panel
${_credentialToken('RCredentialXYZ')} → $(ops_unv_cred_token_c89e7b2caf4247909bc46041df8a264


...

Description

Returns a token representing the Resolvable Credential Credentials#Resolvable Credentials Runtime User that you want to embed.

Syntax

${_credentialUser('<credential_name>')}

Parameters

  • credential_name
    Required; Name of the Credential.
Example


Panel

${_credentialUser('RCredentialXYZ')} → $(ops_unv_cred_user_c89e7b2caf4247909bc46041df8a2643)


...

Description

Returns a token representing the Resolvable Credential Credentials#Resolvable Credentials Runtime Password that you want to embed.

Syntax

${_credentialPwd('<credential_name>')}

Parameters

  • credential_name
    Required; Name of the Credential.
Example


Panel

${_credentialPwd('RCredentialXYZ')} → $(ops_unv_cred_pwd_c89e7b2caf4247909bc46041df8a2643)


Anchor
Database Connection Functions
Database Connection Functions

Database Connection Functions

Returns Property of a Database Connection

Description

Returns a token representing the property associated with a Database connection.

Syntax

${_databaseConnection('<database_connection_name>', '<property_name>')}

Parameters

  • database_connection_name
    Required; Name of the Database Connection.

  • property_name
    Required; Name of the Database Connection property.

    • description
    • name
    • url
    • driver
    • max_rows
    • type
    • cred_user
    • cred_pwd
    • cred_passphrase
    • cred_key_lock
    • cred_token

Example


Panel

${_databaseConnection('db1', 'type')}→ $(ops_unv_db_connection_type_3ac17d7f3ecb4df0b81aec9c7a24a38c)



Anchor
Date Functions
Date Functions

Date Functions

Checks if Date Argument Equals Today's Date

...

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 Properties#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

  • date_time
    Date and time in any of the following formats:
    • yyyy-MM-dd
    • yyyy-MM-dd HH:mm
    • yyyy-MM-dd HH:mm:ss
    • yyyy-MM-dd HH:mm Z
    • yyyy-MM-dd HH:mm:ss Z.
    • yyyy-MM-dd HH:mm:ss.SSS
    • yyyy-MM-dd HH:mm:ss.SSS Z.
    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 format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
  • day_offset
    +/- number of days to offset.
  • use_business_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.

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


...

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 Properties#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

  • date_time
    Date and time in any of the following formats:
    • yyyy-MM-dd
    • yyyy-MM-dd HH:mm
    • yyyy-MM-dd HH:mm:ss
    • yyyy-MM-dd HH:mm Z
    • yyyy-MM-dd HH:mm:ss Z.
    • yyyy-MM-dd HH:mm:ss.SSS
    • yyyy-MM-dd HH:mm:ss.SSS Z.
    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 format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
  • year_offset
    Optional; +/- number of years to offset.
  • month_offset
    Optional; +/- number of months to offset.
  • day_offset
    Optional; +/- number of days to offset.
  • use_business_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.

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


...

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 Properties#Exclude Holidays for Business Days Universal Controller system property.


Syntax

${_nonBusinessDayOfMonth(index, ['date', 'format', reverse])}

Parameters

  • index
    Required; Nth non-business day of month.
  • date
      Date (and time) is specified in any of the following formats:
      • yyyy-MM-dd
      • yyyy-MM-dd HH:mm
      • yyyy-MM-dd HH:mm:ss
      • yyyy-MM-dd HH:mm Z
      • yyyy-MM-dd HH:mm:ss Z.
      • yyyy-MM-dd HH:mm:ss.SSS
      • yyyy-MM-dd HH:mm:ss.SSS Z.
      Default is the current date.
    • format
      Optional; Format of returned date. Default is yyyy-MM-dd. For details on the format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
    • 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


...

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 Properties#Exclude Holidays for Business Days Universal Controller system property.


Syntax

${_businessDayOfMonth(index, ['date', 'format', reverse])}

Parameters

  • index
    Required; Nth business day of month.
  • date
    Date (and time) is specified in any of the following formats:
    • yyyy-MM-dd
    • yyyy-MM-dd HH:mm
    • yyyy-MM-dd HH:mm:ss
    • yyyy-MM-dd HH:mm Z
    • yyyy-MM-dd HH:mm:ss Z.
    • yyyy-MM-dd HH:mm:ss.SSS
    • yyyy-MM-dd HH:mm:ss.SSS Z.
    Default is the current date.
  • format
    Optional; Format of returned date. Default is yyyy-MM-dd. For details on the format parameter, see https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html
  • reverse
    Optional; Specification (true or false) for starting from the end of the month. Default is false.

Examples


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


...

Description

Returns the number of business days between date1 and date2.

  • If return value is > 0, date2 is after 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 Properties#Exclude Holidays for Business Days Universal Controller system property.


Syntax

${_businessDaysBetween('date1', 'date2')}

Parameters

  • date1
    Required.
  • date2
    Required.

date1 and date2 are specified in any of the following formats:

  • yyyy-MM-dd
  • yyyy-MM-dd HH:mm
  • yyyy-MM-dd HH:mm:ss
  • yyyy-MM-dd HH:mm Z
  • yyyy-MM-dd HH:mm:ss Z.
  • yyyy-MM-dd HH:mm:ss.SSS
  • yyyy-MM-dd HH:mm:ss.SSS Z.

Example


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


...

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


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

 
Using Variables for minuend and subtrahend (${minuend} = 100, ${subtrahend} = 5):
 

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


Anchor
Other Task Functions
Other Task Functions

Other Task Functions

Anchor
Business Services List
Business Services List
Business Services Membership

Description

Resolves to a delimited list of business service names the task instance is a member of.

Syntax

${_businessServices(['resultDelimiter'])}

Parameters

  • resultDelimiter
    Optional; Delimiter to use when concatenating business service names. If not specified, ", " will be used.
Example

If a task instance is a member of business services A, B, and C.

Panel
borderStylesolid

${_businessServices()}
A, B, C


Panel
borderStylesolid

${_businessServices('\n')}
A
B
C

If a task instance is not a member of any business service, the function will evaluate to empty.

Anchor
Output Functions
Output Functions

Output Functions

(For Web Service output, see Web Service Functions.)
 

...

Description

Resolves to the JSON output data of the 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.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_outputJsonPath('outputType', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
  • 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.

Example

JSON

{
  "code": 10
}


Function

${_outputJsonPath('STDOUT', '$.code')}


Result

10

Sibling Task Instance Output By JsonPath

Description

Resolves to the JSON output data of the 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.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.
  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
  • 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.

Example

JSON

{
  "code": 10
}

Function

${_outputJsonPathFromTask('Sibling_With_JSON_Output', 'STDOUT', '$.code')}

Result

10

...

Description

Resolves to the JSON output data of the 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.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_outputJsonPathAsArray('outputType', 'pathExpression'[, 'defaultValue', prettyPrint])}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
  • 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.

Example

JSON

[
  
{
    "message" : "Hello",
    "code" : 10
  },
  {
    "message" : "World!",
    "code" : 20
  }
]


Function

${_outputJsonPathAsArray('STDOUT', '$[*].message', '', true)}

Result

[
    "Hello",
    "World!"
]

...

Description

Resolves to the JSON output data of the 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.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_outputJsonPathFromTask('siblingName', 'outputType', 'pathExpression'[, 'defaultValue', prettyPrint])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.
  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
  • 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.

Example

JSON
[
  {
    "message" : "Hello",
    "code" : 10
  },
  {
    "message" : "World!",
    "code" : 20
  }
]

Function
${_outputJsonPathAsArrayFromTask('Sibling_With_JSON_Output', 'STDOUT', '$[*].message')}

Result
["Hello","World!"]

...

Description

Returns a token representing the path to a temporary file containing the specified task instance output data.

  • $(ops_output_path_<instanceId>_<outputType>_<fileExtension>)

The resolved token is supported within the Command, Parameters, and Script of a Windows and Linux/Unix Task.

Syntax

${_outputPath('outputType'[, 'fileExtension'])}

Parameters

  • outputType
    Required; Type of output to create a temporary file for: STDOUT, STDERR, FILE, EXTENSION, JOBLOG, WEBSERVICE, SQL, STOREDPROC.
  • fileExtension
    Optional; The extension to use for the temporary file. Can be a maximum of 10 characters.
    • For SQL and STOREDPROC outputType, the result set is translated to comma-separated values (csv), or tab-separated values (tsv), and, therefore, only csv (default) and tsv are supported file extensions.
    • For any other outputType, the default file extension is txt.
Example


Code Block
languagetext
linenumberstrue
application.exe -file ${_outputPath('STDOUT')}
> application.exe -file $(ops_output_path_1638302212442528629FTPBE4AJQV2FT_stdout_txt)


Code Block
languagetext
linenumberstrue
application.exe -file ${_outputPath('SQL')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_csv)


Code Block
languagetext
linenumberstrue
application.exe -file ${_outputPath('SQL', 'tsv')}
> application.exe -file $(ops_output_path_1639503212294078671DNPMULGSEVMHT_sql_tsv)


Code Block
languagetext
linenumberstrue
application.exe -file ${_outputPath('EXTENSION', 'json')}
> application.exe -file $(ops_output_path_1639503212294187671OAI9SM79CNC2V_extension_json)



Anchor
Sibling Task Instance Output Path
Sibling Task Instance Output Path
Sibling Task Instance Output Path

...

Description

Returns a token representing the property associated with an SAP connection

Syntax

${_sapConnection('<sap_connection_name>', '<property_name>')}

Parameters

  • sap_connection_name
    Required; Name of the SAP Connection.

  • property_name
    Required; Name of the SAP Connection property.

    • description

    • name

    • sap_ashost

    • sap_client

    • sap_connection_type

    • sap_group

    • sap_gwhost

    • sap_gwserv

    • sap_mshost

    • sap_mysapsso2

    • sap_r3name

    • sap_saprouter

    • sap_snc_lib

    • sap_snc_mode

    • sap_snc_myname

    • sap_snc_partnername

    • sap_snc_qop

    • sap_snc_sso

    • sap_sysnr

    • sap_use_symbolic_names

    • sap_x509cert

Example

${_sapConnection('sap1', 'sap_connection_type')}
→ $(ops_unv_sap_connection_sap_connection_type_3ac17d7f3ecb4df0b81aec9c7a24a38c)


Anchor
Script Functions
Script Functions

Script Functions

Anchor
Returns Path to Data Script
Returns Path to Data Script
Returns Path to Data Script

Description

Returns a token representing the path to a Data Script Scripts#Data Scripts that you want to embed Scripts#Embedding a Data Script.

Syntax

${_scriptPath('script_name')}

Parameters

  • script_name
    Required; Name of the Data Script.

Example

Script Name: MyDataScript

Script UUID: 507ffdbd0eba4b62b0e31e0fd22f6bec
Panel
borderStylesolid

${_scriptPath('MyDataScript')} --> $(ops_unv_script_path_507ffdbd0eba4b62b0e31e0fd22f6bec)


Note
titleNote

The Agent will replace the resolved token with a path to a temporary file containing the content of the Data Script.

For additional details, refer to Embedding Scripts#Embedding a Data Script.




Note
titleNote

_scriptPath requires Agent 6.4.0.0 or later.

Anchor
SQL/Stored Procedure Functions
SQL/Stored Procedure Functions

SQL/Stored Procedure Functions

Return Column Names for SQL Results from Current Task

...

Note
titleNote

Indexing functions use zero-based numbering; that is, the initial element is assigned the index 0.

Anchor
Escape Sequences
Escape Sequences
Escape Sequences

An escape character preceded by a backslash (\) is an escape sequence (see the following table for a list of escape sequences).

...

Description

Randomly generates a String with a specified length.

Syntax

${_randomString(length[, 'excludeCharacters', 'defaultCharacters'])}

Parameters

  • length
    Required; String length.
  • excludeCharacters
    Optional; String containing characters to exclude from the default character set.
  • defaultCharacters
    Optional; String for overriding default character set.
Note
titleNote

The following characters are included in the default character set, in addition to the space character.

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


Example


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


...

Description

Replaces each substring of value that matches the specified regular expression Wildcards and Regular Expressions, regex, with the specified replacement.

Syntax

${_replaceAll('value', 'regex', 'replacement')}

Parameters

  • value
    Required; Input string.
  • regex
    Required; Regular expression.
  • replacement
    Required; Replacement string.

...

Description

Replaces each substring of variableName that matches the specified regular expression Wildcards and Regular Expressions, regex, with the specified replacement.

Syntax

${_varReplaceAll('variableName', 'regex', 'replacement')}

Parameters

  • variableName
    Required; Name of the variable being passed into the function.
  • regex
    Required; Regular expression.
  • replacement
    Required; Replacement string.

...

Description

Resolves to the evaluated JsonPath expression applied to the value of the specified variable.

  • If the variable is unresolved, the function will remain unresolved.

  • If the variable is undefined, blank, or the path expression does not yield a result, the function will resolve to the default value.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_varJsonPath('variableName', 'pathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

Parameters

variableName
Required; The name of the variable to apply the JsonPath expression to.

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 will be pretty printed (indented). Default is false.

Example

my_variable=
{
  "code": 10
}

${_varJsonPath('my_variable', '$.code')}
> 10

...

Description

Resolves to the evaluated JsonPath expression applied to the value of the specified variable.

  • If the variable is unresolved, the function will remain unresolved.

  • If the variable is undefined, blank, or the path expression does not yield a result, the function will resolve to the default value.

Note

When using a JsonPath function, the output must be ONLY a JSON formatted string. If the output contains leading or trailing text, the function will fail to work properly.


Syntax

${_varJsonPathAsArray('variableName', 'pathExpression'[, 'defaultValue', prettyPrint])}

Parameters

variableName
Required; The name of the variable to apply the JsonPath expression to.

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 will be pretty printed (indented). Default is false.

Example

my_variable=
[
  {
    "message" : "Hello",
    "code" : 10
  },
  {
    "message" : "World!",
    "code" : 20
  }
]

${_varJsonPathAsArray('my_variable', '$[*].message', '', true)}
>
[
    "Hello",
    "World!"
]

...

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 sysGlossary#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


Panel
${_siblingid('Timer 60')} --> 5dbaaab943d26172015e10ab3e894e10 


...