Versions Compared

Key

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

...

...

...

...

...

...



Panel
Table of Contents
maxlevel2

...

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)


...

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

...

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


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

 
Using Variables for augend and addend (${augend} = 17, ${addend} = 5):
 

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


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


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

 
Using Variables for dividend and divisor (${dividend} = 100, ${divisor} = 5)
 

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


...

(For Web Service output, see 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.

Output CSV Record Count

Description

Resolves to the record count of CSV data for the specified output Type.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will resolve to 0.

Syntax

${_outputCsvRecordCount('<outputType>')}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_outputCsvRecordCount('STDERR')}
> 2

Output CSV Record Value Count

Description

Resolves to the count of CSV data for the specified record index of the specified outputType.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will resolve to 0.
  • If an index is invalid, the function will resolve to 0

Syntax

${_outputCsvRecordValueCount('outputType', recordIndex)}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_outputCsvRecordValueCount('STDERR','1')}
> 4

Output CSV Record Value

Description

Resolves to the value of CSV data for the specified record index & value index of the specified outputType.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputCsvRecordValue('outputType', recordIndex, valueIndex)}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_varCsvRecordValue('STDOUT','1', '2')}
> G

Output TSV Record Count

Description

Resolves to the record count of TSV data for the specified outputType value.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will resolve to 0.

Syntax

${_outputTsvRecordCount('<outputType>')}

Parameters

  • outputType
    Required; Name of the variable.

Example

data="A" "B" "C" "D"\n
     "E" "F" "G" "H"
${_outputTsvRecordCount('STDERR')}
> 2

Output TSV Record Value Count

Description

Resolves to the count of TSV data for the specified record index of the specified outputType.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will resolve to 0.
  • If an index is invalid, the function will resolve to 0.

Syntax

${_outputTsvRecordValueCount('outputType', recordIndex)}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

Example

data="A"  "B" "C" "D"\n
     "E"  "F"  "G"  "H"
${_outputTsvRecordValueCount('STDERR','1')}
> 4

Output TSV Record Value

Description

Resolves to the value of TSV data for the specified record index & value index of the specified outputType.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.
  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputTsvRecordValue('outputType', recordIndex, valueIndex)}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

data="A"  "B" "C" "D"\n
     "E"  "F" "G" "H"
${_outputTsvValue('my_variable','1', '2')}
> G

Output CSV Record Count From Task

Description

Resolves to the record count of CSV output data, of the specified outputType, of the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.

Syntax

${_outputCsvRecordCountFromTask('siblingName', 'outputType')}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_outputCsvRecordCountFromTask('task-1','STDERR')}
> 2

Output CSV Record Value Count From Task

Description

Resolves to the value count of CSV output data, of the specified outputType, & recordIndexof the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.
  • If an index is invalid, the function will resolve to 0. 

Syntax

${_outputCsvRecordValueCountFromTask('siblingName', 'outputType', 'recordIndex')}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_outputCsvRecordValueCountFromTask('task-1','STDERR','1')}
> 4

Output CSV Record Value From Task

Description

Resolves to the value of CSV output data, of the specified outputType, recordIndex & valueIndexof the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputCsvRecordValueFromTask('siblingName','outputType', recordIndex, valueIndex)}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

data="A","B","C","D"\n
     "E","F","G","H"
${_outputCsvRecordValueFromTask('task-1','STDOUT','1', '2')}
> G

Output TSV Record Count From Task

Description

Resolves to the record count of TSV output data, of the specified outputType, of the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.

Syntax

${_outputTsvRecordCountFromTask('siblingName','outputType')}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Name of the variable.

Example

data="A" "B" "C" "D"\n
     "E" "F" "G" "H"
${_outputTsvRecordCountFromTask('task-1','STDERR')}
> 2

Output TSV Record Value Count From Task

Description

Resolves to the value count of TSV output data, of the specified outputType, & recordIndexof the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.
  • If an index is invalid, the function will resolve to 0.

Syntax

${_outputTsvRecordValueCountFromTask('siblingName','outputType', 'recordIndex')}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

Example

data="A"  "B" "C" "D"\n
     "E"  "F"  "G"  "H"
${_outputTsvRecordValueCountFromTask('task-1','STDERR','1')}
> 4

Output TSV Record Value From Task

Description

Resolves to the value of TSV output data, of the specified outputType, recordIndex & valueIndexof the task instance specified by the siblingName parameter.
 
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 of the specified outputType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputTsvRecordValueFromTask('siblingName','outputType', recordIndex, valueIndex)}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

data="A"  "B" "C" "D"\n
     "E"  "F" "G" "H"
${_outputTsvRecordValueFromTask('task-1','STDOUT','1', '2')}
> G

Output Delimited Value Count

Description

Resolves to the count of comma delimited output data, of the specified outputType, of the task instance that is resolving the function.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.

Syntax

${_outputDelimitedValueCount('outputType', [delimiter])}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • delimiter
    Optional;delimiter to split the output. default delimiter is comma(,).

Example

data= A,B,C,D
${_outputDelimitedValueCount('STDOUT')}
> 4

Output Delimited Value

Description

Resolves to the value of specified valueIndex for comma delimited output data, of the specified outputType, of the task instance that is resolving the function.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputDelimitedValue('outputType', valueIndex,[delimiter])}

Parameters

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • valueIndex
    Required; record index number.

  • delimiter
    Optional; delimiter to split the output. default delimiter is comma(,).

Example

