Cloudera Docs

Creating new email jobs

Cloudera Data Visualization supports three type of email jobs:

Immediate email

You can share existing visuals with other users on an ad-hoc basis using email.

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

You need an email template to perform this task. You can use the default template or configure your own. For instructions, see Creating new email templates.
  1. Open the dashboard that you want to share through email or that contains the visual that you want to include in the email.
    For visuals, follow the steps below. For dashboards, follow the same steps, but open the supplemental menu for the dashboard instead.
  2. Click in the upper-right corner to open the supplemental menu,
  3. Select Email from the drop-down.
    The Email Visual modal appears.
  4. Select the Email now option.
  5. Fill in the email details.
    Fields marked with an asterisk are mandatory.

    • To – Enter the email addresses of the primary recipients of the message.

    • CC – Enter the email addresses of other recipients.

    • Error Notification Emails – Enter an email address where you want to receive data visualization error messages.

    • Reply To – Enter an email address if you would like responses to go to a different email address than the sender.

    • From – You can set the value of this field in Site Settings.

    • Subject – You can change the default title of the email.

  6. Under Email Template, leave the Default Email Template selected.
  7. Optional: If you want to see how the template looks, click Preview Email Template.
  8. Enter the text of the email in the Message field.
  9. For visuals that have parameterized fields on their shelves, in Page Parameters you can choose:
    • Include page parameters (default)
    • Do not include page parameters
  10. Optional: You can add a short URL in the email.
    You can create a new alias or use an existing one that you created earlier.
    1. Click the Use URL Alias checkbox.
    2. Choose an existing URL alias or create a new one.
    3. Click Show Job Parameters under the Message textbox.
    4. Click Current Sheet Link.

    The <<app_url>> appears in the message.

  11. For Attach options, decide whether you want to embed the image in the email and select what format to use:
    • Embedded Image (default)
    • PNG
    • PDF
    • XLSX
    • CSV
  12. Click SEND.

    The system notifies you that the email is being prepared. Once the process is complete, a success message will confirm that the operation was successful.

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

You can 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.

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

  • You need an email template to perform this task. You can use the default template or configure your own. For instructions, see Creating new email templates.

  • Before you schedule an email, check the Enable scheduled jobs option in Site Settings > Jobs. For more information, see Enabling scheduled jobs in the Site Settings documentation.

  1. Open the dashboard that you want to share through email or that contains the visual that you want to include in the email.
    For visuals, follow the steps below. For dashboards, follow the same steps, but open the supplemental menu for the dashboard instead.
  2. Click in the upper-right corner to open the supplemental menu,
  3. Select Email from the drop-down.
    The Email Visual modal appears.
  4. Select the Schedule Email option.
  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. Fill in the email details:
    • In the To text box, enter the email addresses of the primary recipients of the message.
    • In the CC text box, enter the valid email addresses of other recipients.
    • In the Error Notification Emails text box, enter an email address where error notifications will be sent to.
    • In the Reply To text box, add an email addres if you want responses to go to a different email address than the sender.
    • 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.
  8. Under Email Template, leave Default Email Template selected.
  9. Optional: If you want to see how the template looks, click Preview Email Template.
  10. Enter the text of the email in the Message field.
  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. Optional: You can add a short URL in the email.
    You can create a new alias or use an existing one that you created earlier.
    1. Click the Use URL Alias checkbox.
    2. Choose an existing URL alias or create a new one.
    3. Click Show Job Parameters under the Message textbox.
    4. Click Current Sheet Link.

    The <<app_url>> appears in the message.

  13. For Attach options, choose one of these:
    • Embedded Image (default)
    • PNG
    • PDF
    • XLSX
    • CSV
  14. Click SAVE.

    The system notifies you that the schedule was created successfully.

Threshold-based email

You can schedule an email job that is triggered by measures on the dataset reaching a defined threshold. It means that email notifications are sent when the 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 in Edit or in View mode.

You need an email template to perform this task. You can use the default template or configure your own. For instructions, see Creating new email templates.
  1. Open the visual you want to include in the email.
  2. Click in the upper-right corner to open the supplemental menu,
  3. Select Email from the drop-down.
    The Email Visual modal appears.
  4. Select the Email based on threshold option.
  5. Fill in the email details.
    Fields marked with an asterisk are mandatory.

    • To – Enter the email addresses of the primary recipients of the message.

    • CC – Enter the email addresses of other recipients.

    • Error Notification Emails – Enter an email address where you want to receive data visualization error messages.

    • Reply To – Enter an email address if you would like responses to go to a different email address than the sender.

    • From – You can set the value of this field in Site Settings.

    • Subject – You can change the default title of the email.

  6. Under Email Template, leave the Default Email Template selected.
  7. Optional: If you want to see how the template looks, click Preview Email Template.
  8. Enter the text of the email in the Message field.
  9. For visuals that have parameterized fields on their shelves, in Page Parameters you can choose:
    • Include page parameters (default)
    • Do not include page parameters
  10. Optional: You can add a short URL in the email.
    You can create a new alias or use an existing one that you created earlier.
    1. Click the Use URL Alias checkbox.
    2. Choose an existing URL alias or create a new one.
    3. Click Show Job Parameters under the Message textbox.
    4. Click Current Sheet Link.

    The <<app_url>> appears in the message.

  11. For Attach options, decide whether you want to embed the image in the email and select what format to use:
    • Embedded Image (default)
    • PNG
    • PDF
    • XLSX
    • CSV
  12. On 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 that visual to the Visual ID field.

    1. Under Job Name, enter the name of the new trigger.

    2. Click Create Threshold.

    This creates a new table visual based on all the fields of the dataset, and the visual opens in a new tab of your browser. Note that the ID for the new visual appears in the URL address, and has the following format: https://ip_address/arc/apps/builder/trigger_id

  13. 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.
  14. Save the new table visual.

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

  15. 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
  16. 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.

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

    You can also select Create New Schedule. This option is available to Admin users only.

  18. 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 selected. 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
  19. Click SAVE.

    The system notifies you that the trigger has been created successfully.