Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

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

...

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

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


...

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

...