runOptionEnum

• bibus » runOption » name

Specifies whether advanced features are enabled for output. Advanced features include the ability to evaluate conditional subscriptions and to import saved output versions into Office Connection. To specify this option, use the bibus » runOptionBoolean class.

Default: false

New in Version 8.3 — Advanced Features for Report Output

This value was added.

Specifies whether saved output can be annotated by report consumers.

This option can be used only when output is saved in the content store using the bibus » runOptionEnum » saveOutput value option.

To specify this option, use the bibus » runOptionBoolean class.

Default: false

New in Version 8.4 — Report Output Annotations

This value was added.

Specifies whether the output will be archived. To specify this option, use the bibus » runOptionBoolean class.

Default: false

New in Version 8.3 — Saving Report Output to File System

This value was added.

Specifies whether the report is to run as a burst report. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Breaks and executes the burst report into several chunks and executes them in parallel.

This should result in the burst outputs being produced much more efficiently.

To specify this option, use the bibus » runOptionString class.

Default: Default

The default value observes the system wide default value, which is set to Disabled in the RSVP.BURST_DISTRIBUTION advanced setting. If this is set to Disabled, burst reports will not be distributed and run sequentially in one process.

New in Version 10.2.1 — New configuration options for burst distribution

This value was added.

Sets the maximum number of burst keys per distributed chunk.

Depending on the data source type, it might be necessary to set this limit in order to prevent the generation of lengthy or complex SQL. If bibus » runOptionEnum » burstDistribution is Disabled, this value has no effect.

If this value is blank (""), the value of the BDS.split.maxKeysPerChunk advanced setting is used. The default value for BDS.split.maxKeysPerChunk is 1000. Use a a value of 0 for this property, or the BDS.split.maxKeysPerChunk setting, to specify that the burst key limit is unlimited.

To specify this option, use the bibus » runOptionInt class.

Default: 1000

New in Version 10.2.1 — New configuration options for burst distribution

This value was added.

When enabled, this allows DQM packages (and only DQM packages) to pre-fetch the burst queries while the outputs are being rendered. The result should be that the burst outputs will be produced faster because the queries are executing in parallel with the report rendering. To specify this option, use the bibus » runOptionString class.

Default: Default

The default value observes the system wide default value, which is set to Disabled by default in the RSVP.BURST_QUERY_PREFETCH setting. If this is set to Disabled, burst queries run sequentially.

New in Version 10.2.1 — New configuration options for burst distribution

This value was added.

Specifies that the asynchronous conversation should continue after the request has executed. To specify this option, use the bibus » runOptionBoolean class. This option can be used with the report » deliver(conversation, parameterValues, options) method

Default: false

Specifies that parameters related to data source connections should be returned by the parameter » getParameters(objectPath, parameterValues, options) method or the parameter » getParametersSpecification(specification, parameterValues, options) method. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies the Web location of the user CSS style sheet to use when rendering the report. This style sheet is used in conjunction with the style sheet specified by the report author. In adherance to the CSS 2.1 standard from W3C, this style sheet must include the keyword !important on each declaration that is intended to override the author's style sheet behavior. For more information, see the W3C website.

To specify this option, use the bibus » runOptionAnyURI class.

This option is validated by CAF if CAF is enabled and the RSVP.RENDER.VALIDATEURL advanced setting is set to 'true':

New in Version 8.4 — URL Validation Rules

CAF validation rules were added.

Specifies whether Report Server will retrieve data when running the report. To specify this option, use the bibus » runOptionData class.

Default: bibus » dataEnum » runWithAllData value

Specifies whether the output will be distributed by email. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies whether the output will be distributed as an email attachment. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies whether a link to the output will be distributed as an email attachment. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies that all parameters defined in the layout section of a report specification should be returned by the parameter » getParameters(objectPath, parameterValues, options) method or the parameter » getParametersSpecification(specification, parameterValues, options) method regardless of whether the parameter is used when the report is executed. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies the maximum number of candidate prompt values in the result set. Use with skipValueCount to partition a large result set.

For example, you can use this option to select the set of candidate prompt values when scrolling in your Web portal.

To specify this option, use the bibus » runOptionInt class.

Default: 0 (Returns all values)

Specifies the metadata model used to execute the report. This option should only be used if the report was not saved in Content Manager. To specify this option, use the bibus » runOptionString class.

Specifies whether the output will be distributed to mobile devices. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Specifies whether the server returns output documents in the response, or caches them in the user's session object and returns a reference to the documents instead.

To use this option, the report output must be returned in the SOAP response. For this to occur, the value of the saveAs option must be unspecified and the values of the following options must be false:

• archive

• email

• print

• saveOutput

To specify this option, use the bibus » runOption class. Possible choices are defined in the bibus » outputEncapsulationEnum enumeration set .

Default: none

Specifies the output format. To specify this option, use the bibus » runOptionStringArray class. Possible choices are defined in the bibus » outputFormatEnum enumeration set.

Default: HTML

