Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

...

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

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

${_varPath('variableName'[, 'fileExtension'])}

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

Description

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

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

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

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

Syntax

${_varCsvRecordCount('<variableName>')}

Parameters

  • variableName
    Required; Name of the variable.

Example

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

Variable CSV Record Value Count

Description

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

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

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

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

Syntax

${_varCsvRecordValueCount('variableName', recordIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

Example

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

Variable CSV Record Value

Description

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

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

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

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

Syntax

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

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

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

Variable TSV Record Count

Description

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

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

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

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

Syntax

${_varTsvRecordCount('<variableName>')}

Parameters

  • variableName
    Required; Name of the variable.

Example

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

Variable TSV Record Value Count

Description

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

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

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

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

Syntax

${_varTsvRecordValueCount('variableName', recordIndex)}

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

Example

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

Variable TSV Record Value

Description

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

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

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

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

Syntax

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

Parameters

  • variableName
    Required; Name of the variable.

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

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

Output CSV Record Count

Description

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

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

  • If the outputTypeis undefined, blank, the function will resolve to the default value 0.

Syntax

${_outputCsvRecordCount('<outputType>')}

Parameters

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

Example

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

Output CSV Record Value Count

Description

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

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

  • If the outputType is undefined, blank, the function will resolve to the default value 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 outputType is unresolved, the function will remain unresolved.

  • If the outputType is undefined, blank, the function will resolve to the default value null.

Syntax

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

Parameters

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

  • recordIndex
    Required; record index number.

  • valueIndex
    Required; record index number.

Example

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

Output TSV Record Count

Description

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

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

  • If the outputType is undefined, blank, the function will resolve to the default value 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


Anchor
System Functions
System Functions
System Functions

...

Description

Resolves to the IP address of the machine running the Controller.

Syntax

${_ipaddress}

Parameters

(none)

Resolve to the Sibling SYS_ID

Description

Resolves to the sys_id of the first task instance found within the same workflow specified by the sibling name.

Syntax

${_siblingid('sibling_name')}

Parameters

  • sibling_name
    Required; Sibling name.

Example


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


...