configurationFolder

Defines a configuration folder.

Use this class to organize bibus » dispatcher objects into hierarchies to simplify the configuration of IBM® Cognos® Analytics. This class defines run-time configuration parameters for the dispatcher, as well as other services that are managed by the dispatcher.

Values for many of the properties of this class can be acquired from its parent object. In addition, values for these properties can be acquired by its child objects. You can take advantage of property acquisition to simplify the configuration of IBM Cognos Analytics installations.

For example, you can share a common configuration for five dispatchers by placing the bibus » dispatcher objects for those dispatchers into the same configurationFolder, so that the property values from the configurationFolder object are acquired by the five dispatchers contained within it.

We recommend that you represent instances of this type as non-leaf nodes in a tree structure.

This class

Container Information

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

What's new

New in Version 10.2.0 — Support for interactive discovery and visualization

This class was added.

Properties

This class has the following properties.

aasAffineConnections

Specifies the number of connections that a adaptive analytics 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 adaptive analytics 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.

There are no secondary requests associated with the adaptive analytics service.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasAuditLevel

Specifies the auditing level for the adaptive analytics 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

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasExecutionTimeLimit

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

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasMaximumProcesses

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

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasNonAffineConnections

Specifies the number of connections that a adaptive analytics 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 adaptive analytics 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.

For the adaptive analytics service, low affinity requests are used by client applications of IBM® Cognos® Analytic Applications to retrieve metadata and query information.

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.1.0 — Adaptive Analytics Service

This property was added.

aasPeakAffineConnections

Specifies the number of connections that a adaptive analytics 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 adaptive analytics 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.

There are no secondary requests associated with the adaptive analytics service.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasPeakMaximumProcesses

Specifies the maximum number of adaptive analytics 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 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Adaptive Analytics Service

This property was added.

aasPeakNonAffineConnections

Specifies the number of connections that a adaptive analytics 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 adaptive analytics 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.

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.1.0 — Adaptive Analytics Service

This property was added.

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

ansAnnotationLifetime

Specifies the lifetime of the annotation in XML Schema 1.0 type xs:duration form.

The lifetime is the length of time in days after the entry associated with the annotation is deleted. For example, if the lifetime for an annotation is set to 60 days, the annotation is deleted 60 days after the associated report is deleted.

For an annotation object associated with a reportVersion object, the annotations are deleted when the report is deleted.

The default is 180 days.

This property

  • is of type duration

    is encoded as type tns:durationProp

  • has a default value of P180D

  • can be acquired from a containing object

New in Version 10.1.0 — Annotation Service

This property was added.

ansAuditLevel

Specifies the auditing level for the annotation 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

New in Version 10.1.0 — Annotation Service

This property was added.

asAuditLevel

Specifies the auditing level for the agent 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

asConnections

Specifies the maximum number of connections that a process of the agent service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

asMaximumEMailAttachmentSize

Specifies the maximum amount of uncompressed data in MB that the agent 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.

asPeakConnections

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

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.

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 » configurationFolder » 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 » configurationFolder » 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.

capacity

Specifies the processing capacity of a dispatcher.

Use with the bibus » dispatcher class to indicate the processing capacity of a dispatcher relative to other dispatchers.

For example, if the first dispatcher is twice as fast as the second, set the capacity of the first to 2.0 and the capacity of the second to 1.0. Incoming requests will be directed to these dispatchers in the same relative proportion (2-to-1). That is, the first dispatcher will receive two-thirds of the requests.

Use with the bibus » configuration class and the bibus » configurationFolder class to indicate the processing capacity of all dispatchers in the configuration folder.

When you add a dispatcher to the configuration folder, it automatically inherits the configuration settings of the folder. However, if you change the default values of a dispatcher or service, the dispatcher's properties will take precedence over those of the bibus » configurationFolder class.

This property

  • is of type float

    is encoded as type tns:floatProp

  • has a default value of 1.0

  • must contain a value greater than 0.0

  • can be acquired from a containing object

cmcsAuditLevel

Specifies the auditing level for the content manager cache 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

New in Version 10.1.0 — Content Manager Cache Service

This property was added.

cmcsHeapLimit

Specifies the upper limit of the cache size for the Content Manager cache service. This value is represented as a percentage of the JVM heap size.

The default is 10%.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 10

  • can be acquired from a containing object

New in Version 10.1.0 — Content Manager Cache Service

This property was added.

cmsAuditLevel

Specifies the auditing level for the content manager 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

cmsConnections

Specifies the maximum number of connections that a process of the content manager service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

cmsPeakConnections

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

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.

configuration – obsolete
dasAuditLevel

Specifies the auditing level for the data advisor 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

New in Version 10.1.0 — Updated Support for IBM Cognos Express

This property was added.

dimsAffineConnections

Specifies the number of connections that a dimensionManagement 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 dimensionManagement 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.

There are no secondary requests associated with the dimension management service.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — Dimension Management Service

This property was added.

dimsAuditLevel

Specifies the auditing level for the dimensionManagement 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

New in Version 8.4 — Dimension Management Service

This property was added.

dimsExecutionTimeLimit

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

New in Version 8.4 — Dimension Management Service

This property was added.

dimsMaximumProcesses

Specifies the maximum number of dimensionManagement service processes that can be started by a dispatcher during non-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.4 — Dimension Management Service

This property was added.

dimsNonAffineConnections

Specifies the number of connections that a dimensionManagement 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 dimensionManagement 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.

For this service, low affinity requests are used to run a bibus » dimensionManagementServiceSpecification.

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.4 — Dimension Management Service

This property was added.

dimsPeakAffineConnections

Specifies the number of connections that a dimensionManagement 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 dimensionManagement 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.

There are no secondary requests associated with the dimension management service.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — Dimension Management Service

This property was added.

dimsPeakMaximumProcesses

Specifies the maximum number of dimensionManagement 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.4 — Dimension Management Service

This property was added.

dimsPeakNonAffineConnections

Specifies the number of connections that a dimensionManagement 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 dimensionManagement 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.

For this service, low affinity requests are used to run a bibus » dimensionManagementServiceSpecification class.

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.4 — Dimension Management Service

This property was added.

dimsQueueLimit

Specifies the number of seconds that a request for the dimensionManagement service can be queued before it exceeds the timeout period.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

New in Version 8.4 — Dimension Management Service

This property was added.

disAuditLevel

Specifies the auditing level for the data integration 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

disConnections

Specifies the maximum number of connections that a process of the data integration service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

dispatcherAuditLevel

Specifies the auditing level for the dispatcher(s) .

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

dispatchers

Contains the IBM Cognos Analytics dispatchers.

disPeakConnections

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

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.

dmsAffineConnections

Specifies the number of connections that a data movement 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 data movement 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.

High affinity requests are used to cancel tasks, remove inactive requests from the service cache, and to notify the server that the client is still waiting for the task to complete.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • 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 8.3 — Data Movement Service Configuration Parameters

This property was added.

dmsAuditLevel

Specifies the auditing level for the data movement 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

dmsConnections – deprecated

Specifies the maximum number of connections that a process of the data movement service can use concurrently to execute requests.

For more information, see Tune Server Performance.

This property

  • is of type int

    is encoded as type tns:intProp

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

  • 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 — Data Movement Service Configuration Parameters

This property is deprecated. Use the following properties instead:

dmsExecutionTimeLimit

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

New in Version 8.3 — Data Movement Service Configuration Parameters

This property was added.

dmsMaximumProcesses

Specifies the maximum number of data movement service processes that can be started by a dispatcher during non-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

dmsNonAffineConnections

Specifies the number of connections that a data movement 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 data movement 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 primary requests, such as requests to run a bibus » dataMovementServiceSpecification or a bibus » dataMovementTask.

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 — Data Movement Service Configuration Parameters

This property was added.

dmsPeakAffineConnections

Specifies the number of connections that a data movement 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 data movement 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.

High affinity requests are used to cancel tasks, remove inactive requests from the service cache, and to notify the server that the client is still waiting for the task to complete.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • 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 8.3 — Data Movement Service Configuration Parameters

This property was added.

dmsPeakMaximumProcesses

Specifies the maximum number of data movement 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

dmsPeakNonAffineConnections

Specifies the number of connections that a data movement 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 data movement 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 primary requests, such as requests to run a bibus » dataMovementServiceSpecification or a bibus » dataMovementTask.

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 — Data Movement Service Configuration Parameters

This property was added.

dmsQueueLimit

Specifies the number of seconds that a request for the data movement service can be queued before it exceeds the timeout period.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

New in Version 8.3 — Data Movement Service Configuration Parameters

This property was added.

dsAuditLevel

Specifies the auditing level for the delivery 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

dsCompressAttachmentLimit

Specifies the maximum size, in MB, of an uncompressed email attachment. The delivery service will compress an attachment that is larger than the maximum size before sending it.

Use a value of 0 to disable email attachment compression.

Use a nil value to compress all email attachments.

Setting a non-nil, non-zero value improves performance when sending email messages with large attachments, such as report outputs.

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

New in Version 8.3 — Email Delivery Enhancements

This property was added.

dsConnections

Specifies the maximum number of connections that a process of the delivery service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

dsMaximumEMailSize

Specifies the maximum amount of data in MB that can be placed in an email by the delivery service.

Base this value on your mail server configuration. Please contact your mail server administrator to determine an appropriate value. If email sizes exceed that which your mail server is configured to support, consider a different transfer method.

If the uncompressed size of the email exceeds the specified configuration parameter value, the deliveryService service removes the largest attachments from the message until the total size of the message is lower than the specified configuration parameter value. If an attachment is removed, an error message is created and added as a plain text attachment to the email indicating that the message size has exceeded the configured limit. If the uncompressed size of the email body (for example, an HTML report) exceeds the configured limit, the error message replaces the content of the body.

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

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 0

  • 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.

dsPeakConnections

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

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.

emsAuditLevel

Specifies the auditing level for the event management 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

evsAuditLevel

Specifies the auditing level for the EV 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

New in Version 9.0.0 — Support for IBM Cognos Express

This property was added.

folders

Contains the IBM Cognos Analytics folder hierarchy.

gsAuditLevel

Specifies the auditing level for the graphics 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

New in Version 10.1.0 — Graphics Service

This property was added.

gsExecutionTimeLimit

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

New in Version 10.1.0 — Graphics Service

This property was added.

gsNonAffineConnections

Specifies the number of connections that a graphics 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 graphics 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.

For the graphics service, low affinity requests process requests to generate graphics (charts) for report run requests.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 50

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Graphics Service

This property was added.

New in Version 10.2.1 — Performance enhancements

Changed the default value to 50.

gsPeakNonAffineConnections

Specifies the number of connections that a graphics 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 graphics 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.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 50

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Graphics Service

This property was added.

New in Version 10.2.1 — Performance enhancements

Changed the default value to 50.

gsQueueLimit

Specifies the number of seconds that a request for the graphics service can be queued before it exceeds the timeout period.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

New in Version 10.1.0 — Graphics Service

This property was added.

htsAuditLevel

Specifies the auditing level for the human task 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

New in Version 10.1.0 — Human Task Service

This property was added.

htsCompletedTaskLifetime

Specifies the lifetime of completed human tasks in XML Schema 1.0 type xs:duration form. If the lifetime is set to P90D, the human task will be deleted after 90 days if all linked reports or dashboards are deleted.

The default lifetime is ninety days.

This property

  • is of type duration

    is encoded as type tns:durationProp

  • has a default value of P90D

  • can be acquired from a containing object

New in Version 10.1.0 — Human Task Service

This property was added.

idsAuditLevel

Specifies the auditing level for the index data 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

idsConnections

Specifies the maximum number of connections that a process of the index data service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

idsPeakConnections

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

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.

idVizAuditLevel

Specifies the auditing level for the idViz 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

New in Version 10.2.0 — Support for interactive discovery and visualization

This property was added.

issAuditLevel

Specifies the auditing level for the index search 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

issConnections

Specifies the maximum number of connections that a process of the index search service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

issPeakConnections

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

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.

iusAuditLevel

Specifies the auditing level for the index update 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

iusConnections

Specifies the maximum number of connections that a process of the index update service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

iusPeakConnections

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

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.

jsAuditLevel

Specifies the auditing level for the job 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

jsConnections

Specifies the maximum number of connections that a process of the job service can use concurrently to execute requests.

For more information, see Tune Server Performance.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 20

  • 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.

jsmNonPeakDemandBeginHour – obsolete
jsmNonPeakDemandMaximumJobs – obsolete
jsmPeakDemandBeginHour – obsolete
jsmPeakDemandMaximumJobs – obsolete
jsPeakConnections

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

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 20

  • 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.

loadBalancingMode

Specifies the load balancing mode for a dispatcher or group of dispatchers.

Use this property to indicate which load balancing algorithm should be used for

This property

lsAuditAdminLevel – obsolete
lsAuditLevel – obsolete
lsAuditNativeQuery – obsolete
lsAuditOtherLevel – obsolete
lsAuditUsageLevel – obsolete
mbsAuditLevel

Specifies the auditing level for the mobile 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

mbsConnections

Specifies the maximum number of connections that a process of the mobile service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

mbsPeakConnections

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

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.

mdsAffineConnections

Specifies the number of connections that a metadata 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 metadata 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.

The metadataService does not use this property as this service only processes synchronous requests.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — Lineage Metadata

This property was added.

mdsAuditLevel

Specifies the auditing level for the metadata 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

mdsExecutionTimeLimit

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

New in Version 8.4 — Lineage Metadata

This property was added.

mdsMaximumProcesses

Specifies the maximum number of metadata service processes that can be started by a dispatcher during non-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.4 — Lineage Metadata

This property was added.

mdsNonAffineConnections

Specifies the number of connections that a metadata 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 metadata 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.

For this service, low affinity requests process lineage requests that process metadata in published Framework Manager models as well as in the query section of a report specification.

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.4 — Lineage Metadata

This property was added.

mdsPeakAffineConnections

Specifies the number of connections that a metadata 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 metadata 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.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — Lineage Metadata

This property was added.

mdsPeakMaximumProcesses

Specifies the maximum number of metadata 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.4 — Lineage Metadata

This property was added.

mdsPeakNonAffineConnections

Specifies the number of connections that a metadata 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 metadata 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.

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.4 — Lineage Metadata

This property was added.

mdsQueueLimit

Specifies the number of seconds that a request for the metadata service can be queued before it exceeds the timeout period.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

New in Version 8.4 — Lineage Metadata

This property was added.

misAuditLevel

Specifies the auditing level for the migration 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

New in Version 8.4 — Migration Service

This property was added.

misConnections

Specifies the maximum number of connections that a process of the migration service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.4 — Migration Service

This property was added.

misPeakConnections

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

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.4 — Migration Service

This property was added.

mmsAuditLevel

Specifies the auditing level for the metrics manager 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

mmsConnections

Specifies the maximum number of connections that a process of the metrics manager service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

mmsPeakConnections

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

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.

msAuditLevel

Specifies the auditing level for the monitor 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

nonPeakDemandBeginHour

Specifies the hour of the day at which the non-peak demand time begins.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 18

  • must contain a value greater than or equal to 0

  • must contain a value less than or equal to 23

  • can be acquired from a containing object

New in Version 8.3 — Improve Batch Processing

This property was added.

pacsAuditLevel

Specifies the auditing level for the planning administration console 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

pacsConnections

Specifies the maximum number of connections that a process of the planning administration console service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

pacsPeakConnections

Specifies the number of connections that a planning administration console service process can use to execute requests during peak hours. This property limits the number of these requests that can be executed concurrently by a process.

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.

pdsAuditLevel

Specifies the auditing level for the planning data 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

pdsConnections

Specifies the maximum number of connections that a process of the planning data service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

pdsEListAccessCacheLimit

Specifies the number of seconds that an e-list access rights cache entry can remain in the cache before it must be recalculated.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 3600

  • must contain a value greater than or equal to 0

  • can be acquired from a containing object

pdsMaximumProcesses

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

This property

  • is of type int

    is encoded as type tns:intProp

  • 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.

pdsPeakConnections

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

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.

pdsPeakMaximumProcesses

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

This property

  • is of type int

    is encoded as type tns:intProp

  • 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.

pdsShowCellAnnotations

Specifies whether authoring studios should display cell annotations.

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

peakDemandBeginHour

Specifies the hour of the day at which the peak demand time begins.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 7

  • must contain a value greater than or equal to 0

  • must contain a value less than or equal to 23

  • can be acquired from a containing object

New in Version 8.3 — Improve Batch Processing

This property was added.

ppsAffineConnections

Specifies the number of connections that a PowerPlay 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 PowerPlay 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.

High affinity requests are used to retrieve saved output, and also when a request must go to a particular instance of powerPlayService service.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

ppsAuditLevel

Specifies the auditing level for the PowerPlay 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

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

ppsExecutionTimeLimit

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

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

ppsMaximumEMailAttachmentSize

Specifies the maximum amount of uncompressed data in MB that the PowerPlay 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.

ppsNonAffineConnections

Specifies the number of connections that a PowerPlay 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 PowerPlay 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 a report, and also when a request can be sent to any instance of powerPlayService service.

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.4 — PowerPlay 8 Integration

This property was added.

ppsPeakAffineConnections

Specifies the number of connections that a PowerPlay 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 PowerPlay 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.

The initial request to open an IBM Cognos PowerPlay cube or report is handled as a low affinity request. Most subsequent operations on the open cube or report are handled as high affinity requests.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

ppsPeakNonAffineConnections

Specifies the number of connections that a PowerPlay 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 PowerPlay 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.

The initial request to open an IBM Cognos PowerPlay cube or report is handled as a low affinity request. Most subsequent operations on the open cube or report are handled as high affinity requests.

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.4 — PowerPlay 8 Integration

This property was added.

ppsQueueLimit

Specifies the number of seconds that a request for the PowerPlay service can be queued before it exceeds the timeout period.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

New in Version 8.4 — PowerPlay 8 Integration

This property was added.

prsAuditLevel

Specifies the auditing level for the planning runtime 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

prsConnections

Specifies the maximum number of connections that a process of the planning runtime service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

prsPeakConnections

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

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.

psAuditLevel

Specifies the auditing level for the presentation 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

ptsAuditLevel

Specifies the auditing level for the planning task 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

ptsConnections

Specifies the maximum number of connections that a process of the planning task service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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.

ptsPeakConnections

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

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.

qsAdditionalJVMArguments

Specifies additional arguments that control the JVM. The arguments may vary depending on the JVM.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsAuditLevel

Specifies the auditing level for the query 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

New in Version 10.1.0 — Query Service

This property was added.

qsDiagnosticsEnabled – deprecated

Specifies whether diagnostics information is recorded in a log file.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

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

  • has a default value of false

  • can be acquired from a containing object

New in Version 10.1.0 — Query Service

This property was added.

New in Version 10.2.0 — New queryService configuration options

This property is deprecated.

qsDisableQueryPlanCache – deprecated

Specifies whether query plans are cached for possible re-use. A query plan represents a set of transformations applied to query data objects to obtain desired query results.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

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

  • has a default value of false

  • can be acquired from a containing object

New in Version 10.1.0 — Query Service

This property was added.

New in Version 10.1.1 — Deprecation of qsDisableQueryPlanCache

This property is deprecated.

qsDisableVerboseGCLogging

Specifies whether garbage collection information is recorded in a log file.

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

New in Version 10.2.0 — New queryService configuration options

This property was added.

qsDumpModelToFile

Specifies whether the model is dumped to a file when a query is run.

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

New in Version 10.1.0 — Query Service

This property was added.

qsGCPolicy

Specifies the garbage collection policy used to manage JVM heap storage.

Default: Generational

This property

  • is of type bibus » gcPolicyEnum

    is encoded as type tns:anyURIProp

  • can be acquired from a containing object

New in Version 10.2.0 — New queryService configuration options

This property was added.

qsGenerateCommentsInNativeSQL

Specifies whether comments in native SQL are recorded in a log file.

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

New in Version 10.2.0 — New queryService configuration options

This property was added.

qsIdleConnectionTimeout

Specifies the timeout period, in seconds, for an idle database connection.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 300

  • can be acquired from a containing object

New in Version 10.1.0 — Query Service

This property was added.

qsInitialJVMHeapSize

Specifies the initial size, in MB, of the JVM heap.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1024

  • must contain a value greater than 0

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsInitialJVMNurserySize

Specifies the initial nursery size, in MB, of the JVM. A value of zero indicates that the initial nursery size is system managed.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 0

  • must contain a value greater than or equal to 0

  • can be acquired from a containing object

New in Version 10.2.0 — New queryService configuration options

This property was added.

qsJVMHeapSizeLimit

Specifies the maximum size, in MB, of the JVM heap.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1024

  • must contain a value greater than 0

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsJVMNurserySizeLimit

Specifies the maximum size, in MB, of the JVM nursery. A value of zero indicates that the nursery size limit is system managed.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 0

  • must contain a value greater than or equal to 0

  • can be acquired from a containing object

New in Version 10.2.0 — New queryService configuration options

This property was added.

qsManualCubeStart

Specifies whether ROLAP cubes are started manually.

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

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsMetricsEnabled – deprecated

Specifies whether metrics information is recorded in a log file.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

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

  • has a default value of false

  • can be acquired from a containing object

New in Version 10.1.0 — Query Service

This property was added.

New in Version 10.2.0 — New queryService configuration options

This property is deprecated.

qsMultiDimensionalQuerySizeLimit

Specifies memory size, in MB, allotted to each locally executed multi-dimensional query. A value of 0 means the memory size is limited to available system memory.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 0

  • must contain a value greater than or equal to 0

  • can be acquired from a containing object

New in Version 10.2.0 — IBM Cognos Dynamic Cubes Aggregate Advisor configuration

This property was added.

qsQueryExecutionTrace

Specifies whether information tracing the execution of queries is recorded in a log file.

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

New in Version 10.1.0 — Query Service

This property was added.

qsQueryPlanningTrace

Specifies whether information tracing the development of query plans is recorded in a log file.

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

New in Version 10.1.0 — Query Service

This property was added.

qsResultSetCacheQueryTimeThreshold

Specifies the minimum time, in milliseconds, that must elapse during the construction of a result set before it is considered for caching.

Important: The unit of measurement for this configuration parameter is milliseconds (1/1000th of a second) whereas other configuration parameters that specify a duration use seconds.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 50

  • must contain a value greater than or equal to 1

  • must contain a value less than or equal to 1000

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsROLAPCubeAdministrationCommandTimeout

Specifies the time, in seconds, that the queryService will wait for internal resources to become available while executing a ROLAP cube administration command. If the specified timeout period has elapse without resources becoming available, the queryService will time out.

Use a value of 0 when you do not want the queryService to time out.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 120

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsROLAPCubeConfigurations

Defines configuration data for ROLAP cubes.

This property

  • is an array of type bibus » baseROLAPCubeConfiguration

    is encoded as type tns:baseROLAPCubeConfigurationArrayProp

  • can be acquired from a containing object

New in Version 10.1.1 — IBM Cognos ROLAP Administration

This property was added.

qsROLAPMemberCacheAliasRoot

Reserved.

This property

  • is of type token

    is encoded as type tns:tokenProp

  • can be acquired from a containing object

New in Version 10.2.0 — IBM Cognos Dynamic Cubes Administration

This property was added.

qsVerboseGCLogLimit

Specifies the maximum number of JVM garbage collection cycles that are logged when bibus » configurationFolder » qsDisableVerboseGCLogging is enabled.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1000

  • must contain a value greater than 0

  • can be acquired from a containing object

New in Version 10.2.0 — New queryService configuration options

This property was added.

rdsAuditLevel

Specifies the auditing level for the report data 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

rdsGatewayMappings

Contains the mappings between the internal and external PowerPlay® gateways.

This property

  • is an array of type bibus » gatewayMapping

    is encoded as type tns:gatewayMappingArrayProp

  • can be acquired from a containing object

rdsMaximumDataSize

Specifies the maximum amount of data that can be read from a content provider in MB.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 10

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

reposAuditLevel

Specifies the auditing level for the repository 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

New in Version 10.2.0 — Repository service

This property was added.

reposCacheObjTTL

Reserved.

This property

  • is of type positiveInteger

    is encoded as type tns:positiveIntegerProp

  • has a default value of 1200

  • can be acquired from a containing object

New in Version 10.2.0 — Repository service

This property was added.

reposNumObjDisk

Reserved.

This property

  • is of type positiveInteger

    is encoded as type tns:positiveIntegerProp

  • has a default value of 1000

  • can be acquired from a containing object

New in Version 10.2.0 — Repository service

This property was added.

reposNumObjMem

Reserved.

This property

  • is of type positiveInteger

    is encoded as type tns:positiveIntegerProp

  • has a default value of 100

  • can be acquired from a containing object

New in Version 10.2.0 — Repository service

This property was added.

rmdsAffineConnections

Specifies the number of connections that a relational metadata 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 relational metadata 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.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Relational Metadata Service

This property was added.

rmdsAuditLevel

Specifies the auditing level for the relational metadata 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

New in Version 10.1.0 — Relational Metadata Service

This property was added.

rmdsConnections

Specifies the maximum number of connections that a process of the relational metadata service can use concurrently to execute requests.

For more information, see Tune Server Performance.

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 — Relational metadata service

This property was added.

rmdsExecutionTimeLimit

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

New in Version 10.1.0 — Relational Metadata Service

This property was added.

rmdsNonAffineConnections

Specifies the number of connections that a relational metadata 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 relational metadata 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.

Writer comment

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.1.0 — Relational Metadata Service

This property was added.

rmdsPeakAffineConnections

Specifies the number of connections that a relational metadata 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 relational metadata 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.

This property

  • is of type int

    is encoded as type tns:intProp

  • has a default value of 1

  • must contain a value greater than or equal to 1

  • can be acquired from a containing object

New in Version 10.1.0 — Relational Metadata Service

This property was added.

rmdsPeakConnections

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

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 — Relational metadata service

This property was added.

rmdsPeakNonAffineConnections

Specifies the number of connections that a relational metadata 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 relational metadata 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.

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.1.0 — Relational Metadata Service

This property was added.

rsAffineConnections

Specifies the number of connections that a 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 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.

rsAuditLevel

Specifies the auditing level for the 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

rsAuditNativeQuery

Specifies whether to log native query information for the 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

rsChartHotspotLimit

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.

rsDataSourceChange

Specifies the change time of the data source for the 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

rsExecutionTimeLimit

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

rsMaximumEMailAttachmentSize

Specifies the maximum amount of uncompressed data in MB that the 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.

rsMaximumProcesses

Specifies the maximum number of 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

rsNonAffineConnections

Specifies the number of connections that a 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 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 8

  • 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 8.

rsPDFCharacterEncoding

Specifies the character encoding for PDF documents created by the 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.

rsPDFCompressionLevel

Specifies the compression level for PDF documents created by the 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 » configurationFolder » rsPDFCompressionType property
rsPDFCompressionType

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

This property

New in Version 8.3 — PDF Configuration Parameters

This property was added.

Related information:
bibus » configurationFolder » rsPDFCompressionLevel property
rsPDFEmbedFonts

Specifies whether the 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.

rsPeakAffineConnections

Specifies the number of connections that a 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 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.

rsPeakMaximumProcesses

Specifies the maximum number of 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.

rsPeakNonAffineConnections

Specifies the number of connections that a 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 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 8

  • 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 8.

rsQueueLimit

Specifies the number of seconds that a request for the report service can be queued before it exceeds the timeout period.

This property

  • is of type positiveInteger

    is encoded as type tns:positiveIntegerProp

  • has a default value of 240

  • must contain a value greater than or equal to 5

  • can be acquired from a containing object

saCAMAuditLevel

Specifies the auditing level for the saCAM 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

New in Version 10.2.0 — New standalone IBM Cognos Access Manager (CAM) service

This property was added.

New in Version 10.2.1 — New standalone IBM Cognos Access Manager (CAM) service

This previously reserved feature, introduced in Version 10.2.0, is now available for use.

serverGroup

Specifies the server group associated with this object.

Use this property to identify groups of dispatchers in different application server clusters. Dispatchers that share the same value for this property act as a single cluster.

By default, all dispatchers registered in the same content store act as a single, load-balancing cluster. If your installation uses application server clusters, use this property to identify members of different clusters. For example, if you need some of your dispatchers to operate in weightedRoundRobin mode while others operate in clusterCompatible mode, use the serverGroup property to distinguish these groupings. When you group your dispatchers using this property, requests are only forwarded to a dispatcher that is part of the same server group.

You must use this setting in conjunction with the values you have set in the bibus » loadBalancingModeEnum enumeration set to properly contain your dispatchers in groups that use the same load-balancing algorithm. Failure to meet this requirement will result in unpredictable forwarding of requests by dispatchers.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 255 characters

  • can be acquired from a containing object

ssAuditLevel

Specifies the auditing level for the system 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