Logi Composer 5.9 Release Notes

The following enhancements and updates were made to Composer in version 5.9. See the following topics:

Email salesteam@logianalytics.com to purchase Composer.

New Long-Term Support (LTS) Release

Logi Composer 5.9 is now the newest LTS release in the Zoomdata and Composer product line. A new rapid release for Composer is in development. See Logi Composer (Zoomdata) Release Vehicles.

Installation Changes

The following installation changes occur with this release:

  • This version of Composer now uses PostgreSQL 12 for its metadata store. In past versions, PostgreSQL 9.5 was used.

    The upgrade to Composer 5.9 or later from a Composer version prior to 5.9, will usually successfully upgrade the PostgreSQL code and your Composer metadata store automatically. In addition, the previous PostgreSQL 9.5 installation is retained to ensure that data is not lost if the upgrade should fail.

    Before you attempt to upgrade to Composer 5.9, be sure to back up your metadata store. See Backing Up and Restoring the Metadata Store.

    If you are upgrading to Composer 5.9 or later, consider the following possible PostgreSQL migration issues:

    • No check for available disk space is performed during the upgrade. So the PostgreSQL automatic upgrade might fail if there is not enough available disk space to accommodate it. The Bootstrap installation procedure cannot predict the required amount of free disk space it will need.

    • If your installation uses an external PostgreSQL instance for Composer's metadata store, you must disable the automatic PostgreSQL upgrade in the Bootstrap procedure before you upgrade Composer.

    If either of these migration issues is true for your installation, you can disable the automatic PostgreSQL upgrade using the Bootstrap ZOOMDATA_POSTGRES_DISABLE_UPGRADE option. This option must be exported before running the Bootstrap procedure (for example by running export ZOOMDATA_POSTGRES_DISABLE_UPGRADE=TRUE).

    After running the Bootstrap procedure with the PostgreSQL upgrade disabled, you must manually upgrade your PostgreSQL metadata store to PostgreSQL 12 before you can use Composer 5.9.

  • Support for CentOS 6 will be deprecated when it is no longer supported by Red Hat Enterprise Linux (RHEL). A special installation Bootstrap procedure, called bootstrap-zoomdata-centos6.run, must be used to install or upgrade to Composer 5.9 or later in a CentOS 6 environment. The regular Bootstrap procedure will fail in CentOS 6 environments. In addition, manual steps to install OpenJDK 11 in a CentOS 6 environment must be performed. See Manually Installing OpenJDK 11.

  • Support for CentOS 8 and Red Hat Linux 8 have been added in this release.

  • Ubuntu 14 is no longer an officially supported platform for Logi Composer. Its binaries have been removed from the Composer software.

  • Support for Ubuntu 18 has been added in this release.

Migration Considerations

The following migration issues should be considered for this release:

  • The API privilege ROLE_SAVE_DASHBOARDS has been deprecated in this release and will be removed in a future release. Use ROLE_CREATE_DASHBOARDS for all new API calls. All existing groups that had the ROLE_SAVE_DASHBOARDS privilege granted are automatically migrated to ROLE_CREATE_DASHBOARDS. However, if your organization has integrated Composer API calls into third-party software, you will need to manually change all references of ROLE_SAVE_DASHBOARDS to ROLE_CREATE_DASHBOARDS. See Group Privilege Reference.

  • Review the PostgreSQL 12 information in Installation Changes. It contains possible migration considerations regarding your metadata store.

    Before you attempt to upgrade to Composer 5.9, be sure to back up your metadata store. See Backing Up and Restoring the Metadata Store.
  • The supplied palette names ZoomSequential and ZoomPalette were renamed DefaultSequential and DefaultQualitative, respectively. If you use the original names, be sure to change them.

Product Rebranding Updates

The following product rebranding updates occurred in this release.

  • The base URL for Composer changed from zoomdata to composer. However, the use of zoomdata in the base URL is still supported to provide backward API compatibility.

    • The link to log into the Composer UI changed to include composer instead of zoomdata. It is now https://<composer-url>/composer.
    • The link for the Composer API changed to include composer instead of zoomdata. It is now https://<composer-url>/composer/api.
    • The link for the Composer REST API documentation changed to include composer instead of zoomdata. It is now https://<composer-URL>/composer/swagger-ui.html.
  • References to Zoomdata were changed to Composer on many additional UI screens, including supervisor UI screens.

  • The supplied palette names ZoomSequential and ZoomPalette were renamed DefaultSequential and DefaultQualitative, respectively.

Authorization Updates

