Functions Quick Reference

The table below lists basic information about each EngageOne™ Enrichment function.

Function Type Description
a2e String Performs ASCII to EBCDIC conversion.
ARRAYSIZE Numeric Returns the number of elements in the array.
CHANGED Logical Returns TRUE if a variable has changed since the last invocation of this function.
CHECKSUM String Calculates a checksum for a specified string.
CLOSE String Closes a file that was previously opened by the READ or WRITE function.
COMPARE Numeric Evaluates characters from two strings to determine if they are the same.
CONVERT String Converts one string from a specified code page to another.
COPIES String Returns a specified number of copies of a string.
DATE String Returns the system date in the specified format.
DAY String Returns the system day (for example, “Monday”) in the specified format.
DECLARE String Declares either a global variable (a variable independent of any document) or an array.
E2A String Performs EBCDIC to ASCII conversion.
EXISTS Logical Tests to see if files exists.
FINDNUM Numeric Returns the integer value of a specified currency amount.
FINDWORD String Locates a specified word within a string.
FINDZIP String Returns the ZIP Code™ from a specified string.
FLOAT String Performs floating point math operations
FORMAT String Returns a currency-formatted string from a specified integer value.
FOUND Logical Returns TRUE if a variable was found in the current document.
FOURSTATE String Returns a string of digits, each digit from 0 to 3, representing the bars in the 4-State bar code, including any start/stop characters and characters for error detection or correction.
FTP File Perform a file transfer of a file to a remote system.
GETFONT String Returns the AFPDS font whose local ID in the MCF record for the page matches the requested font number.
IMB String Returns a string of digits, each digit from 0 to 3, representing the bars in the Intelligent Mail Barcode, including any start/stop characters and characters for error detection or correction.
IMBRANGE String Retrieves a range of consecutive serial numbers from Mail360 Manager for use in constructing Intelligent Mail Barcodes.
INITCAP String Capitalizes the first letter of each blank-delimited word in a string.
JUSTIFY String Left- or right-justifies or centers a specified string.
LENGTH Numeric Returns the length of a specified string.
LOOKUP String Returns a record from a file that contains a specified string at a particular position.
LOOKUPV String Returns a record from a key-sequenced data set (KSDS) VSAM file that contains a specified string as the key. (Mainframe only.)
LOWER String Returns a specified string in lowercase letters.
MATH Numeric Performs mathematical operations in any base from 2 to 50, or convert from one base to another.
MESSAGE Command Writes a user-defined message to the EngageOne™ Enrichment message file.
OVERWRITE String Finds and replaces a string in PTX records without changing the length of the record. This function performs a binary replace; arguments must be in the proper code page.
PATTERN String Returns a substring that matches a specified pattern from a string.
POSITION Numeric Returns the position of a specified substring within a string.
READ String Returns a record from a file.
REVERSE String Returns a specified string in reverse order.
RGET String Returns the value of a portion of a record converted to its numeric value.
RPUT String Returns the modified value of a record after being overlaid with a specified string.
RSQLTABLE Numeric Returns the size of a result set - number of rows.
SPLIT String Parses a string and populates an array variable.
SQL String Updates a database with runtime information generated by EngageOne™ Enrichment.
STRIP String Strips specified characters from a string.
SUBSTR String Returns a specified substring from a string.
SYSTEM Command Execute an operating system command.
TIME String Returns the time (in the specified order and format) that EngageOne™ Enrichment began running the application (current or runtime).
TRANSLATE String Translates the specified characters within a string to specified output.
UPDATE Command Rewrites the most recently matched record in a LOOKUP file.
UPPER String Returns a specified string in uppercase letters.
USERFUNCTION Command Declares a user-written function to EngageOne™ Enrichment.
WORDPOS Numeric Returns the position of a specified word within a string.
WORDS Numeric Returns the number of blank-delimited words in a specified string.
WRITE Command Writes a specified record to a sequential file, deleting the existing contents.
WRITEA Command Appends a record to a specified file.
WRITEEV Command Write, update, or delete a record from a KSDS VSAM file. (Mainframe only.)