Internal Functions

Resource Governor provides functions that are designed to assist with application development using Custom rules. These include String Functions, Date Functions, File Functions, and Current Request Functions. These functions are described below, along with variables and syntax examples. The ACTIVATE command can be executed directly from any Business rules file.

The following table lists and describes internal functions executable as ACTIVATE routines in the rules.

%CLOSE

%COLUMNS

%CONCAT

%COPY

%DATE

%DELETE

%DISTINCT

%DOW

%DYNAM

%FILEDEF

%FTOA

%FUNCOLS

%FUNCTION

%GET

%GROUPBY

&INSERT

%LEFTREL

%LENGTH

%LOCATE

%LOWCASE

%MONTH

%ORDERBY

%ORNOTERR

%OVERLAY

%PAD

%PUT

%RELATION

%RELCNT

%RELOPCOL

%RELOPS

%RELTABS

%REQUEST

%RIGHTREL

%SUBSTR

%TABLES

%TIME

%TRIM

%TRUNC

%UPCASE

Note: All function names begin with a percent (%) sign and must be entered in uppercase.

Syntax:

ACTIVATE function_name DATA parm 1
ACTIVATE function_name
DATA parm 1
DATA parm 2
.
.
.
DATA parm n

where:

function_name

Is any valid internal function name.

Parameters passed to and received from functions are identified through the DATA statement(s) as shown in the example below,

parm n

Represents the parameters being passed to function_name using the DATA statement.

Note: The ACTIVATE and DATA keywords must always be entered in uppercase.

Examples in the following function descriptions are based on this sample TABLE request:

JOIN INDEX1 IN TABLE1 TO ALL INDEX2 IN TABLE2
END
TABLE FILE TABLE1
SUM AVE.COLUMN4 MAX.COLUMN5
BY COLUMN1
BY COLUMN2
WHERE COLUMN3 GT '20101231'
END

Note: TABLE1 contains columns 1 and 3. TABLE2 contains columns 2,4 and 5.

The %CLOSE function closes a file defined with DYNAM or FILEDEF.

Syntax:

ACTIVATE %CLOSE
DATA (input string variable)

Example:

The %COLUMNS function returns all the column names specified in the request.

Syntax:

ACTIVATE %COLUMNS
DATA Column name IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Column name IS TABLE1.COLUMN1
Column name IS TABLE2.COLUMN2

The %CONCAT function concatenates two strings into a resultant string value.

Syntax:

ACTIVATE %CONCAT
DATA (input/output string variable)
DATA (input string variable)

Example:

The %COPY function makes a copy of a file.

Syntax:

ACTIVATE %COPY
DATA (output numeric variable)

Example:

RULE Copy file
ACTIVATE %COPY
DATA ioresult

This function will copy a file allocated as SYSUT1 to a file allocates as SYSUT2 using %DYNAM or %FILEDEF. Using the example above, if ioresult numeric variable is not a zero then the copy failed.

The %DATE function converts month, day, and year (numeric values) to an nn/nn/nn formatted string.

Syntax:

ACTIVATE %DATE
DATA (output string variable)
DATA (input numeric variable)
DATA (input numeric variable)
DATA (input numeric variable)

Example:

RULE make a date
ACTIVATE %DATE
DATA Message1
DATA Message2
DATA Message3

Given the month, day, and year (numeric values), the syntax example updates Extra String with a formatted string mm/dd/yy, dd/mm/yy, or yy/mm/dd.

The order of the DATA statements can be changed if a different date format is required. For example, if the required format was dd/mm/yy, then day would be on the first DATA statement and month on the second.

The %DELETE function deletes characters between starting and ending positions inclusively.

Syntax:

ACTIVATE %DELETE
DATA (input/output string variable)
DATA (input string variable)
DATA (input string variable)

Example:

RULE Delete characters
ACTIVATE %DELETE
DATA Extra String
DATA Start Pos
DATA End Pos 

The syntax example deletes all characters in Extra String between the specified Start Pos and End Pos, inclusively.

The %DISTINCT function returns true if DISTINCT is specified in the SELECT clause; otherwise, it returns false.

Syntax:

ACTIVATE %DISTINCT
DATA Distinct columns

Example:

Based on the sample request, the SIMPLEFACT Distinct columns are false. Distinct columns would be true if the sample had been:

PRINT DST.COLUMN1 ...

