advertisement

ORA supports transform functions where you can change a value before inserting it in the output. For general information about transforms, see the Text Templates page.

The transforms are categorized as follows:

Date Transforms

The transforms listed below manipulate date values.

For general information about the date transforms, see the Date Transforms page.

Transform Description
date Formats a date
dateAdd Adds days, months, or years to a date
dateDay Returns the day part of a date, a number from 1 to 31
dateGtoJ Converts a Gregorian date to a Julian date
dateJtoG Converts a Julian date to a Gregorian date
dateJNYD Specifies the Julian New Year's Day for subsequent conversions
dateModifier Returns the modifier word from a date, such as "bef", "circa", etc.
dateMonth Returns the month part of a date, a number from 1 to 12
dateMonthAbbr Returns the month part of a date converted to an abbreviated name, "Jan", "Feb", etc.
dateMonthName Returns the month part of a date converted to a name, "January", "February", etc.
dateYear Returns the year part of a date with an optional argument to add or substract years
dateSubtract Subtracts days, months, or years from a date
dayOfWeek Returns the day of the week for a Gregorian date

Letter Case Transforms

The transforms listed below modify letter casing.

For general information about the letter case transforms, see the Letter Case Transforms page.

Transform Description
capitalize Changes the first letter of words in the value to uppercase, and the remaining letters in the words to lowercase
initialCapital Changes the first letter of the first word in the value to uppercase, and the remaining letters in the value to lowercase
lowercase Changes the letters in the value to lowercase
uppercase Changes the letters in the value to uppercase

Name Transforms

The transforms listed below manipulate name values.

For general information about the name transforms, see the Name Transforms page.

Transform Description
namePrefix Returns returns the name prefix, such as "Mr." in "Mr. John F. Reilly, Jr."
namePrefixRaw Returns returns the name prefix, such as "Mr." in "Mr. John F. Reilly, Jr.", prior to any standardization by ORA
nameGiven Returns returns the given name, such as "John F." in "Mr. John F. Reilly, Jr."
nameGivenRaw Returns returns the given name, such as "John F." in "Mr. John F. Reilly, Jr.", prior to any standardization by ORA
nameSurname Returns returns the given name, such as "John F." in "Mr. John F. Reilly, Jr."
nameSurnameRaw Returns returns the given name, such as "John F." in "Mr. John F. Reilly, Jr.", prior to any standardization by ORA
nameSuffix Returns returns the name suffix, such as "Jr." in "Mr. John F. Reilly, Jr."
nameSuffixRaw Returns returns the name suffix, such as "Jr." in "Mr. John F. Reilly, Jr.", prior to any standardization by ORA
nameToGivenFirst Converts a name in surname-first format to given-name-first format

Place Transforms

The transforms listed below manipulate place values using conventions for places based on a locale value.

For general information about the place transforms, see the Place Transforms page.

Place Part Value Transforms
Transform Description
placeDetail returns the detail (street address, etc.) from a place value
placeCity Returns the city, town, or village from a place value
placeCounty Returns the county or district (smaller than state) from a place value
placeDistrict An alias for placeCounty
placeState Returns the state or province from a place value
placeProvince An alias for placeState
placeCountry Returns the country from a place value
placePostalCode Returns the postal code from a place value
Place Part Information Transforms
Transform Description
placeHasDetail Returns true if the given place has a detail component
placeHasCity Returns true if the given place has a city component
placeHasCounty Returns true if the given place has a county (AKA district) component
placeHasDistrict Returns true if the given place has a district (AKA county) component
placeHasState Returns true if the given place has a state (AKA province) component
placeHasProvince Returns true if the given place has a province (AKA state) component
placeHasCountry Returns true if the given place has a country component
placeHasPostalCode Returns true if the given place has a postal code component
Place Locale Information Transform
Transform Description
placeLocale Returns the locale used by ORA when parsing a place

Table Lookup Transforms

The transforms listed below convert one value to another by using the input value as a key to find the output value in a lookup table.

For general information about the table lookup transforms, see the Table Lookup Transforms page.

Transform Description
abbr Converts the input value to an abbreviation using a lookup table
abbrSplit Splits the input field into substrings and searches for a substring it can convert to an abbreviation using a lookup table
full Converts the input value from an abbreviation a full value using a lookup table<
fullSplit Splits the input field into substrings and searches for a substring it can convert from an abbreviation to a full using a lookup table
lookup Converts the input value from its initial value to a replacement value using a lookup table<
lookupSplit Splits the input field into substrings and searches for a substring it can convert from its initial value to a replacement value using a lookup table

Text Transforms

The transforms listed below manipulate text values.

For general information about the text transforms, see the Text Transforms page.

Transform Description
append Returns the input value with append's parameter concatenated as a suffix
extract Extracts a substring from the value using a Regular Expression pattern to identify the substring
extractIndex Extracts a substring from the value using a Regular Expression pattern to identify the substring. The pattern may match the value multiple times, and if so, you may specify an index number to indicate which matching value you want to extract
numberToWords Converts the field value from digits ("17") to words ("seventeen")
padLeft Pads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the left (start) of the current string
padRight Pads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied to the right (end) of the current string
plural Returns one of three text values based on the numeric value of the field value
prepend Returns the input value with prepend's parameter concatenated as a prefix
replace Replaces text that matches either a Regular Expression pattern or a literal value with new text
split Splits the field value into parts using the separator to divide the parts and returns the part indicated by the index number
splitCount Splits the field value into parts using the separator to divide the parts and returns the number of parts
substring Extracts a subset of characters from a value
urlParameter Returns the input value encoded for use in a URL
On This Page