跳至主要內容
文件
文件
Adaptive Planning
上次更新時間 ：2024-03-08
Reference: exportData Performance

Reference: exportData Performance

To benefit from exportData performance and scalability optimizations, your requests must use specific API versions, attributes, and elements.
Performance improvements affect standalone exportData API calls and these functionalities that call exportData:
  • Publish Plans.
  • Retrieval of account data from the Adaptive Planning data source in Design Integrations.
See exportData.
API v38 includes a new request and response format, depending on the presence of
stream="true"
 or
stream="false"
 in the
call
 element.

Supported Accounts

The exportData performance and scalability improvements support:
All account types,
except
:
  • System account (includes allocation, minority interest %, elimination, cumulative translation adjustment).
  • Model sheet assumption account.
All modeling features,
except
:
  • Weighted average translation.
  • Text rollups.
  • Spread lookups.
  • Value lookups.

Consuming Applications

  • Publish Plans.
  • Retrieval of account data from the Adaptive Planning data source in Design Integrations.
    • Includes exportData API performance optimization, except for cube data with time stratum.
    • Doesn't include streaming's larger Export Row limit.

exportData Performance and Behavior

The exportData API behaves differently based on these configurations:
API v36
Request includes unsupported account types or properties
stream
 attribute
Response Format
Export Row Limit
Performance Optimizations
No
Unavailable
No change
500K
Yes
Yes
Unavailable
No change
500K
No
API v38
Request includes unsupported account types or properties
stream
 attribute
Response Format
Export Row Limit
Performance Optimizations
No
Absent or
false
Non-streaming
500K
Yes
No
true
Streaming
2 million
Yes
API v39
Request includes unsupported account types or properties
stream
 attribute
Response Format
Export Row Limit
Performance Optimizations
No
Absent or
false
Non-streaming
500K
Yes
No
true
Streaming
2 million
Yes
Yes
true
Non-streaming
500K
No
Yes
false
Non-Streaming
500K
No
Updates to exportData API v36 and beyond
The table below lists enhancements for the performance optimized path introduced in 2024R1 for exportData API v36 and beyond, as part of the exportData API Performance Optimization feature.
exportData API
Non-optimized Behavior
Optimized Behavior
User doesn’t have access to ALL account, level combinations for a dimension in DAC rule and that dimension is not included in the exportData API request.
Response doesn’t return data for account in cube sheet or model sheet which:
  • Includes the dimension.
  • Has data against the dimension value user has access to as well as the uncategorized dimension value.
Response returns rows with the uncategorized value for the dimension.
API request with a dimension included in both places:
  • <dimensions>
     block (e.g. through
    <dimension>
     or
    <dimensionIds>
     element).
  • As value of
    directChildrenofDimension
     attribute of the
    <dimensionValue>
     element in the
    <dimensionValues>
     block.
Response doesn't return any rows for the direct children of the dimension or the dimension.
Response returns rows for the rollup value of the direct children and row for the uncategorized value of the dimension.
API request on a cube account with dimension specified in both places:
  • <dimensions>
     block (e.g. through
    <dimension>
     or
    <dimensionIds>
     element).
  • As value of
    dimName
     attribute of the
    <dimensionValue>
     element, which has empty value for the
    name
     attribute, in the
    <dimensionValues>
     block.
Response doesn’t return any rows for the direct children of the dimension or the dimension.
Response returns rows for the dimension rollup or the direct children rollup, as well as the uncategorized value of the dimension based on the values specified for the
directChildren
 and the
uncategorized
 attributes within the
<dimensionValue>
 element.
API request on
directChildren
 of a level dimension value for an account in a cube sheet that doesn’t include the level dimension.
Response doesn’t return rows for level contributed to the rollup values of the direct children of the level dimension value.
Response returns rows for level contributed to the rollup values of the direct children of the level dimension value.