batchReportService

Defines run-time configuration parameters for the batchReportService.

Values for many of the properties of this class can be acquired from the parent object. You can use property acquisition to simplify the configuration of IBM® Cognos® Analytics installations.

A dispatcher creates an instance of this class within its associated bibus » dispatcher object if the object does not already exist.

We recommend that you represent instances of this type as leaf nodes in a tree structure. These objects can be manipulated independent of their containing object.

This class

Container Information

Contains instances of the following classes
Contained by instances of the following classes

Properties

This class has the following properties.

advancedSettings

Specifies advanced configuration information in XML format.

The settings can be changed at run time, without having to restart the server. However, changing these settings using the SDK requires advanced XML programming skills.

For more information, see Advanced settings.

This property

  • is of type anyType

    is encoded as type tns:anyTypeProp

  • can be acquired from a containing object

brsAffineConnections

Specifies the number of connections that a batch report service process can use to execute high affinity requests during non-peak hours. This property limits the number of these requests that can be executed concurrently by a batch report service process.

High affinity requests are requests that are closely associated with a particular process. These requests are usually executed faster than low affinity requests.

If the request is sent to a different process, that process usually requires more time to execute the request because it must perform all the activities performed by the process that received the previous request.

For example, when requesting the next page of report output, the request can be executed most efficiently by the process that executed the previous request in the conversation.

High affinity requests are used to save report output, print report output, send report output by email, move between pages of report output, and move forward and backward in prompt pages.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 2

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.2.0 — Updated default settings for Report Service and Batch Report Service

Changing default value to 2.

brsAuditLevel

Specifies the auditing level for the batch report service.

This property

  • is of type bibus » auditLevelEnum

    is encoded as type tns:auditLevelEnumProp

  • has a default value of minimal

  • can be acquired from a containing object

brsAuditNativeQuery

Specifies whether to log native query information for the batch report service.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

  • has a default value of false

  • can be acquired from a containing object

brsChartHotspotLimit

Specifies the default maximum number of hotspots generated in a chart when the report specification does not specify the number of hotspots.

Use a value of 0 to disable the generation of chart hotspots.

Use a nil value to generate all hotspots in a chart.

Setting a non-nil value improves performance when generating charts that contain large numbers of members.

This property

  • is of type int

    is encoded as type tns:intProp

  • can be acquired from a containing object

New in Version 8.3 — Chart Hotspot Limit

This property was added.

brsDataSourceChange

Specifies the change time of the data source for the batch report service, in Coordinated Universal Time (UTC).

When the service detects that this property has been changed, it will close all connections to data sources. Subsequent requests will cause new connections to the data sources to be established. This property can be used when a new version of a PowerCube is ready to be used in the production environment.

This property

  • is of type dateTime

    is encoded as type tns:dateTimeProp

  • can be acquired from a containing object

brsExecutionTimeLimit

Specifies the maximum number of seconds that a task can run before being canceled by the dispatcher.

The dispatcher logs an error (DPR-ERR-2087) indicating that the task execution was canceled due to the execution time limit set being exceeded. A secondary request made against a conversation that has exceeded the time limit returns an error message.

Use a value of 0 when you want to allow the task to complete execution, regardless of the amount of time necessary.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 0

  • can be acquired from a containing object

brsMaximumEMailAttachmentSize

Specifies the maximum amount of uncompressed data in MB that the batch report service allows for an email attachment.

Requests to deliver email messages are sent to the deliveryService service. If very large email attachments are causing memory errors on the server that hosts the deliveryService service, the value of this setting may need to be adjusted. If an email attachment that a request generates exceeds the specified amount, the attachment is removed and replaced with an error message in the body of the email.

Use a value of 0 to specify that the size of an attachment is unlimited.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 15

  • must contain a value greater than or equal to 0

  • can be acquired from a containing object

New in Version 10.1.0 — New Email Configuration Parameters

This property was added.

brsMaximumProcesses

Specifies the maximum number of batch report service processes that can be started by a dispatcher during non-peak hours.

This property

  • is of type nonNegativeInteger

    is encoded as type tns:nonNegativeIntegerProp

  • has a default value of 2

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