data=A,B,C,D
${_outputDelimitedValue('STDOUT','2')}
> C

Output Delimited Value Count From Task

Description

Resolves to the count of comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will resolve to 0.

Syntax

${_outputDelimitedValueCountFromTask('siblingName','outputType', [delimiter])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • delimiter
    Optional;delimiter to split the output. default delimiter is comma(,).

Example

data=A,B,C,D
${_outputDelimitedValueCountFromTask('task-1','STDOUT'
,','
)}
> 4

Output Delimited Value From Task

Description

Resolves to the value of specified valueIndex for comma delimited output data, of the specified outputType, of the task instance specified by the siblingName parameter.

  • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

  • If the output is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_outputDelimitedValueFromTask('siblingName','outputType', valueIndex,[delimiter])}

Parameters

  • siblingName
    Required; Name of a sibling task instance.

  • outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

  • valueIndex
    Required; record index number.

  • delimiter
    Optional;delimiter to split the output. default delimiter is comma(,).

Example

data=A:B:C:D
${_outputDelimitedValueFromTask('task-1','STDOUT','2
',':
')}
> C

Anchor
Task Instance Output
Task Instance Output
Task Instance Output

...

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


Code Block
languagetext
linenumberstrue


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



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

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
application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC')}
> application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_csv)


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 20152753, below). Escape Sequences


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.

...

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.

...

Variable CSV Record Count

Description

Resolves to the CSV data record count for the specified variable.

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

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

  • If the variable is undefined, or the variable value is blank, the function will resolve to 0.

Syntax

${_varCsvRecordCount('<variableName>')}

Parameters

  • variableName
    Required; Name of the variable.

Example

my_variable="A","B","C","D"\n
            "E","F","G","H"
${_varCsvRecordCount('my_variable')}
> 2

Variable CSV Record Value Count

Description

Resolves to the CSV record value count for the specified variable and record index.

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

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

  • If the variable is undefined, or the variable value is blank, the function will resolve to 0.

  • If an index is invalid, the function will resolve to 0.

Syntax

${_varCsvRecordValueCount('variableName', recordIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

Example

my_variable="A","B","C","D"\n
            "E","F","G","H"
${_varCsvRecordValueCount('my_variable','1')}
> 4

Variable CSV Record Value

Description

Resolves to the CSV record value for the specified variable, record index, and variable index.

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

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

  • If the variable is undefined, or the variable value is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_varCsvRecordValue('variableName', recordIndex, valueIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

my_variable="A","B","C","D"\n
            "E","F","G","H"
${_varCsvRecordValue('my_variable','1', '2')}
> G

Variable TSV Record Count

Description

Resolves to the TSV data record count for the specified variable.

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

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

  • If the variable is undefined, or the variable value is blank, the function will resolve to 0.

Syntax

${_varTsvRecordCount('<variableName>')}

Parameters

  • variableName
    Required; Name of the variable.

Example

my_variable="A" "B" "C" "D"\n
            "E" "F" "G" "H"
${_varTsvRecordCount('my_variable')}
> 2

Variable TSV Record Value Count

Description

Resolves to the TSV record value count for the specified variable and record index.

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

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

  • If the variable is undefined, or the variable value is blank, the function will resolve to 0.

  • If an index is invalid, the function will resolve to 0.

Syntax

${_varTsvRecordValueCount('variableName', recordIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

Example

my_variable="A","B","C","D"\n
            "E","F","G","H"
${_varTsvRecordValueCount('my_variable','1')}
> 4

Variable TSV Record Value

Description

Resolves to the value of TSV data for the specified record index & value index of the specified variable.

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

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

  • If the variable is undefined, or the variable value is blank, the function will remain unresolved.
  • If an index is invalid, the function will remain unresolved.

Syntax

${_varTsvRecordValue('variableName', recordIndex, valueIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

my_variable="A","B","C","D"\n
            "E","F","G","H"
${_varTsvRecordValue('my_variable','1', '2')}
> G

Var Delimited Value Count

Description

Resolves to the count of delimited values for the specified variable.

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

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

  • If the variable is undefined, or the variable value is blank, the function will resolve to 0.

Syntax

${_varDelimitedValueCount('variableName', [delimiter])}

Parameters

  • variableName
    Required; The name of the variable to return the count of delimited strings.

  • delimiter
    Optional;delimiter to split the output. default delimiter is comma(,).

Example

data=A:B:C:D
${_varDelimitedValueCount('my_variable',':')}
> 4

Var Delimited Value

Description

Resolves to the indexed value of delimited values for the specified variable.

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

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

  • If the variable is undefined, or the variable value is blank, the function will remain unresolved.

  • If an index is invalid, the function will remain unresolved.

Syntax

${_varDelimitedValue('variableName', valueIndex,[delimiter])}

Parameters

  • variableName
    Required; The name of the variable to return the indexed value of delimited strings.

  • valueIndex
    Required; record index number.

  • delimiter
    Optional;delimiter to split the output. default delimiter is comma(,).

Example

data=A:B:C:D
${_varDelimitedValue('my_variable','2',':')}
> C

Anchor
System Functions
System Functions
System Functions

...

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

${_resolve('variable_name'[, 'default_value'])}

Parameters

  • variable_name
    Required; Variable name.
  • default_value
    Required; Default value to use if the variable cannot be resolved.

...

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 20152753.) _resolve

Anchor
Universal Task Functions
Universal Task Functions
Universal Task Functions

...

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.

...