|
Image
Panopticon Real Time provides the functionality to generate and email dashboard images.
This feature is similar with Email PDF discussed above and uses the same URL parameters. However, this feature sends dashboard images as part of the email body and not as a PDF attachment. In addition, it does not support pagination.
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/
|
The email contains the following Body components:
q Body message: The email starts with the provided body message in the request.
q Dashboard Title: The title displays before the dashboard image and uses a h2 heading tag.
q Dashboard image: The image (.png) of the dashboard.
Usage
q URL: http://[server]/[path]/server/rest/media/image/dashboard/email
q Method: POST
q Content-Type: application/json
q Request body:
· bodyText – The text will appear in the message body. The text can be formatted in HTML. Special characters, such as double quotation marks (“) should have a backslash preceding them in order for the Server to regard them as special characters.
· to - One or more email recipients. Comma is used as a delimiter to separate the email recipients.
· cc – One or more email recipients. Comma is used as a delimiter to separate the email recipients.
· bcc – One or more email recipients. Comma is used as a delimiter to separate the email recipients.
· sender – The sender’s email address. This value will also be used as a username.
· senderpassword – The password to the sender’s email account.
· subject – The subject of the email.
· useHyperlink – The property that determines whether the images should be hyperlinks. The hyperlink then opens the dashboard in the Thin Client. Hyperlinks will be used when set to true (default value). The images will be regular images and not a hyperlink when the property is set to false.
Example
|
Property |
Value |
|
Workbook |
How to Actions |
|
Dashboard Name |
Scatter of Filtered Universe |
|
Recipients (To) |
|
|
Sender |
|
|
Password |
password |
|
Subject |
Altair Image Generator |
|
Body Message |
Hello. This email contains dashboard images. |
|
Use hyperlink |
true |
As an example:
Panopticon configuration (panoption.properties):
email.host=smtp.server.com
email.port=587
email.security.mode=TLS
URL:
http://localhost:8080/panopticon/server/rest/media/image/dashboard/email?workbook=How+To+Actions&dashboard=Scatter+of+Filtered+Universe
Body:
{
"bodyText": "<h1>Hello.</h1><p>This email contains dashboard images.</p>",
"to": "to-mail1@mail.com, to-mail2@mail.com",
"sender": "from-mail@mail.com",
"senderPassword": "password",
"subject": "Altair Image generator",
"useHyperlink": "true"
}