Email customization for dashboard subscription


Users can subscribe to receive a regular email with dashboard reports as a PDF attachment. To enable this functionality, make sure you have installed the headless Google Chrome browser on your Jira server.

eazyBI provides the option to customize the body of an email sent via the eazyBI dashboard email subscription. Keep in mind that customizations might interfere with the standard eazyBI functionality and may conflict with future eazyBI versions. Please review and retest your customizations after each eazyBI version upgrade.

You can customize your email body when the eazyBI dashboard email subscription is enabled. Customization would not be possible for Jira Cloud add-on.

First, create a directory JIRA_HOME/data/eazybi/locales and create there a customization file with .yml extension (i.e., custom_email.yml or any name can be used) and the following content:

en:
  dashboard_mailer:
    pdf_export:
      subject: "[eazyBI] Dashboards - %{account_name}"
      body_html: |
        Hello %{user_name}!

        Please see attached dashboard pages from eazyBI account <strong>%{account_name}</strong> .

        %{subscription_settings}<br/>


        Kind regards,
        eazyBI

Next, you could edit the content of this file to customize the text in body_html section.


Here is the list of possible variables that you can use in the body of the email

VariableDescription
account_nameReturns the name of eazyBI account
user_name

Returns the name of the user that subscribed for the dashboard

subscription_settingsReturns a link to the dashboard subscription settings with an additional sentence: "If you would like to change dashboards email subscription settings then please visit eazyBI dashboards page."
page_urlReturns the URL to the page where the dashboard is created in eazyBI.


When you edit *.yml file, keep in mind:

  • You can name the file as you want - all localization files from JIRA_HOME/data/eazybi/locales will be loaded
  • The file is in a YAML format which is indentation sensitive - please do not break the indentation hierarchy as then it will fail to load

This .yml file is common for all eazyBI accounts (for one JIRA instance) and can't be specified for each eazyBI account separately.

After updating advanced settings, please disable and then re-enable eazyBI plugin from Jira administration Add-ons page.