Email customization for dashboard subscription

eazyBI for Jira eazyBI for Confluence Private eazyBI

You can customize the subject and body of the email that eazyBI sends with dashboard subscriptions. You can set a template for a single dashboard or a global template for all dashboards.

eazyBI uses two levels of templates:

• Dashboard-specific template applies to one dashboard. Users who can manage dashboards set it in the dashboard PDF options. It overrides the global template.
• Global template applies to all dashboards in the eazyBI instance. eazyBI admins can set it in the eazyBI settings.

If neither template is set, eazyBI uses the default email text.

Dashboard-specific email customization

A user with the role to manage dashboards in the account can set a custom email subject and body for each dashboard independently. These settings apply to a particular dashboard and override the global email template when configured.

1. Open the dashboard and select More actions (three-dot menu) > PDF options.
2. Click Edit next to Subscription email subject or Subscription email body and enter the text. Template variables work in both fields, and Markdown formatting works in the body.
3. 
4. Click Save. To use the global template for this dashboard again, clear the fields and save.

Global email customization

The global template applies to all dashboards in the eazyBI instance, and eazyBI admins can set a global email subject and body. However, a dashboard-specific template overrides it.

1. Open eazyBI advanced settings or site settings for Cloud and select the Email tab.
2. Click Edit next to Email subject or Email body and enter the text.
3. Click Update email settings.

You can use the same template variables and Markdown formatting as in the dashboard-specific template.

Global email customization before version 9.1

In eazyBI for Jira Data Center versions before 9.1, you can customize the global email template with a locale file.

Customizations in the locale file can conflict with future eazyBI versions. After each eazyBI upgrade, review and test your customizations.

1. Create the directory JIRA_HOME/data/eazybi/locales and, in it, a .yml file, for example, custom_email.yml.

2. Edit the subject and body_html values. The default content is:

   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.

Locale file details:

• eazyBI loads all .yml files from the locales directory, so you can choose any file name.
• YAML is indentation-sensitive. If the indentation is wrong, eazyBI does not load the file.
• In the locale file, variables use the %{account_name} syntax, and the email body uses HTML.
• %{subscription_settings} adds a link to the dashboard subscription settings, and %{page_url} is the URL of that link.
• The file applies to all eazyBI accounts in the Jira instance.

Template variables and formatting

Use these template variables in the subject and body of the dashboard-specific and global templates:

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

In the email body, you can use Markdown formatting, such as headings, lists, bold and italic text, and links. A URL in the body automatically becomes a link.

At the end of the email, eazyBI adds a link to the dashboard subscription settings.