IExecutionDefinition
Execution definition contains 100% complete description of what will the execution compute and how will the resulting data look like.
export interface IExecutionDefinition
Remarks
While the execution definition is part of the public API, it is a low-level structure and as such SHOULD NOT be used in the typical application code. The UI.SDK offers several convenience layers to construct the execution definition. The typical flows start in the Analytical Workspace.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| Attributes to slice the results by. MAY be empty. If not specified, then measures MUST be specified. | ||
| IBucket[] | Buckets describe logical grouping within attributes and measures - they serve as a metadata about the execution. They ARE NOT used during the execution itself. MAY be empty. | |
| Dimensionality and contents of dimensions. MUST be specified. The dimensions specify how the result should be organized. For instance which attributes should be used to slice the row dimension, in which dimension should the measures be located. | ||
| (Optional) additional configuration of the execution | ||
| IFilter[] | Filters to apply during the execution. MAY be empty. | |
| IMeasure[] | Measures to calculate. MAY be empty. If not specified, then attributes MUST be specified. | |
| (Optional) Contains any configuration that should be done with the data after they are obtained from the server and before they are passed to the user. | ||
| Sorting to apply on the results. MAY be empty. | ||
| string | Analytical Workspace against which the execution should be run. |
Property details
IExecutionDefinition.attributesproperty
Attributes to slice the results by. MAY be empty. If not specified, then measures MUST be specified.
readonly attributes: IAttribute[];
IExecutionDefinition.bucketsproperty
Buckets describe logical grouping within attributes and measures - they serve as a metadata about the execution. They ARE NOT used during the execution itself. MAY be empty.
readonly buckets: IBucket[];
IExecutionDefinition.dimensionsproperty
Dimensionality and contents of dimensions. MUST be specified.
The dimensions specify how the result should be organized. For instance which attributes should be used to slice the row dimension, in which dimension should the measures be located.
readonly dimensions: IDimension[];
IExecutionDefinition.executionConfigproperty
additional configuration of the execution
readonly executionConfig?: IExecutionConfig;
IExecutionDefinition.filtersproperty
Filters to apply during the execution. MAY be empty.
readonly filters: IFilter[];
IExecutionDefinition.measuresproperty
Measures to calculate. MAY be empty. If not specified, then attributes MUST be specified.
readonly measures: IMeasure[];
IExecutionDefinition.postProcessingproperty
Contains any configuration that should be done with the data after they are obtained from the server and before they are passed to the user.
readonly postProcessing?: IPostProcessing;
IExecutionDefinition.sortByproperty
Sorting to apply on the results. MAY be empty.
readonly sortBy: ISortItem[];
IExecutionDefinition.workspaceproperty
Analytical Workspace against which the execution should be run.
readonly workspace: string;