|
Panopticon Real Time provides the functionality to generate and download PDFs. Use the following URL to download PDFs from the server:
q URL: http://[server]/panopticon/server/rest/media/pdf
The URL can be accessed through scheduled batch tasks to retrieve and process generated PDFs. (e.g., email to predefined mailing list).
Each URL has the following properties:
q Mandatory arguments
· Workbook – Workbook name without an extension.
q Optional arguments
· Dashboard – Dashboard name in the workbook.
· HideScrollbars – Show/Hide the visualization scrollbar in the PDF. Possible values are true/false. The default value is true.
· EnablePagination– Enable pagination in the PDF. Possible values are true/false. The default value is true.
The following examples show how to export a PDF from a local Server. For these examples, we have used the example workbook How To Actions.
q Generate PDF report of the entire workbook
· Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Workbook name}
· Example: Error! Hyperlink reference not valid.http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions
q Generate PDF report of the entire workbook in a folder
· Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Folder name%5CWorkbook name}
· Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=my+folder%5CHow+To+Actions
|
NOTE |
When the workbook name specifies any folder or subfolders, the path delimiter must be backslash (URL-encoded as %5C) and not forward slash (URL-encoded as %2F).
|
q Generate PDF report of a single dashboard in the workbook
· Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Workbook name}&dashboard={Dashboard name}
· Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&dashboard=How+To+Actions
· Example (Multiple dashboards): http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&dashboard=How+To+Actions&dashboard=Data+Entry
q Hide scrollbars from visualizations in the PDF
· Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Workbook name}&hideScrollbars={true/false}
· Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&hideScrollbars=true
q Enable or disable pagination of visualizations with vertical scrollbars in the PDF report
· Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Workbook name}&enablePagination={true/false}
· Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&enablePagination=true
Dashboard Parameters
The PDF report can be generated based on the workbook data table parameters. The parameter and its values can be specified to determine the context of the generated PDF report.
Syntax: http://[server]/[path]/server/rest/media/pdf?workbook={Workbook name}&{dashboardParameterName1=value1}&{dashboardParameterName2=value2}
Adding Region=Europe and Industry=Financials parameters
Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&dashboard=Scatter+of+Filtered+Universe&Region=Europe&Industry=Financials
Adding Region=Asia Pacific, or Region=Europe and Industry= Financials parameters produces an output PDF that is focused on Asia Pacific & European Financials. In this case the Region parameter is repeated for each of the supplied regions.
Example: http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions&dashboard=Scatter+of+Filtered+Universe&Region=Asia+Pacific&Region=Europe&Industry=Financials
Authentication
In order to generate certain workbooks, the user might need to be authenticated. The user will be prompted with a login window if the user tries to export a PDF from a web browser. The user can also send the credentials via a header to be authenticated. This could be necessary if the user is using commands like wget to invoke the Server to generate PDFs.
The credentials are sent as basic authorization. The user provides the credentials in the Authorization header. The value is formatted in the following way: Basic username:password. Please note that the username and password must be Base64 encoded. Example: MyUsername:MyPassword = TXlVc2VybmFtZTpNeVBhc3N3b3Jk
Wget example: wget -O “Output.pdf” --header="Authorization: Basic TXlVc2VybmFtZTpNeVBhc3N3b3Jk“ “http://localhost:8080/panopticon/server/rest/media/pdf?workbook=How+To+Actions”
The PDF generator supports the following authentication mechanisms:
q BASIC
q LDAP
q Filter authentication
q Header authentication
q Windows authentication