Cloudera Docs

Creating new email jobs

Cloudera Data Visualization supports two types 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 have the option to use an email template for this task, but it is not required. You can send the email as-is, without a message, or include your own custom message. If you decide to use a template, you can choose the default template or create a custom one. For guidance, see Creating new email templates.
  1. Open the dashboard that you want to share through email or navigate to the visual that you want to include in the email.
  2. Access the supplemental menu.
    For visuals:

    Click in the upper-right corner of the visual.

    For dashboards:

    Click the same icon () but in the upper-right corner of the dashboard.

  3. Select Email from the drop-down menu.
    The Send visual or Send sheet modal appears.
  4. Select Email now.
  5. Fill in the required details.
    Fields marked with an asterisk are mandatory.

    • To* – Enter the primary recipients' email addresses.

    • CC – Enter the email addresses of additional recipients.

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

    • Subject* – You can modify the default title of the email.

  6. You can set the Email Template that you want to use.

    If you want to see how the template looks, click Preview Email Template.

  7. Enter the body text of the email in the Message field.
  8. Optional: Click Show Job Parameters to view the list of parameters you can add to the message.
  9. Choose how the visual is included in the email.
    You can either embed the visual directly into the email body (default option) or attach it in one of the following formats:
    • PNG
    • PDF
    • PPTX
    • XLSX
    • CSV

    If you select the PDF attachment, you can choose how the PDF attachment is generated using the Pdf option dropdown to determine which part of the dashboard is included in the PDF file:

    • Current sheet: Exports only the sheet currently open in the dashboard. All visuals on that sheet appear on a single PDF page.
    • One sheet per page: Exports the entire dashboard. Each sheet appears on a separate page in the PDF file.
    • One visual per page on current sheet: Exports only the current sheet, placing each visual from that sheet on its own page in the PDF file.

    If you select the XLSX or CSV attachment option, ou can specify the maximum number of rows to include. The default limit is 5000 rows.

  10. Configure Advanced Settings.

    • Error Notification Emails To – Specify an email address to receive error messages.

    • Reply To – Specify a different reply-to address if needed.

    • Use Alias – Create a new or use an existing alias for easier access.

    • Page Parameters – For visuals that have parameterized fields on their shelves, you can choose:
      • Include page parameters (default)
      • Do not include page parameters
      You can also show or hide the page parameters.
  11. Click Save.

    A notification appears while the email is prepared. Once completed, a success message confirms the operation.

You can choose to review the list of pending emails, cancel any running email jobs, or resend previously sent emails. For more information, see Managing jobs.

Schedule-based email

You can set up regular emails to share visuals, sheets, and dashboards. Scheduled email jobs run at defined times or are triggered when dataset measures meet specified thresholds.

Use scheduled email jobs to automatically distribute visuals, sheets, or dashboards to recipients. You can define a delivery schedule or configure threshold-based triggers so emails are sent when specified dataset conditions are met. You can accomplish the task both in Edit and in View mode.

  • Before you schedule an email,
    • Ensure that email is enabled and configured in Site Settings. For more information, see Configuring Email.
    • Ensure that Enable scheduled jobs is turned on in Site Settings > Jobs. For more information, see Enabling scheduled jobs in the Site Settings documentation.
  • You have the option to use an email template for this task, but it is not required. You can send the email as-is, without a message, or include your own custom message. If you decide to use a template, you can choose the default template or create a custom one. For more information, see Creating new email templates.
  1. Open the dashboard that you want to share through email or navigate to the visual that you want to include in the email.
  2. Access the supplemental menu.
    For visuals:

    Click in the upper-right corner of the visual.

    For dashboards:

    Click the same icon () but in the upper-right corner of the dashboard.

  3. Select Email from the drop-down menu.
    The Send visual or the Send sheet modal appears.
  4. Select the Schedule email option.
  5. Fill in the fields on the available tabs.
    • If Threshold is not enabled, you will see the Email Details and Schedule Details tabs.
    • If Threshold is enabled, the Threshold Details will also appear.

      With threshold, 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.

    Fields marked with an asterisk are mandatory.

    • To* – Enter the primary recipients' email addresses.

    • CC – Enter the email addresses of additional recipients.

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

    • Subject* – You can modify the default title of the email.

    • You can set the Email Template that you want to use.

      If you want to see how the template looks, click Preview Email Template.

    • Enter the body text of the email in the Message field.

    • [Optional] Click Show Job Parameters to view the list of parameters you can add to the message.

    • Choose how the visual is included in the email.

      You can either embed the visual directly into the email body (default option) or attach it in one of the following formats:
      • PNG
      • PDF
      • PPTX
      • XLSX
      • CSV

      If you select the PDF attachment, you can choose how the PDF attachment is generated using the Pdf option dropdown to determine which part of the dashboard is included in the PDF file:

      • Current sheet: Exports only the sheet currently open in the dashboard. All visuals on that sheet appear on a single PDF page.
      • One sheet per page: Exports the entire dashboard. Each sheet appears on a separate page in the PDF file.
      • One visual per page on current sheet: Exports only the current sheet, placing each visual from that sheet on its own page in the PDF file.

      If you select the XLSX or CSV attachment option, ou can specify the maximum number of rows to include. The default limit is 5000 rows.

    • Configure Advanced Settings.

      • Error Notification Emails To – Specify an email address to receive error messages.

      • Reply To – Specify a different reply-to address if needed.

      • Use Alias – Create a new or use an existing alias for easier access.

      • Page Parameters – For visuals that have parameterized fields on their shelves, you can choose:
        • Include page parameters (default)
        • Do not include page parameters
        You can also show or hide the page parameters.

    • Enter a name for the scheduled job.

    • In the Schedule field of the Schedule Details tab, select an existing schedule interval from the following options:
      • Hourly (default)
      • Daily
      • Every Weekday
      • Weekly
      • Monthly
      • Quarterly
      • Custom intervals (available to administrators only)

    You can define a threshold-based trigger to send email notifications when specific conditions are met.

    • Trigger Visual ID – Define a new trigger visual or add the ID of an existing table visual.

    • Send Email Limit – Specify how often emails should be sent when the condition is met:
      • Only on first trigger
      • When trigger occurs
      • Once a half hour (default)
      • Once an hour
      • Once a day
      • Once a week
      • Once in 2 weeks
      • Once a month

    • Trigger Type – Select one of the following options:

      • Threshold met: Triggers an email when the first measure of the first row in the trigger visual meets 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 meets the conditional expression.

    • Trigger Conditions – Set logical operators (one of <, >, ≤, ≥, or =) and values.

      You can add multiple trigger conditions with + Add Condition.
  6. Click Save.

    A notification appears while the email is prepared. Once completed, a success message confirms the operation.

You can choose to review the list of pending emails, cancel any running email jobs, or resend previously sent emails. For more information, see Managing jobs.