adaptiveAnalyticsService

Defines run-time configuration parameters for the adaptive analytics service.

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

What's new

New in Version 10.1.0 — Adaptive Analytics Service

This class was added.

Related information:

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

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.