Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

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

output data, of the specified outputType, of the task instance that is resolving the function

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

${_

output

outputCsvRecordCount('

outputType'[, 'defaultValue']

<outputType>')}

Parameters

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

  • defaultValue
    Optional; Default value to return if the output data is not found. Default is empty ('').
  • ...

    Example

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

    Output CSV Record Value Count

    Description

    Resolves to the

    output data,

    count of CSV data for the specified record index 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
    • 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

    ${_

    outputFromTask

    outputCsvRecordValueCount(

    'siblingName',

    'outputType'

    [

    ,

    'defaultValue']

    recordIndex)}

    Parameters

    siblingName

    Required; Name of a sibling task instance.
    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.

    defaultValue

    Description

    Resolves to the number of lines of output data, of the specified outputType, of the task instance that is resolving the function
    • recordIndex

    Optional; Default value to return if the output data is not found. Default is empty ('').

    ...

    • 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

    ${_

    outputNumberOfLines

    outputCsvRecordValue('outputType', recordIndex, valueIndex)}

    Parameters

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

    Example

    ${_outputNumberOfLines('STDOUT')}
    > 6

    ...

    • 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

    number of lines of 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

    record count of TSV data for the specified outputType value.

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

    Syntax

    ${_

    outputNumberOfLinesFromTask

    outputTsvRecordCount('

    siblingName', 'outputType

    <outputType>')}

    Parameters

    siblingName
    • outputType
      Required; Name of

    a sibling task instance

    Description

    Resolves to the specified line(s) of output data, of the specified outputType, of the task instance that is resolving the function
    • the variable.

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

    ${_outputNumberOfLinesFromTask('test', 'STDOUT')}
    > 8

    ...

    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

    ${_

    outputLines

    outputTsvRecordValueCount('outputType',

    startLine, numberOfLines[, 'defaultValue', 'resultDelimiter']

    recordIndex)}

    Parameters

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

    startLine
    • recordIndex
      Required;

    Start line, where 1 is the first line and -1 is the last line.
  • numberOfLines
    Required; Number of lines to return starting from the startLine.
  • defaultValue
    Optional; Default value to return if no lines qualify. Default is empty ('')
  • resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.
  • ...

    • 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

    specified line(s) of 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

    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
    record of the specified outputType cannot be found
    • is blank, the function will remain unresolved.
    • If an index is invalid, the function will remain unresolved.

    Syntax

    ${_

    outputLinesFromTask

    outputTsvRecordValue(

    'siblingName',

    'outputType',

    startLine, numberOfLines[, 'defaultValue', 'resultDelimiter']

    recordIndex, valueIndex)}

    Parameters

    siblingName
    Required; Name of a sibling task instance.

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

    startLine
    • recordIndex
      Required;

    Start line, where 1 is the first line and -1 is the last line.
  • numberOfLines
    Required; Number of lines to return starting from the startLine.
  • defaultValue
    Optional; Default value to return if no lines qualify. Default is empty ('').
  • resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.
  • ...

    Description

    Resolves to the line(s) of output data that match the specified regular expression, of the specified outputType,
    • 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

    by specifying a regular expression.
  • The complete output line is returned.
  • must have Read permission for the sibling task instance.

    • If the output record of the specified

    ouptutType
    • outputType cannot be found, the function will remain unresolved.

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

    Syntax

    ${_

    outputLinesByRegex

    outputCsvRecordCountFromTask('

    outputType

    siblingName', '

    regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter']

    Description

    Resolves to the line(s) of output data that match the specified regular expression, of the specified outputType,

    outputType')}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.

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

  • regexPattern
    Required; Regular expression used for determining if a line matches. Regular expression must match the whole line (see Example, below).
  • maxCount
    Optional; Maximum number of matching lines to return. Default is 1.
  • numberOfLinesBefore
    Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
  • numberOfLinesAfter
    Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
  • defaultValue
    Optional; Default value to return if no lines match the regular expression. Default is empty ('').
  • resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.
  • Example

    STDOUT contains:
    Some_Text
    ABC=Some_String
    More_Text
     
    ${_outputLinesByRegex('STDOUT', '^ABC=')} Returns empty (the whole Line was not matched)
    ${_outputLinesByRegex('STDOUT', '^ABC=.*')} Returns ABC=Some_String

    Sibling Task Instance Output by Line(s) Matching Regular Expression

    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

    ${_

    outputLinesByRegexFromTask

    outputCsvRecordValueFromTask('siblingName','outputType',

    'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter']

    recordIndex, valueIndex)}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.

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

    regexPattern
    • recordIndex
      Required;

    Regular expression used for determining if a line matches
    • record index number.

    maxCount
    • valueIndex

    Optional
    • Required;

    Maximum number of matching lines to return. Default is 1

    Description

    Resolves to the XML output data of the task instance that is resolving the function, corresponding to the evaluated XPath expression.

    If the output record
    • record index number.

  • numberOfLinesBefore
    Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
  • numberOfLinesAfter
    Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
  • defaultValue
    Optional; Default value to return if no lines match the regular expression. Default is empty ('').
  • resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.
  • ...

    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
    record is found, but the path expression does not yield a result
    • is blank, the function will resolve to
    the default value
    • 0.

    Syntax

    ${_

    outputXPath

    outputTsvRecordCountFromTask('

    outputType

    siblingName','

    xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint]

    outputType')}

    Parameters

    outputType
    • siblingName
      Required;

    Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
  • xPathExpression
    Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter
    Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint
    Optional; Specification (true or false) for whether or not XML output will be pretty printed (indented). Default is false.
  • Example

    XML
    <message>
      <code>10</code>
    </message>
    Function${_outputXPath('STDOUT', '//code/text()')}
    Result
    10

    Sibling Task Instance Output By XPath

    Description

    Resolves to the XML output data of the task instance specified by the siblingName, corresponding to the evaluated XPath expression.

    • 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
    record is found but the path expression does not yield a result
    • is blank, the function will resolve to
    the default value.

    Syntax

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

    Syntax

    ${_outputTsvRecordValueCountFromTask('siblingName','outputType', '

    xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint]

    recordIndex')}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.

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

    xPathExpression
    • recordIndex
      Required;

    XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
  • defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').
  • delimiter
    Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
  • prettyPrint
    Optional; Specification (true or false) for whether or not XML output will be pretty printed (indented). Default is false.
  • Example

    XML
    <message> <code>10</code> </message>
    Function${_outputXPathFromTask('Sibling_With_XML_Output', 'STDOUT', '//code/text()')}
    Result
    10

    ...

    Description

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

    , corresponding to the evaluated JsonPath expression

    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
    record
    • is
    found but the path expression does not yield a result
    • blank, the function will remain unresolved.
    • If an index is invalid, the function will
    resolve to the default value
    • remain unresolved.

    Syntax

    ${_

    outputJsonPath

    outputTsvRecordValueFromTask('

    outputType

    siblingName','

    pathExpression

    outputType'

    [

    ,

    'defaultValue', 'delimiter', prettyPrint]

    recordIndex, valueIndex)}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.

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

    PathExpression
    • recordIndex
      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
    • 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

    must have Read permission for the sibling task instance

    .

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

    • If the output
    record is found but the path expression does not yield a result
    • is blank, the function will resolve to
    the default value
    • 0.

    Syntax

    ${_

    outputJsonPathFromTask

    outputDelimitedValueCount('

    siblingName', '

    outputType',

    'pathExpression'

    [

    , 'defaultValue', '

    delimiter

    ', prettyPrint

    ])}

    Parameters

    siblingName
    • outputType
      Required;

    Name of a sibling task instance.outputType
    Required; Type of

    Description

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

    ...

    • 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

    , corresponding to the evaluated JsonPath expression

    .

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

    • If the output
    record
    • is
    found but the path expression does not yield a result
    • blank, the function will remain unresolved.
    • If an index is invalid, the function will
    resolve to the default value
    • remain unresolved.

    Syntax

    ${_

    outputJsonPathAsArray

    outputDelimitedValue('outputType', valueIndex,

    'pathExpression'[, 'defaultValue', prettyPrint

    [delimiter])}

    Parameters

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

    PathExpression
    • valueIndex
      Required;

    JsonPath expression. https://github.com/json-path/JsonpathdefaultValue
    • record index number.

    • delimiter
      Optional;

    Default value
    • delimiter to

    return if the result is not found. Default is empty (''
    • split the output. default delimiter is comma(,).

  • 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!"
    ]

    ...

    Example

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

    Output Delimited Value Count From Task

    Description

    Resolves to the

    JSON

    count of comma delimited output data, of the specified outputType, of the task instance specified by the siblingName

    , corresponding to the evaluated JsonPath expressionIf the output record

    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 ouptutType cannot be found, the function will remain unresolved.

    • If the output
    record is found but the path expression does not yield a result
    • is blank, the function will resolve to
    the default value
    • 0.

    Syntax

    ${_

    outputJsonPathFromTask

    outputDelimitedValueCountFromTask('siblingName','outputType',

    'pathExpression'[, 'defaultValue', prettyPrint

    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

    [delimiter])}

    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!"]

    ...

    • 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

    ${_

    outputPath

    outputDelimitedValueFromTask('

    outputType

    siblingName'

    [

    ,'

    fileExtension

    outputType', valueIndex,[delimiter])}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.

    • outputType
      Required; Type of output to

    create a temporary file for
    • resolve: STDOUT, STDERR, FILE, EXTENSION,

    JOBLOG, WEBSERVICE, SQL, STOREDPROC.fileExtension
    • or JOBLOG.

    • valueIndex
      Required; record index number.

    • delimiter
      Optional;

    The extension
    • delimiter to

    use for
    • split 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)

    ...

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

    Resolves to the 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.

    Syntax

    ${_output('outputType'[, 'defaultValue'])}

    Parameters

    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • defaultValue
      Optional; Default value to return if the output data is not found. Default is empty ('').

    Sibling Task Instance Output

    Description

    Resolves to the 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.

    Syntax

    ${_outputFromTask('siblingName', 'outputType'[, 'fileExtensiondefaultValue'])}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.
    • outputType
      Required; Type of output to create a temporary file forresolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG, WEBSERVICE, SQL, STOREDPROC.
    • fileExtensiondefaultValue
      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)
    Code Block
    languagetext
    linenumberstrue
    application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'STOREDPROC', 'tsv')}
    > application.exe -file $(ops_output_path_1639503212294197671Q13UV8MSH6355_storedproc_tsv)
    Code Block
    languagetext
    linenumberstrue
    application.exe -file ${_outputPathFromTask('Sibling_Instance_Name', 'WEBSERVICE', 'json')}
    > application.exe -file $(ops_output_path_1639503212294088671CAWMP3VNQ468B_webservice_json)

    SAP Connection Functions

    ...

    Description

    ...

    Returns a token representing the property associated with an SAP connection

    ...

    Syntax

    ...

    ${_sapConnection('<sapConnection_name>', '<property-name>')}

    ...

    Parameters

    ...

    • sapConnection_name
      Required; Name of the SAP Connection.

    • property_name
      Required; Name of the SAP Connection property.

    ...

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

    ...

    Description

    ...

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

    ...

    Syntax

    ...

    ${_scriptPath('script_name')}

    ...

    Parameters

    ...

    • script_name
      Required; Name of the Data Script.

    ...

    Example

    Script Name: MyDataScript

    ...

    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 a Data Script.

    Note
    titleNote

    _scriptPath requires Agent 6.4.0.0 or later.

    ...

    Return Column Names for SQL Results from Current Task

    ...

    Description

    ...

    Returns the column names for the SQL results from the current SQL or Stored Procedure task. Column names are separated by the specified separator.

    ...

    Syntax

    ...

    ${_resultsColumnNames(['separator'])}

    ...

    Parameters

    ...

    • separator
      Optional; Column name separator. Default is comma (,).

    Return Column Names for SQL Results from Sibling Task

    ...

    Description

    ...

    Returns the column names for the SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Column names are separated by the specified separator.

    ...

    Syntax

    ...

    ${_resultsColumnNamesFromTask('name'[, 'separator'])}

    ...

    Parameters

    ...

    • name
      Required; Name of the sibling task that the results should come from. The task must be within the same workflow.
    • separator
      Optional; Column name separator. Default is comma (,).

    Return SQL Results from Current Task

    ...

    Description

    ...

    Returns all SQL results from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

    ...

    Syntax

    ...

    ${_resultsAll(['separator', 'rowSeparator'])}

    ...

    Parameters

    ...

    • separator
      Optional; Column separator. Default is comma (,).
    • rowSeparator
      Optional; Overrides default New Line character.

    Return SQL Results from Sibling Task

    ...

    Description

    ...

    Returns all SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

    ...

    Syntax

    ...

    ${_resultsAllFromTask('name'[, 'separator', 'rowSeparator'])}

    ...

    Parameters

    ...

    • name
      Required; Name of the task that the results should come from. The task must be within the same workflow.
    • separator
      Optional; Column separator. Default is comma (,).
    • rowSeparator
      Optional; Overrides default New Line character.

    Return SQL Warnings from Current Task

    Description

    Returns all SQL warnings from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

    Syntax

    ${_SQLWarnings(['separator'])}

    Parameters

    • separator
      Optional; Column separator. Default is comma (,).

    Return SQL Warnings from Sibling Task

    ...

    Description

    ...

    Returns all SQL warnings from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

    ...

    Syntax

    ...

    ${_SQLWarningsFromTask('name'[, 'separator'])}

    ...

    Parameters

    ...

    • name
      Required; Name of the sibling task that the warnings should come from. The task must be within the same workflow.
    • separator
      Optional; Column separator. Default is comma (,).

    Return String Value of Row/Column by Column Name

    ...

    Description

    ...

    Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

    ...

    Syntax

    ...

    ${_resultsColumn('name', 'colname'[, rownum, 'default_value'])}

    ...

    Parameters

    ...

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • colname
      Required; Name of column to retrieve.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.
    • default_value
      Optional; Default value to return if result not found.

    Return String Value of Row/Column by Column Number

    ...

    Description

    ...

    Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

    ...

    Syntax

    ...

    ${_resultsColumnByNo('name', colnum[, rownum, 'default_value'])}

    ...

    Parameters

    ...

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • colnum
      Required; Number of column to retrieve. First column in result is 1, second is 2, and so on.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.
    • default_value
      Optional; Default value to return if result not found.

    Return String Values of Columns

    ...

    Description

    ...

    Returns the string values of columns in a specific row in CSV (comma-separated values) format, from a previously executed SQL task within the same workflow, or from the current SQL task.

    ...

    Syntax

    ...

    ${_resultsColumnsCSV('name'[, rownum])}

    ...

    Parameters

    ...

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.

    ...

    String Functions can accept:

    • String content in a String parameter.
    • Variable name in a String parameter (prefixed with _var) from which string content can be obtained.
    • Integer and Boolean parameters.

    For String functions that accept a String value parameter directly, the value parameter can be specified using hard-coded text, variables, functions, or any combination of the three.
     

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

    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.

    ...

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

    If you are using a String function to manipulate a String value that potentially may contain an escape sequence, you should use the String function that accepts a variable name parameter to allow for passing the value to the function without the escape sequence being interpreted.
     

    ...

    Escape Sequences

    ...

    Escape Sequence Description

    ...

    \t

    ...

    Insert a tab in the text at this point.

    ...

    \b

    ...

    Insert a backspace in the text at this point.

    ...

    \n

    ...

    Insert a newline in the text at this point.

    ...

    \r

    ...

    Insert a carriage return in the text at this point.

    ...

    \f

    ...

    Insert a formfeed in the text at this point.

    ...

    \'

    ...

    Insert a single quote character in the text at this point.

    ...

    \"

    ...

    Insert a double quote character in the text at this point.

    ...

    \\

    ...

    Insert a backslash character in the text at this point.

    ...

    Description

    ...

    Converts all of the characters in the value to lower case using the rules of the default locale.

    ...

    Syntax

    ...

    ${_toLowerCase('value')}

    ...

    Parameters

    ...

    • value
      Required; String to convert to lower case.

    ...

    Description

    Converts all of the characters in the variable to lower case using the rules of the default locale.

    Syntax

    ${_varToLowerCase('variableName')}

    Parameters

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

    ...

    Description

    ...

    Converts all of the characters in the value to upper case using the rules of the default locale.

    ...

    Syntax

    ...

    ${_toUpperCase('value')}

    ...

    Parameters

    ...

    • value
      Required; String to convert to upper case.

    ...

    Description

    ...

    Converts all of the characters in the variable to upper case using the rules of the default locale.

    ...

    Syntax

    ...

    ${_varToUpperCase('variableName')}

    ...

    Parameters

    ...

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

    ...

    Description

    ...

    Escapes the characters in a variable value using XML entities.

    ...

    Syntax

    ...

    ${_varEscapeXml('variableName')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into XML.

    ...

    Example

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

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

    ...

    Description

    ...

    Escapes the characters in a variable value using JSON string values.

    ...

    Syntax

    ...

    ${_varEscapeJson('variableName')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JSON.

    ...

    Example

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

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

    ...

    Description

    ...

    Escapes the characters in a variable value using JavaScript String rules.

    ...

    Syntax

    ...

    ${_varEscapeJavaScript('variableName')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into JavaScript.

    ...

    Example

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

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

    ...

    Description

    ...

    Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.)

    ...

    Syntax

    ...

    ${_varEscapeHtml('variableName')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into HTML.

    ...

    Example

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

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

    ...

    Description

    ...

    Returns a literal regular expression pattern String for the value of the specified variable.
     
    This method produces a String that can be used to create a Pattern that would match the String as if it were a literal pattern.

    ...

    Syntax

    ...

    ${_varLiteralPattern('variableName')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into a regular expression as a literal pattern.

    ...

    Example

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

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

    ...

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

    ...

    Returns the value of the specified variable encoded using the Base64 encoding scheme.

    ...

    Syntax

    ...

    ${_varEncodeBase64('variableName'[, 'charset'])}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable whose value will be encoded using the Base64 encoding scheme.
    • charset
      Optional; Name of the charset; default UTF-8.

    ...

    Where Variable rawstring contains a value of "Test String":

    Panel

    ${_varEncodeBase64('rawstring')} --> VGVzdCBTdHJpbmc=

    ...

    Description

    ...

    Returns a copy of value, with leading and trailing whitespace omitted.

    ...

    Syntax

    ...

    ${_trim('value')}

    ...

    Parameters

    ...

    • value
      Required; String to trim.

    ...

    Description

    ...

    Returns a copy of variableName, with leading and trailing whitespace omitted.

    ...

    Syntax

    ...

    ${_varTrim('variableName')}

    ...

    Parameters

    ...

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

    ...

    Description

    ...

    Returns the index within the string value of the first occurrence of the specified substring, str.

    ...

    Syntax

    ...

    ${_indexOf('value', 'str')}

    ...

    Parameters

    ...

    • value
      Any string.
    • str
      Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.

    ...

    Description

    ...

    Returns the index within the string variable of the first occurrence of the specified substring, str.

    ...

    Syntax

    ...

    ${_varIndexOf('variableName', 'str')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.

    ...

    Description

    ...

    Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest value.

    ...

    Syntax

    ...

    ${_indexOfWithOffset('value', 'str', offset)}

    ...

    Parameters

    ...

    • value
      Required; Any string.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    ...

    Description

    ...

    Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest variable.

    ...

    Syntax

    ...

    ${_varIndexOfWithOffset('variableName', 'str', offset)}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    ...

    Description

    ...

    Returns the index within the string value of the rightmost occurrence of the specified substring, str.

    ...

    Syntax

    ...

    ${_lastIndexOf('value', 'str')}

    ...

    Parameters

    ...

    • value
      Required; Any string.
    • str
      Required; Substring to search for. If the str argument occurs one or more times as a substring within the value, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.

    ...

    Description

    ...

    Returns the index within the string variable of the rightmost occurrence of the specified substring, str.

    ...

    Syntax

    ...

    ${_varLastIndexOf('variableName', 'str')}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs one or more times as a substring within the variable, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.

    ...

    Description

    ...

    Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest value.

    ...

    Syntax

    ...

    ${_lastIndexOfWithOffset('value', 'str', offset)}

    ...

    Parameters

    ...

    • value
      Required; Any string.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    ...

    Description

    ...

    Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest variable.

    ...

    Syntax

    ...

    ${_varLastIndexOfWithOffset('variableName', 'str', offset)}

    ...

    Parameters

    ...

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    ...

    Description

    Returns the length of value.

    Syntax

    ${_length
    • Default value to return if the output data is not found. Default is empty ('').

    Anchor
    Task Instance Output Number of Lines
    Task Instance Output Number of Lines
    Task Instance Output Number of Lines

    Description

    Resolves to the number of lines of 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.

    Syntax

    ${_outputNumberOfLines('outputType')}

    Parameters

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

    ${_outputNumberOfLines('STDOUT')}
    > 6

    Anchor
    Sibling Task Instance Output Number of Lines
    Sibling Task Instance Output Number of Lines
    Sibling Task Instance Output Number of Lines

    Description

    Resolves to the number of lines of 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.

    Syntax

    ${_outputNumberOfLinesFromTask('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

    ${_outputNumberOfLinesFromTask('test', 'STDOUT')}
    > 8

    Anchor
    Task Instance Output by Specific Line(s)
    Task Instance Output by Specific Line(s)
    Task Instance Output by Specific Line(s)

    Description

    Resolves to the specified line(s) of 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.

    Syntax

    ${_outputLines('outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])}

    Parameters

    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • startLine
      Required; Start line, where 1 is the first line and -1 is the last line.
    • numberOfLines
      Required; Number of lines to return starting from the startLine.
    • defaultValue
      Optional; Default value to return if no lines qualify. Default is empty ('')
    • resultDelimiter
      Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Sibling Task Instance Output by Specific Line(s)

    Description

    Resolves to the specified line(s) of 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.

    Syntax

    ${_outputLinesFromTask('siblingName', 'outputType', startLine, numberOfLines[, 'defaultValue', 'resultDelimiter'])}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.
    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • startLine
      Required; Start line, where 1 is the first line and -1 is the last line.
    • numberOfLines
      Required; Number of lines to return starting from the startLine.
    • defaultValue
      Optional; Default value to return if no lines qualify. Default is empty ('').
    • resultDelimiter
      Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Anchor
    Task Instance Output by Line(s) Matching Regular Expression
    Task Instance Output by Line(s) Matching Regular Expression
    Task Instance Output by Line(s) Matching Regular Expression

    Description

    Resolves to the line(s) of output data that match the specified regular expression, of the specified outputType, of the task instance that is resolving the function by specifying a regular expression.

    • The complete output line is returned.
    • If the output record of the specified ouptutType cannot be found, the function will remain unresolved.

    Syntax

    ${_outputLinesByRegex('outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])}

    Parameters

    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • regexPattern
      Required; Regular expression used for determining if a line matches. Regular expression must match the whole line (see Example, below).
    • maxCount
      Optional; Maximum number of matching lines to return. Default is 1.
    • numberOfLinesBefore
      Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
    • numberOfLinesAfter
      Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
    • defaultValue
      Optional; Default value to return if no lines match the regular expression. Default is empty ('').
    • resultDelimiter
      Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Example

    STDOUT contains:
    Some_Text
    ABC=Some_String
    More_Text
     
    ${_outputLinesByRegex('STDOUT', '^ABC=')} Returns empty (the whole Line was not matched)
    ${_outputLinesByRegex('STDOUT', '^ABC=.*')} Returns ABC=Some_String

    Sibling Task Instance Output by Line(s) Matching Regular Expression

    Description

    Resolves to the line(s) of output data that match the specified regular expression, 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.

    Syntax

    ${_outputLinesByRegexFromTask('siblingName', 'outputType', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])}

    Parameters

    • siblingName
      Required; Name of a sibling task instance.
    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • regexPattern
      Required; Regular expression used for determining if a line matches.
    • maxCount
      Optional; Maximum number of matching lines to return. Default is 1.
    • numberOfLinesBefore
      Optional; Number of lines before each matching line to return along with the matching line. Default is 0.
    • numberOfLinesAfter
      Optional; Number of lines after each matching line to return along with the matching line. Default is 0.
    • defaultValue
      Optional; Default value to return if no lines match the regular expression. Default is empty ('').
    • resultDelimiter
      Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Anchor
    Task Instance Output By XPath
    Task Instance Output By XPath
    Task Instance Output By XPath

    Description

    Resolves to the XML output data of the task instance that is resolving the function, corresponding to the evaluated XPath expression.

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

    • If the output record is found, but the path expression does not yield a result, the function will resolve to the default value.

    Syntax

    ${_outputXPath('outputType', 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint])}

    Parameters

    • outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.
    • xPathExpression
      Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
    • defaultValue
      Optional; Default value to return if the result is not found. Default is empty ('').
    • delimiter
      Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
    • prettyPrint
      Optional; Specification (true or false) for whether or not XML output will be pretty printed (indented). Default is false.

    Example

    XML

    <message>
      <code>10</code>
    </message>

    Function

    ${_outputXPath('STDOUT', '//code/text()')}

    Result

    10

    Sibling Task Instance Output By XPath

    Description

    Resolves to the XML output data of the task instance specified by the siblingName, corresponding to the evaluated XPath 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

    ${_outputXPathFromTask('siblingName', 'outputType', 'xPathExpression'[, '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.
    • xPathExpression
      Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp
    • defaultValue
      Optional; Default value to return if the result is not found. Default is empty ('').
    • delimiter
      Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).
    • prettyPrint
      Optional; Specification (true or false) for whether or not XML output will be pretty printed (indented). Default is false.

    Example

    XML
    <message>
      <code>10</code>
    </message>

    Function
    ${_outputXPathFromTask('Sibling_With_XML_Output', 'STDOUT', '//code/text()')}

    Result
    10

    Anchor
    Task Instance Output By JsonPath
    Task Instance Output By JsonPath
    Task Instance Output By JsonPath

    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.

    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

    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

    Anchor
    Task Instance Output By JsonPath As Array
    Task Instance Output By JsonPath As Array
    Task Instance Output By JsonPath As Array

    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.

    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!"
    ]

    Sibling Task Instance Output By JsonPath As Array

    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.

    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!"]

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

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


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


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


    SAP Connection Functions

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

    Description

    Returns a token representing the property associated with an SAP connection

    Syntax

    ${_sapConnection('<sapConnection_name>', '<property-name>')}

    Parameters

    • sapConnection_name
      Required; Name of the SAP Connection.

    • property_name
      Required; Name of the SAP Connection property.

    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 that you want to embed.

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

    Description

    Returns the column names for the SQL results from the current SQL or Stored Procedure task. Column names are separated by the specified separator.

    Syntax

    ${_resultsColumnNames(['separator'])}

    Parameters

    • separator
      Optional; Column name separator. Default is comma (,).

    Return Column Names for SQL Results from Sibling Task

    Description

    Returns the column names for the SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Column names are separated by the specified separator.

    Syntax

    ${_resultsColumnNamesFromTask('name'[, 'separator'])}

    Parameters

    • name
      Required; Name of the sibling task that the results should come from. The task must be within the same workflow.
    • separator
      Optional; Column name separator. Default is comma (,).

    Return SQL Results from Current Task

    Description

    Returns all SQL results from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

    Syntax

    ${_resultsAll(['separator', 'rowSeparator'])}

    Parameters

    • separator
      Optional; Column separator. Default is comma (,).
    • rowSeparator
      Optional; Overrides default New Line character.

    Return SQL Results from Sibling Task

    Description

    Returns all SQL results from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

    Syntax

    ${_resultsAllFromTask('name'[, 'separator', 'rowSeparator'])}

    Parameters

    • name
      Required; Name of the task that the results should come from. The task must be within the same workflow.
    • separator
      Optional; Column separator. Default is comma (,).
    • rowSeparator
      Optional; Overrides default New Line character.

    Return SQL Warnings from Current Task

    Description

    Returns all SQL warnings from the current SQL or Stored Procedure task. Columns are separated by the specified separator and rows are separated by a new line.

    Syntax

    ${_SQLWarnings(['separator'])}

    Parameters

    • separator
      Optional; Column separator. Default is comma (,).

    Return SQL Warnings from Sibling Task

    Description

    Returns all SQL warnings from a sibling SQL or Stored Procedure task, within the same workflow. Columns are separated by the specified separator and rows are separated by a new line.

    Syntax

    ${_SQLWarningsFromTask('name'[, 'separator'])}

    Parameters

    • name
      Required; Name of the sibling task that the warnings should come from. The task must be within the same workflow.
    • separator
      Optional; Column separator. Default is comma (,).

    Return String Value of Row/Column by Column Name

    Description

    Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

    Syntax

    ${_resultsColumn('name', 'colname'[, rownum, 'default_value'])}

    Parameters

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • colname
      Required; Name of column to retrieve.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.
    • default_value
      Optional; Default value to return if result not found.

    Return String Value of Row/Column by Column Number

    Description

    Returns the string value of a row/column from a previously executed SQL task within the same workflow, or from the current SQL task.

    Syntax

    ${_resultsColumnByNo('name', colnum[, rownum, 'default_value'])}

    Parameters

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • colnum
      Required; Number of column to retrieve. First column in result is 1, second is 2, and so on.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.
    • default_value
      Optional; Default value to return if result not found.

    Return String Values of Columns

    Description

    Returns the string values of columns in a specific row in CSV (comma-separated values) format, from a previously executed SQL task within the same workflow, or from the current SQL task.

    Syntax

    ${_resultsColumnsCSV('name'[, rownum])}

    Parameters

    • name
      Required; Name of a sibling SQL task within the same workflow from which you want the function to fetch results. If you want to execute the function against the current task, use an empty string for the name parameter.
    • rownum
      Optional; Numeric row number in result set to retrieve. Default is 1.

    Anchor
    String Functions
    String Functions
    String Functions

    String Functions can accept:

    • String content in a String parameter.
    • Variable name in a String parameter (prefixed with _var) from which string content can be obtained.
    • Integer and Boolean parameters.

    For String functions that accept a String value parameter directly, the value parameter can be specified using hard-coded text, variables, functions, or any combination of the three.
     

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


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

    If you are using a String function to manipulate a String value that potentially may contain an escape sequence, you should use the String function that accepts a variable name parameter to allow for passing the value to the function without the escape sequence being interpreted.
     

    Escape Sequences

    Escape Sequence Description

    \t

    Insert a tab in the text at this point.

    \b

    Insert a backspace in the text at this point.

    \n

    Insert a newline in the text at this point.

    \r

    Insert a carriage return in the text at this point.

    \f

    Insert a formfeed in the text at this point.

    \'

    Insert a single quote character in the text at this point.

    \"

    Insert a double quote character in the text at this point.

    \\

    Insert a backslash character in the text at this point.

    Anchor
    _toLowerCase
    _toLowerCase
    Convert Characters in Value to Lower Case

    Description

    Converts all of the characters in the value to lower case using the rules of the default locale.

    Syntax

    ${_toLowerCase('value')}

    Parameters

    • value
      Required; Any stringString to convert to lower case.

    Anchor
    _

    ...

    varToLowerCase
    _

    ...

    Description

    ...

    varToLowerCase
    Convert Characters in Variable to Lower Case

    Description

    Converts all of the characters in the variable to lower case using the rules of the default locale.

    Syntax

    ${_varLengthvarToLowerCase('variableName'[, useEmptyForUndefined])}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function
    .useEmptyForUndefined
    Optional; Specification (true or false) for the handling of a missing variable name
    • .
    Default is false.
  • If useEmptyForUndefined = true, the function will return 0.
  • If useEmptyForUndefined = false, the function will remain unresolved if the variable name does not exist.
  • Anchor
    _

    ...

    toUpperCase
    _

    ...

    Description

    ...

    toUpperCase
    Convert Characters in Value to Upper Case

    Description

    Converts all of the characters in the value to upper case using the rules of the default locale.

    Syntax

    ${_substringtoUpperCase('value', beginIndex[, endIndex])}

    Parameters

    • value
      Required; String to
    make a substring from.
  • beginIndex
    Required; Beginning index, inclusive.
  • endIndex
    Optional; Ending index, exclusive.
  • Example

    panel
    • convert to upper case.

    Anchor
    _varToUpperCase
    _varToUpperCase
    Convert Characters in Variable to Upper Case

    Description

    Converts all of the characters in the variable to upper case using the rules of the default locale.

    Syntax

    ${_

    substring

    varToUpperCase('

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

    variableName')}

    Parameters

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

    Anchor
    _

    ...

    varEscapeXml
    _

    ...

    varEscapeXml
    Escape Characters in Variable Using XML Entities

    Description

    Returns a new string that is a substring of variableName. The substring begins at beginIndex and extends to the character at endIndex -1Escapes the characters in a variable value using XML entities.

    Syntax

    ${_varSubstringvarEscapeXml('variableName', beginIndex[, endIndex])}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function
    .
  • beginIndex
    Required; Beginning index, inclusive.
  • endIndex
    Optional; Ending index, exclusive.
  • Examples

    If the value of the food variable is hamburger, and the value of the face variable is smiles:
    • . The variable value will be escaped for insertion into XML.

    Example

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

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

    ...

    Description

    Returns a URL-encoded string according to the ASCII Encoding Reference for UTF-8; all non-alphanumeric characters are replaced with their equivalent hexadecimal escape sequences
    `1234567890\E-=[]\;&apos;,./ ~!@#$%^&amp;*()_+{}|:&quot;&lt;&gt;?


    Anchor
    _varEscapeJson
    _varEscapeJson
    Escape Characters in Variable Using JSON String Rules

    Description

    Resolves to the evaluated XPath 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

    Where Variable rawstring contains a value of “ABC$%^----DEF":

    Description

    Escapes the characters in a variable value using JSON string values.

    Syntax

    ${_varEncodeUrlvarEscapeJson('variableName')}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function. The variable whose value will be converted to a URL encoded stringescaped for insertion into JSON.

    Example

    Panel

    ${_varEncodeUrl(‘rawstring’)} --> ABC%24%25%5E----DEF

    Variable By XPath

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

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


    Anchor
    _varEscapeJavaScript
    _varEscapeJavaScript
    Escape Characters in Variable Using JavaScript String Rules

    Description

    Escapes the characters in a variable value using JavaScript String rules.

    Syntax

    ${_

    varXPath

    varEscapeJavaScript('variableName'

    , 'xPathExpression'[, 'defaultValue', 'delimiter', prettyPrint]

    )}

    Parameters

    • variableName
      Required;
    The name
    • Name of the variable
    to apply the XPath expression to.

    xPathExpression
    Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp

    defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').

    delimiter
    Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).

    prettyPrint
    Optional; Specification (true or false) for whether or not XML will be pretty printed (indented). Default is false.

    Example

    my_variable=
    <message>
      <code>10</code>
    </message>
    
    ${_varXPath('my_variable', '//code/text()')}
    > 10

    Variable By JsonPath

    ...

    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.

    ...

    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

    Variable By JsonPath As Array

    ...

    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.

    ...

    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!"
    ]

    Variable Number of Lines

    Description

    Resolves to the number of lines the value of the specified variable has.

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

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

    Syntax

    ${_varNumberOfLines('variableName
    • being passed into the function. The variable value will be escaped for insertion into JavaScript.

    Example

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

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


    Anchor
    _varEscapeHtml
    _varEscapeHtml
    Escape Characters in Variable Using HTML Entities

    Description

    Escapes the characters in a variable value using HTML entities. (Supports all known HTML 4.0 entities.)

    Syntax

    ${_varEscapeHtml('variableName')}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into HTML.

    Example

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

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


    Anchor
    _varLiteralPattern
    _varLiteralPattern
    Escape Characters in Variable as a Literal Pattern

    Description

    Returns a literal regular expression pattern String for the value of the specified variable.
     
    This method produces a String that can be used to create a Pattern that would match the String as if it were a literal pattern.

    Syntax

    ${_varLiteralPattern('variableName')}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function. The variable value will be escaped for insertion into a regular expression as a literal pattern.

    Example

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

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


    Anchor
    _randomString
    _randomString
    Randomly Generate a String

    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


    Anchor
    _replaceAll
    _replaceAll
    Replace Substring of Value with Regular Expression

    Description

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

    Syntax

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

    Parameters

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

    Anchor
    _varReplaceAll
    _varReplaceAll
    Replace Substring of Variable with Regular Expression

    Description

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

    Syntax

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

    Parameters

    • variableName
      Required;
    The name
    • Name of the variable
    to return the number of lines for.

    Example

    my_variable=
    Line 1
    Line 2
    Line 3
    
    ${_varNumberOfLines('my_variable')}
    > 3

    Variable By Specific Line(s)

    Description

    Resolves to the specified line(s) of variable data for the specified variable.

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

  • If the variable is undefined, blank, or no lines qualify, the function will resolve to the default value
    • being passed into the function.
    • regex
      Required; Regular expression.
    • replacement
      Required; Replacement string.

    Anchor
    _varEncodeBase64
    _varEncodeBase64
    Return Base64 Encoded String

    Description

    Returns the value of the specified variable encoded using the Base64 encoding scheme.

    Syntax

    ${_

    varLines

    varEncodeBase64('variableName'

    , startLine, numberOfLines

    [, '

    defaultValue',

    charset'

    resultDelimiter'

    ])}

    Parameters

    • variableName
      Required;
    The name
    • Name of the variable
    to apply the function to.

    startLine
    Required; Start line, where 1 is the first line and -1 is the last line.

    numberOfLines
    Required; Number of lines to return starting from the startLine.

    defaultValue
    Optional; Default value to return if no lines qualify. Default is empty ('').

    resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Example

    my_variable=
    Line 1
    Line 2
    Line 3
    Line 4
    
    ${_varLines('my_variable', 2, 2)}
    >
    Line 2
    Line 3

    Variable By Line(s) Matching Regular Expression

    Description

    Resolves to the line(s) of variable data that match the specified regular expression, of the specified variable.

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

  • If the variable is undefined, blank, or no lines qualify, the function will resolve to the default value
    • whose value will be encoded using the Base64 encoding scheme.
    • charset
      Optional; Name of the charset; default UTF-8.
    Example

    Where Variable rawstring contains a value of "Test String":

    Panel

    ${_varEncodeBase64('rawstring')} --> VGVzdCBTdHJpbmc=


    Anchor
    _trim
    _trim
    Return Copy of Value with Whitespace Omitted

    Description

    Returns a copy of value, with leading and trailing whitespace omitted.

    Syntax

    ${_trim('value')}

    Parameters

    • value
      Required; String to trim.

    Anchor
    _varTrim
    _varTrim
    Return Copy of Variable with Whitespace Omitted

    Description

    Returns a copy of variableName, with leading and trailing whitespace omitted.

    Syntax

    ${_

    varLinesByRegex('variableName', 'regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter']

    varTrim('variableName')}

    Parameters

    • variableName
      Required;
    The name
    • Name of the variable
    to apply
    • being passed into the function
    to
    • .

    regexPattern
    Required; Regular expression used for determining if a line matches. Regular expression must match the whole line (see Example, below).

    maxCount
    Optional; Maximum number of matching lines to return. Default is 1.

    numberOfLinesBefore
    Optional; Number of lines before each matching line to return along with the matching line. Default is 0.

    numberOfLinesAfter
    Optional; Number of lines after each matching line to return along with the matching line. Default is 0.

    defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').

    resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Example

    my_variable=
    Some_Text
    ABC=Some_String
    More_Text
    
    ${_varLinesByRegex('my_variable', '^ABC=')} /* Returns empty (the whole Line was not matched) */
    >
    
    ${_varLinesByRegex('my_variable', '^ABC=.*')}
    > ABC=Some_String

    Variable Path

    ...

    Description

    Returns a token representing the path to a temporary file containing the value of the specified variable.

    • $(ops_variable_path_<variableName><fileExtension>)

    ...

    Anchor
    _indexOf
    _indexOf
    Return Index of Substring in String Value

    Description

    Returns the index within the string value of the first occurrence of the specified substring, str.

    Syntax

    ${_indexOf('value', 'str')}

    Parameters

    • value
      Any string.
    • str
      Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.

    Anchor
    _varIndexOf
    _varIndexOf
    Return Index of Substring in String Variable

    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

    Description

    Returns the index within the string variable of the first occurrence of the specified substring, str.

    Syntax

    ${_varPathvarIndexOf('variableName'[, 'fileExtensionstr'])}

    Parameters

    • variableName
      Required;
    The variable to create a temporary file for.

    fileExtension
    Optional; The extension to use for the temporary file. Can be a maximum of 10 characters. Default is txt.

    Example

    application.exe -file ${_varPath('my_variable')}
    > application.exe -file $(ops_variable_path_my_variable_txt)
    
    application.exe -file ${_varPath('my_variable', 'csv')}
    > application.exe -file $(ops_variable_path_my_variable_csv)

    Variable CSV Record Count

    • Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.

    Anchor
    _indexOfWithOffset
    _indexOfWithOffset
    Return Index of Substring Plus Offset in String Value

    Description

    Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest value.

    Syntax

    ${_indexOfWithOffset('value', 'str', offset)}

    Parameters

    • value
      Required; Any string.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    Anchor
    _varIndexOfWithOffset
    _varIndexOfWithOffset
    Return Index of Substring Plus Offset in String Variable

    Description

    Returns the index within this string of the first occurrence of the specified substring plus the specified offset. The integer returned is the smallest variable.

    Syntax

    ${_

    varCsvRecordCount

    varIndexOfWithOffset('

    <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

    variableName', 'str', offset)}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    Anchor
    _lastIndexOf
    _lastIndexOf
    Return Index of Rightmost Occurrence of Substring in String Value

    Description

    Returns the index within the string value of the rightmost occurrence of the specified substring, str.

    Syntax

    ${_

    varCsvRecordValueCount

    lastIndexOf('

    variableName

    value',

    recordIndex

    'str')}

    Parameters

    variableName
    • value
      Required;
    Name of the variable
    • Any string.
    recordIndex
    • str
      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
    • Substring to search for. If the str argument occurs one or more times as a substring within the value, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.

    Anchor
    _varLastIndexOf
    _varLastIndexOf
    Return Index of Rightmost Occurrence of Substring in String Variable

    Description

    Returns the index within the string variable of the rightmost occurrence of the specified substring, str.

    Syntax

    ${_varLastIndexOf('variableName', 'str')}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs one or more times as a substring within the variable, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.

    Anchor
    _lastIndexOfWithOffset
    _lastIndexOfWithOffset
    Return Index of Rightmost Occurrence of Substring Plus Offset in String Value

    Description

    Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest value.

    Syntax

    ${_

    varCsvRecordValue

    lastIndexOfWithOffset('value', '

    variableName

    str',

    recordIndex, valueIndex

    offset)}

    Parameters

    variableName
    • value
      Required;
    Name of the variable
    • Any string.
    recordIndex
    • str
      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
    • Substring to search for. If the str argument occurs as a substring within the value, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    Anchor
    _varLastIndexOfWithOffset
    _varLastIndexOfWithOffset
    Return Index of Rightmost Occurrence of Substring Plus Offset in String Variable

    Description

    Returns the index within this string of the rightmost occurrence of the specified substring, plus the specified offset. The returned index is the largest variable.

    Syntax

    ${_varLastIndexOfWithOffset('variableName', 'str', offset)}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function.
    • str
      Required; Substring to search for. If the str argument occurs as a substring within the variable, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.
    • offset
      Required; Number (positive or negative) to offset the found index.

    Anchor
    _length
    _length
    Return Length of Value

    Description

    Returns the length of value.

    Syntax

    ${_length('value')}

    Parameters

    • value
      Required; Any string.

    Anchor
    _varLength
    _varLength
    Return Length of Variable

    Description

    Returns the length of variableName.

    Syntax

    ${_

    varTsvRecordValueCount

    varLength('variableName'[,

    recordIndex

    useEmptyForUndefined])}

    Parameters

    • variableName
      Required; Name of the variable being passed into the function.
    recordIndex
    • useEmptyForUndefined
    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
    • Optional; Specification (true or false) for the handling of a missing variable name. Default is false.
      • If useEmptyForUndefined = true, the function will return 0.
      • If useEmptyForUndefined = false, the function will remain unresolved if the variable name does not exist.

    Anchor
    _substring
    _substring
    Return New String that is Substring of Value

    Description

    Returns a new string that is a substring of value. The substring begins at beginIndex and extends to the character at endIndex -1.

    Syntax

    ${_

    varTsvRecordValue

    substring('

    variableName

    value',

    recordIndex

    beginIndex[,

    valueIndex

    endIndex])}

    Parameters

    variableName
    • value
      Required;
    Name of the variable
    • String to make a substring from.
    recordIndex
    • beginIndex
      Required;
    record
    • Beginning index
    number
    • , inclusive.
    valueIndex
    • endIndex
    Required
    • Optional;
    record
    • Ending index
    number
    • , exclusive.

    Example

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

    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


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


    Anchor
    _varSubstring
    _varSubstring
    Return New String that is Substring of Variable

    Description

    Returns a new string that is a substring of variableName. The substring begins at beginIndex and extends to the character at endIndex -1.

    Syntax

    ${_

    outputCsvRecordCount

    varSubstring('

    <outputType>'

    variableName', beginIndex[, endIndex])}

    Parameters

    outputType
    • variableName
      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
    • Name of the variable being passed into the function.
    • beginIndex
      Required; Beginning index, inclusive.
    • endIndex
      Optional; Ending index, exclusive.

    Examples

    If the value of the food variable is hamburger, and the value of the face variable is smiles:
     

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


    Anchor
    varEncodeUrl
    varEncodeUrl
    Return URL-Encoded String

    Description

    Returns a URL-encoded string according to the ASCII Encoding Reference for UTF-8; all non-alphanumeric characters are replaced with their equivalent hexadecimal escape sequences.

    Syntax

    ${_varEncodeUrl('variableName')}

    Parameters

    • variableName
      Required; Name of the variable whose value will be converted to a URL encoded string.
    Example

    Where Variable rawstring contains a value of “ABC$%^----DEF":

    Panel

    ${_varEncodeUrl(‘rawstring’)} --> ABC%24%25%5E----DEF


    Variable By XPath

    Description

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

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

    • If the

    output is blank
    • variable is undefined, blank, or the path expression does not yield a result, the function will

    remain unresolved.If an index is invalid, the function will remain unresolved
    • resolve to the default value.

    Syntax

    ${_

    outputCsvRecordValue

    varXPath('

    outputType

    variableName', 'xPathExpression'[, 'defaultValue',

    recordIndex, valueIndex

    'delimiter', prettyPrint])}

    Parameters

    outputType

    variableName
    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 name of the variable to apply the XPath expression to.

    xPathExpression
    Required; XPath expression. https://www.w3schools.com/xml/xpath_intro.asp

    defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').

    delimiter
    Optional; If xPathExpression evaluates to multiple results, the delimiter to be used to separate those results. Default is new line character (\n).

    prettyPrint
    Optional; Specification (true or false) for whether or not XML will be pretty printed (indented). Default is false.

    Example

    my_variable=
    <message>
      <code>10</code>
    </message>
    
    ${_varXPath('my_variable', '//code/text()')}
    > 10

    Variable By JsonPath

    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

    output
    • variable is undefined, blank,

    the function will resolve to 0.
    If an index is invalid
    • or the path expression does not yield a result, the function will resolve to

    0_outputTsvRecordValueCount('STDERR','1
    • the default value.

    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" ${

    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')}
    > 
    4

    ...

    10

    Variable By JsonPath As Array

    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

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

    • If the

    output
    • variable is

    blank
    • unresolved, the function will remain unresolved.

    • If

    an index is invalid
    • the variable is undefined, blank, or the path expression does not yield a result, the function will

    remain unresolved
    • resolve to the default value.

    Syntax

    ${_

    outputTsvRecordValue

    varJsonPathAsArray('variableName', '

    outputType

    pathExpression'[,

    recordIndex, valueIndex

    'defaultValue', prettyPrint])}

    Parameters

    outputType

    variableName
    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

    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
      },
      {
        "
    E
    message" : "
    F
    World!",
        "
    G
    code"
    "H"
     : 20
      }
    ]
    
    ${_
    outputTsvValue
    varJsonPathAsArray('my_variable',
    '1
     '$[*].message', '
    2
    ', true)}
    >
    
    G

    ...

    [
        "Hello",
        "World!"
    ]

    Variable Number of Lines

    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

    number of lines the value of the specified variable has.

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

    • If the

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

    Syntax

    ${_

    outputCsvRecordCountFromTask

    varNumberOfLines('

    siblingName', 'outputType

    variableName')}

    Parameters

    siblingName

    variableName
    Required;

    Name of a sibling task instance.outputType
    Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG

    The name of the variable to return the number of lines for.

    Example

    data="A","B","C","D"\n "E","F","G","H"
    my_variable=
    Line 1
    Line 2
    Line 3
    
    ${_
    outputCsvRecordCountFromTask
    varNumberOfLines('
    task-1','STDERR'
    my_variable')}
    > 
    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
    3

    Variable By Specific Line(s)

    Description

    Resolves to the specified line(s) of variable data for the specified variable.

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

    • If the

    output
    • variable is undefined, blank, or no lines qualify, the function will resolve to

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

    Syntax

    ${_

    outputCsvRecordValueCountFromTask

    varLines('

    siblingName

    variableName', startLine, numberOfLines[, '

    outputType

    defaultValue', '

    recordIndex

    resultDelimiter'])}

    Parameters

    siblingName

    variableName
    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 name of the variable to apply the function to.

    startLine
    Required; Start line, where 1 is the first line and -1 is the last line.

    numberOfLines
    Required; Number of lines to return starting from the startLine.

    defaultValue
    Optional; Default value to return if no lines qualify. Default is empty ('').

    resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Example

    my_variable=
    Line 1
    Line 2
    Line 3
    Line 4
    
    ${_varLines('my_variable', 2, 2)}
    >
    Line 2
    Line 3

    Variable By Line(s) Matching Regular Expression

    Description

    Resolves to the line(s) of variable data that match the specified regular expression, of the specified variable.

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

    • If

    an index is invalid
    • the variable is undefined, blank, or no lines qualify, the function will

    remain unresolved
    • resolve to the default value.

    Syntax

    ${_

    outputCsvRecordValueFromTask

    varLinesByRegex('

    siblingName

    variableName', '

    outputType', recordIndex, valueIndex

    regexPattern'[, maxCount, numberOfLinesBefore, numberOfLinesAfter, 'defaultValue', 'resultDelimiter'])}

    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

    variableName
    Required; The name of the variable to apply the function to.

    regexPattern
    Required; Regular expression used for determining if a line matches. Regular expression must match the whole line (see Example, below).

    maxCount
    Optional; Maximum number of matching lines to return. Default is 1.

    numberOfLinesBefore
    Optional; Number of lines before each matching line to return along with the matching line. Default is 0.

    numberOfLinesAfter
    Optional; Number of lines after each matching line to return along with the matching line. Default is 0.

    defaultValue
    Optional; Default value to return if the result is not found. Default is empty ('').

    resultDelimiter
    Optional; Delimiter to use when concatenating matching lines. If not specified, "\n" or "\r\n" depending on original output line endings.

    Example

    my_variable=
    Some_Text
    ABC=Some_String
    More_Text
    
    ${_varLinesByRegex('my_variable', '^ABC=')} /* Returns empty (the whole Line was not matched) */
    >
    
    ${_varLinesByRegex('my_variable', '^ABC=.*')}
    > ABC=Some_String

    Variable Path

    Description

    Returns a token representing the path to a temporary file containing the value of the specified variable.

    • $(ops_variable_path_<variableName><fileExtension>)

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

    Syntax

    ${_

    outputTsvRecordCountFromTask

    varPath('

    siblingName

    variableName'[, '

    outputType

    fileExtension'])}

    Parameters

    siblingName

    variableName
    Required;

    Name of a sibling task instance

    The variable to create a temporary file for.

    outputType

    fileExtension

    Required; Name of the variable.

    Example

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

    ...

    Optional; The extension to use for the temporary file. Can be a maximum of 10 characters. Default is txt.

    Example

    application.exe -file ${_varPath('my_variable')}
    > application.exe -file $(ops_variable_path_my_variable_txt)
    
    application.exe -file ${_varPath('my_variable', 'csv')}
    > application.exe -file $(ops_variable_path_my_variable_csv)

    Variable CSV Record Count

    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

    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

      output

      variable is

      blank

      undefined,

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

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

    Syntax

    Example

    data="A" "B" "C"

    ${_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.

    varCsvRecordCount('<variableName>')}

    Parameters

    • variableName
      Required; Name of the variable.

    Example

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

    ...

    Variable CSV Record Value

    ...

    Count

    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

    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 output

      the variable is undefined, or the variable value is blank, the function will

      remain unresolved

      resolve to 0.

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

    Syntax

    ${_outputTsvRecordValueFromTaskvarCsvRecordValueCount('siblingNamevariableName', 'outputType', recordIndex, valueIndex)}

    Parameters

    • siblingName variableName
      Required; Name of a sibling task instance.outputType
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOGthe variable.

    • recordIndex
      Required; record index number.valueIndexRequired; record index number.

    Example

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

    ...

    4

    Variable CSV Record Value

    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 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 the output an index is blankinvalid, the function will resolve to 0remain unresolved.

    Syntax

    ${_outputDelimitedValueCountvarCsvRecordValue('outputTypevariableName', recordIndex, [delimiter]valueIndex)}

    Parameters

    • outputType variableName
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOG.delimiter
      Optional;delimiter to split the output. default delimiter is comma(,)Name of the variable.

    • recordIndex
      Required; record index number.

    • valueIndex
      Required; record index number.

    Example

    datamy_variable="A","B","C","D"\n
                "E","F","G","H"
    ${_outputDelimitedValueCountvarCsvRecordValue('STDOUT'my_variable','1', ':2')}
    > 4

    ...

    G

    Variable TSV Record Count

    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

    TSV data record count for the specified variable.

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

    • If the

      output

      variable value is

      blank

      unresolved, the function will remain unresolved.

    • If

      an index is invalid

      the variable is undefined, or the variable value is blank, the function will

      remain unresolved

      resolve to 0.

    Syntax

    ${_outputDelimitedValuevarTsvRecordCount('outputType', valueIndex,[delimiter]<variableName>')}

    Parameters

    data
    • outputType variableName
      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

    • Name of the variable.

    Example

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

    ...

    2

    Variable TSV Record Value Count

    ...

    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

    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 output is blank

      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

    ${_outputDelimitedValueCountFromTaskvarTsvRecordValueCount('siblingNamevariableName', 'outputType', [delimiter]recordIndex)}

    Parameters

    data
    • siblingName variableName
      Required; Name of a sibling task instancethe variable.

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

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

    Example

    • record index number.

    Example

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

    ...

    Variable TSV Record Value

    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

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

    ${_outputDelimitedValueFromTaskvarTsvRecordValue('siblingNamevariableName', 'outputType'recordIndex, valueIndex,[delimiter])}

    Parameters

    • siblingName variableName
      Required; Name of a sibling task instancethe variable.

    • outputType recordIndex
      Required; Type of output to resolve: STDOUT, STDERR, FILE, EXTENSION, or JOBLOGrecord index number.

    • valueIndex
      Required; record index number.delimiter
      Optional;delimiter to split the output. default delimiter is comma(,).

    Example

    datamy_variable="A":,"B":,"C":,"D"\n
                "E","F","G","H"
    ${_outputDelimitedValueFromTaskvarTsvRecordValue('task-1my_variable','STDOUT1', '2',':')}
    > CG

    Var Delimited Value Count

    ...

    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 


    ...