Report service and batch report service advanced settings

This section describes advanced settings for the report service and the batch report service.

BDS.split.maxKeysPerChunk

Specifies the maximum key limit for burst reports processing. Setting the key limit lets you avoid complex SQL clauses when the RSVP.BURST_DISTRIBUTION setting is set to true. The value of 0 sets no limit on this parameter.

Data type:
Positive integer
Default:
1000

HyperlinkButtonNewWindow

Specifies that when a hyperlink button is clicked, a new window is created.

Data type:
Boolean
Default:
false

HyperlinkMultipleToolbars

Specifies that duplicate toolbars in HTML reports are permitted. Set to false to eliminate duplicate toolbars from appearing.

Data type:
Boolean
Default:
true

RSVP.ATTACHMENTENCODING.BASE64EXTENDED

Specifies whether base64 encoding is used when generating report output in MHT or XWLA format.

In some instances, if custom applications specify MHT or XLWA output format for reports, problems with end of line characters used in the XML output can prevent applications from opening the report.

Data type:
Boolean
Default:
false

RSVP.BURST_DISTRIBUTION

Specifies whether burst reports run in parallel or sequentially. If you use the default value of false, jobs run sequentially, which takes more time.

This setting corresponds to the Run in parallel burst option in the user interface. This setting is valid only when Run in parallel is set to Default. When the Run in parallel option is set to Disabled or Enabled, it overrides this setting.

Data type:
Boolean
Default:
false

RSVP.BURST_QUERY_PREFETCH

When you set this option to true, you enable query prefetching. As a result, the burst report outputs are produced much faster because the queries run in parallel with the report rendering. This setting is applicable to dynamic query mode relational models only.

Data type:
Boolean
Default:
false

RSVP.CHARTS.ALTERNATECOLOURS

Specifies that each chart instance assigns colors in palette order, and does not attempt to preserve the color of items from one chart instance to another.

Data type:
Boolean
Default:
false

RSVP.CONCURRENTQUERY.ENABLEDFORINTERACTIVEOUTPUT

Enables concurrent query execution when the report service is producing interactive output.

Data type:
Boolean
Default:
false

RSVP.CONCURRENTQUERY.MAXNUMHELPERSPERREPORT

Specifies the maximum number of query execution helpers for each report. This parameter is used to prevent a single report from consuming all available query execution helpers.

Data type:
Integer
Default:
1

RSVP.CONCURRENTQUERY.NUMHELPERSPERPROCESS

Enables concurrent query execution and set the maximum number of query execution helpers for each report service or batch report service process. The default value is 0, meaning that concurrent query execution is disabled.

Data type:
Integer
Default:
0

RSVP.CSV.DELIMITER

Specifies the field delimiter character used for CSV output.

Data type:
String
Default:
TAB

RSVP.CSV.ENCODING

Specifies the encoding that is used when generating CSV output.

Data type:
String
Default:
utf-16le

RSVP.GROUP_METADATA_REQUESTS

Specifies if metadata requests are grouped, when possible, to improve performance. Users can disable the grouping of metadata requests by setting this parameter to false.

Data type:
Boolean
Default:
true

RSVP.CSV.MIMETYPE

Specifies the MIME type that is attributed to the CSV output.

Data type:
String
Default:
application/csv

RSVP.CSV.QUALIFIER

Specifies the string qualifier that is used for CSV output.

Data type:
String
Default:
"

RSVP.CSV.REPEAT_XTAB_LABELS

Specifies whether to repeat the edge labels in a nested crosstab report.

Data type:
Boolean
Default:
false

RSVP.CSV.TERMINATOR

Specifies the line terminator that is used for CSV output.

Data type:
String
Default:
LF

RSVP.DRILL.clearAllMappedParamsOnMismatch

Specifies how mapping of passed parameter values is processed during a drill-through operation when some parameters fail to map. The parameter mapping is continued (default), or all the mapping is discarded and the user is prompted for values.

When you set this property to 1, if any parameter fails to map, all other mapped parameters are removed from the mapping table. This could cause re-prompting for all missing parameters. When you set this property to 0, if any parameter fails to map while the drill-through component attempts to map the parameters, the mapping of the remaining parameters is not affected.

Data type:
Integer
Default:
0

RSVP.CSV.TRIMSPACES

Specifies that trailing spaces are removed from CSV output.

Data type:
Boolean
Default:
false

RSVP.DRILL.DynamicFilterUsesBusinessKey

Specifies dynamic drill-through filter behavior. Set this option to 1 if you want drill-through to generate a filter using the Member Business Key instead of the default Member Caption.

Data type:
Positive integer
Default:
0

RSVP.DRILL.ExtractSourceContextFromRequest

Specifies whether the report server makes an attempt to extract the metadata for the parameters of the drill-through request from the source context of the request instead of issuing a new metadata request. This type of processing improves performance of a drill-through operation. It is turned on by default.

When you set this property to 0, metadata requests are always issued.

Data type:
Integer
Default:
1

RSVP.EXCEL.EXCEL_XLS2007_ENABLE_SHARED_STRINGS_TABLE_SIZE_LIMIT

