REL Functions and Implicit Objects

Redwood Expression Language (or REL) is a simple expression language that supports basic arithmetic and comparison operators, and some predefined functions. Different scripting contexts have different predefined objects, the functions on this page are available in all contexts.

You can create your own functions for use in REL and RedwoodScript using a library with REL entry points, see Libraries for more information.

The REL can be used to specify:

• Job definition parameter default values
• Job definition return code mappings
• Step preconditions
• Chain job preconditions
• Chain job parameter mappings
• Chain job scheduling parameters
• Event raiser comments
• ...

See the scripting contexts topic for more information.

Expressions in REL are designed to be very similar to expressions in RedwoodScript, and the predefined functions are the same. REL expressions start with an equals sign (=) such as:

=Time.now('Europe/Paris')

You can build sentences by concatenating elements with the plus character (+):

='The time in Paris is ' + Time.now('Europe/Paris') + ', in New York it is ' + Time.now('America/New York')

Operators

Redwood Expression Language provides support for the basic arithmetic operators:

• + - addition and string concatenation
• - - subtraction
• * - multiplication
• / - division
• % - integer modulus
• && - logical AND
• || - logical OR
• ! - NOT

It also supports comparison:

• === - equal to
• !== - not equal to
• > - greater than
• >= - greater than or equal
• < - less than
• <= - less than or equal

Escape Character

• \ - escape character, and thus must be escaped if the literal is meant to be used. This means that a UNC path would be specified as follows:

\\\\\\\\server\\\\share\\\\folder\\\\file

Builtin Constants

• true - true value of the boolean type.
• false - false value of the boolean type.

Built in function classes

• BaseCast - Prefix: None.
• BaseString - Prefix: None.
• BaseArray - Prefix: Array
• BaseCast - Prefix: Casts
• BaseMath - Prefix: Math
• BaseRange - Prefix: Range
• BaseStringPrefix - Prefix: String
• BaseTime - Prefix: Time
• ExtendedRange - Prefix: Range
• ExtendedRepository - Prefix: Repository
• ExtendedTime - Prefix: Time
• ModuleScriptingConstraint - Prefix: Constraint
• ModuleScriptingCredential - Prefix: Credential
• ModuleScriptingEvent - Prefix: Event
• ModuleScriptingJDBC - Prefix: JDBC
• ModuleScriptingJobChainParameters - Prefix: JobChainParameters
• ModuleScriptingLogic - Prefix: Logic
• ModuleScriptingLoop - Prefix: Loop
• ModuleScriptingPLSQL - Prefix: PLSQL
• ModuleScriptingQuery - Prefix: Query
• ModuleScriptingSap - Prefix: SAP
• ModuleScriptingTable - Prefix: Table
• ModuleScriptingUserMessage - Prefix: UserMessage
• ModuleScriptingVariable - Prefix: Variable

Note: The current<data_type> object designates the object you want to use with the function.

Built in functions

Array

Prefix: Array

Create an array from several elements.

Example: Array.toStringArray()

=Array.toStringArray('Apples', 'Oranges', 'Bananas', 'Lemons')

Returns an array with 4 fruity elements.

Example: Array.toNumberArray()

=Array.toNumberArray(1, 2, 3, 4)

Returns an array with 4 numbers.

Example: Array.toDateTimeZoneArray()

=Array.toDateTimeZoneArray(Time.now(),Time.parse('202350803100236','yyyyMMddhhmmss'))

Returns an array with 2 date/times elements.

Example: Array.toTimeArray()

=Array.toTimeArray(Time.now(),Time.parse('20230803100236','yyyyMMddhhmmss'))

Returns an array with 3 epoch time elements.

Example: Array.toString()

=Array.toString(['Apples', 'Oranges', 'Bananas', 'Lemons'], ',')

Returns "Apples,Oranges,Bananas,Lemons".

Example: Array.toStringAffix()

=Array.toStringAffix(['Apples', 'Oranges', 'Bananas', 'Lemons'], ',', '[', ']',)

Returns "[Apples,Oranges,Bananas,Lemons]".

Example: Array.get()

=Array.get(['Apples', 'Oranges', 'Bananas', 'Lemons'], 0)

Returns "Apples".

Cast

Prefix:

Change a data type to another.

Example: ToBoolean()

=ToBoolean('true')

Returns true.

Example: ToNumber()

=ToNumber('123')

Returns 123.

Example: ToInteger()

=ToInteger('123')

Returns 123.

Example: ToString()

=ToString(true)

Returns true.

