Creating Task to Send Image File via Email

Allows you to create tasks to generate and email Image files.

In addition, hyperlinks can also be used in email dashboard images. Hyperlinks can redirect to a workbook and a dashboard in the server.

NOTE: In cases when you schedule the emailing of dashboard images or when you are behind a proxy or load balancer, it is recommended to specify the server address in the Panopticon.properties file.

For example: server.host=http://www.company.com/dashboards/

1. On the New Task pane, enter the Name of the task. Ensure the name is unique.
2. Tap the Activated slider to turn it on.
3. Select the Trigger. You can either select:
   • Period then enter the Interval (in seconds), or

     

   • CRON then enter a CRON Expression on the format:

     sec mins hours dayofmonth month dayofweek (e.g., 09 02 18 ? * MON-FRI)

     

4. Select the task Type: Email Image.
5. Upon selecting Email Image, the Scheduler page changes to allow specification of the following:
   • Enter the Description of the task.
   • Select the Workbook Name in the drop-down list. These are the published workbooks available in the Workbooks page.

     You can also enter the workbook name in the Search box. For workbooks in folders, ensure to start with \ to include folder names.

   • Select dashboards or parts to include in the image file by checking their corresponding boxes in the Dashboards and Parts drop-down list.

      

     The selected dashboards or parts are inserted as parameterized text and inline images in the Body edit box.

     

     Clicking the Preview    icon displays the image placeholders for the selected dashboards or parts.

     

   • Select bookmarks in the workbook to include in the image file by checking their corresponding boxes in the Bookmarks drop-down list.
6. You can also do the following:
   • Enter the Parameter Values that will be added as parameters to the subject line of emails or as dashboard values in the Image file.

     Such as Parameter=Value, and are comma separated. For example:

     Region=Europe,Industry=Financials

     NOTE:

     • See Setting Parameter Values in Scheduler Tasks for more information on the different syntax you can use to enter parameters with multiple values, as well as parameter values that contain comma.
     • The following Date/Time range querying parameters are also supported in the Email Image File task:
       • CurrentTime
       • LastWorkDay
       • WeekStart
       • QuarterStart

       For example:

       {CurrentTime:dd-MMM-yyyy}

       However, when there is no Date/Time format supplied, the default format yyyy-MM-dd will be used instead.

   • Enter the Width and Height of the Image file. Default values are 1024 and 768, respectively.
   • Select the Hide Scrollbars checkbox.
   • Select the Hyperlinks checkbox. This makes the Image file in the email will be clickable.
7. Enter the email address of the recipient in the To field.
8. You can also enter the following:
   • Sender Name alias to use when sending email. If left blank, the value of email.sender_name property in Panopticon.properties will be used.
   • CC and/or BCC recipients of the email separated by a comma
   • The mail message subject to be used in the email notifications in the Subject field.

     NOTE: Supports dashboard parameters.

   • Content of the email in the Body box.
9.  Click  .
   • Once saved, you can opt to click  to manually run the task.
   • Click  to go back to the Tasks pane. A new task is added to the list.

(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support