3.3 Migration Guide

In this document, we will see the major steps to migrate from 3.2 to 3.3.

Please check the change log for detailed list of fixes, changes and improvements introduced in 3.3.

Database migration

Migration scripts are available there.

Breaking Changes

If you have not overridden the code of BI module, you can ignore this section.

Renamed field in BiDashboardFilter

The field field in BiDashboardFilter has been renamed to column. Update all references to this field in custom code.

Changed type of logicalOperator in BiDashboard

The field logicalOperator in BiDashboard has been changed from an integer to an enum. Update any code that sets or reads this field as a raw integer.

Changed method signature in BiDashboardFilterService

The method getRlsFilter now accepts a BiDashboard instead of a list of filters:

Old signature New signature

getRlsFilter(List<BiDashboardFilter> biDashboardFilters, Object context)

getRlsFilter(BiDashboard biDashboard, Object context)

Removed method

The method addFilterToClauses has been removed from BiDashboardFilterHelper. The logic has been inlined into its single caller.

Removed field

The field isPublished has been removed from BiDashboard.

Dashboard menu name prefix change

The prefix of menus generated from BI dashboards has changed from studio-menu-dashboard- to bi-dashboard-. Existing menus are migrated by the SQL migration script.

If you have extended any view that references menus by name using the old prefix studio-menu-dashboard-, update those references to use the new prefix bi-dashboard-.

Removed method in BiChartController/BiChartService (3.3.1)

The following methods have been removed:

  • BiChartController.exportDataInCSVFormat

  • BiChartService.exportDataInCSVFormat

Upgrade dependencies

The following dependencies have been upgraded:

  • bi-studio-api-client to 2.3.x

  • embedded-sdk to 0.1.3