Example: ToYN()

=ToYN('true')

Returns Y.

Math

Prefix: Math

Mathematical functions for use with Numbers.

Example: Math.abs()

=Math.abs(-12.12)

Returns 12.12.

Example: Math.floor()

=Math.floor(-12.12)

Returns -13.

Example: Math.ceil()

=Math.ceil(-12.12)

Returns -12.

Example: Math.round()

=Math.round(12.49)

Returns 12.

Example: Math.getInstance()

Range

Prefix: Range

Functions for working with sets and ranges.

Set is written as "XXXXXXX" where X is either '' or a letter and the first X represents 0 (or Sunday for days of the week, or January for months). Any letter is in the set, and '' is not in the set.

Example sets:

Ranges are made up of comma separated sections, each of which is a number (eg. 1) or a range of numbers (eg. 4-7). All numbers specified are in the range, other numbers are not.

Example: Range.inRange()

The following example uses the Time.format function. This boolean function checks if the current day of the month is between 1 and 7.

=Range.inRange(Time.format(Time.now('Europe/Berlin'), 'd'), '1-7')

.

Example: Range.inSet()

The following example uses the Time.format function. This boolean function checks if the current month is the first month of a quarter.

=Range.inSet(Time.format(Time.now('Europe/Berlin'), 'M'), ' X__X__X__X__')

. Note the leading space in trueRange to convert from the 1-based month to the 0-based trueRange.

String

Prefix:

Functions for working with Strings.

Example: currentString.concat()

='Hello'.concat(' World', '!')

Returns Hello World!.

Example: currentString.toString()

='123'.toString()

Returns 123, it can be used as a string.

Example: currentString.charAt()

='Hello World!'.charAt(4)

Returns o.

Example: currentString.indexOf()

='Hello World!'.indexOf('o')

Returns 4.

='Hello World!'.indexOf('o', 5)

Returns 7.

Example: currentString.lastIndexOf()

='Hello World!'.lastIndexOf('o')

Returns 7.

='Hello World!'.lastIndexOf('o', 5)

Returns 4.

Example: currentString.split()

='1 2 3 4 5 6 7 8 9 10'.split(' ', 5)

Returns [1, 2, 3, 4, 5].

Example: currentString.substring()

='Hello World!'.substring(0)

Returns Hello World!.

='Hello World!'.substring(6)

Returns World!.

='Hello World!'.substring(1, 3)

Returns el.

Example: currentString.toLowerCase()

='HeLLo WorLd!'.toLowerCase()

Returns hello world!.

Example: currentString.toUpperCase()

='HeLLo WorLd!'.toUpperCase()

Returns HELLO WORLD!.

Example: currentString.length()

='HeLLo WorLd!'.length()

Returns 12.

Example: getSystemId()

=getSystemId()

Returns SAP:C51_30 in this system.

Example: currentString.contains()

='Hello'.contains('l')

Returns true.

='Hello'.contains('lol')

Returns false.

Example: currentString.startsWith()

='Hello'.startsWith('He')

Returns true.

='Hello'.startsWith('llo')

Returns false.

Example: currentString.trim()

='Hello   '.trim()

Returns 'Hello'.

='   Hello'.trim()

Returns 'Hello'.

='   Hello   '.trim()

Returns 'Hello'.

='Hel  lo'.trim()

Returns 'Hel lo'.

String

Prefix: String

Functions for use with Strings.

Functions in the String package for working with Strings.

Example: String.concat()

=String.concat(Time.now('Europe/Paris'), ', Rue Toulouse-Lautrec')

Returns 2023/07/27 15:32:33,946 Europe/Paris, Rue Toulouse-Lautrec.

Example: String.toString()

=String.toString(123)

Returns 123 as a String.

Example: String.charAt()

=String.charAt('Hello John', 4)

Returns o.

Example: String.indexOf()

=String.indexOf('Hello', 'l', '3')

Returns 3.

Example: String.lastIndexOf()

=String.lastIndexOf('Hello', 'l', '3')

Returns 3.

Example: String.split()

=String.split('Some people like', ' ', '3')

Returns [Some, people, like].

Example: String.substring()

=String.substring('like it on ice', 8, 14)

Returns on ice.

Example: String.toLowerCase()

=String.toLowerCase('but I like it dry.')

Returns but i like it dry..

Example: String.toUpperCase()

=String.toUpperCase('I like it dry.')

Returns I LIKE IT DRY..

Example: String.length()

=String.length('but I like it dry.')

Returns 18.

Example: String.getSystemId()

