Panopticon Real Time provides the functionality to generate and email PDFs.
This feature works exactly as the URL PDF generation and uses the same URL parameters. The main difference between the two features is that this feature sends the PDF in an email rather than downloading it as a file. Another difference is this feature
requires a POST request to the following URL: http://[server]/[path]/server/rest/media/pdf/email.
Usage
The following properties can be configured:
- URL: http://[server]/[path]/server/rest/media/pdf/email
- Method: POST
- Content-Type: application/json
- 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.
Example
For example, an On-Demand PDF will be emailed based on the following information:
| Property | Description |
|
Workbook |
How to Actions |
|
Dashboard Name |
Scatter of Filtered Universe |
|
Recipients (To) |
to-mail1@mail.com to-mail2@mail.com |
|
Sender |
from-mail@mail.com |
|
Password |
password |
|
Subject |
Altair PDF Generator |
|
Body Message |
Hello. This is an auto-generated PDF. |
As an example:
Panopticon configuration (Panopticon.properties):
email.host=smtp.server.com email.port=587 email.security.mode=TLS
URL:
http://localhost:8080/panopticon/server/rest/media/pdf/email?workbook=How+To+Actions&dashboard=Scatter+of+Filtered+Universe
Body:
{
"bodyText": "<h1>Hello.</h1><p>This is an auto-generated PDF.</p>",
"to": "to-mail1@mail.com, to-mail2@mail.com",
"sender": "from-mail@mail.com",
"senderPassword": "password",
"subject": "Altair PDF generator"
}
(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.