Report Manager

Installing the Report Manager

The Report Manager is installed as a Sisense add-on. When you install the Report Manager, the following are installed:

Add-ons Client Side:

1. Report Manager: This add-on generates all the UI pages displayed in Sisense, including the Report Manager page, the Reports list page, and the Create/Edit report.
2. Hide Report Schedule: This add-on removes the option to schedule reports through the Share Dashboard window.
   Note: This add-on is on by default, which means the option to send reports from the dashboard page is no longer available.

Add-ons Server Side:

1. Report Manager: If the user is logged out of Sisense and tries to browse to the Report Manager, this add-on redirects them to the Login page.

Microservices:

1. Rest API – Data manager: Adds another Report Manager route to the Sisense REST API list under the V1 version.
2. Engine: Exports reports and sends them to recipients. If it fails, all reports that were in the middle of export will be set to not running with a server error message.
3. Scheduler: Manages the report execution time based on priority and capacity. In case of failure and going up again, it will be set to ‘no running’.
4. Messaging: Sends report update messages from the server to all logged-in users. If it fails, all sent messages are not stored and will not be sent after the service is restored. In this case, your users will need to refresh the page to see the updated data.

Every microservice has a log file located in the Sisense logs directory.

Read the manual for additional information about the installation process and the add-on capabilities.

Limitations

• Report manager does not offer any PDF formatting capabilities.
• Widget of type Table with aggregation are not exported to csv or excel.
• As of version 1.4, you can only customize the branding and look-and-feel using the out-of-the-box feature. Changing the look-and-feel using a CSS file is no longer supported.
• Metadata translation is not applied to Excel and CSV files.

This is a premium Sisense add-on. For pricing details please get in touch with your CSM

Version 1.11.25 – October 23, 2024

• Added possibility to bypass 50K rows limit in csv
• Added configuration for report running timeout
• Added toggle to allow sending empty excel files
• Optimized service memory consumption for large csv and xls exports
• Removed excessive debug logs for the external-plugins service, produced by nodemailer
• Bugfix: CSRF header mismatching with cookie causes unexpected user logouts
• Bugfix: Designer user is not able to choose jasper formats and create the report
• Bugfix: Excel reports are failing with blank Pivot widget
• Bugfix: Excel report fails with ‘Or’ dashboard filter relationship
• Bugfix: Custom (uploaded) fonts are not applied on report manager page
• Bugfix: Incorrect CRON generation for days level

Version 1.11.12 – June 12, 2024

• Bugfix: incorrect cube build time in PDF export
• Bugfix: wrong redirection to the login page instead of SSO login page after session expiration, when SSO is enabled
• Bugfix: Report Manager tab is not displayed for Data Designer user role
• Bugfix: Report manager not sending reports if a report recipient is created via SSO and never accessed Sisense yet.
• Added support for API token expiration. When the flag is enabled in the configuration of Sisense, the reports will continue to execute properly.
• Reports can now be created without subscription or “event based” mode selected.
• Jasper Excel format option is returned back

Version 1.11.2 – March 12, 2024

• Attachments size limit parameter introduced
• Resumption of reports that were in the pending queue or running after service restart, improved logging
• Bugfix: add-on sends heavy query to identity service
• Bugfix: Report Manager is failing to send out report to users created automatically via SSO and the never opened dashboard
• Bugfix: compatibility with Jasper report templates created with version < 2.1.4 of the Jasper Report add-on
• Bugfix: Archive report via SFTP is not workingBugfix: Monthly reporting schedule creates incorrect cron, January is excluded
• Bugfix: Custom language error – Cannot find module ‘./en-SG’
• Bugfix: Report manager functionality should be forbidden in WAT flow

Version 1.9.4 – Nov. 21, 2023

• Bug fix: Active Directory users are not displayed correctly in the recipients list
• Bug fix: incorrect date format for Excel attachments
• Bug fix: users from restricted group are exposed in the recipient list
• Bug fix: after change of widget type from “pivot” with “highlight” filter mode enabled to “table”, the CSV for such widget doesn’t honor the widget filter

Version 1.9.1 – Sept. 18, 2023

• Report manager access for users with “viewer” role (closed beta)
• Bug fix: export to excel fails if a query returns no results.

Version 1.8.8 – July 19, 2023

• Bugfixes:
  • CSV export formatting issue
  • Wrong date format for Excel export
• Remove “Jasper Excel” option from report types (if Jasper reports add-on is installed)