=String.getSystemId()

Returns SAP:C51_30 on this system.

Example: String.contains()

=String.contains('Hello', 'l')

Returns true.

=String.contains('Hello', 'lol')

Returns false.

Example: String.startsWith()

=String.startsWith('Hello', 'He')

Returns true.

=String.startsWith('Hello', 'llo')

Returns false.

Example: String.trim()

=String.trim('Hello   ')

Returns 'Hello'.

=String.trim('   Hello')

Returns 'Hello'.

=String.trim('   Hello   ')

Returns 'Hello'.

=String.trim('Hel  lo')

Returns 'Hel lo'.

Time

Prefix: Time

Time expressions are a sequence of operations, applied in order to a time (generally now, but may be a specified date). They may be:

• set <specifier> <value> - set <specifier> to <value>
• add <value> <specifier> - add <value> to <specifier> (This may propagate)
• subtract <value> <specifier> - subtract <value> from <specifier> (This may propagate)
• truncate <specifier> - truncate at <specifier> (This will zero everything below <specifier>).

The <value> is always a number:

• The days of the week start at 1 for Sunday.
• The days of the year start at 1 for 1 January.

The <specifier> is one of:

• add/subtract: second, minute, hour, day, week, month, year
• truncate: second, minute, hour, day, month
• set: second, minute, hour, day, day_of_week, day_of_year, week_of_month, month

Plurals with an additional 's' are accepted (eg. days, weeks, ...). The day is always the day of the month. English names are accepted for day of week (day_of_week) and month; for example set day_of_week Monday or set month January, three letter abbreviations are accepted as well.

Example time expressions:

• add 1 minute
• add 3 seconds
• set hour 1
• set day_of_week Mon
• truncate day
• subtract 2 days

The time zone used by default is the JVM time zone. The examples use the Europe/Amsterdam time zone by default.

Example: Time.now()

=Time.now()

Returns the current time with time zone.

Example: Time.expression()

=Time.expression(Time.now('Europe/Amsterdam'), 'add 1 day')

Returns tomorrow, Europe/Amsterdam time.

Example: Time.expressionNow()

=Time.expressionNow('truncate day')

Returns 2023/07/27 00:00:00,000 Europe/Amsterdam.

Example: Time.isTimeWindowOpenNow()

=Time.isTimeWindowOpenNow('GLOBAL.System_Week_Monday')

• boolean functions which returns true if today is Monday.

Example: Time.isTimeWindowOpen()

=Time.isTimeWindowOpen(Time.expressionNow('subtract 1 day'), 'GLOBAL.System_Week_Monday')

• boolean function which returns true if today is Tuesday .

=Time.isTimeWindowOpen(Time.expressionNow('truncate day add 3 hours add 25 minutes'), '$.SomeTimeWindow')

• this example illustrates the use of the $ identifier for the partition.

Range - Extended

Prefix: Range

Extended Range function with notification.

Example: Range.inRangeWarning()

=Range.inRangeWarning(52, '10-50', '51-100', 50, 'Warning: range exceeded')

Returns true and creates an Operator Message.

Repository - Extended

Prefix: Repository

Functions for accessing the data model.

Example: Repository.getSystemId()

=Repository.getSystemId()

Returns SAP:C51_30 on this system.

Example: Repository.getParentJobId()

=Repository.getParentJobId('27')

Returns 21 on this system.

Example: Repository.queryHTMLTable()

=Repository.queryHTMLTable('select Job.Description from Job where Job.JobId = 21')

Returns My Job on this system.

Example: Repository.queryCSV()

=Repository.queryCSV('select Job.Description from Job where Job.JobId = 21')

Returns My Job on this system.

Time - Extended

Prefix: Time

Advanced time functions.

In previous releases, you used sysdate and systimestamp to retrieve the current date and date-time-offset, respectively. You can use the following REL functions to retrieve the data:

sysdate

=Time.format(Time.now(), 'dd-MM-yyyy')

systimestamp

=Time.format(Time.now(), 'dd-MM-yyyy hh.mm.ss.SSS a XXXXX')

The time zone used by default is the JVM time zone. The examples use the Europe/Amsterdam time zone by default.

Example: Time.isDayOfWeekInSetNow()

=Time.isDayOfWeekInSetNow('_X_X_X_')

Returns true if the current day is Monday, Wednesday, or Friday.

Example: Time.isDayOfWeekInSet()

=Time.isDayOfWeekInSet(Time.now('Europe/Paris'), '_X_X_X_')

