Returns the datetime resulting from adding integer_exp days to timestamp_exp.
_add_days(timestamp_exp, integer_exp)
Returns the datetime resulting from adding integer_exp months to timestamp_exp.
_add_months(timestamp_exp, integer_exp)
Returns the datetime resulting from adding integer_exp years to timestamp_exp.
_add_years(timestamp_exp, integer_exp)
Returns a number that is obtained from subtracting timestamp_exp from today's date in YYYYMMDD format (years, months, days).
_age(timestamp_exp)
Returns the day of week (between 1 and 7), where 1 is the first day of the week as indicated by integer_exp (between 1 and 7, 1 being Monday and 7 being Sunday). Note that in ISO 8601 standard, a week begins with Monday being day 1. In North America where Sunday is the first day of the week being day 7.
_day_of_week(timestamp_exp, integer_exp)
_day_of_week(2003-01-01, 1) will return 3 because 2003-01-01 was a Wednesday.
Result: 3
Returns the ordinal for the day of the year in date_ exp (1 to 366). Also known as Julian day.
_day_of_year(timestamp_exp)
Returns a positive or negative number representing the number of days between the two datetime expressions. If timestamp_exp1 < timestamp_exp2 then the result will be a negative number.
_days_between(timestamp_exp1, timestamp_exp2)
Returns a number representing the number of days remaining in the month represented by the datetime expression timestamp_exp.
_days_to_end_of_month(timestamp_exp)
Returns a datetime that is the first day of the month represented by timestamp_exp.
_first_of_month(timestamp_exp)
Returns a datetime that is the last day of the month represented by timestamp_exp.
_last_of_month(timestamp_exp)
Returns a timestamp constructed from integer_exp1 (the year), integer_exp2 (the month) and integer_exp3 (the day). The time portion defaults to 00:00:00.000 .
_make_timestamp(integer_exp1, integer_exp2, integer_exp3)
Returns a positive or negative number representing the number of months between the two datetime expressions. If timestamp_exp1 < timestamp_exp2 then the result will be a negative number.
_months_between(timestamp_exp1, timestamp_exp2)
Returns the number of the week of the year of the timestamp_exp according to the ISO 8601, in which week 1 of the year is the first week of the year to contain a Thursday, which is equivalent to the first week containing January 4th. A week starts on Monday (day1) and ends on Sunday (day7).
_week_of_year(timestamp_exp)
Returns a positive or negative integer number representing the number of years from timestamp_exp1 to timestamp_exp2. If timestamp_exp1 < timestamp_exp2 then a negative value is returned.
_years_between(timestamp_exp1, timestamp_exp2)
Returns a number representing the difference between the datetime expressions timestamp_exp1 and timestamp_exp2. This value has the form YYYYMMDD, where YYYY represents the number of years, MM represents the number of months, and DD represents the number of days.
_ymdint_between(timestamp_exp1, timestamp_exp2)
Returns the absolute value of numeric_exp. The sign of negative values is changed to positive.
abs(numeric_exp)
Returns the date value of the As Of Time expression, if it is defined. Otherwise, AsOfDate returns the report execution date.
AsOfDate()
Returns the time value of the As Of Time expression, if it is defined. Otherwise, AsOfTime returns the report execution time.
AsOfTime()
Returns burst key.
BurstKey()
Returns the distribution list of burst recipients.
BurstRecipients()
Returns the smallest integer greater than or equal to numeric_exp.
ceiling(numeric_exp)
Returns the value of the current crosstab cell.
CellValue()
Returns the number of characters in string_exp.
character_length(string_exp)
Returns the current column number.
ColumnNumber()
Returns the date and time when the cube was created. The dimension parameter specifies from which cube to retrieve the metadata. If the dimension source is a Cognos PowerCube (.mdc), the function returns a blank string. The initial creation date of a PowerCube is not maintained.
CubeCreatedOn(dimension)
Returns the current period for the cube. The dimension parameter specifies from which cube to retrieve the metadata.
CubeCurrentPeriod(dimension)
Returns the date time that data in the cube was last updated. The dimension parameter specifies from which cube to retrieve the metadata.
CubeDataUpdatedOn(dimension)
Returns the name of the default measure for the cube. The dimension parameter specifies from which cube to retrieve the metadata.
CubeDefaultMeasure(dimension)
Returns the description of the cube. The dimension parameter specifies from which cube to retrieve the metadata.
CubeDescription(dimension)
Returns true if the cube is optimized. The dimension parameter specifies from which cube to retrieve the metadata.
CubeIsOptimized(dimension)
Returns the name of the cube. The dimension parameter specifies from which cube to retrieve the metadata.
CubeName(dimension)
Returns the date time that cube schema was last updated. The dimension parameter specifies from which cube to retrieve the metadata.
CubeSchemaUpdatedOn(dimension)
Returns e raised to the power of numeric_exp. The constant e is the base of the natural logarithm.
exp(numeric_exp)
Returns an integer representing the value of datepart_exp ("year", "month", "day", "hour", "minute", "second" (=default)) in datetime_exp.
extract(datepart_exp , datetime_exp)
Returns the largest integer less than or equal to numeric_exp.
floor(numeric_exp)
Returns run locale (deprecated).
GetLocale()
Returns current horizontal page count.
HorizontalPageCount()
Returns current horizontal page number.
HorizontalPageNumber()
Returns boolean 1 (TRUE) when cell is in the scope of the data items and MUNs; otherwise, 0 (FALSE).
InScope(dataItem, MUN, ...)
Returns boolean 1 (TRUE) when report will be distributed to given recipient; otherwise, 0 (FALSE).
IsBursting('recipientName')
Returns boolean 1 (TRUE) if the current node is a crosstab column node member.
IsCrosstabColumnNodeMember()
Returns boolean 1 (TRUE) if the current node is a crosstab row node member.
IsCrosstabRowNodeMember()
Returns boolean 1 (TRUE) if the current column is the first column.
IsFirstColumn()
Returns boolean 1 (TRUE) if the current node is an innermost crosstab column node member.
IsInnerMostCrosstabColumnNodeMember()
Returns boolean 1 (TRUE) if the current node is an innermost crosstab row node member.
IsInnerMostCrosstabRowNodeMember()
Returns boolean 1 (TRUE) if the current column is the last column.
IsLastColumn()
Returns boolean 1 (TRUE) if the current node is the last innermost crosstab column node member.
IsLastInnerMostCrosstabColumnNodeMember()
Returns boolean 1 (TRUE) if the current node is the last innermost crosstab row node member.
IsLastInnerMostCrosstabRowNodeMember()
Returns boolean 1 (TRUE) if the current node is an outermost crosstab column node member.
IsOuterMostCrosstabColumnNodeMember()
Returns boolean 1 (TRUE) if the current node is an outermost crosstab row node member.
IsOuterMostCrosstabRowNodeMember()
Returns boolean 1 (TRUE) if the page count is available for the current execution of the report.
IsPageCountAvailable()
Returns the natural logarithm of the numeric_exp.
ln(numeric_exp)
Returns run locale.
Locale()
Returns string_exp with all uppercase characters shifted to lowercase.
lower(string_exp)
The user should supply the initial letter and the number is added to it.
mapNumberToLetter(string_exp, integer_exp)
mapNumberToLetter ('a', 1) will result in 'b'.
Result: 'b'
Returns the integer value of the remainder (modulo) when integer_exp1 is divided by integer_exp2.
mod (integer_exp1, integer_exp2)
Returns model path.
ModelPath()
Returns current system time.
Now()
Returns NULL if string_exp1 equals string_exp2 (case insensitive), otherwise returns string_exp1.
nullif(string_exp1, string_exp2)
Returns the number of bytes in string_exp.
octet_length(string_exp)
Returns the current page count. If you run the report, this function works only when the report output is PDF or Excel. If you save the report output, this function works for all formats.
PageCount()
Returns the current page name.
PageName()
Returns current page number.
PageNumber()
Returns parameter count of the variable identified by parameterName.
ParamCount('parameterName')
Returns a string that is the parameter display value of the variable identified by parameterName.
ParamDisplayValue('parameterName')
Returns parameter name of the variable identified by parameterName.
ParamName('parameterName')
Returns all parameter names.
ParamNames()
Returns a string that is the parameter value of the variable identified by parameterName.
ParamValue('parameterName')
Returns the integer value representing the starting position of string_exp1 in string_exp2 or 0 when string_exp1 is not found.
position(string_exp1, string_exp2)
Returns num_exp1 raised to the power of num_exp2.
power(num_exp1, num_exp2)
Returns author locale.
ReportAuthorLocale()
Returns the date when the report was created.
ReportCreateDate()
Returns report execution date and time.
ReportDate()
Returns report description. This function works only when the report is run from Cognos Connection.
ReportDescription()
Returns the report id.
ReportID()
Returns run locale.
ReportLocale()
Returns report name. This function works only when the report is run from Cognos Connection.
ReportName()
Returns the value of run option variable identified by optionName. Possible values for optionName: attachmentEncoding, burst, cssURL, email, emailAsAttachment, emailAsURL, emailBody, emailSubject, emailTo, emailToAddress, history, metadataModel, outputEncapsulation, outputFormat, outputLocale, outputPageDefinition, outputPageOrientation, primaryWaitThreshold, print, printer, printerAddress, prompt, promptFormat, saveAs, saveOutput, secondaryWaitThreshold, verticalElements, xslURL.
ReportOption('optionName')
Returns the name of the output format. Possible return values: CSV, HTML, layoutDataXML, MHT, PDF, rawXML, singleXLS, spreadsheetML, XLS, XML, XLWA.
ReportOutput()
Returns report path. This function works only when the report is run from Cognos Connection.
ReportPath()
Returns product locale.
ReportProductLocale()
Returns the date when the report was last saved.
ReportSaveDate()
Returns numeric_exp rounded to the nearest value integer_exp places right of the decimal point. If integer_exp is negative, numeric_exp is rounded to the nearest value absolute (integer_exp) places to the left of the decimal point.
round(numeric_exp, integer_exp)
round (125, -1) rounds to 130.
Result: 130.
Returns current row.
RowNumber()
Returns the locale of the server that runs the report.
ServerLocale()
Returns the name of the server that runs the report.
ServerName()
Returns the square root of numeric_exp. numeric_exp must be non-negative.
sqrt(numeric_exp)
Returns the substring of string_exp that starts at position integer_exp1 for integer_exp2 characters or to the end of string_exp if integer_exp2 is -1. The first character in string_exp is at position 1.
substring(string_exp , integer_exp1, integer_exp2)
Returns the table of contents heading count for a specific heading level.
TOCHeadingCount(headingLevel)
Returns current system date.
Today()
Returns a string_exp trimmed of leading and/or trailing blanks or trimmed of a character specified in match_character_exp. trim_what_exp may be: "LEADING", "TRAILING" or "BOTH" (default). match_character_exp = empty string to trim blanks, or specifies a character to be trimmed. String_exp = the string to be trimmed.
trim(trim_what_exp, match_character_exp, string_exp)
Returns string_exp with all lowercase characters shifted to uppercase.
upper(string_exp)
Returns the url encoded value of the input text.
URLEncode('text')
Returns a date as string in YYYY-MM-DD format.
date2string(date_exp)
Converts a date to a timestamp. The time part of the timestamp will be zero.
date2timestamp(date_exp)
Converts a date to a timestamp with time zone. The time and time zone parts of the timestamp will be zero.
date2timestampTZ(date_exp)
Returns a date time interval as string in "DDDD HH:MM:SS.FFFFFFF" or "-DDDD HH:MM:SS.FFF" format.
DTinterval2string(DTinterval_exp)
Returns a date time interval as string. The days are converted to hours. Output format: "HHHH:MM:SS.FFFFFFF" or "HH:MM:SS.FFF".
DTinterval2stringAsTime(DTinterval_exp)
Converts an integer to a date time interval. String_exp specifies what the integer_exp is representing: "ns"=nanoseconds, "s"=seconds (=default), "m"=minutes, "h"=hours, "d"=days.
int2DTinterval(integer_exp, string_exp)
Converts an integer to a year month interval. String_exp specifies what the integer_exp is representing: "y"=years, "m"=months (=default).
int2YMinterval(integer_exp, string_exp)
Converts a number to a string, using the %g format specifier (C/C++ syntax).
number2string(num_exp)
Returns a date string as date in "YYYY-MM-DD" format.
string2date(string_exp)
Returns a floating point number. The string argument to the function "string2double" has the following form:"[whitespace] [sign] [digits] [digits] [ {d | D |e | E }[sign]digits]"
string2double(string_exp)
Returns a date-time interval string as Date Time Interval in "[-]DD HH:MM[:SS[.FFF]]" format.
string2DTinterval(string_exp)
Returns an integer. The string argument to the function "string2int32" has the following form: "[whitespace] [{+ | -}] [digits]"
string2int32(string_exp)
Returns a long integer. The string argument to the function "string2int64" has the following form: "[whitespace] [{+ | -}] [digits]"
string2int64(string_exp)
Returns a time string as time in "HH:MM:SS.FFFFFFF" format.
string2time(string_exp)
Returns a timestamp string as timestamp in "YYYY-MM-DD [white space]+ HH:MM:SS.FFFFFFF" format.
string2timestamp(string_exp)
Returns a timestamp with time zone "YYYY-MM-DD HH:MM:SS.FFFFFFF +HHMM" or "YYYY-MM-DD HH:MM:SS.FFF -HHMM" format.
string2timestampTZ(string_exp)
Returns a year-month interval string as Year Month Interval in "[-]YY MM" format.
string2YMinterval(string_exp)
Returns a time as string in HH:MM:SS.FFF format.
time2string(time_exp)
Converts a timestamp to a date. The time part of the timestamp will be ignored.
timestamp2date(timestamp_exp)
Returns a timestamp as string in YYYY-MM-DD HH:MM:SS.FFFFFFF format.
timestamp2string(timestamp_exp)
Converts a timestamp to a timestamp with time zone. The displacement part of the timestamp with time zone will be zero.
timestamp2timestampTZ(timestamp_exp)
Converts a timestamp with time zone to a date. The time and time zone parts of the timestamp will be ignored.
timestampTZ2date(timestampTZ_exp)
Returns a timestamp with time zone as string in "YYYY-MM-DD HH:MM:SS.FFFFFFF +HHMM" or "YYYY-MM-DD HH:MM:SS.FFF -HHMM" format.
timestampTZ2string(timestampTZ_exp)
Converts a timestamp with time zone to a timestamp. The displacement part of the timestamp with time zone will be ignored.
timestampTZ2timestamp(timestampTZ_exp)
Returns a time with time zone as string in "HH:MM:SS.FFF +HHMM" or "HH:MM:SS.FFFFFFF -HHMM" format.
timeTZ2string(timeTZ_exp)
"-05:30" means a TimeZone of GMT minus 5 hours and 30 minutes.
Result: GMT minus 5 hours and 30 minutes
Returns a year month interval as string in "(YY MM)" or "-(YY MM)" format.
YMinterval2string(YMinterval_exp)