Optimize Aggregation

Improves the performance of ASO cubes. You must first enable query tracking to capture tracking statistics on the aggregate storage cube. Then, after you enable query tracking, you must allow sufficient time to collect user data-retrieval patterns before you execute the aggregation process based on query data. The execute aggregation process deletes existing aggregated views and generates optimized views based on the collected query tracking data.

This job has two actions: Enable query tracking and Execute aggregation process.

REST Resource

Request

POST     /HyperionPlanning/rest/{api_version}/applications/{application}/jobs/{jobId}

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic to all jobs, see Execute a Job.

Table 5-23 Parameters

Name Description Required Default
jobType Optimize Aggregation Yes None
jobName The job name to be used for this job execution No Optimize Aggregation
parameters Parameters required for the job Yes None
cubeName Name of the ASO cube Yes None
type Can take one of these values: enableQueryTracking or executeAggregationProcess Yes None
useQueryData (Based on query data) – Permissible values: true or false. Applicable only if type is executeAggregationProcess. No None
includeAlternateRollups Include rollup option - Permissible values: disable or enable. Applicable only if type is executeAggregationProcess. No None
growthSizeRatio Include growth size option – Value can be a real number such as 1.01. Applicable only if type is executeAggregationProcess . No None

Sample Payload

Example 1: This request will enable query tracking on the Vis1ASO cube.

{
    "jobType": "Optimize Aggregation",
    "jobName": "CubeOptimizeAggr",
    "parameters": {
        "cubeName": "Vis1ASO",
        "type": "enableQueryTracking"
    }
}

Example 2: This request will execute the aggregation process on the Vis1ASO cube.

{
    "jobType": "Optimize Aggregation",
    "jobName": "CubeOptimizeAggr",
    "parameters": {
        "cubeName": "Vis1ASO",
        "type": "executeAggregationProcess"
    }
}

Example 3: This request will execute aggregation process on the Vis1ASO cube. Aggregation process will use the query tracking data, will not include alternate roll ups, and use growth size ratio as 1.01.

{
    "jobType": "Optimize Aggregation",
    "jobName": "CubeOptimizeAggr",
    "parameters": {
        "cubeName": "Vis1ASO",
        "type": "executeAggregationProcess",
        "useQueryData": "true",
        "includeAlternateRollups": "disable",
        "growthSizeRatio": "1.01"
    }
}