The following authorization updates were made in this release.

  • A new UI privilege, Can Manage Dashboard Permissions (API privilege ROLE_PERMISSION_DASHBOARDS), is added in this release. Use this privilege to control whether users can assign permissions to a dashboard. If your user has the Can Administer Dashboards privilege, they automatically have this privilege as well.

  • The UI privilege Can Save Visuals & Dashboards has been renamed Can Create Dashboards in this release. Use this privilege to control whether users can create dashboards in Composer. If this privilege is not granted, the button is not available in the dashboard library. In addition, if this privilege is not granted, you cannot import a dashboard or make of copy a dashboard using the Save As dialog.

    A new API privilege associated with this UI privilege, ROLE_CREATE_DASHBOARDS, has been added in this release. It replaces the API privilege ROLE_SAVE_DASHBOARDS, which has been deprecated in this release and will be removed in a future release. Use ROLE_CREATE_DASHBOARDS for all new API calls. All existing groups that had the ROLE_SAVE_DASHBOARDS privilege granted are automatically migrated to ROLE_CREATE_DASHBOARDS. However, if your organization has integrated Composer API calls into third-party software, you will need to manually change all references of ROLE_SAVE_DASHBOARDS to ROLE_CREATE_DASHBOARDS.

  • The UI privilege Can Share Visuals & Dashboards has been renamed Can Generate Dashboard Public Link in this release and can still be used to generate a dashboard public link that can be shared externally with non-Composer users or with users in a different Composer account using the API endpoint /api/dashboards/{id}/key. (The associated API privilege, ROLE_SHARE_DASHBOARDS, remains unchanged.) However, the functionality controlled by this privilege (the ability to publicly share links from Composer) is officially deprecated and is replaced by the new dashboard authorization feature. In a future release, both the UI privilege and the API privilege will be removed from the Composer software.

See Group Privilege Reference.

Dashboard Authorization and Other Dashboard Changes

This release introduces dashboard authorization, the ability to permit your account or specific groups in your account to read, write, or delete a dashboard. To manage dashboard authorization, you must be an administrator or your user definition must be a member of a group assigned the Can Manage Dashboard Permissions(ROLE_PERMISSION_DASHBOARDS) privilege. For complete information, see About Dashboard Authorization.

API updates were made to support dashboard authorization. See API Changes.

A new option in a new Permissions column in the UI dashboard library allows you to specify dashboard permissions for a dashboard. When selected, a new Dashboard Permissions dialog appears. You can use the dialog to grant and revoke read, write, and delete permissions for specific dashboards to your entire account or to groups of users in your account.

With the introduction of dashboard authorization, the ability to share a dashboard as you did before from the Save or Save As dialogs for a dashboard is deprecated. Instead, use dashboard authorization to perform this function. See About Dashboard Authorization. Finally, the API endpoints and UI and API privileges associated with this functionality are also officially deprecated. They will be removed in a future release. See What's Deprecated?

API Changes

The following changes were made to the API in this release.

  • The accountId parameter is now deprecated and will be removed from the following API endpoints in a future release:

    • GET /api/actions
    • DELETE /api/actions/{id}
    • POST /api/actions/{id}/invoke
    • GET /api/dashboards/export
    • GET /api/groups
    • GET /api/inventory
    • GET /api/sources/name/{name}
    • GET /api/sources
    • POST /api/upload/{sourceId}
    • DELETE /api/upload/{sourceId}
    • GET /api/preferences
    • GET /api/users
    • GET /api/visuals
  • The following changes have been made to API endpoints to support dashboard authorization.

    • The GET /api/user/permissions/dashboards/<dashboardid> endpoint was added to retrieve the user permissions for a specific dashboard.

    • The GET /api/dashboards/<dashboardid>/acls endpoint was enhanced to retrieve the group or account permissions for a specific dashboard.

    • The PUT /api/dashboards/<dashboardid>/acls/bulk endpoint was enhanced to update the group or account permissions for one or more groups.

    • The response from the GET /api/inventory/<type>/<id> endpoint was enhanced to include the read, write, and delete permissions assigned to a dashboard for the current user in the dashboard library. A new section "permissions" has been added to the response.

  • The visualizations container in the response from a GET or PATCH /api/sources/<id> request is deprecated. The code will be removed in a future release.

  • The JSON file used as input to the /customization/themes API endpoint has been enhanced as listed below to provide palette specifications that can be used by visuals. This functionality replaces the default color palette settings specified in data source configurations in prior releases.

    • Color palette definitions can now be specified in a new palettes property inside the variables section of the JSON file. A DefaultSequential palette is supplied with your installation. Use this supplied palette as a template for your own.
    • References to palette definitions can be specified in the base settings for charts in the customProperties section. The reference is specified using the palette property, which can be set to a supplied color palette or to a palette defined in the JSON file. The base palette can also be overridden for specific visual styles in the same section of the JSON.
    • The supplied palettes ZoomSequential and ZoomPalette were renamed DefaultSequential and DefaultQualitative, respectively.

    A sample JSON file is provided in Sample Themes JSON File.

API documentation is provided with your Composer installation at this link: https://<composer-URL>/composer/swagger-ui.html.

User Interface Changes