Returns true if the day falls on a Monday, Wednesday, or Friday.

Example: Time.isDayInRangeNow()

=Time.isDayInRangeNow('4-7')

Returns true if the current day of the month is between 4 and 7.

Example: Time.isDayInRange()

=Time.isDayInRange(Time.now('Europe/Bratislava'), '4-7')

Returns true if the day of the month in the time expression is between 4 and 7.

Example: Time.isLastDayInMonthNow()

=Time.isLastDayInMonthNow()

Returns true if the current day is the last day of the month.

Example: Time.isLastDayInMonth()

=Time.isLastDayInMonth(Time.expressionNow('add 2 days'))

• return true if the current day is two days before the end of the month.

Example: Time.isMonthInSetNow()

=Time.isMonthInSetNow('_X_X_X_X_X_X')

• return true if the current month has an even number.

Example: Time.isMonthInSet()

=Time.isMonthInSet(Time.expression(Time.now(), 'add 1 month'), '_X_X_X_X_X_X')

• return true if the current month has an uneven number.

Example: Time.format()

=Time.format(Time.now(), 'yyyy-MM-dd')

Returns the date in the yyyy-MM-dd format, as in 2023-07-27.

Example: Time.formatLocale()

=Time.formatLocale(Time.now(), 'yyyy-MM-dd', 'de_DE')

Returns the date in the yyyy-MM-dd format, as in 2023-07-27 using the German/Germany locale.

Example: Time.formatDuration()

=Time.formatDuration(100000)

Returns 0:01:40.000.

Example: Time.formatDurationEx()

=Time.formatDurationEx(10000000000, '|1 week, |# weeks, |1 day, |# days, |#|:#|:#|.#|')

Returns 16 weeks, 3 days, 17:46:40.000.

=Time.formatDurationEx(10000000000, '|1 semaine, |# semaines, |1 jour, |# jours, |#|:#|:#|.#|')

Returns 16 semaines, 3 jours, 17:46:40.000.

=Time.formatDurationEx(10000000000, '|||1 day,|# days, |#|:#|:#|.#|')

Returns 115 days, 17:46:40.000.

=Time.formatDurationEx(10000000000, '||||# days, |#|:#|:#|.#|')

Returns 2777:46:40.000, which is the duration in hours, minutes, seconds, and milliseconds. The first and third elements were empty, causing the second which was empty and the fourth which was

# days,

to be discarded.

Example: Time.getUTCMillisecondsNow()

=Time.getUTCMillisecondsNow()

Returns the milliseconds since January 1 1970, for example 1690464753 on 2023/07/27 15:32:33,298 Europe/Amsterdam.

Example: Time.getUTCMilliseconds()

=Time.getUTCMilliseconds(Time.now())

Returns the milliseconds since January 1 1970, for example 1690464753 on 2023/07/27 15:32:33,298 Europe/Amsterdam.

Example: Time.formatNow()

=Time.formatNow('yyyyMMddhhmmss')

Returns 20230727153233.

Example: Time.parse()

=Time.parse('20230727153233', 'yyyyMMddhhmmss')

Returns 2023/07/27 15:32:33,000 Europe/Amsterdam.

Example: Time.nextTimeWindowOpeningNow()

=Time.nextTimeWindowOpeningNow('GLOBAL.System_Week_Thursday')

Returns 2023/08/03 00:00:00,000 Europe/Amsterdam.

=Time.nextTimeWindowOpeningNow('$.SomeTimeWindow')

Returns 2023/07/27 00:00:00,000 Europe/Amsterdam.

Example: Time.nextTimeWindowOpening()

=Time.nextTimeWindowOpening(Time.parse('20230727153233', 'yyyyMMddhhmmss'), 'GLOBAL.System_Week_Thursday')

Returns 2023/07/27 15:32:33,000 Europe/Amsterdam.

Example: Time.nextTimeWindowClosingNow()

=Time.nextTimeWindowClosingNow('GLOBAL.System_Week_Thursday')

Returns 2023/08/03 00:00:00,000 Europe/Amsterdam.

Example: Time.nextTimeWindowClosing()

=Time.nextTimeWindowClosing(Time.parse('20230727153233', 'yyyyMMddhhmmss'), 'GLOBAL.System_Week_Wednesday')

Returns 2023/07/27 00:00:00,000 Europe/Amsterdam.

Constraint

Prefix: Constraint

The following methods are used in the ''Simple Constraint Data'' field, the simple constraint type must be set to ''Expression''.

value

value

Example: Constraint.listConstraint()

