Skip to main content

​
Introduction

Atoti organizes cubes into catalogs and schemas, both coordinated by a top-level manager. The StartBuilding fluent API is the entry point for defining all of these objects. If the application is complex and cover several use cases, it is possible to define several cubes in the same application. We organize them using catalogs and schemas:
  • A catalog is a collection of cubes.
  • A schema is a collection of cubes that have the same selection on the underlying database. It means that the cubes inside a same schema are based on the same data.
The manager will orchestrate catalogs and schemas. This is the highest entity. All these objects can be described using the StartBuilding fluent builder.

​
Create selection, managers, catalogs and schemas

​
Create a selection

To create a selection, use StartBuilding.selection():
  • fromBaseStore("storeName") defines the base store
  • withAllReachableFields() adds all the fields reachable from the base store via the references in the database.
  • withField("fieldName") adds one field to the selection
  • withAlias("fieldName", "alias") defines a new name for a field
Adding fields individually:

​
Create managers, catalogs and schemas

To create a selection, use StartBuilding.manager():
  • withSchema("schemaName") defines a schema. The name is optional if there is only one schema. The default name is ” Schema”.
  • withSelection(selection) adds the selection created earlier
  • withCube(cubeDescription) adds a cube description. How to create a cube description is described below.
  • withDistributedCube(cubeDescription) adds a distributed cube description.
  • withCatalog("catalogName) groups the cubes into catalogs. This is optional if there is only one catalog. The default name of catalog is “Catalog”.
Here is a simple example:
Here is a more complex example:
It is possible to give the manager a name to be able to create several. The default name is “Manager”.
The catalogs names are displayed in the UI (as opposed to the managers names and schemas names).

​
Cube Configuration

To create a cube, use StartBuilding.cube("cubeName").

​
Create a minimal cube

The minimal cube only has a single level (so a single hierarchy and a single dimension) and only the native measures ( the contributors count and a timestamp).

​
Add measures and dimensions

To add dimensions, hierarchies and levels please see the dedicated articles. To add measures, the preferred way is Copper. To add simple aggregated measures, use withAggregatedMeasure():
  • choose a common aggregation function with sum("fieldName"), min("fieldName"), max("fieldName"), avg("fieldName")
  • call the aggregation function plugin key otherwise with withAggregateFunctionFunction(pluginKey)
  • optional: choose a folder to visually organize the measure in with withinFolder("folderName")
  • optional: choose a formatter with withFormatter("formatter")
Here is an example that defines several measures:

​
Optional cube configurations

​
Configure the aggregate provider

To add an aggregate provider, please see the dedicated article.

​
Configure the aggregate cache

Queries can be served from an aggregate cache to avoid recomputing aggregates that have already been requested by previous queries. The cache is configured per cube, with options to control its size, the measures it caches, and the branches it covers. Use withAggregatesCache to configure the aggregate cache:
  • withSize() defines the cache size (number of (location, measure) pairs)
  • cachingOnlyMeasures("measure1", "measure2") lists the measures to keep in the cache
See the aggregate cache page for the full set of options, performance considerations, and best practices.

​
Configure the shared context values

The cube description can also define context values for all queries of all users. Use withSharedContextValue to define shared context value:

​
Add a global fact filter

The cube retrieves its data from the database using the selection. It is possible to filter some of the data using a fact filter. The filter is applied when feeding the cube, on the facts in the selection, before any queries happening. The cube retrieves data from the database based on the defined selection. A fact filter can be applied to limit the facts available to the cube. This filter ensures that all queries and updates on the cube respect the specified condition. Any operation performed on the cube, including queries and updates, is constrained by the fact filter. To create a fact filter, use withFactFilter(condition) and define the filtering condition.