Version 1.8.3 – April 27, 2023

• Added support for Export Modifications add-on (please make the “Export Modifications” add-on link to here: https://www.sisense.com/marketplace/export-modifications/)
• Support for system tenant users only

Version 1.8.1 – Mar 22, 2023

• Added translations support
• Added email template management configuration in UI (supports translations)
• Extended UI configuration
• Bug fixes:
  • Shared Dashboard is not shown in dashboard list in case it was never opened
  • Users from the same group are not shown in the recipient list in case Limit autocomplete add-on is enabled
  • Report Manager & Jasper Reports add-on installation issue
  • Export to CSV returns an error when filter in formula is used
  • Pulse tab is not hidden if Report Manager tab is open
  • Wrong time format in Excel file
  • External-Plugins pod restarting in case report without report owner was sent
  • Archive to report via SFTP is not working for multiple attachments

Version 1.7.5-hotfix.5 – Dec 22, 2022

• Bug Fix: Reports stuck in pending or running state

Version 1.7.5 – Sept 27, 2022

• Bug Fix: Report Manager doesn’t send report to any users after it hits an external user
• Improved error/warning indication on the front-end

Version 1.7.4 – Sept 14, 2022

• Bug fixes

Version 1.7.3 – Sept 1, 2022

• Added new configuration option to show (or not) an error message in case of sending a report to non-Sisense users
• Added SSH private key setting for SFTP server configuration
• UI improvements for dashboard selection
• Bug fixes

Version 1.7.1 – July 18, 2022

• Added features management on UI for admins
• Added support for groups as recipients
• Added support for custom Mandrill server
• Bug fixes

Version 1.6.3 – March. 7, 2022

• Install scripts were updated to v13
• Bug fixes:
  • Excel files stop being generated during concurrent job execution
  • Report Manager hard-coded to use old analytical engine
  • Report Manager overloads MongoDB and causes system downtime

Version 1.6.2 – Feb. 10, 2022

• Bug fixes:
  • List with recipients is not shown in case external user was added first;
  • Filters are not applied properly to excel, combined excel and csv in case it was disabled in widget;
  • Email templates are not updated immediately when new templates have been uploaded;
  • Default PDF and Excel are overwritten with Jasper PDF and Excel in case “Override existing file(s)” is enabled.
• Added support for L2022.2
• Installation steps have been changed to support installation with scripts

Version 1.6.1 – Jan. 21, 2022

• Added support for L2022.1
• Verified on W2021.9
• Added support Jasper Reports 1.1.6

Version 1.5.8 – Nov. 16, 2021

• Compatibility with Windows W2021.9 and Linux L2021.11
• The option to send reports to non-Sisense recipients can be turned off by the Admins.

Version 1.5.7 – Nov. 01, 2021

• Added support for L2021.11

Version 1.5.7   – Oct. 27, 2021

• Added support for W2021.9

Version 1.5.6   – Oct. 22, 2021

• Added support for L2021.10.0

Version 1.5.5  – Oct. 20, 2021

• Added support for Jasper Reports with BloX support

Version 1.5.4 – Oct. 11, 2021

• Added support for Jasper Reports solution

Version 1.5.3  – Nov. 03, 2021

• Added support for W2021.6

Version 1.5.3  – Sept. 03, 2021

• Added support for L2021.9.0

Version 1.5.3 – Sept. 19, 2021

• Added support for Linux L2021.8
• The administrator can choose if reports for recipients that do not have a Sisense user are sent with the report owner credentials or with the configured non-Sisense user.
• Important Note: the version is not supported on Windows

Version 1.5.2 – Aug. 12, 2021

• Added support for Linux L2021.7
• Additional export format file: You can export all widgets that can be exported into a CSV or Excel into a single Excel file.
• Important note: the version is not supported on Windows

Version 1.5.1 – July 27, 2021

• Added support for Linux L2021.3.2 and Windows W2021.4.0
• Upon report creation/editing completed, the recipients are validated against the selected dashboard, and the user is alerted if there are users who are not shared with the dashboard.

Version 1.5.0 – May 27, 2021

• Custom filters per report
• Supports archive reports to SFTP server
• Bug fixes
  • Search reports by owner name is no longer case-sensitive
  • Non-Sisense user emails cannot be added more than once as report recipients
  • Default error email address can be deleted manually from the UI
  • When a report is edited and the logged in user is not the dashboard owner, the selected dashboard owner is now presented in the dashboard selection box
• Breaking changes
  • The configurations of the Report Manager have changed:
    • Admin token and non-Sisense user token should no longer be provided. A new parameter was added to the Configuration Manager – the admin user email.

Version 1.4.1 – April 26, 2021

• Open Report Manager as a popup – Report Manager can be configured to always be presented as a popup instead of replacing the main content area.

Version 1.4.1 – April 26, 2021

• Open Report Manager as a popup – Report Manager can be configured to always be presented as a popup instead of replacing the main content area.

Version 1.4.0 – April 16, 2021

• Added support for Linux L2021.3.1 and Windows W2021.2.1
• Rebranding can be done using the out-of-the-box look and feel feature
• Rebranding the report manager can no longer be done using the CSS

Version 1.3.3 – March 31, 2021

• Added support for Linux L2021.1.0
• All Windows microservice statuses are updated live in the /app/test
• Windows Limitations -The actual number of simultaneous reports is offset by 1 in case of manual execution of reports (i.e 4 instead of 5)
• Linux Limitations – In case of a user logged out,  the user is not redirected to the login page, but instead shown an error message that an error has occurred and no reports are presented.

Version 1.3.2 – March 19, 2021

• Added support for Linux L2021.1.1
• Application logs were improved, including: client logs, error email logs and log file messages
• Errors such as when the dashboard is not shared with a recipient are now presented on report failure
• The user can open the report dashboard in a new tab
• Report list: the dashboard name is a  link to open the dashboard in a new tab
• New/edit report page: a new Go To icon was added next to dashboard names. Clicking on the icon will open the relevant dashboard in a new tab
• Windows Limitations – The actual number of simultaneous reports is offset by 1 in case of manual execution of reports (i.e 4 instead of 5)
• Linux Limitations – In case of a user logged out,  the user is not redirected to the login page. Instead, the user sees an error message that an error has occurred and no reports are presented

Version 1.3.1 – March 04, 2021

• UI fixes were made
• The Sisense navigation header was added to the report manager
• Bug fixes:
  • Proxy support was added
  • Support for Linux multi-node was added
  • In case of a user logged out,  the user is not redirected to the login page. Instead, the user sees an error message indicating that he is logged out
  • Corrupted excel files as email attachments when a custom email server is on
  • Windows Limitations – The actual number of simultaneous reports is offset by 1 in case of manual execution of reports (i.e 4 instead of 5).

Version 1.3.0 – Feb 11, 2021

• Linux: Multi-node is not supported
• In case of a user logged out, the user is not redirected to the login page. Instead, an error message displays indicating that the user is logged out
• The number of simultaneous reports cannot exceed five reports at a time
• Windows: The actual number of simultaneous reports is offset by 1 in the case of manual execution of reports (e.g. 4 instead of 5)
  -Report Manager is not presented properly when using a proxy server

Version 1.2.4 – Oct. 28, 2020

• Support for versions 8.2.3-8.2.5

Version 1.2.3 – July 29, 2020

• CSV date format can be configured in the Configuration Manager page.

Version 1.2.2 – July 20, 020-07

• Configuration updates are reflected in real-time, restart of the services is not needed
• Bug fixes:
  • Support Table with Aggregation widget
  • Support special characters in pivots and table titles when exporting to CSV or Excel
  • CSV and Excel file names include a running number to make sure the files are unique

Version 1.2.0 – May 07, 2020

• Support Active Directory users
• Support export the dashboard pivot widgets to Excel
• Support rebranding

Version 1.0.0 – March 18, 2020

• Bug fixes:
  • Fixed issue with the report manager tab
  • Email server – if there is no “enable” key the email sending is failed.  Added validation to properly set ‘enabled’
  • Fixed issues related to compatibility solution with custom email server.

Version 1.0.0 (beta) – March 05, 2020

• Implemented in beta version:
  • Interactive Web UI
  • Export dashboard to PDF
  • Export Pivots and Tables to CSV
  • Send dashboard link
  • Send Report to non-Sisense users
  • Sending emails to non-Sisense users is done on behalf of 1 single Sisense user
  • Archive report files to a shared folder
  • Parallel Report Execution
  • Supported Roles: Admins, Designers
  • Advanced scheduling options: Once, Daily, hourly, weekly, monthly
  • Run reports on demand
  • Cancel running reports
  • Hold all reports
  • Configure maximum simultaneous reports to export
  • Event-based reports generation
  • Admins and Designers can schedule reports
  • Bulk operations