Skip to main content

Enable email notifications

Zuora

Enable email notifications

Introduces how to enable the email framework and how to configure email templates for Zuora Revenue.

The email framework provides a monitoring feature of the key revenue processes in Zuora Revenue. You can enable email notifications for specific users or user groups so that they can get notified of the important processes in Zuora Revenue. Currently, the email notification functionality supports email notifications for the following processes:

  • Holds apply and release
  • Period open and period close
  • Revenue contract approval
  • Schedule jobs
  • Schedule reports
  • Download report

Email notifications from the email framework are different from the password reset notifications. If you can receive notifications of password reset, it does not necessarily mean that email notifications have been enabled for you.

The following procedure is used by implementation partners and the Zuora Support team to enable the email notification functionality in sandbox and/or production environments.

Procedure

To enable the email framework for your environment, complete the following steps:

  1. Access the internal JIRA system to create a technical operation ticket (project key is TOPS) requesting to enable the email framework. In that ticket, provide the following information:

    • Name of the customer affected

    • Environment tenant ID

    • Zuora Revenue version number

    • Type of the request (which is to enable the email framework to support email notifications of key revenue processes)

    • The system URL of Zuora Revenue

    If you do not have access to create a ticket directly, contact Zuora Support or your implementation partner for help.

  2. Before the TOPS request is completed, if there are previously configured email templates in the application before the email framework is enabled, use the following commands to purge data from the email specific tables. Data stored in these tables before the email framework is enabled is useless. Purging this data can prevent sending mass or bad emails to users after the email framework is enabled.

    • TRUNCATE TABLE rpro_eml_hdr_g

    • TRUNCATE TABLE rpro_eml_dt_g

  3. After the TOPS request is processed, complete the following steps in the UI to configure the email template:

    1. Navigate to Setups > Application > Email Template.

    2. To add an email template, click the New Template icon icon-add.png. The New Template window opens.

    3. On the Email Template tab, specify the name of the template in the Name field and select the target notification type from the Notification Type list.

    4. Specify the subject, header, body, and footer of the email based on your need.

      You can add variables to these items by using the tokens provided for each notification type. To find the available tokens for the selected notification type, click the Insert Tokens icon icon-insert-tokens.png next to the save icon.

      For example, the following email template is configured for scheduled jobs. The tokens, <program name>, <request id>, and <job status> will be replaced with the actual values in the email.

      email-template.png

    5. After you are done configuring the email template, click icon-save.png.

    6. Click the Subscribers tab, select the subscribed object type, select the user or user role who will receive the email notifications, and then click icon-save-green.png.

    7. Click the Assign Books tab, click the target revenue books from the Available Books list and move your selection to the Selected Books list by clicking the arrow icon, and then click icon-save.png.

    8. Close the window. The email template is set up.

After you complete all the configuration steps and still cannot get email notifications for the Zuora Revenue processes, create an L3 ticket to Zuora Support by using zendesk.