Alice Williams
1dd560977b
* add files back from lost local files Signed-off-by: Alice Williams <[email protected]> * nest reporting CLI under main Reporting page Signed-off-by: Alice Williams <[email protected]> * rough draft examples for AWS Lambda and Cron Signed-off-by: Alice Williams <[email protected]> * better title for cron job report example Signed-off-by: Alice Williams <[email protected]> * for more details from tech reviewer Signed-off-by: Alice Williams <[email protected]> * for better cron job usage description Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * remove needs info markers and add links to events doc Signed-off-by: Alice Williams <[email protected]> * more info Signed-off-by: Alice Williams <[email protected]> * more details from demonstration Signed-off-by: Alice Williams <[email protected]> * remove reporting directory to keep both parallel in left nav Signed-off-by: Alice Williams <[email protected]> * small addition Signed-off-by: Alice Williams <[email protected]> * for two configuration settings in the function Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * more details from eng meeting adding to the steps Signed-off-by: Alice Williams <[email protected]> * for more details Signed-off-by: Alice Williams <[email protected]> * for additional steps to create and test the lambda function Signed-off-by: Alice Williams <[email protected]> * for scheduling reports with lambda Signed-off-by: Alice Williams <[email protected]> * merge redundant set of steps together Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to add download correct title and link Signed-off-by: Alice Williams <[email protected]> * for reporting directory to nest new cli page Signed-off-by: Alice Williams <[email protected]> * un-nest reporting directory Signed-off-by: Alice Williams <[email protected]> * to remove reporting directory - will nest with other page in separate PR Signed-off-by: Alice Williams <[email protected]> * tech review comments and some reorg Signed-off-by: Alice Williams <[email protected]> * for tech review comments Signed-off-by: Alice Williams <[email protected]> * to minor changes Signed-off-by: Alice Williams <[email protected]> * more info about crontab sequence Signed-off-by: Alice Williams <[email protected]> * cron updates Signed-off-by: Alice Williams <[email protected]> * for cron syntax Signed-off-by: Alice Williams <[email protected]> * small updates to lambda proc Signed-off-by: Alice Williams <[email protected]> * for final writer checklist Signed-off-by: Alice Williams <[email protected]> * cron link update Signed-off-by: Alice Williams <[email protected]> * format fix Signed-off-by: Alice Williams <[email protected]> * for doc review cron & lambda sections Signed-off-by: Alice Williams <[email protected]> * for cron reference to man page Signed-off-by: Alice Williams <[email protected]> * add internal link to cron ref Signed-off-by: Alice Williams <[email protected]> * reorg single topic into 7 pages Signed-off-by: Alice Williams <[email protected]> * minor update Signed-off-by: Alice Williams <[email protected]> * link to set ses permissions Signed-off-by: Alice Williams <[email protected]> * for tech review meeting updates Signed-off-by: Alice Williams <[email protected]> * small update Signed-off-by: Alice Williams <[email protected]> * npm download command name changed to remove opensearch prepended name Signed-off-by: Alice Williams <[email protected]> * for new download via artifacts hub Signed-off-by: Alice Williams <[email protected]> * for new download instructions Signed-off-by: Alice Williams <[email protected]> * small fix signature file Signed-off-by: Alice Williams <[email protected]> * typo Signed-off-by: Alice Williams <[email protected]> * for cleaner image Signed-off-by: Alice Williams <[email protected]> * remove image for push commands we won't use Signed-off-by: Alice Williams <[email protected]> --------- Signed-off-by: Alice Williams <[email protected]>
50 lines
2.1 KiB
Markdown
50 lines
2.1 KiB
Markdown
---
|
|
layout: default
|
|
title: Creating and requesting a visualization report
|
|
nav_order: 15
|
|
parent: Creating reports with the Reporting CLI
|
|
|
|
---
|
|
|
|
# Creating and requesting a visualization report
|
|
|
|
First, you need to get the URL for the visualization that you want to download as an image file or PDF.
|
|
|
|
To generate a visualization report, you need to specify the Dashboards URL.
|
|
|
|
Open the visualization for which you want to generate a report, and select **Share > Permalinks > Generate link as Shapshot > Short URL > Copy link**, as shown in the following image.
|
|
|
|
|
|
|
|
You will need to add the URL with the `-u` argument when you request the report in the CLI.
|
|
|
|
#### Example: Requesting a PNG file
|
|
|
|
The following command requests a report in PNG format with basic authentication and sends the report to an email address using Amazon SES:
|
|
|
|
```
|
|
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address> -f png
|
|
```
|
|
|
|
#### Example: Requesting a PDF file
|
|
|
|
The following command requests a PDF file and specifies the recipient's email address:
|
|
|
|
```
|
|
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address> -f pdf
|
|
```
|
|
|
|
Upon success, the file will be sent to the specified email address. The following image shows an example PDF report.
|
|
|
|
|
|
|
|
#### Example: Requesting a CSV file
|
|
|
|
The following command generates a report that contains all table content in CSV format and sends the report to an email address using Amazon SES transport:
|
|
|
|
```
|
|
opensearch-reporting-cli -u https://localhost:5601/app/dashboards#/view/7adfa750-4c81-11e8-b3d7-01146121b73d -f csv -a basic -c admin:Test@1234 -e ses -s <email address> -r <email address>
|
|
```
|
|
|
|
Upon success, the email will be sent to the specified email address with the CSV file attached.
|