Cloudera Docs

Creating new email jobs

CDP Data Visualization supports three type of email jobs:

Immediate email

Cloudera Data Visualization enables you to share existing visuals with other users on an ad-hoc basis.

Follow these steps to email a visual, a sheet, or a dashboard of your choice. You can accomplish this either from Edit mode, or from View mode.

  1. See the initial steps described in Creating email templates.
  2. Open the visual you want to inlcude in the email.
  3. On the upper right corner click the ellipsis and select Email from the drop-down menu.
    The email modal appears.
  4. In the Email Visual/Email Current Sheet/Email Dashboard modal, select the option Email now.
  5. In the To text box, enter the email addresses of the primary recipients of the message.
  6. In the CC text box, enter the valid emails of other recipients.

    The value of the From field is configured on the Site Settings interface.

    In the Subject text box, you can change the title of the email.

  7. Under Email Template, leave Default Email Template.
  8. To see how the template looks, click Preview Email Template.
  9. Enter the text of the email in the Message field.
  10. For Attach options, choose one of these:
    • Embedded Image (default)
    • PNG
    • CSV
  11. For visuals that have parametrized fields on their shelves, in the Page Parameters you can chose one of these:
    • Include page parameters (default)
    • Do not include page parameters, which includes default picklist parameters.
  12. Click SEND.

    The system notifies the user that an email is being prepared.

    After the operation succeeds, you get the following message:

You may choose to see the list of pending emails, cancel running jobs, or re-send an email. Click the link Go to Jobs page to view status on the UI for details.

For more information, see Managing jobs.

Schedule-based email

In Cloudera Data Visualization, you can use the Email interface to schedule regular emails of visuals, sheets, and dashboards. Scheduled jobs run on a schedule, or are triggered by measures on the dataset reaching a defined threshold.

Before you schedule an email, make sure you check the Enable scheduled jobs option under Jobs. For more information, see Site settings.

Follow these steps to schedule emails of visual, sheet, or dashboard. You can accomplished this either in Edit mode, or in View mode.

  1. See the initial steps described in Creating email templates.
  2. Open the visual you want to inlcude in the email.
  3. On the upper right corner click the ellipsis and select Email from the drop-down menu.
    The email modal appears.
  4. In the Email Visual/Email Current Sheet/Dashboard Visual modal, select the option Schedule Email.
  5. In the Job Name text box of the Email Detail tab, enter the name of the scheduled job.
  6. In the Repeat field, select an existing schedule interval:
    • Hourly (default)
    • Daily
    • Every Weekday
    • Weekly
    • Monthly
    • Quarterly
    • or any existing custom schedule.
  7. In the To text box, enter the valid email addresses of the primary recipients of the message.
  8. In the CC text box, enter the valid emails of other recipients.

    The value of the From field is configured on the Site Settings interface.

    In the Subject text box, you can change the title of the email.

  9. Under Email Template, leave Default Email Template.
  10. To see how the template looks, click Preview Email Template.
  11. Enter the text of the email.
  12. For Attach options, choose one of these:
    • Embedded image (default)
    • PNG
    • CSV
  13. For visuals that have parametrized fields on their shelves, in the Page Parameters you can chose one of these:
    • Include page parameters (default)
    • Do not include page parameters, which includes default picklist parameters.
  14. Click SAVE.

    The system notifies you that the schedule was created successfully.

Threshold-based email

Cloudera Data Visualization enables you to set up email notifications when a specified triggering condition occurs.

Follow these steps to define triggering conditions and triggered emails for a visual, a sheet, or a dashboard. You can accomplish this either from Edit mode, or from View mode.

  1. See the initial steps described in Creating email templates.
  2. Open the visual you want to inlcude in the email.
  3. On the upper right corner click the ellipsis and select Email from the drop-down menu.
    The email modal appears.
  4. In the Email Visual/Email Current Sheet/Email Dashboard modal, select the option Email based on threshold.
  5. In the To text box, enter the valid email addresses of the primary recipients of the message.
  6. In the CC text box, enter the valid emails of other recipients.
    The value of the From field is configured on the Site Settings interface. For more information, see Enabling and customizing email settings.
  7. Optional: In the Subject text box, you can change the title of the email.
  8. Under Email Template, leave Default Email Template.
  9. To see how the template looks, click Preview Email Template.
  10. Enter the text of the email in the Message field. Additionally, you can embed job parameters in the message body.
  11. For Attach options, choose one of the following:
    • Embedded Image (default)
    • PNG
    • CSV
  12. For visuals that have parameterized fields on their shelves, in the Page Parameters you can chose one of these:
    • Include page parameters (default)
    • Do not include page parameters, which includes default picklist parameters.
  13. In the Set Threshold tab, perform the following actions to create a threshold definition and a new table visual that specifies the trigger values.

    Alternatively, instead of defining a new threshold, you can use an existing table visual to specify threshold values, and add the ID of the that visual to the Visual ID field.

  14. Under Job Name, enter the name of the new trigger.
    In this example, Threshold on Georgia Flights is used.
  15. Click Create Threshold.

    This creates a new table visual based on all the fields of the dataset. The table visual is called Trigger: Threshold on Georgia Flights.

    The visual opens in a new tab of your browser. Note that the ID for the new visual appears in the URL address (in this example, it is 2148), and has the following form:

    https://ip_address/arc/apps/builder/trigger_id
  16. Make changes to the visual so that the field that contains the triggering measurements is the first field on the Measures shelf, and sort/filter results to ensure that the triggering measurement is in the first row. Save the new table visual.

    Back on the Email Visual/Email Dashboard modal, in the Set Threshold tab, notice that the Visual ID field holds the ID of the new trigger table visual. In this example, it is 2148.

  17. Under Trigger, select one of the options:
    • Threshold met: triggers an email when the first measure of the first row in the trigger visual satisfies the conditional expression
    • Value changed since last assessment: triggers an email when the change in the first measure of the first row after the last assessment satisfies the conditional expression
  18. For the triggering Value, adjust the logical operand (one of <, >, ≤, ≥, or =) and the number.

    In this example the expression ≥ 1000 is used.

    You can add multiple trigger conditions by clicking the + ADD CONDITION button.

  19. For Assess Trigger, select an existing schedule interval:
    • Hourly (default)
    • Daily
    • Every Weekday
    • Weekly
    • Monthly
    • Quarterly
    • or any existing custom schedule

    Users with administrative privileges can also select Create New Schedule.

    The Send Email Limit gives you the option of sending only the first email in circumstances when a triggering event occurs multiple times within the specified time interval.

    In this example, Once a day has been. This means that if the trigger satisfies the conditional expression, it may not be sent if an earlier one was sent in the preceding 24 hours.

    The options are:

    • When trigger occurs (which does not suppress any emails)
    • Once a half hour (default)
    • Once an hour
    • Once a day
    • Once a week
    • Every 2 weeks
    • Once a month
  20. Click SAVE.

    The system notifies the user that the trigger was created successfully.