Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

Universal Controller supports a number of functions that can be specified in free-text fields. They are resolved when a task instance runs or when a Creating a Set Variable Action within a Task or Workflow action containing a function is executed.

...

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

Anchor
Conditional Functions
Conditional Functions
Conditional Functions

...

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)


...

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


...

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

Note
titleNote

A prerequisite for the use of these functions is that Automatic Output Retrieval and Wait For Output are selected at task level, with the exception of the EXTENSION output type.

...

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


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


Code Block
languagetext
linenumberstrue


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)


Code Block
languagetext
linenumberstrue



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

application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC')} > application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_csv)
    • txt.

Description

Returns a token representing the path to a temporary file containing the specified sibling 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

${_outputPathFromTask('siblingName', 'outputType'[, 'fileExtension'])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.
  • 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 ${_outputPathFromTask('Sibling_Instance_Name', 'STDERR')}
> application.exe -file $(ops_output_path_1639503212294128671YL1B04U3OT55P_stderr_txt)
Code Block
languagetext
linenumberstrue

Example


application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC', 'tsv')} > application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_tsv)
Code Block
languagetext
linenumberstrue


Code Block
languagetext
linenumberstrue


application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'WEBSERVICE', 'json')} > application.exe -file $(ops_output_path_1639503212294088671CAWMP3VNQ468B_webservice_json)
Code Block
languagetext
linenumberstrue


Code Block
languagetext
linenumberstrue


SAP Connection Functions

Anchor
SAP Connection Function
SAP Connection Function
Returns Property of an SAP Connection

...

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.

...

Note
titleNote

When using String functions that accept a String value parameter directly, you should be aware of expectations with respect to escape characters and escape sequences (see 63578569 Escape Sequences, below).


For String functions that accept a variable name parameter, the fully resolved value of the variable by the specified name will be used as the String value argument. The variable must be fully resolvable and must not contain an unresolved function.

...

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


...

Description

Resolves the variable specified by the variable_name parameter and substitutes the default value if the variable cannot be resolved.

Syntax

${_resolveadv('variable_name', 'default_value', [use_default_if_blank])}

Parameters

  • variable_name
    Required; Variable name.
  • default_value
    Required; Default value to use if the variable cannot be resolved.
  • use_default_if_blank
    Optional; Specification (true or false) for whether or not to use the default value if the variable is empty or blank. (If use_default_if_blank is false, _resolveadv behaves like 63578569 _resolve.)

Anchor
Universal Task Functions
Universal Task Functions
Universal Task Functions

...