Metric editor

Analytical Designer includes the metric editor of GoodData Cloud. Users create and change metrics, written in MAQL, while they build a visualization. They don’t have to leave Analytical Designer or your application. The editor comes with the AnalyticalDesigner component, both standalone and when the Dashboard component opens it, and needs no setup.

Where it appears

• Create metric at the top of the catalog opens the editor for a new metric. The button is disabled while the workspace has no data.
• The details of a metric in the catalog have an Edit button, or a View button when the user can’t edit the metric.

The editor opens as a panel over Analytical Designer. It keeps each metric in its own tab, so the user can work on several metrics at once. The user can minimize the panel and go back to the visualization. If the user leaves Analytical Designer with unsaved metric changes, Analytical Designer asks for confirmation first.

Who can create and edit metrics

The rules follow the enableMetricPermissions setting of the workspace:

Everyone else opens metrics read-only, through View.

What changes for your application

A saved or deleted metric changes data that your application may have cached:

• AnalyticalDesigner calls cacheReset.resetAll before it reloads its own data, and emits the metricsChanged event. Pass cacheReset when your backend caches, and use metricsChanged in onEvent to refresh the rest of your application. See Keep a shared cache fresh.
• In the Dashboard component, the same moment emits GDC.DASH/EVT.INSIGHT_EDITOR.CACHE_RESET_REQUESTED with the scope "all". See Keep a caching backend fresh.

The MAQL editor runs part of its work in a web worker. The worker ships bundled with the package, so it needs no bundler configuration.