Specifies the language of the report output. The value is expressed as a hyphenated language-region pair, in accordance with the RFC3066 standard.

To specify a locale other than the default output locale, you can specify a single locale or you can specify multiple locales in conjunction with any of the following run options:

• email

• print

• saveAs

• saveOutput

• savePromptCache

To specify this option, use the bibus » runOptionLanguageArray class.

Default: an array with the single value en-us

Specifies the location for storing temporary objects created by reportService and batchReportService.

To specify this option, use the bibus » runOptionAnyURI class and values from the bibus » temporaryObjectLocationEnum enumeration set.

Default: contentStore

New in Version 10.1.0 — Storing Temporary Output Objects Outside the Content Store

This value was added.

Specifies the bibus » pageDefinition attributes of the output report. To specify this option, use the bibus » runOptionString class.

Specifies the page orientation of the output report. To specify this option, use the bibus » runOptionString class. Possible choices are defined in the bibus » pageOrientationEnum enumeration set.

Default: portrait

Specifies whether the new output will be printed. To specify this option, use the bibus » runOptionBoolean class.

Default: false

Identifies the instance of the bibus » printer class that will be used to print the report. To specify this option, use the bibus » runOptionString class.

Identifies the network address of the printer that will be used to print the report. To specify this option, use the bibus » runOptionString class.

Specifies whether the report service will issue prompts, so that users can enter report option values. To specify this option, use the bibus » runOptionBoolean class.

Default: true

Specifies the action that the report service will perform on the prompt cache. To specify this option, use the bibus » runOptionPromptCacheMode class.

Default: none

New in Version 8.4 — On Demand Refresh of Prompt Cache

This value was added. It replaces the bibus » runOptionEnum » savePromptCache value.

Specifies the format produced for prompt pages.

If the value of the outputFormat run option is HTML, the default value is HTML. Otherwise, the default value is XHTML.

Use an option of class bibus » runOptionString to specify different values.

Specifies that available output should be returned in the response (bibus » asynchReply » details property) to a wait(conversation, parameterValues, options) request.

By using this option, your application does not need to call the report » getOutput(conversation, parameterValues, options) method to retrieve report output from the reportService service. When you use this option, the reportService service never returns responseReady in the bibus » asynchDetailReportStatus » status property.

To specify this option, use the bibus » runOptionBoolean.

Default: false

New in Version 10.1.0 — i_d15e431437.html#ReleaseNotes_ReleaseNotes_101_10.1.RTM.RTC71244

This value was added.

Contains the information required to create a new object in Content Manager based on the object to be executed. To specify this option, use the bibus » runOptionSaveAs class.

This option cannot be used with the asynch » runSpecification(specification, parameterValues, options) method .

Specifies whether the output should be saved to the content store. To specify this option, use the bibus » runOptionBoolean class.

This option cannot be used with the asynch » runSpecification(specification, parameterValues, options) method .

Default: false

Specifies whether the prompt data should be saved in the content store. To specify this option, use the bibus » runOptionBoolean class.

Existing cache data is deleted each time the cache is updated. Prompt controls that rely on parameter values, other controls, or additional data do not generate data in the cache.

This option is used in conjunction with the prePopulateLevels option on tree prompt controls to control the amount of data stored in the cache.

Default: false

New in Version 8.4 — On Demand Refresh of Prompt Cache

This value is deprecated. Use the bibus » runOptionEnum » promptCacheMode value instead.

Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. To specify this option, use the bibus » runOptionInt class.

Use a value of 0 when you want the client to wait indefinitely.

Default: 30

This value

• is deprecated and will be removed in a future version of the product

Specifies whether selection-based features are enabled in report output. To specify this option, use the bibus » runOptionBoolean class.

Default: true

Disabling this option turns off package drill-through and IBM Cognos Search features.

New in Version 8.3 — Disabling Selection-based Interactive Report Output Features

This value was added.

Specifies the number of candidate prompt values to be skipped in the result set. Use with maximumValueCount to partition a large set of prompt values.

For example, you can use this option to select the set of candidate prompt values when scrolling in your Web portal.

To specify this option, use the bibus » runOptionInt class.

Default: 0

Specifies the number of vertical elements to be rendered on an infinitely sized canvas, such as an HTML page. To specify this option, use the bibus » runOptionInt class.

Use a value of 0 if you want all vertical elements to be rendered on one page.

Specifies values for the parameters defined in the XSL style sheet specified by xslURL. To specify this option, use the bibus » runOptionNameValueArray class.

Specifies the name of an XSL style sheet that can be applied to the report to render it in the requested format. The value of this option must match the name of a file in the templates/rsvp/xsl directory of the IBM® Cognos® Analytics installation. The value must not contain a path qualifier.

To specify this option, use the bibus » runOptionAnyURI class.

This option is valid only for the HTML, HTMLFragment, and XHTML output formats. It is ignored for non-HTML output formats.

The default value is v5html.xsl and should not be changed. Specifying a value other than the default may reduce the functionality of the output. For example, drill through may not work properly.