=Constraint.listConstraint('Country', 'de,nl,gt', value !== '')

This will show a drop down list with the values de, gt and nl. However you can fill in any non-empty value, for example also mx

=Constraint.listConstraint('Country', 'de,nl,gt')

This will show a drop down list with the values de, gt and nl. You can only choose values from this list.

=Constraint.listConstraint('Ciphers or letters', '1,2,3,...|a,b,c,...', null, '\\|')

This will show a drop down list with the values 1,2,3,... and a,b,c,.... Note, the commas in the values. Also note, that the bar here is a special character in regular expressions and therefore it needs to be escaped with two slashes. You can only choose values from this list.

Example: Constraint.pairListConstraint()

=Constraint.pairListConstraint('Country, Code', 'de=49,nl=31,gt=502', value !== '')

.

This will show a drop down list, like

However, you can fill in any non-empty value, for example also mx.

=Constraint.pairListConstraint('Country Code, Country', 'de=Deutschland,nl=Nederland,gt=Guatemala')

.

This will show a drop down list, like

You can only choose one of the the values de, nl, or gt.

=Constraint.pairListConstraint('Code|Various symbols', 'C:1,2,3,...|L:a,b,c,...|O:=-*+/', null, '\\|', ':')

.

This will show a drop down list, like:

Note, the commas and equal sign in the values. Also note, that the bar here is a special character in regular expressions and therefore it needs to be escaped with two slashes. You can only choose values from this list.

Credential

Prefix: Credential

Example: Credential.getProtectedPasswordByProtocolRealUser()

=Credential.getProtectedPasswordByProtocolRealUser('GLOBAL', 'login', 'host', 'root')

or.

=Credential.getProtectedPasswordByProtocolRealUser('$', 'login', 'host', 'root')

where '$' represents the partition of the Process Definition the parameter is in.

Example: Credential.getProtectedPasswordByProtocolVirtualUser()

=Credential.getProtectedPasswordByProtocolVirtualUser('GLOBAL', 'login', 'host', 'appowner')

.

Example: Credential.getProtectedPassword()

=Credential.getProtectedPassword('host', 'root')

.

Functions for working with Events.

Event

Prefix: Event

Example: Event.isEventRaised()

=Event.isEventRaised('MyPartition.MyEvent')

Returns true on this system as the event is currently raised.

JDBC

Prefix: JDBC

Example: JDBC.clearCache()

Example: JDBC.constraint()

