agentService

Defines run-time configuration parameters for the agentService.

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

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.

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.