Alphabetized Functions for Integrator

The Data Integrator language has close to 100 different functions. This section presents an alphabetized list with a cross-reference to the topic that describes the function in detail. Most Integrator functions are available to the classic Model Builder. Many are also available in ProDiver.

TIP: Integrator and Spectre have many of the same functions, but the syntax and usage can be different.

Function Description Function Type
abs
Compute the absolute value of a given numeric expression. Numeric Functions
add
Return the sum of two numbers. Numeric Functions
age
Return the age of a person with a specified birth date on a specified day. Date Functions
and
Return, when used with IF, the logical AND of all the Boolean expressions. Logical Functions
arccos
Return the standard trigonometric arc cosine of a number. Trigonometric Functions
arcsin
Return the standard trigonometric arc sine of a number. Trigonometric Functions
arctan
Return the standard trigonometric arc tangent of a number. Trigonometric Functions
ascii
Return the integer value of the first character in the specified string. String Functions
binary
Given a non-negative integer number, return a binary representation of the number. Conversion Functions
capitalize
Capitalize the first letter of every word or token in the string to uppercase, and change the remaining characters in each word to lowercase. String Functions
ceil
Return the closest integer equal to or greater than the given number. Numeric Functions
chr
Return a single-character string with the character represented by the number value in the current character set (ASCII or EBCDIC). String Functions
concat
Concatenate strings together. String Functions
cos
Return the standard trigonometric cosine of an angle. Trigonometric Functions
date_offset
Perform an arithmetic function on a date by adding or subtracting a number of days or periods. Date Functions
datevalue/date_value
Accept a date, in the ISO or DI standard date format, and return the number of days since December 30, 1899. Date Functions
day
Return the two digit day portion of date. Date Functions
day_name
Return the day of the week for the given date, in the specified language. Date Functions
decimal
Given a string representing a non-negative integer in a specified base (from 2 through 16), convert it into a decimal number. Conversion Functions
div
Return the quotient of two numbers. Numeric Functions
elapsed_time
Return the elapsed time between two dates and times. Time Functions
equals
Compare two strings and return one or zero. String Functions
equals_ignore_case
Works like the equals function, except that the string comparison is not case-sensitive. String Functions
exp
Return the exponential, X raised to the Y power. Numeric Functions
floor
Return the closest integer equal to or less than the given number. Numeric Functions
format_date
Take a date and format string and return the same date in DI’s standard date format, YYYY/MM/DD. Date Functions
format_date_range
Accept two-digit years more flexibly than format_date and returns the same date in DI’s standard date format, YYYY/MM/DD. Date Functions
format_date_value
Put a calculated datevalue back into the standard DI date format. Date Functions
format_time
Formats the string timestring according to the given format and returns a standard time string in the format of HH:MM:SS. Time Functions
hex
Given a non-negative integer number, return a hexadecimal representation of the number. Conversion Functions
hours
Return the number of hours in a standard time string. Time Functions
if
Select between two expressions based on a condition. Logical Functions
index
Return the starting position of a string within another string. String Functions
insert_decimal
Insert a decimal point into the specified number. Numeric Functions
julian_day
Return the number representing the day of the year for the specified date. Date Functions
kilometers
Return the distance, in kilometers, between two latitude-longitude pairs. Miscellaneous Functions
length
Determine the length of the specified string. String Functions
ln
Return the Natural Logarithm (base e) of a number. Numeric Functions
log10
Return Log base 10 of a number. Numeric Functions
lower
Return the string with all uppercase characters converted to lowercase. String Functions
lpad
Pad the beginning of the specified string with the specified characters until the result is the specified length. String Functions
ltrim
Return the string stripped of characters from the beginning of the string. String Functions
map_filename
Change special characters to underscores (_). String Functions
match
Check whether a string appears in a set of other strings, and return a positive number based on which string it matches. String Functions
max
Return the maximum numeric value of its arguments. Numeric Functions
meditech_date
Return the date for a Meditech time expressed in 9 digit format. Date Functions
meditech_time
Return the time for a Meditech time expressed in 9 digit format. Time Functions
miles
Return the distance, in miles, between two latitude-longitude pairs. Miscellaneous Functions
min
Return the minimum numeric value of its arguments. Numeric Functions
minutes
Return, as a number, the number of minutes in a standard time string. Time Functions
mod
Return the remainder when dividing a numerator by a denominator. Numeric Functions
month
Return the two-digit month portion of the specified date. Date Functions
month_name
Return the month name of the given date. Date Functions
month_offset
Perform an arithmetic function on a month, by adding or subtracting a number of months. Date Functions
mul
Returns the product of two numbers. Numeric Functions
not
When used with IF, return the logical NOT of the Boolean expression. Logical Functions
now
Return the current time in a standard time string, HH:MM:SS. Time Functions
octal
Given a non-negative integer, return an octal representation of the number. Conversion Functions
or
When used with IF, return the logical OR of the Boolean expressions. Logical Functions
platform
Return the platform that the program is running on. Miscellaneous Functions
quarter
Return the one-digit calendar quarter in which the specified date occurs. Date Functions
rand
Return a random number between 0 and 1 with six decimal places. Numeric Functions
randbetween
Return a random integer between a low and high value, inclusive. Numeric Functions
regexp
Perform a search of a string based on a regular expression and return a Boolean. String Functions
regexp_value
Perform a search of a string based on a regular expression and return a string. String Functions
replace
Replace every occurrence of a string within another string. String Functions
reverse
Return the reversed contents of the string. String Functions
round
Round the number to the nearest integer or other rounding unit, if specified. Numeric Functions
row_num
Return the current row number of the data file. Miscellaneous Functions
rpad
Pad the end of the specified string with the specified characters until the result is the specified length. String Functions
rtrim
Return the string stripped of characters from the end of the string. String Functions
scan
Parse the string into separate segments based on the specified delimiters. String Functions
seconds
Return the number of seconds in a standard time string. Time Functions
sign
Accept a number and return 1 for positive, -1 for negative, and 0 for zero. Numeric Functions
sin
Return the standard trigonometric sine of an angle. Trigonometric Functions
sqrt
Return the standard square root of the specified number. Numeric Functions
string
Treat a column containing numeric values as if it contained string values. String Functions
sub
Return the difference between two numbers. Numeric Functions
subplatform
Identify the system in more detail than the platform function. Miscellaneous Functions
substr
Separate a portion of a string from the entire string. String Functions
tan
Return the standard trigonometric tangent of an angle. Trigonometric Functions
time_add
Add two standard time strings in the format HH:MM:SS together and return a standard time string. Time Functions
time_sub
Subtract two standard time strings in the format HH:MM:SS and return a standard time string. Time Functions
timevalue/time_value
Convert a standard time string into a number of seconds. Time Functions
today
Return the current date in standard date format (YYYY/MM/DD). Date Functions
translate
Translate characters in a string that appear in a source list with the character in the same position in a destination list. String Functions
trunc
Return the expression as an integer, ignoring any non-integer component of the number. Numeric Functions
underpunch
Convert the numeric data generated by a Cobol program to ASCII. Miscellaneous Functions
upper
Return the string with all case characters converted to uppercase. String Functions
week_date
Return the ISO 8601 week date representation for the given date. Date Functions
weekday
Return the day of the week for the given date, with the numbering based on a given standard. Date Functions
year
Return the four-digit year portion of the specified date. Date Functions