The following changes were made to the user interface in this release:

  • Data source configuration default color settings for visuals have been removed. Color palettes are now defined for the Composer environment and are assigned to visuals using themes. See Manage Composer v5 UI Themes. For more information on the changes to the JSON file used as input to the themes API endpoints to support color palettes, see API Changes.

    Color settings can still be set for individual visuals in the UI and a new Inherit from theme option is available on the Color sidebar of a visual. Select this option to use the theme colors for the visual, regardless of which palette might already be selected on the Color sidebar. See Changing Color Schemes.

  • The dashboard library no longer shows thumbnail view or a dashboard preview in the preview panel. This view and the preview panel are deprecated. See Using the Dashboard Library.

  • A new option in a new Permissions column in the UI dashboard library allows you to specify dashboard permissions for a dashboard. When selected, a new Dashboard Permissions dialog appears. You can use the dialog to grant and revoke read, write, and delete permissions for specific dashboards to your entire account or to groups of users in your account.

  • The ability to share a dashboard via a dashboard link with users outside of your account is officially deprecated. If you need this functionality, contact your Technical Support representative.

  • The dialogs Save Options and Save As Options for a dashboard no longer include the Share Dashboard with users in my account option. To share a dashboard with users in your account, use dashboard authorization. See About Dashboard Authorization.

  • The Export sidebar for visuals has been replaced with Export pop-up dialogs. In past releases, the Export sidebar appeared to the left of the visual. See Exporting Visuals.
  • You can now specify custom values for attribute filters. A new Customize field appears on the filter sidebar. To create and select a custom value, enter the value in the Customize field and select Add. Your custom field is added and selected in the list of possible values. To remove the custom value, uncheck it in the list of possible values. It is removed from the filter and from the list of possible values for the filter. See Setting an Attribute Filter.

What's Fixed?

The following problems were fixed in this release:

  • The text on the Export dialog when a dashboard is exported as a PNG file has been changed to read "Click the image to download the PNG snapshot."

  • Histograms no longer break when one of the fields is named Count.

  • The known issue described in the 5.8 Release Notes concerning the error 500s that you might have received with the Java JDK 11 migration has been resolved.

What's Deprecated?

The following platforms, software and features are no longer supported in this release.

  • Support for CentOS 6 will be deprecated when it is no longer supported by Red Hat Enterprise Linux (RHEL). A special installation Bootstrap procedure, called bootstrap-zoomdata-centos6.run, must be used to install or upgrade to Composer 5.9 or later in a CentOS 6 environment. The regular Bootstrap procedure will fail in CentOS 6 environments. In addition, manual steps to install OpenJDK 11 in a CentOS 6 environment must be performed. See Manually Installing OpenJDK 11.

  • Ubuntu 14 is no longer an officially supported platform for Logi Composer. Its binaries have been removed from the Composer software.

  • The supplied View All group is officially deprecated. It will be removed from the product in a future release. See About Supplied Group Definitions.

  • The accountId parameter is now deprecated and will be removed from the following API endpoints in a future release:

    • GET /api/actions
    • DELETE /api/actions/{id}
    • POST /api/actions/{id}/invoke
    • GET /api/dashboards/export
    • GET /api/groups
    • GET /api/inventory
    • GET /api/sources/name/{name}
    • GET /api/sources
    • POST /api/upload/{sourceId}
    • DELETE /api/upload/{sourceId}
    • GET /api/preferences
    • GET /api/users
    • GET /api/visuals
  • The visualizations container in the response from a GET or PATCH /api/sources/<id> request is deprecated. The code will be removed in a future release.

  • The dashboard library no longer shows thumbnail view or a dashboard preview in the preview panel. This view and the preview panel are deprecated. See Using the Dashboard Library.

  • Default color settings are no longer set for visuals in data source configurations. Instead, use themes to define color palettes for the environment and to assign them to visuals and use the Color sidebar in the UI to specify other color settings for individual visuals. See Manage Composer v5 UI Themes and Changing Color Schemes.

  • The supplied palette names ZoomSequential and ZoomPalette are deprecated. These palettes were renamed DefaultSequential and DefaultQualitative, respectively. Please use these new names.
  • The API privilege ROLE_SAVE_DASHBOARDS has been deprecated in this release and will be removed in a future release. Use ROLE_CREATE_DASHBOARDS for all new API calls. All existing groups that had the ROLE_SAVE_DASHBOARDS permission granted are automatically migrated to ROLE_CREATE_DASHBOARDS. However, if your organization has integrated Composer API calls into third-party software, you will need to manually change all references of ROLE_SAVE_DASHBOARDS to ROLE_CREATE_DASHBOARDS. See Group Privilege Reference.

  • The ability to share a dashboard with users within your account from the Save and Save As dashboard dialogs has been deprecated. Use the new dashboard authorization feature instead.

  • The ability to share a dashboard via a dashboard link with users outside of your account is officially deprecated. If you need this functionality, contact your Technical Support representative.

    The UI privilege Can Share Visuals & Dashboards (API privilege ROLE_SHARE_DASHBOARDS) associated with this functionality has been renamed Can Generate Dashboard Public Link (same API privilege), but is officially deprecated in this release. Both the UI and API privileges will be removed in a future release.