This setting determines whether RSVP.EXCEL.EXCEL_2007_XLS2007_SHARED_STRINGS_TABLE_SIZE_LIMIT is enabled.

Data type:
Boolean
Default:
true

RSVP.EXCEL.EXCEL_2007_LARGE_WORKSHEET

Enables support for large Microsoft Excel 2007 worksheets. When this option is set to true, worksheets with up to 1,048,576 rows are supported.

Data type:
Boolean
Default:
false

RSVP.EXCEL.EXCEL_2007_OUTPUT_FRAGMENT_SIZE

Adjusts the internal memory fragment size, in rows, that the IBM Cognos Analytics server generates before flushing to a disk. This property can be useful when there are issues, such as running out of memory, when generating reports with the default value. The values might need to be lowered to allow the report to run successfully.

Data type:
Integer
Default:
45000 (approximate)

RSVP.EXCEL.EXCEL_2007_XLS2007_SHARED_STRINGS_TABLE_SIZE_LIMIT

This setting determines whether to limit the shared strings in the Excel output. Limiting shared strings increases the file size of the excel output. When shared strings are unlimited and too high it can cause Excel performance problems.

Data type:
Integer
Default:
10000

RSVP.EXCEL.EXCEL_2007_WORKSHEET_MAXIMUM_ROWS

Specifies the number of rows to output before moving to a new worksheet.

Data type:
Integer

RSVP.EXCEL.PAGEGROUP_WSNAME_ITEMVALUE

Specifies that, when producing output in Microsoft Excel 2007 format and page breaks are specified, the worksheet tabs are named for the data items used to break the pages.

Data type:
Boolean
Default:
false

RSVP.EXCEL.XLS2007_SUFFIX_PAGENUMBER

This setting determines the logic for handling duplicate names in Excel sheets in Cognos Analytics 12.0.1.
Note: This setting is not supported starting with Cognos Analytics 12.0.2.
Data type:
Boolean
Default:
true

RSVP.EXCEL_FILENAME_TIME_SUFFIX

Use this setting to append a timestamp to the file name of the saved report in the Excel format. The timestamp helps to distinguish between the saved Excel files. By default, the saved Excel report file name is the same as the report name.

Data type:
Boolean
Default:
false

RSVP.EXCEL.XLS2007_ALLOW_WRAPPING_SINGLE_CELL

Specifies whether text is wrapped within a cell in Excel outputs.

Data type:
Boolean
Default:
false

RSVP.EXCEL.XLS2007_COLUMN_WIDTH_CONTROL

Prevents cell merging in Excel 2007 report outputs if you set the Size and Overflow values for a column.

Data type:
Boolean
Default:
false

RSVP.EXCEL.XLS2007.FULLDECIMALPRECISION

When set to true, numbers in Excel output are rendered with up to 15 decimal places. When set to false (the default value), numbers can contain a maximum of 12 decimal places.

Data type:
Boolean
Default:
false

RSVP.EXCEL.XLS2007_PRINT_MEDIA

Specifies whether the Don't Print style is applied to Excel 2007 report outputs.

Data type:
Boolean
Default:
true

RSVP.FILE.EXTENSION.XLS

Specifies to use XLS as the file extension on XLS output format email attachments instead of HTML.

Data type:
String
Default:
false

RSVP.OPTIMIZED_TABS

Specifies that each tab is rendered individually when a report is run.

Optimized rendering is faster; however, it has the following limitations:
  • It's not suitable for reports with conditional pages or reports that rely on continuous page numbers across tabs.
  • Pages with no content are still rendered as tabs.
Note: The batch requests always run without optimized tab rendering because in this case performance is not an issue.
Values
No
Optimized tab rendering is not used. This is the default value. If the property is not specified, the default value is applied automatically.
Yes
Optimized tab rendering is used.
Even if you set the advanced property renderPageWhenEmpty to False for the report service, the empty pages are rendered.
Auto

The report service determines whether to use optimized tab rendering, which is based on the presence of conditional pages. With this value, the reports run as fast as possible without the risk of displaying tabs that have no content.

Data type:
String
Default:
No

RSVP.PARAMETER_CACHE

Specifies whether parameters caching is enabled or disabled at the server level. By default, parameters caching is enabled.

When RSVP issues a getParameters request, it stores the results in a child object under the report object in IBM Cognos Content Manager. This allows the cache to be created or updated without modifying the report specification. When RSVP needs parameter information, it uses the cached information from Content Manager. If the cache does not contain the information required by RSVP, RSVP calls the query engine directly to get the information.

The cache is populated by making a ReportService getParameters SOAP request to the batch report service with the run option http://developer.cognos.com/ceba/constants/runOptionEnum#createParameterCache. This way, if RSVP determines the cache is missing or stale, creating the cache does not affect the execution of the report, since the cache is created by an independent request. However, since the request is handled by the batch report service, a history entry is created which is visible in the run history of a report.

The cache creation is triggered when a report is created or updated from Cognos Analytics Reporting as well as when a report is executed and RSVP determines the existing cache is stale. RSVP uses the version of the module or root model of the report to determine if the cache is stale.

Data type:
Boolean
Default:
true

