Logi Composer 5.8 Release Notes

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

Email salesteam@logianalytics.com to purchase Composer.

Installation Changes

This release deprecates Ubuntu 14 as an officially supported platform. Its binaries will be removed from the Composer software in the next release.

In addition, this release deprecates support for Java 8 (1.8.0_131) and it introduces support for Java JDK 11.0.5. The Composer Bootstrap installation script installs OpenJDK 11 on most supported platforms.

Support for CentOS 6 will be deprecated when it is no longer supported by Red Hat Enterprise Linux (RHEL).

If your environment is running CentOS 6, you must manually install OpenJDK 11. OpenJDK 11 is available from various vendors, such as AWS Corretto, OpenJDK11, or Oracle JDK11. See Manually Installing OpenJDK 11.

When you attempt to install or upgrade Composer in a CentOS 6 environment that does not have OpenJDK 11 installed, the installation script will start, but will produce FAIL messages during its execution because of the missing OpenJDK 11 software. When the installation script runs, the Composer binaries are upgraded to the latest version, but you will not be able to start Composer without first manually installing OpenJDK 11.

See also the workaround for a potential Java JDK problem after you upgrade to this release, described in Known Issues.

For information on how Composer validates the version of Java in use, see How Composer Validates an Environment's Java Version.

Authorization Updates

The following authorization updates were made in this release.

  • A new Can Create Scheduled Reports (ROLE_CREATE_DASHBOARD_REPORTS) privilege is added in this release. Use this privilege to control whether users can schedule dashboards.

See Group Privilege Reference.

Dashboard Scheduling

With this release, you can now schedule the capture and delivery of dashboard reports using UI screens and API endpoints. See About Scheduled Dashboard Reports.

If you will be scheduling many concurrent dashboard reports, you should consider altering the memory configuration settings for the Composer installation and Screenshot service pool configuration settings. See Setting Up the Screenshot Microservice.

API Changes

A new endpoint called api/dashboards/<dashID>/reports is introduced in this release to support dashboard scheduling. If your Composer user belongs to a group that has been assigned the Can Create Scheduled Reports (ROLE_CREATE_DASHBOARD_REPORTS) privilege, you can use this endpoint to create, update, and delete scheduled dashboard reports as well as to retrieve scheduled dashboard report settings either by dashboard ID or by report ID.

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

Property Changes

Implementation of dashboard scheduling introduced some new properties and renamed some existing properties in the zoomdata.properties file. The following table lists the renamed properties.

Property Renamed
export.dashboard.http.client.connect.timeout.milliseconds screenshot.service.http.client.connect.timeout.milliseconds
export.dashboard.http.client.read.timeout.milliseconds screenshot.service.http.client.read.timeout.milliseconds
export.dashboard.http.client.write.timeout.milliseconds screenshot.service.http.client.write.timeout.milliseconds
export.dashboard.service.name screenshot.service.name
export.dashboard.service.url screenshot.service.url

The following table describes the newly introduced properties:

New Property Description
dashboard.scheduling.screenshot.png.height Identifies the height (in pixels) of the screenshot PNG file that will be sent. The default is 720 pixels.
dashboard.scheduling.screenshot.png.width Identifies the width (in pixels) of the screenshot PNG file that will be sent. The default is 1280 pixels.
dashboard.scheduling.screenshot.timeout

Specifies the timeout (in seconds) to take a screenshot for a dashboard email report. The default is 60 seconds.

Note: The time specified by this property must be less than or equal to the time set by the screenshot.service.http.client.read.timeout.milliseconds property. If you increase the value of this property, make sure that you increase the value of the screenshot.service.http.client.read.timeout.milliseconds property accordingly. Bear in mind that this property is specified in seconds, but the screenshot.service.http.client.read.timeout.milliseconds property is specified in milliseconds.

mail.from Specifies the email address identifying where the email comes from.
mail.login Specifies the email login to use to access the mail server.
mail.password Specifies the password associated with the email login identified in the mail.login property.