brsNonAffineConnections

Specifies the number of connections that a batch report service process can use to execute low affinity requests during non-peak hours. This property limits the number of low affinity requests that can be executed concurrently by a batch report service process.

Low affinity requests establish the context for requests that may follow by caching information. Low affinity requests usually take longer to execute than subsequent high affinity requests. There are no benefits to sending low affinity requests to a particular process because these requests do not use cached information.

Low affinity requests are used to execute reports, extract parameter information from a report, obtain parameter values for a report, retrieve metadata, test data source connections, and validate report specifications.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 4

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.2.0 — Updated default settings for Report Service and Batch Report Service

Changing default value to 4.

brsPDFCharacterEncoding

Specifies the character encoding for PDF documents created by the batch report service.

This property

  • is of type bibus » pdfCharacterEncodingEnum

    is encoded as type tns:pdfCharacterEncodingEnumProp

  • has a default value of auto

  • can be acquired from a containing object

New in Version 8.3 — PDF Configuration Parameters

This property was added.

brsPDFCompressionLevel

Specifies the compression level for PDF documents created by the batch report service.

A higher value indicates that more compression is applied. This increases the time required to create and to open the PDF documents. The value 0 means no compression, while the value 9 means maximum compression.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 9

  • must contain a value greater than or equal to 0

  • must contain a value less than or equal to 9

  • can be acquired from a containing object

New in Version 8.3 — PDF Configuration Parameters

This property was added.

Related information:
bibus » batchReportService » brsPDFCompressionType property
brsPDFCompressionType

Specifies the PDF compression type for PDF documents created by the batch report service.

This property

New in Version 8.3 — PDF Configuration Parameters

This property was added.

Related information:
bibus » batchReportService » brsPDFCompressionLevel property
brsPDFEmbedFonts

Specifies whether the batch report service should embed fonts in generated PDF documents.

This property

  • is of type bibus » pdfFontEmbeddingEnum

    is encoded as type tns:pdfFontEmbeddingEnumProp

  • has a default value of allow

  • can be acquired from a containing object

New in Version 8.3 — PDF Configuration Parameters

This property was added.

brsPeakAffineConnections

Specifies the number of connections that a batch report service process can use to execute high affinity requests during peak hours. This property limits the number of these requests that can be executed concurrently by a batch report service process.

High affinity requests are requests that are closely associated with a particular process. These requests are usually executed faster than low affinity requests.

If the request is sent to a different process, that process usually requires more time to execute the request because it must perform all the activities performed by the process that received the previous request.

For example, when requesting the next page of report output, the request can be executed most efficiently by the process that executed the previous request in the conversation.

High affinity requests are used to save report output, print report output, send report output by email, move between pages of report output, and move forward and backward in prompt pages.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 2

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.3 — Improve Batch Processing

This property was added.

New in Version 10.2.0 — Updated default settings for Report Service and Batch Report Service

Changing default value to 2.

brsPeakMaximumProcesses

Specifies the maximum number of batch report service processes that can be started by a dispatcher during peak hours.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 2

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.3 — Improve Batch Processing

This property was added.

brsPeakNonAffineConnections

Specifies the number of connections that a batch report service process can use to execute low affinity requests during peak hours. This property limits the number of low affinity requests that can be executed concurrently by a batch report service process.

Low affinity requests establish the context for requests that may follow by caching information. Low affinity requests usually take longer to execute than subsequent high affinity requests. There are no benefits to sending low affinity requests to a particular process because these requests do not use cached information.

Low affinity requests are used to execute reports, extract parameter information from a report, obtain parameter values for a report, retrieve metadata, test data source connections, and validate report specifications.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 4

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.3 — Improve Batch Processing

This property was added.

New in Version 10.2.0 — Updated default settings for Report Service and Batch Report Service

Changing default value to 4.

runningState

Specifies the running state of the service.

This property

runTimeState

Contains the run-time state information.

This property

  • must have at most 1 item

systemMetricThresholds

Contains the set of system metric thresholds.

New in Version 8.3 — System Metrics

This property was added.