=JDBC.constraint('user=scott endpoint=xe',
      'select name "City", state "State/province" from cities where country =
      ?', parameters.Country)

• Implements a constraint, showing two columns. The first column has the title "City", the second column has the title "State/province". The data in the drop down list is a list of cities from the country as defined in the parameter Country, where the data comes from the database table cities. The actual value that is chosen is the city. The other column is only informational.

Example: JDBC.query()

=JDBC.query('user=scott endpoint=xe',
      'select global_name from global_name where rownum <= ?', 1)

• returns the global name of the Oracle database. Do not use a cached value of the result.

=JDBC.query('user=scott endpoint=xe cache=0',
      'select global_name from global_name where rownum <= ?', 1)

• returns the global name of the Oracle database. Do not use a cached value of the result, but do cache the result for a next time.

=JDBC.query('user=scott endpoint=xe
      cache=60', 'select global_name from global_name where rownum <= ?',
      1)

Returns the global name of the Oracle database. Do use a cached value of the result, but only when the cached value is not older than 60 seconds.

=JDBC.query('user=scott endpoint=xe cache=1m',
      'select global_name from global_name where rownum <= ?', 1)

• returns the global name of the Oracle database. Do use a cached value of the result, but only when the cached value is not older than 1 minute.

=JDBC.query('user=scott
      endpoint=xe cache', 'select global_name from global_name where rownum
      <= ?', 1)

Returns the global name of the Oracle database. Do use a cached value of the result, but only when the cached value is not older than the number of seconds as specified in the registry key

/configuration/REL/JDBC/DefaultMaxCacheAge

.

JobChainParameters

Prefix: JobChainParameters

Chain job names take the form Step name, job job number. For example: Step 2, job 3 or Data load, job 2. This expression is not zero-based, so the first job is Job 1.

Example: JobChainParameters.getOutValueString()

=JobChainParameters.getOutValueString('Step 1, Job 1', 'Parameter')

Returns the String Out value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getOutValueNumber()

=JobChainParameters.getOutValueNumber('Step 1, Job 1', 'Parameter')

Returns the Number Out value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getOutValueDate()

=JobChainParameters.getOutValueDate('Step 1, Job 1', 'Parameter')

Returns the Date Out value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getOutValueArray()

=JobChainParameters.getOutValueArray('Step 1, Job 1', 'Parameter')

Returns the Array Out value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getInValueString()

=JobChainParameters.getInValueString('Step 1, Job 1', 'Parameter')

Returns the String In value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getInValueNumber()

=JobChainParameters.getInValueNumber('Step 1, Job 1', 'Parameter')

Returns the Number In value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getInValueDate()

=JobChainParameters.getInValueDate('Step 1, Job 1', 'Parameter')

Returns the Date In value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getInValueArray()

=JobChainParameters.getInValueArray('Step 1, Job 1', 'Parameter')

Returns the Array In value of the parameter named "Parameter" of the first job (Job 1) in Step Step 1.

Example: JobChainParameters.getJobId()

=JobChainParameters.getJobId('Step 1, Job 1')

Returns the job ID of the first job (Job 1) of the Step Step 1.

Example: JobChainParameters.getJobStatus()

=JobChainParameters.getJobStatus('Step 2, Job 1')

Returns the job status of the first job (Job 1) of the Step Step 2.

Example: JobChainParameters.getJobReturnCode()

=JobChainParameters.getJobReturnCode('Step 2, Job 1')

Returns the job return code of the first job (Job 1) of the Step Step 2.

Example: JobChainParameters.getJobFilePath()

=JobChainParameters.getJobFilePath('Step 1, Job 1', 'stdout.log')

Returns the path to the output file of the first job (Job 1) of the Step Step 1.

Example: JobChainParameters.jobFileExists()

=JobChainParameters.jobFileExists('Step 1, Job 1', 'stdout.log')

Returns true if the output file of the first job (Job 1) of the Step Step 1 exists and can be read.

Logic

Prefix: Logic

Example: Logic.keyword_case()

=Logic.case(getSystemId(), 'SAP:O51_32', '32', 'SAP:O51_31', '31', 'Not Matched')

Returns 31 on this system.

Example: Logic.keyword_if()

=Logic.if(getSystemId() === 'SAP:O51_31', '31', 'Not Matched')

Returns 31 on this system.

Example: Logic.nvl()

=Logic.nvl(getSystemId(), 'Not null')

Returns SAP:O51_31 on this system.

Loop

Prefix: Loop

Example: Loop.getString()

=Loop.getString('symbol')

Returns the value of the column named symbol as a String.

Example: Loop.getBigDecimal()

=Loop.getBigDecimal('price')

Returns the value of the column named price as a BigDecimal.

Example: Loop.getDate()

=Loop.getString('date')

Returns the value of the column named date as a DateTimeZone.

Example: Loop.formatBigDecimal()

=Loop.formatBigDecimal('price', '$#.00')

• retrieves the value of the column named price as a BigDecimal and formats it as specified and returns it as a String.

Example: Loop.formatDate()

=Loop.formatDate('date', 'dd-MM-yyyy')

• retrieves the value of the date column named date, formats it using dd-MM-yyyy and returns it as a String.

Example: Loop.reformatStringAsBigDecimal()

=Loop.reformatStringAsBigDecimal('price', '$#.00', '#,00')

• retrieves the value of the column named price parses it using $#.00 and formats it using #,00 and returns it as a String.

Example: Loop.reformatStringAsDate()

=Loop.reformatStringAsDate('date', 'yyyy-MM-dd', 'dd-MM-yyyy')

• retrieves the value of the string column named date, parses it using yyyy-MM-dd, formats it using dd-MMM-yyyy, and returns it as a String.

PLSQL

Prefix: PLSQL

Example: PLSQL.booleanExpr()

=PLSQL.booleanExpr('user=scott
      endpoint=xe', '? > 0', 1)

Returns true. Do not use a cached value of the result.

=PLSQL.booleanExpr('user=scott endpoint=xe cache=0',
      '? > 0', 1)

Returns true. Do not use a cached value of the result, but do cache the result for a next time.

=PLSQL.booleanExpr('user=scott endpoint=xe
      cache=60', '? > 0', 1)

Returns true. Do use a cached value of the result, but only when the cached value is not older than 60 seconds.

=PLSQL.booleanExpr('user=scott endpoint=xe
      cache=1m', '? > 0', 1)

Returns true. Do use a cached value of the result, but only when the cached value is not older than 1 minute.

=PLSQL.booleanExpr('user=scott
      endpoint=xe cache', '? > 0', 1)

Returns true. Do use a cached value of the result, but only when the cached value is not older than the number of seconds as specified in the registry key

/configuration/REL/PLSQL/DefaultMaxCacheAge

.

=PLSQL.booleanExpr('user=scott cache=1m', '? > ?',
      parameters.param1, parameters.param2)

• compares two numbers defined in parameters param1 and param2. Note that this uses the System_Oracle endpoint (default)

Example: PLSQL.dateExpr()

Example: PLSQL.numberExpr()

Example: PLSQL.stringExpr()

Query

Prefix: Query

Functions for querying the data model.

Example: Query.getNumber()

=Query.getNumber('select Job.JobId from Job where Job.Description=\'My Job\'')

Returns 21 on this system. .

=Query.getNumber('select Job.ReturnCode from Job where Job.JobId = ?', [JobChainParameters.getJobId('Step 1,job 1')], 'n')

Returns 0 on this system.

Example: Query.getString()

=Query.getString('select Job.Description from Job where Job.Queue in (select q.UniqueId from Queue q where q.Name=?) order by Job.JobId DESC', ['System'])

Returns My Job on this system.

=Query.getString('select Job.Description from Job where Job.JobId=?', [parameters.JOBID])

Returns My Job on this system; note that the job has a JOBID parameter of type Number that holds the actual job ID.

=Query.getString('select Job.Description from Job where Job.JobId=?', [parameters.JOBID], 'n')

Returns My Job on this system; note that the job has a JOBID parameter of type String that holds the actual job ID, so in this case casting is required.

=Query.getString('select Job.Description from Job where Job.JobId = ?', [Query.getRelativeJob('Step 1,job 1')], 'n')

• First Job on this system.

Example: Query.getRelativeJob()

=Query.getRelativeJob('Step 1, Job 1')

• get the job ID of the first job of the Step named Step 1.

SAP

Prefix: SAP

Ranges are sent as a long string in the form [<sign><option><low><high>]+ where

• <sign> is a single character I or E
• <option> a select option, for example EQ, BT
• <low> the low value of the range
• <high> the high value of the range

All fields are always sent, regardless of the value of the <option>. If the value is shorter than the length of the field, it is padded with blanks.

Such ranges are known to be sent by Closing Cockpit.

Example: SAP.convertJobParameterRangesToExpression()

=SAP.convertJobParameterRangesToExpression('Step 1, Job 1', 'Parameter', 32)

Returns a select option.

Example: SAP.convertRangesToExpression()

=SAP.convertRangesToExpression('IBTAAZZ', 2)

Returns AA - ZZ.

Table

Prefix: Table

Functions for querying a table.

You use the

$

placeholder to specify the partition of the object you are editing, in job definitions and Chains.

Example: Table.getRow()

=Table.getRow('System_Variables', '2')

Returns EMEA on this system.

Example: Table.getColumnString()

=Table.getColumnString('System_Variables', '2', 'SystemValue')

Returns EMEA on this system.

Example: Table.getColumnNumber()

=Table.getColumnNumber('System_Variables', 'CCOP')

Returns 13100 on this system.

Example: Table.formatRow()

=Table.formatRow('System_Variables', '2', '<row><entry>', '{1}', '</entry><entry>', '</entry></row>')

Returns <row><entry>EMEA</entry></row> on this system.

=Table.formatRow('$.Countries', '49', '#', '{2}{0}={1}', '|', '#')

Returns #Abbreviation=De|Conversion_Rate=1.0|Name=Germany|Translation=Deutschland#.

=Table.formatRow('$.Countries', '31', '<row><entry>', '{2}{1}', '</entry><entry>', '</entry></row>')

• returns <row><entry>NL</entry><entry>1.0</entry><entry>The Netherlands</entry><entry>Nederland</entry></row>

Example: Table.l()

Example: Table.lookup()

=Table.lookup('PROD', 'CustomTable', 'Identifier10', 'ColumnA')

Returns the value from the table 'CustomTable' (table is in partition 'PROD') from the row with key 'Identifier10', and from that row the value of 'ColumnA'.

=Table.lookup('CustomTable', 'Identifier10', 'ColumnA')

Returns the value from the table 'CustomTable' (table is in partition 'GLOBAL', as partitionName is not specified) from the row with key 'Identifier10', and from that row the value of 'ColumnA'.

UserMessage

Prefix: UserMessage

Example: UserMessage.renderHistoryAsHTML()

=UserMessage.renderHistoryAsHTML(parameters.UserMessage_UniqueId, 'aCssPrefix')

.

Example: UserMessage.renderHistoryAsText()

=UserMessage.renderHistoryAsText(parameters.UserMessage_UniqueId)

.

Variable

Prefix: Variable

Functions for querying the System_Variables table.

Example: Variable.getString()

=Variable.getString(2)

Returns EMEA on this system.

Example: Variable.getNumber()

=Variable.getNumber('CCOP')

Returns 13100 on this system.

Scripting contexts are fields in which scripting with Redwood Expression Language may be used. The implicit objects provided differ between the contexts.

RedwoodExpressionLanguage Implicit Objects

This section lists the implicit objects by category, and what they contain.

The placeholders for the JobChainParameters.getOutValue methods are as follows:

• <jobName> - the name of the job, for example:
  • Step 1, Job 2
  • Extract data, Job 4
• <parameter> - the name of the parameter

Example

The following example returns the Out value of parameter Param1 on Job number 4 of Step Extract data in the Chain.

=JobChainParameters.getOutValueString('Extract data, Job 4', 'Param1')

Partition Placeholder

The $ placeholder is replaced with the partition of the job definition or Chain it is specified on.

Example

The job definition Partition1.JD_Partition is in the partition Partition1, just like the Time Window Partition1.TW_DailyWorkShift. A parameter default expression has REL expression that is referring to this Time Window as $.TW_DailyWorkShift. The Chain Partition2.JC_Partition is in the partition Partition2; if you try to override the parameter with a parameter mapping using the $.TW_DailyWorkShift syntax, the $ will be replaced with Partition2. This means that you must duplicate the Time Window in the partition Partition2 or specify Partition1.TW_DailyWorkShift for this to work.

The advantage of this syntax is that you can safely promote this job definition to another system without having to change the REL expression even if the partition name in the target system differs, provided you promote the referenced object as well.

You must keep objects that refer to each other using this syntax in the same partition and should, ideally, keep them in the same application so you can simply promote the application tree.

Note: The promotion module will not detect references that are using the $ syntax. This means that Export with related objects and Promote with related objects will not export all referenced objects.

Substitution Parameters and REL Contexts

In fields that support REL expressions you can specify the substitution parameters using either REL variables or Ant syntax, the latter inside string literals. Note that the substitution parameters will be replaced <b>after</b> the REL expression has been evaluated; this means that REL will only see the substitution parameter names, not their values.

Example

In the Subject field of an email sent for a Process Server alert, the following expression has been specified:

='Process Server ${processServer} went from ${oldStatus} to ${newStatus} at ' + Time.now()

This will first be evaluated as REL:

Process Server ${processServer} went from ${oldStatus} to ${newStatus} at 12:00:00pm Thursday 27 July 2023

Then the Ant substitutions are applied:

Process Server MSLN_UNIXS3 went from Running to PartiallyRunning at 12:00:00pm Thursday 27 July 2023

This expression can also be specified using REL syntax only:

='Process Server '+processServer+' went from '+oldStatus+' to '+newStatus+' at ' + Time.now()

Since the Ant substitution is performed after the REL expression has been evaluated, the following example will not return UNIXS3 but cessServer} instead:

=String.substring('${processServer}', 5)

RedwoodExpressionLanguage Contexts

This section lists implicit objects.

AdHocAlertSource

Ad Hoc Alert Source (Redwood Expression Language)

AlertGateway

CallSchedulingParameter

ConstraintLOV

Simple Constraint List of Values (Redwood Expression Language)

DefaultParameter

ForecastCallPrecondition

ForecastStepPrecondition

Step Precondition (Redwood Expression Language)

GotoStepEvaluation

JobChainCallPrecondition

JobChainInExpression

Chain Call Parameter Expression (Redwood Expression Language)

JobChainStepPrecondition

Step Precondition (Redwood Expression Language)

JobDefinitionAlertSource

JobDefinitionRuntimeLimit

JobEvent

Return Code Mapping (Redwood Expression Language)

JobSearch

Return Code Mapping (Redwood Expression Language)

MailJob

MonitorAlertSource

MonitorCondition

OSNativeParameter

ProcessMonitorEvaluation

ProcessServerAlertSource

ProcessServerCheckAlertSource

Return Code Mapping (Redwood Expression Language)

ReportColumnEvaluation

ReportPreviewDefaultParameter

ReportSelectionEvaluation

Period Function (RedwoodScript)

ReturnCodeMapping

Return Code Mapping (Redwood Expression Language)

SAPMassActivityParameter

Simple