In addition, JavaMail properties should be added to the zoomdata.properties file to identify the mail server and other mail properties required to use that server to send the scheduled dashboard (for example, mail.smtp.auth, mail.smtp.host, mail.smtp.port, mail.imap.host, and mail.imap.port). Composer supports both IMAP and SMTP protocols. Complete descriptions of IMAP and SMTP protocol JavaMail properties can be found at these links:

For information about the properties in the zoomdata.properties file, see zoomdata.properties Properties.

User Interface Changes

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

  • In this release, the Dashboard Filter sidebar has been moved from the left side of the dashboard canvas to the right side. See Applying Row-Level Filters.

  • Two new interactivity controls were added to the interactivity sidebar in this release: Link and Select Time Bar Field.

    • Use Link to control the ability to link to another dashboard using the Link option on the radial menu.
    • Use Select Time Bar Field to control the ability to change the time field selected for the time bar.

    See Controlling How Users Interact With a Visual.

  • The Time Bar option, originally on the visual drop-down menu has been moved to the visual sidebar menu and a new Time Bar sidebar is provided on the right side of visual or dashboard canvas. See Using the Sidebar Menu and Using the Time Bar Sidebar.

  • You can now generate dashboard reports in PDF and PNG format and schedule their delivery to other users. A new Schedule column appears on the dashboard library page in list view. The icon () in this column allows you to access the Scheduled Reports dialog and schedule a report for the associate dashboard. See Using the Dashboard Library and About Scheduled Dashboard Reports.

  • The home page was rebranded in this release. See Home Page.

  • A new Logout button now appears on the About dialog. Select it to log out of the product. See About Dialog.

  • The Customize UI page in the supervisor UI has been rebranded with Logi Composer logos as well as rebranded support and documentation links. In addition, you can now customize the Composer home page background using the Customize UI page. See Customizing the Composer User Interface and Customizing the Home Page Background Image.

  • The ability to specify a master theme was introduced in this release. Master themes are optional, but allow you to identify the Composer-supplied theme from which properties should be inherited by a custom theme, if the properties are not specified in the custom theme JSON. See Sample Themes JSON File.

What's Fixed?

The following problems were fixed in this release:

  • LDAP users can now log into Composer if their user was manually added to a Composer group.

  • Resolved an issue where SAML custom attributes were not showing on connection parameters.

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

  • Composer now accepts white space around parentheses in derived fields.

Known Issues

  • If you are an existing user migrating to Java JDK 11 for this release of Composer, you may receive 500 errors after the Composer upgrade. These errors can be resolved by deleting user session data from the Postgres database in the spring_sessions_attributes and spring_sessions tables. This problem will be fixed in Composer 5.9.

What's Deprecated?

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

  • Ubuntu 14 is deprecated in this release as an officially supported platform. Its binaries will be removed from the Composer software in the next release.

  • Java 8 (1.8.0_131) support is deprecated in this release and support for Java JDK 11.0 is introduced.

    Support for CentOS 6 will be deprecated when it is no longer supported by Red Hat Enterprise Linux (RHEL).

    If your environment is running CentOS6, a special installation Bootstrap procedure, called bootstrap-zoomdata-centos6.run, must be used to install or upgrade to Composer 5.9 or later. The regular Bootstrap procedure will fail in CentOS 6 environments.

    In addition, if your environment is running CentOS 6, you must manually install OpenJDK 11. OpenJDK 11 is available from various vendors, such as AWS Corretto, OpenJDK11, or Oracle JDK11. See Manually Installing OpenJDK 11.

    When you attempt to install or upgrade Composer in a CentOS 6 environment that does not have OpenJDK 11 installed, the installation script will start, but will produce FAIL messages during its execution because of the missing OpenJDK 11 software. When the installation script runs, the Composer binaries are upgraded to the latest version, but you will not be able to start Composer without first manually installing OpenJDK 11.

    Ubuntu users who have Composer or Zoomdata versions earlier than 5.8 installed must first remove the legacy repository before upgrading Composer 5.8 or later. Use this command:

    sudo rm -f /etc/apt/sources.list.d/saltstack.list