Report Functions
- Today
Returns the current system date. - Now
Returns the current system time. - AsOfDate
Returns the date value of the AsOfDate expression, if it is defined. Otherwise, AsOfDate returns the report execution date. - AsOfTime
Returns the time value of the AsOfTime expression, if it is defined. Otherwise, AsOfTime returns the report execution time. - ReportDate
Returns the report execution date and time. - ReportName
Returns the report name. This function works only when the report is run from IBM® Cognos® Connection. If a saved report view is run, returns the report view name. - ReportPath
Returns the report path. This function works only when the report is run from IBM® Cognos® Connection. - ReportDescription
Returns the report description. This function works only when the report is run from IBM® Cognos® Connection. - ReportLocale
Returns the run locale. - GetLocale
Returns the run locale (deprecated). - Locale
Returns the run locale. - ReportProductLocale
Returns the product locale. - ReportAuthorLocale
Returns the author locale. - ReportSaveDate
Returns the date when the report was last saved. - ReportCreateDate
Returns the date when the report was created. - ReportID
Returns the report ID. - ReportOutput
Returns the name of the output format, such as CSV, HTML, HTMLFragment, layoutDataXML, MHT, PDF, rawXML, spreadsheetML (Excel 2007 format), XHTML, xlsxData (Excel 2007 Data format), XLWA (Excel 2002 format), XML, singleXLS (deprecated), XLS (deprecated). - ReportOption
Returns the value of the run option variable identified by "optionName", such as attachmentEncoding, burst, cssURL, email, emailAsAttachment, emailAsURL, emailBody, emailSubject, emailTo, emailToAddress, metadataModel, outputEncapsulation, outputFormat, outputLocale, outputPageDefinition, outputPageOrientation, primaryWaitThreshold, print, printer, printerAddress, prompt, promptFormat, saveAs, saveOutput, secondaryWaitThreshold, verticalElements, or xslURL. - ServerName
Returns the name of the web server where the run request originated from. The value may be empty if the request is executed from the scheduler. - ServerLocale
Returns the locale of the server that runs the report. - ModelPath
Returns the model path. - BurstKey
Returns the burst key. - BurstRecipients
Returns the distribution list of burst recipients. - IsBursting
Returns Boolean 1 (true) when the report will be distributed to the recipient; otherwise, returns Boolean 0 (false). - ParamNames
Returns all parameter names. - ParamName
Returns the parameter name of "parameterName". - ParamDisplayValue
Returns a string that is the parameter display value of "parameterName". This function appears in the Recruitment Report sample report in the GO Data Warehouse (analysis) package. - ParamValue
Returns the parameter value of "parameterName". - ParamCount
Returns the parameter count of "parameterName". - RowNumber
Returns the current row. - PageNumber
Returns the current page number. - PageCount
Returns the current page count. This function works only when the report output is Adobe® PDF or Microsoft® Excel. If you save the report output, this function works for all formats. - IsPageCountAvailable
Returns Boolean 1 (true) if the page count is available for the current execution of the report; otherwise, returns Boolean 0 (false). - HorizontalPageNumber
Returns the current horizontal page number. - HorizontalPageCount
Returns the current horizontal page count. - PageName
Returns the current page name. - URLEncode
Returns the URL encoded value of the input text. - TOCHeadingCount
Returns the table of contents heading count for a specified heading level. - IsAccessible
Returns Boolean 1 (true) if the report is run with the accessibility features enabled. Use this function as a variable expression with a conditional block to make your reports accessible. For example, you can add a list or crosstab equivalent to a chart in reports that are run with accessibility features enabled. - IsBooklet
Returns Boolean 1 (true) if the report is a child report of a booklet; otherwise, returns Boolean 0 (false). - ColumnNumber
Returns the current column number. - IsCrosstabRowNodeMember
Returns Boolean 1 (true) if the current node is a crosstab row node member. - IsCrosstabColumnNodeMember
Returns Boolean 1 (true) if the current node is a crosstab column node member. - IsInnerMostCrosstabRowNodeMember
Returns Boolean 1 (true) if the current node is an innermost crosstab row node member. - IsInnerMostCrosstabColumnNodeMember
Returns Boolean 1 (true) if the current node is an innermost crosstab column node member. - IsOuterMostCrosstabRowNodeMember
Returns Boolean 1 (true) if the current node is an outermost crosstab row node member. - IsOuterMostCrosstabColumnNodeMember
Returns Boolean 1 (true) if the current node is an outermost crosstab column node member. - IsFirstColumn
Returns Boolean 1 (true) if the current column is the first column. - IsLastColumn
Returns Boolean 1 (true) if the current column is the last column. - IsLastInnerMostCrosstabColumnNodeMember
Returns Boolean 1 (true) if the current node is the last innermost crosstab column node member. - IsLastInnerMostCrosstabRowNodeMember
Returns Boolean 1 (true) if the current node is the last innermost crosstab row node member. - CubeName
Returns the name of the cube. "Dimension" specifies from which cube to retrieve the metadata. - CubeDescription
Returns the description of the cube. "Dimension" specifies from which cube to retrieve the metadata. - CubeCreatedOn
Returns the date and time when the cube was created. "Dimension" specifies from which cube to retrieve the metadata. If the dimension source is an IBM® Cognos® PowerCube (.mdc), the function returns a blank string because the initial creation date of a PowerCube is not maintained. - CubeDataUpdatedOn
Returns the date time that data in the cube was last updated. "Dimension" specifies from which cube to retrieve the metadata. - CubeSchemaUpdatedOn
Returns the date time that the cube schema was last updated. "Dimension" specifies from which cube to retrieve the metadata. - CubeIsOptimized
Returns "true" if the cube is optimized. "Dimension" specifies from which cube to retrieve the metadata. - CubeDefaultMeasure
Returns the name of the default measure for the cube. "Dimension" specifies from which cube to retrieve the metadata. - CubeCurrentPeriod
Returns the current period for the cube. "Dimension" specifies from which cube to retrieve the metadata. - CellValue
Returns the value of the current crosstab cell. - InScope
Returns Boolean 1 (true) when the cell is in the scope of the data items and MUNs; otherwise, returns Boolean 0 (false).
Parent topic: Using the expression editor