You can access any of the following types of functions:
Most supplied functions are available in both WebFOCUS and FOCUS. However, some functions are available only in WebFOCUS. They are:
For details on these functions, see the individual topics.
The following functions perform calculations based on multiple rows in the internal matrix. For details, see Simplified Analytic Functions.
Calculates a simple moving average column.
Calculates a single exponential smoothing column.
Calculates a double exponential smoothing column.
Calculates a triple exponential smoothing column.
Calculates a linear regression column.
Creates rolling calculations.
Retrieves prior or subsequent fields.
Calculates the difference between a value in the current row and a prior row within a partition.
Calculates the percent difference between a value in the current row and a prior row within a partition.
Retrieves a prior value within a partition.
Calculate the average over a group of rows within a partition.
Calculate the minimum over a group of rows within a partition.
Calculate the maximum over a group of rows within a partition.
Calculate the sum over a group of rows within a partition.
The following functions manipulate alphanumeric fields or character strings and have simplified parameter lists. For details, see Simplified Character Functions.
Returns the length, in characters, of a string.
Available Languages: reporting
Converts a number to a character string of the specified length.
Available Languages: reporting
Extracts a token (substring) based on a token number and a string listing acceptable delimiter characters.
Available Languages: reporting
Capitalizes the first letter of every word in a string and makes all other letters lowercase, where a word starts at the beginning of the string, after a blank space, or after a special character.
Available Languages: reporting
retrieves the last field value that is neither blank nor missing. If all previous values are either blank or missing, returns a missing value.
Translates a string to lowercase.
Available Languages: reporting
Left-pads a string with a given character.
Available Languages: reporting
Removes all blanks from the left end of a string.
Available Languages: reporting
Returns a pattern that represents the structure of the source string.
Available Languages: reporting
Returns the first position (in characters) of a substring in a source string.
Available Languages: reporting
Matches a string to a regular expression and returns true (1) or false (0).
Right-pads a string with a given character.
Available Languages: reporting
Removes all blanks from the right end of a string.
Available Languages: reporting
Extracts a substring from a source string.
Available Languages: reporting
Extracts a token (substring) based on a token number and a delimiter string.
Available Languages: reporting
Removes all occurrences of a single character from either the beginning or end of a string, or both.
Available Languages: reporting
Translates a string to uppercase.
Available Languages: reporting
The following functions manipulate alphanumeric fields or character strings. For details, see Character Functions.
Measures the length of a character string within a field, excluding trailing blanks.
Available Languages: reporting, Maintain
Distinguishes between a blank and a zero in Dialogue Manager.
Available Languages: reporting
Evaluates an individual bit within a character string to determine whether it is on or off.
Available Languages: reporting, Maintain
Evaluates a string of bits within a character string and returns its value.
Available Languages: reporting, Maintain
Translates a character to its corresponding ASCII or EBCDIC decimal value.
Available Languages: reporting, Maintain
Checks a character string for incorrect characters or character types.
Available Languages: reporting, Maintain
Translates a character within a character string to another character based on its decimal value.
Available Languages: reporting, Maintain
Centers a character string within a field.
Available Languages: reporting, Maintain
Extracts characters from or adds characters to a character string.
Available Languages: reporting
Divides a character string into substrings, called tokens, where a specific character, called a delimiter, occurs in the string.
Available Languages: reporting, Maintain
Converts the letters in a character string to mixed case.
Available Languages: reporting, Maintain
Converts the letters in a character string to mixed case.
Available Languages: reporting, Maintain
Converts the letters in a character string to mixed case.
Available Languages: reporting, Maintain
Left-justifies a character string within a field.
Available Languages: reporting
Converts alphanumeric text to lowercase.
Available Languages: reporting, Maintain
Overlays a base character string with a substring.
Available Languages: reporting
Divides a line of text into smaller lines by marking them with a delimiter.
Available Languages: reporting, Maintain
Finds the starting position of a substring within a larger string.
Available Languages: reporting
Reverses the characters in a character string.
Available Languages: reporting, Maintain
Right-justifies a character string.
Available Languages: reporting
Searches for a character string phonetically without regard to spelling.
Available Languages: reporting, Maintain
Takes an alphanumeric string or a numeric value with two decimal places and spells it out with dollars and cents.
Available Languages: reporting, Maintain
Reduces multiple contiguous spaces within a character string to a single space.
Available Languages: reporting, Maintain
Removes all occurrences of a specific character from a string.
Available Languages: reporting, Maintain
Replaces all occurrences of a specific character string.
Available Languages: reporting, Maintain
Extracts a substring based on where it begins and its length in the parent string.
Available Languages: reporting
Removes leading and/or trailing occurrences of a pattern within a character string.
Available Languages: reporting
Converts a character string to uppercase.
Available Languages: reporting
The following functions manipulate variable length alphanumeric fields or character strings. For details, see Variable Length Character Functions.
Returns the actual length of an AnV field or the size of an An field.
Available Languages: reporting
Converts alphanumeric text to lowercase in an AnV field.
Available Languages: reporting
Finds the starting position of a substring in an AnV field.
Available Languages: reporting
Extracts a substring based on where it begins and its length in the parent string in an AnV field.
Available Languages: reporting
Removes leading and/or trailing occurrences of a pattern within a character string in an AnV field.
Available Languages: reporting
Converts a character string to uppercase in an AnV field.
Available Languages: reporting
The following functions manipulate character strings for DBCS code pages. For details, see Character Functions for DBCS Code Pages.
Translates a single-byte or double-byte character to another character.
Extracts characters from or adds characters to a string.
Removes a single-byte or double-byte character from a string.
Extracts a substring based on its length and position in the source string.
Converts Japanese specific characters.
The following functions manipulate alphanumeric fields or character strings. They are available only in the Maintain language. For details, see Maintain-specific Character Functions.
Translates an ASCII or EBCDIC character to the integer value it represents, depending on the operating system.
Translates an integer into the equivalent ASCII or EBCDIC character, depending on the operating system.
Converts the letters in a character string to mixed case.
Measures the length of a character string, including trailing blanks.
Left-justifies a character string within a field.
Converts a character string to lowercase.
Extracts characters from or adds characters to a character string.
Divides a character string into substrings, called tokens.
Converts a character from the native English code page to the running code page.
Overlays a base character string with a substring.
Finds the starting position of a substring within a larger string.
Right-justifies a character string.
Decodes a value from a stack.
Substitutes a substring for another substring in a character string.
Compares two alphanumeric strings using the ASCII or EBCDIC collating sequence.
Compares two alphanumeric strings using the ASCII or EBCDIC collating sequence, but ignoring case differences.
Compares a specified number of characters in two character strings starting at the beginning of the strings using the EBCDIC or ASCII collating sequence.
Extracts a substring based on where it begins and its length in the parent string.
Removes trailing occurrences of a pattern within a character string.
Determines the length of a character string excluding trailing spaces.
Converts a character string to uppercase.
The following functions search for data source records, retrieve data source records or values, and assign values. For details, see Data Source and Decoding Functions.
Returns the value of the first non-missing argument.
Available Languages: reporting
Inserts an SQL expression into the SQL generated for a request against a relational data source.
Available Languages: reporting, MODIFY
Compares values in a source file to values in a target file, or if the source file is a relational data source, to values retrieved by a subquery.
Available Languages: reporting, MODIFY
Computes an MD5 hash check value of its input parameter.
Available Languages: reporting
Computes hash sum of its input parameter.
Available Languages: reporting
Retrieves a data value from a lookup data source.
Available Languages: reporting, MODIFY
Assigns values based on the coded value of an input field.
Available Languages: reporting, Maintain
Determines if an incoming data value is in an indexed FOCUS data source field.
Available Languages: reporting
Retrieves the preceding value for a field.
Available Languages: reporting
Retrieves a data value from a cross-referenced FOCUS data source in a MODIFY request.
Available Languages: MODIFY, Maintain
Returns a missing value when its parameters have equal values.
Available Languages: reporting
The following functions manipulate date and date- time values. For details see Simplified Date and Date-Time Functions.
Returns the current date.
Returns the current date and time.
Returns the current time.
Returns a new date after adding the specified number of a supported component
Available Languages: reporting, Maintain
Returns the number of given component boundaries between the two dates.
Available Languages: reporting, Maintain
Extracts time components from a date-time value.
Returns a component value in integer format.
Available Languages: reporting, Maintain
Returns the first date within a period
Available Languages: reporting, Maintain
|
In this section: |
The following functions manipulate dates. For details see Date Functions.
Adds a unit to or subtracts a unit from a date format.
Available Languages: reporting, Maintain
Converts date formats.
Available Languages: reporting, Maintain
Returns the difference between two dates in units.
Available Languages: reporting, Maintain
Moves a date to a significant point on the calendar.
Available Languages: reporting, Maintain
Formats dates in international formats.
Available Languages: reporting, Maintain
Extracts a component from a date field and returns it in numeric format.
Available Languages: reporting, Maintain
Returns the financial year, also known as the fiscal year, corresponding to a given calendar date based on the financial year starting date and the financial year numbering convention.
Available Languages: reporting, Maintain
Returns the financial quarter corresponding to a given calendar date based on the financial year starting date and the financial year numbering convention.
Available Languages: reporting, Maintain
Returns a financial date containing both the financial year and quarter that corresponds to a given calendar date.
Available Languages: reporting, Maintain
Extracts components from a date-time value and moves them to a target date-time field with all other components of the target field preserved.
Available Languages: reporting, Maintain
Retrieves the current date from the system.
Available Languages: reporting, Maintain
Adds or subtracts months from dates that are in year-month format.
Available Languages: reporting, Maintain
Adds or subtracts days from dates that are in year-month-day format.
Available Languages: reporting, Maintain
Rearranges the year, month, and day portions of alphanumeric dates, and converts dates between long and short date formats.
Available Languages: reporting, Maintain
Convert dates to the corresponding number of days elapsed since December 31, 1899.
DADMY converts dates in day-month-year format.
DADYM converts dates in day-year-month format.
DAMDY converts dates in month-day-year format.
DAMYD converts dates in month-year-day format.
DAYDM converts dates in year-day-month format.
DAYMD converts dates in year-month-day format.
Available Languages: reporting, Maintain
Calculate the difference between two dates.
Available Languages: reporting, Maintain
Find the day of the week that corresponds to a date.
Available Languages: reporting, Maintain
Converts the number of days elapsed since December 31, 1899 to the corresponding date.
DTDMY converts numbers to day-month-year dates.
DTDYM converts numbers to day-year-month dates.
DTMDY converts numbers to month-day-year dates.
DTMYD converts numbers to month-year-day dates.
DTYDM converts numbers to year-day-month dates.
DTYMD converts numbers to year-month-day dates.
Available Languages: reporting, Maintain
Converts dates in Julian format to year-month-day format.
Available Languages: reporting, Maintain
Converts dates from year-month-day format to Julian (year-day format).
Available Languages: reporting, Maintain
Calculates the number of months that elapse between two dates. The dates must be in year-month format.
Available Languages: reporting, Maintain
The following functions manipulate date-time values. For details see Date-Time Functions.
Increments a date-time field by a given number of units.
Available Languages: reporting, Maintain
Converts a date-time field to a character string.
Available Languages: reporting, Maintain
Extracts the date portion of a date-time field, converts it to a date format, and returns the result in the format YYMD.
Available Languages: reporting, Maintain
Calculates the number of units between two date-time values.
Available Languages: reporting, Maintain
Converts a date field to a date-time field. The time portion is set to midnight.
Available Languages: reporting, Maintain
Extracts components from a date-time value and moves them to a target date-time field with all other components set to zero.
Available Languages: reporting, Maintain
Stores the current date and time in a date-time field.
Available Languages: reporting, Maintain
Extracts components from a date-time value and moves them to a target date-time field with all other components of the target field preserved.
Available Languages: reporting, Maintain
Retrieves the current time from the system.
Available Languages: reporting
Converts an alphanumeric string to a date-time value.
Available Languages: reporting, Maintain
Changes the time portion of a date-time field to midnight (all zeros).
Available Languages: reporting, Maintain
Extracts a specified component from a date-time field and returns it in alphanumeric format.
Available Languages: reporting, Maintain
Extracts a specified component from a date-time field and returns it in numeric format.
Available Languages: reporting, Maintain
Inserts the numeric value of a specified component into a date-time field.
Available Languages: reporting, Maintain
Converts the time portion of a date-time field to the number of milliseconds or microseconds.
Available Languages: reporting, Maintain
Converts a time to a timestamp.
Available Languages: reporting, Maintain
|
In this section: |
The following functions manipulate dates and times. They are available only in the Maintain language. For details, see Maintain-specific Date and Time Functions.
Retrieves the current time from the system.
Retrieves the time that the Maintain module was started.
Retrieves the date that the Maintain module was started.
Retrieves the current date from the system.
Retrieves the current date from the system.
Adds a given number of days to a date.
Extracts the day of the month from a date.
Determines the number of days that have elapsed so far in the year up to a given date.
Extracts the month from a date.
Determines the quarter of the year in which a date resides.
Sets a value to a date.
Subtracts a given number of days from a date.
Determines the day of the week for a date.
Extracts the year from a date.
The following functions convert fields from one format to another, using streamlined parameter lists. For details, see Simplified Conversion Functions.
Returns a character based on a numeric code.
Converts a numeric value to an alphanumeric value that represents the number in an abbreviated format, using the characters K, M, B, and T to represent the abbreviation.
Available Languages: reporting
Returns a non-printable control character.
Converts a numeric, date, or date-time value to a character string.
Returns the hexadecimal view of an input value.
Returns a phonetic key.
The following functions convert fields from one format to another. For details, see Format Conversion Functions.
Converts a number in alphanumeric format to double-precision format.
Available Languages: reporting, Maintain
Converts an alphanumeric field that contains numeric characters to numeric format or converts a numeric field to alphanumeric format.
Available Languages: reporting
Converts a field to alphanumeric format.
Available Languages: reporting
Converts a number in a numeric format to alphanumeric format.
Available Languages: reporting, Maintain
Obtains the ASCII or EBCDIC character equivalent of a decimal integer value.
Available Languages: reporting, Maintain
Converts a large binary integer in a non-FOCUS data source to double-precision format.
Available Languages: reporting, Maintain
Converts a large binary integer in a non-FOCUS data source to packed-decimal format.
Available Languages: reporting, Maintain
Converts a number in numeric format to zoned format.
Available Languages: reporting, Maintain
Writes a packed number of variable length to an extract file.
Available Languages: reporting, Maintain
Converts a packed decimal number from numeric format to alphanumeric format.
Available Languages: reporting, Maintain
Converts a Microsoft SQL Server or Sybase TIMESTAMP column (which contains an incremented counter) to packed decimal.
Available Languages: reporting
Converts characters in alphanumeric field values to hexadecimal representation.
Available Languages: reporting, Maintain
Stores a packed number with up to 31 significant digits in an alphanumeric field, retaining decimal data.
The following functions retrieve WebFOCUS variable or parameter data implicitly from within a Maintain procedure. These functions are available only in Maintain Data. For details, see Maintain-specific Light Update Support Functions.
Imports the value of a WebFOCUS parameter or variable into a Maintain Data variable.
Retrieves WebFOCUS parameter or variable values.
The following functions perform calculations on numeric constants or fields, using streamlined parameter lists. For details, see Simplified Numeric Functions.
Returns the smallest integer value greater than or equal to a value.
Raises e to a power.
Returns the largest integer value less than or equal to a value.
Calculates the remainder from a division.
Raises a value to a power.
The following functions perform calculations on numeric constants or fields. For details, see Numeric Functions.
Returns the absolute value of a number.
Available Languages: reporting, Maintain
Distinguishes between a blank and a zero in Dialogue Manager.
Available Languages: reporting
Produces a horizontal bar chart.
Available Languages: reporting, Maintain
Validates the data in a field described as packed format.
Available Languages: reporting, Maintain
Calculate the remainder from a division.
Available Languages: reporting, Maintain
Raises the number "e" to a specified power.
Available Languages: reporting, Maintain
Is an operator that evaluates a number expressed in scientific notation. For information, see Using Expressions in the Creating Reports With TIBCO WebFOCUS® Language manual.
Returns the FOR value associated with each row in an FML report.
Available Languages: reporting
Returns a string containing the complete tag list for each row in an FML request.
Available Languages: reporting
Retrieves the tag value associated with each row in an FML request.
Available Languages: reporting
Returns the caption value for each row in an FML hierarchy request.
Available Languages: reporting
Returns the integer component of a number.
Available Languages: reporting, Maintain
Returns the natural logarithm of a number.
Available Languages: reporting, Maintain
Return the maximum or minimum value, respectively, from a list of values.
Available Languages: reporting, Maintain
Calculates the modified internal rate of return for a series of periodic cash flows.
Available Languages: reporting
Perform calculations on a standard normal distribution curve.
Available Languages: reporting
Generate reproducible random numbers.
Available Languages: reporting, Maintain
Generate random numbers.
Available Languages: reporting, Maintain
Calculates the square root of a number.
Available Languages: reporting, Maintain
Calculates the internal rate of return for a series of cash flows that can be periodic or non-periodic.
Available Languages: reporting
Script functions integrate JavaScript and VBScripts into your Maintain Data applications and perform client-side execution without returning to the WebFOCUS® Reporting Server. These functions are available only in Maintain Data. For details, see Maintain-specific Script Functions.
Executes external procedures.
Turns the Secure Sockets layer on and off, respectively.
Returns control from the script to your application.
The following functions perform statistical functions. For details, see Simplified Statistical Functions.
Calculates the degree of correlation between two independent sets of data.
Partitions observations into clusters based on the nearest mean value.
Calculates a linear regression column based on multiple fields.
Runs an R script.
Calculates the standard deviation in a set of data values.
The following functions call the operating system to obtain information about the operating environment or to use a system service, using streamlined parameter lists. For details, see Simplified System Functions.
Inserts a custom message in the EDAPRINT log file.
The following functions call the operating system to obtain information about the operating environment or to use a system service. For details, see System Functions.
Closes a file and frees the memory used to store information about open files.
Available Languages: reporting, Maintain
Retrieves a WebFOCUS error message.
Available Languages: reporting, Maintain
Determines if a specific member of a partitioned data set (PDS) exists in batch processing.
Available Operating Systems: z/OS
Available Languages: reporting, Maintain
Retrieves the value of a browser cookie.
Available Languages: reporting, Maintain
Retrieves the value of an HTTP Header variable.
Available Languages: reporting, Maintain
Determines if a specific member of a partitioned data set (PDS) exists, and if it does, returns the PDS name.
Available Operating Systems: z/OS
Available Languages: reporting, Maintain
Retrieves the ID of the connected user.
Available Languages: reporting, Maintain
Transfers a FOCUS DYNAM command to the DYNAM command processor.
Available Operating Systems: z/OS
Available Languages: reporting, Maintain
Submits a value to a browser cookie.
Available Languages: reporting, Maintain
Writes a character string as a record in a sequential file. Opens the file if it is closed.
Available Languages: reporting, Maintain
Suspends execution for a specified number of seconds.
Available Languages: reporting
Spawns a child process to execute system commands without terminating the current procedure. After the child process terminates, control returns to the parent process. This function is available only for WebFOCUS.
Available Operating Systems: UNIX
Available Languages: reporting
Calls a DOS program, a DOS batch program, or a Windows application. This function is available only for WebFOCUS.
Available Operating Systems: Windows
Available Languages: reporting
Retrieves the value of a z/OS system variable.
Available Operating Systems: z/OS
Available Languages: reporting
These functions perform location-based calculations and retrieve geocoded points for various types of location data. For details, see Simplified Geography Functions.
Calculates the distance between geography points.
Calculates the driving directions between geography points.
Builds a geometry point.
Geocodes a complete address.
Geocodes an address line, city, and state.
Geocodes an address line and postal code.
Builds a JSON geometry object.
Determines whether a point is in a complex polygon.
Builds a JSON line.
Given a longitude, latitude, and component name, returns the applicable geographic component.
Calculates a geometry area around a given point.
Calculates a geometry area around a given coordinate.
The trigonometric functions provide trigonometric calculations, inverse trigonometric calculations, and angle conversion functions. For details, see Trigonometric Functions.
Given the cosine of an angle in radians, ACOS (arccosine) returns an angle between 0 (zero) and pi radians.
Given the sine of an angle in radians, ASIN (arcsine) returns an angle between -(pi/2) and pi/2 radians.
Given the tangent of an angle in radians, ATAN (arctangent) returns an angle between -(pi/2) and pi/2 radians.
Given the coordinates of the tangent of an angle in radians, ATAN2 (arctangent2) returns an angle between -pi and pi radians.
Given an angle in radians, COS calculates the cosine of the angle.
Given an angle in radians, COT calculates the cotangent of the angle.
Converts an angle in radians to an angle in degrees.
Returns the constant pi as a floating-point number.
Converts an angle in degrees to an angle in radians.
Given an angle in radians, SIN calculates the sine of the angle.
Given an angle in radians, TAN calculates the tangent of the angle.