RSVP.PARAMETERS.LOG

Specifies whether the report run options and prompt parameters must be logged to the logging system.

Parameters are logged after the report stops running. If the report execution is canceled, parameters are not logged.

Data type:
Boolean
Default:
false

RSVP.PARAMETERS.SAVE

Specifies that report prompt values that are entered by a user are saved automatically.

Data type:
Boolean
Default:
false

RSVP.PRINT.POSTSCRIPT

Specifies which interface to use to print PDF documents from a UNIX operating system. When this option is set to false, the Adobe Acrobat PDF interface is used. Otherwise, the internal postscript interface is used.

Data type:
Boolean
Default:
true

RSVP.PROMPT.CASTNUMERICSEARCHKEYTOSTRING

Specifies to convert numeric data items into a string (varchar) format. This may be required if your data source does not convert numeric data items to strings.

Data type:
Boolean
Default:
true

RSVP.PROMPT.EFFECTIVEPROMPTINFO.IGNORE

Disables the issuing of the effectivePromptInfo attribute in metadata requests and effectively disables moving the prompt information from under the caption attribute of a level to the level itself. This is the default behavior.

Data type:
Boolean
Default:
false

RSVP.PROMPT.RECONCILIATION

Specifies a system-wide configuration that defines how queries and query groups are processed.

See the topic on setting query prioritization in the IBM Cognos Analytics Administration and Security Guide for a description of the possible values of this setting.

Data type:
Positiver integer or string
Default:
0 or COMPLETE

RSVP.PROMPT.RECONCILIATION.CHUNKSIZE

Specifies the chunk size when the value of the RSVP.PROMPT.RECONCILIATION setting is CHUNKED GROUPED or CHUNKED.

Data type:
Positive integer
Default:
5

RSVP.PROMPTCACHE.LOCALE

Specifies the locale to use instead of the locale specified in the report whenever prompt cache data is created, updated, or used. This means that a single prompt cache is used for each report regardless of the report user's locale.

Data type:
String

RSVP.RENDER.PDF_FONT_SWITCHING

Specifies that each character in a string is displayed in the preferred font. The preferred font is any font listed in a report specification, followed by the fonts listed in the global styles cascading stylesheet (css) file. When a character is not available in the preferred font, it is displayed using the next font on the list.

In previous versions, a font was used only if all characters in a string could be displayed using that font. Starting with IBM Cognos Business Intelligence 10.1, the preferred font is applied at the character level. As a result, one word can be displayed using different fonts, or some fonts might be bigger, which can cause word wrapping.

Set the parameter value to false to restore the font-choosing behavior of earlier versions.

Data type:
Boolean
Default:
true

RSVP.RENDER.ROUNDING

Specifies the rounding rule for data formatting.

In previous versions, the halfEven rule was used when rounding numbers. This rule is often used in bookkeeping. However, precision regulations in some regions require different rounding rules, for example, the halfUp rule. Starting with version IBM Cognos Business Intelligence 10.2.0, you can choose a rounding rule that complies with the precision regulations in your organization.

The following rounding rules are available:

halfEven
Rounds to the nearest neighbor, where an equidistant value is rounded to the nearest even neighbor.
halfDown
Rounds to the nearest neighbor, where an equidistant value is rounded down.
halfUp
Rounds to the nearest neighbor, where an equidistant value is rounded up.
ceiling
Rounds to a more positive number.
floor
Rounds to a more negative number.
down
Rounds towards zero.
up
Rounds away from zero.
Data type:
String
Default:
halfEven

RSVP.RENDER.VALIDATEURL

Specifies whether IBM Cognos Application Firewall validation is imposed on URLs that are contained within a report specification (including URLs on image tags, buttons, hyperlinks, and background images in CSS rules) or are specified by the cssURL run option of the report.

When this option is set to true and CAF in enabled, validation occurs using the following rules:

  • Fully qualified, or absolute URLs:

    protocol://host[:port]/path[?query]

    Where protocol is either 'http' or 'https' and the host is validated against the valid domain list

  • URLs relative to the server installation web root:

    /<install root>/.*

    Where <install root> is the gateway file path, taken from the Gateway URI in IBM Cognos Configuration. For example, /ibmcognos/ps/portal/images/action_delete.gif

  • One of the following specifically allowed URLs:
    • about:blank (case insensitive)
    • JavaScript:window.close() (case insensitive, with or without trailing semi-colon)
    • JavaScript:parent.close() (case insensitive, with or without trailing semi-colon)
    • JavaScript:history.back() (case insensitive, with or without trailing semi-colon)
    • parent.cancelErrorPage() (case insensitive, with or without trailing semi-colon)
    • doCancel() (case insensitive, with or without trailing semi-colon)
Data type:
Boolean
Default:
false

RSVP.REPORTSPEC.LOG

Specifies whether report specifications must be logged to the logging system.

Data type:
Boolean
Default:
false

RSVP.SLICER_ON_DRILL

Specifies whether context filter value is included in the package drill-through definition.

This setting has no impact on slicer filters.

Set this property to context to include the context filter in the package drill-through definition.

Data type:
String
Default:
no