The %DOW function creates a day string value from a numeric indicator. The Day of Week NUMERIC value passed into business rules is a number from 0 through 6, Sunday through Saturday.

Syntax:

ACTIVATE %DOW
DATA (input numeric variable)
DATA (output string variable)

Example:

The %DYNAM function is used to manipulate files in PDS deployment.

Syntax:

ACTIVATE %DYNAM
DATA (input string variable)
DATA (input string variable)

Example:

The %FILEDEF function is equivalent to using the %DYNAM command and uses the FILEDEF system command for reserving, deleting, or modifying files on systems other than PDS deployment.

Syntax:

ACTIVATE %FILEDEF
DATA (input string variable)
DATA (input string variable)

Example:

The %FTOA function converts a NUMERIC fact value to a STRING.

Syntax:

ACTIVATE %FTOA
DATA (output string variable) 
DATA (input string variable)           !Format String 
DATA (input numeric variable)

Example:

The %FUNCOLS function returns all the functions with column names specified in the request.

Syntax:

ACTIVATE %FUNCOLS
DATA Function column IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Function column IS AVG.TABLE2.COLUMN4
Function column IS MAX.TABLE2.COLUMN5

The %FUNCTION function returns all the function names specified in the request.

Syntax:

ACTIVATE %FUNCTION
DATA Function name IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Function name IS AVG
Function name IS MAX

The %GET function reads a line from a file defined with DYNAM or FILEDEF.

Syntax:

ACTIVATE %GET
DATA (input string variable)
DATA (output string variable)
DATA (output numeric variable)

Example:

The %GROUPBY function returns all the column names specified in the GROUP BY clause.

Syntax:

ACTIVATE %GROUPBY
DATA Group by column IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Group by column IS TABLE1.COLUMN1
Group by column IS TABLE2.COLUMN2

The %INSERT function inserts characters between starting and ending positions inclusively.

Syntax:

ACTIVATE %INSERT
DATA (input/output string variable)
DATA (input string variable)
DATA (input numeric variable)

Example:

RULE Insert characters
ACTIVATE %INSERT
DATA Extra String
DATA Extra String 1
DATA Start Pos 

The syntax example inserts characters in Extra String1 into Extra String at the position specified in Start Pos.

The %LEFTREL function returns the left-hand side of the relational condition as specified in the WHERE clause.

Syntax:

ACTIVATE %LEFTREL
DATA Left relational column IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Left relational column IS TABLE1.INDEX1
Left relational column IS TABLE1.COLUMN3

The %LENGTH function returns the length of a string value.

Syntax:

ACTIVATE %LENGTH
DATA (output numeric variable)
DATA (input string variable)

Example:

The %LOCATE function locates the existence of a string within a string value and returns the position.

Syntax:

ACTIVATE %LOCATE
DATA (input string variable)
DATA (input string variable)
DATA (output numeric variable)

Example:

The %LOWCASE function sets a string value to lower case.

Syntax:

ACTIVATE %LOWCASE
DATA (input/output string variable)

Example:

The %MONTH function creates a month string value from a numeric indicator 0 through 12, January through December.

Syntax:

ACTIVATE %MONTH
DATA (input numeric value)
DATA (output string value)

Example:

The %ORDERBY function returns all the column names specified in the ORDER BY clause.

Syntax:

ACTIVATE %ORDERBY
DATA Order by column IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Order by column IS TABLE1.COLUMN1
Order by column IS TABLE2.COLUMN2

The %ORNOTERR function returns true if a faulty OR/NOT condition is specified in a WHERE clause.

Syntax:

ACTIVATE %ORNOTERR
DATA Bad or not condition

Example:

Based on the sample request, the SIMPLEFACT Bad or not condition are false. If the sample had been:

TABLE FILE TABLE
PRINT COLUMN1
WHERE COLUMN9 NE 'RED' OR 'BLUE'
END

Then, when COLUMN9 is RED, it is not BLUE, so the OR makes the condition true; and when COLUMN9 is BLUE, it is not RED, so the OR still makes the condition true; and when COLUMN9 is neither RED nor BLUE, the condition is still true. The effect is the same as coding PRINT COLUMN1 without a WHERE clause.

In this case, the Bad or not condition is true.

The %OVERLAY function overlays one string with another at a specified position.

Syntax:

ACTIVATE %OVERLAY
DATA (input/output string variable)
DATA (input string variable)
DATA (input numeric variable)

Example:

RULE Overlay a string
ACTIVATE %OVERLAY
DATA Extra String
DATA Extra String 1
DATA Start Pos

The syntax example overlays Extra String with Extra String 1 at position Start Pos for the length of Extra String 1.. The starting position is relative to 1, for example, the first position in the string that can be overlaid is position = 1.

The %PAD function Pads a given string with a given character to a specified length.

Syntax:

ACTIVATE %PAD
DATA (input/output string variable)
DATA (input string variable)
DATA (input numeric variable)
DATA (defined string variable)

Example:

RULE Pad string
Extra String 1 := "x"
Extra Number = 3
ACTIVATE %PAD
DATA Extra String
DATA Extra String 1
DATA Extra Number
DATA right

The syntax example pads Extra String with the character in Extra String 1 for a total of Extra Number characters.

The forth DATA statement must be one of the system defined string variables:

left     will trim characters from the left side of the string.
right    will trim characters from the right side of the string.
both     will trim characters from both the left and right sides of the string.

The %PUT function writes a record to a file defined with DYNAM or FILEDEF.

Syntax:

ACTIVATE %PUT
DATA (input string variable)
DATA (input string variable)
DATA (output numeric variable)

Example:

The %RELATION function returns all the relational statements specified in the WHERE clause.

Syntax:

ACTIVATE %RELATION
DATA Relational statement IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Relational statement IS TABLE1.INDEX1.EQ.TABLE2.INDEX2
Relational statement IS TABLE1.COLUMN3.GT.19951231

The %RELCNT function returns the number of times a column name is used in a relational clause.

Syntax:

ACTIVATE %RELCNT
DATA (input string variable)
DATA (output numeric variable)

Example:

The %RELOPCOL function returns all the relational column/operator combinations and determines whether they compare against a literal or a field as specified in the WHERE clause.

Syntax:

ACTIVATE %RELOPCOL
DATA Relational IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Relational IS TABLE1.INDEX1.EQ.FIELD
Relational IS TABLE1.COLUMN3.GT.LITERAL

The %RELOPS function returns all the relational operators and determines whether they compare against a literal or a field as specified in the WHERE clause.

Syntax:

ACTIVATE %RELOPS
DATA Relational operator IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Relational operator IS EQ.FIELD
Relational operator IS GT.LITERAL

The %RELTABS function returns all the relational conditions between tables as specified in the WHERE clause.

Syntax:

ACTIVATE %RELTABS
DATA Table relations ARE WHAT

Example:

Based on the sample request, the following attribute-value pair are true:

Relational statement IS TABLE1.EQ.TABLE2

The %REQUEST function writes the current command request being processed to a file.

Syntax:

ACTIVATE %REQUEST
DATA (input string variable)

Example:

The %RIGHTREL function returns the right-hand side of the relational condition when it references a field as specified in the WHERE clause.

Syntax:

ACTIVATE %RIGHTREL
DATA Right relational column IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Right relational column IS TABLE2.INDEX2

The %SUBSTR function picks out a section of a string value with starting and ending numeric positions and puts that section into a resultant string value.

Syntax:

ACTIVATE %SUBSTR
DATA (input string variable)
DATA (Output string variable)
DATA (Start position)
DATA (End position)

The %TABLES function returns all the table names specified in the FROM clause.

Syntax:

ACTIVATE %TABLES
DATA Table IS WHAT

Example:

Based on the sample request, the following attribute-value pairs are true:

Table IS TABLE1
Table IS TABLE2

The %TIME function creates a formatted time string value of xx:yy, where xx or yy can be any character values chosen. For example, Message1 and 2 may have been initialized using %SUBSTR from Day of Week.

Syntax:

ACTIVATE %TIME
DATA (output string variable)
DATA (input string variable)
DATA (input string variable)

Example:

The %TRIM function trims blanks from the beginning, end, or both from a string value.

Syntax:

ACTIVATE %TRIM
DATA (input/output string variable)
DATA (defined string variable) 

Example:

The %TRUNC function truncates a string at the desired position.

Syntax:

ACTIVATE %TRUNC
DATA (input/output string variable)
DATA (input numeric variable)

Example:

The %UPCASE function sets a string value to upper case.

Syntax:

ACTIVATE %UPCASE
DATA (input/output string variable)

Example: