deliveryService

Defines run-time configuration parameters for the deliveryService.

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

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

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

This class

Container Information

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

Properties

This class has the following properties.

advancedSettings

Specifies advanced configuration information in XML format.

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

For more information, see Advanced settings.

This property

  • is of type anyType

    is encoded as type tns:anyTypeProp

  • can be acquired from a containing object

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.

runningState

Specifies the running state of the service.

This property

runTimeState

Contains the run-time state information.

This property

  • must have at most 1 item

systemMetricThresholds

Contains the set of system metric thresholds.

New in Version 8.3 — System Metrics

This property was added.