Email customization for dashboard subscription

eazyBI for Jira eazyBI for Confluence Private eazyBI

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 two levels of email customization for dashboard subscriptions:

• dashboard-specific template for a specific dashboard,
• global settings template for all dashboards in the eazyBI accounts.

Dashboard-specific email customization

You can set a custom email subject and body for each dashboard independently. These settings apply to the scheduled subscription email for that particular dashboard and override the global email template when configured.

1. Open the dashboard to configure email customization. Then click More actions (the three-dot menu) → PDF options.
2. Fields Subscription email subject and Subscription email body are locked by default to avoid unintentional activities. Click Edit next to the field name to unlock it and change its value. 

3.  You can use the following template variables in both the subject and the body:

   1. {{account_name}} — the name of the eazyBI account
   2. {{dashboard_name}} — the name of the dashboard
   3. {{user_name}} — the name of the subscribed user
   4. {{dashboard_url}} — the URL of the dashboard
4. In the email body, you can use Markdown formatting to organize the text.
5. Save the settings.

Global email customization

Users with admin rights can customize the global email body template for the eazyBI dashboard email subscription from the eazyBI settings, by selecting the Email tab.

From there, you can change the Email subject and Email body for the global email template, which will affect all eazyBI accounts that use the email subscription feature.

Use the following template variables in both the subject and the body:

• {{account_name}} — the name of the eazyBI account
• {{user_name}} — the name of the subscribed user
• {{dashboard_name}} — the name of the dashboard
• {{dashboard_url}} — the URL of the dashboard.

Older Jira Datacenter versions and Private eazyBI

For eazyBI versions before 9.1, admins can also customize the global email template if the eazyBI dashboard email subscription is enabled.

Keep in mind that for Jira Datacenter customers, 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.

1. 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 other name can be used) and the following content.

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

   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
   
       subscription_settings:
         eazybi_html: |
           If you would like to change dashboards email subscription settings then please visit <a href="%{page_url}">eazyBI dashboards</a> page.

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.