Reports
You can create reports on Visualization or Dashboards. Once you add and configure a report on dashboard or visualizations, you can schedule the frequency at which you wish to receive Reports as Emails. You can create multiple reports on Dashboards and Visualizations.
Enabling Reports
To enable the Reports feature, you must create a role, create a user, and assign the role to the user.
Creating a Role
To create a Role:
- Click the users icon.
- Click +Create Role.
- In the Name field, enter Report_Generator.
- Select the required permissions.
- Click Save.
Create a User
To create a User:
- Click the users icon.
- Click the Users tab.
- Click +Create User.
- Enter report_generator in the User Name field.
- Contact Acceldata SRE team for the password.
- Select the Report_Generator role.
- Click Save.
Add Reports
To add reports on Dashboards or Visualizations:
- Navigate to Dashplots.
- Click either Dashboards or Visualizations tab.
- Click the ellipsis menu on the right end for the required Dashboard/Visualization.
- Select Add Report.
Reporting Sections
The Reporting feature has two sections.
Schedule
In this section, you can set the schedule and frequency at which you want to receive the reports. The various fields in this section are as follows.
| Field | Descriptions |
|---|---|
| Title | Displays the assigned name of the visualization. You can change the title. It is a required field. |
| Start from | Displays the visualization's default start date. When you click on the date field, a calendar appears where you can edit the day and time. It is a required field. |
| Repeat | This determines the frequency of the notifications. The dropdown menu provides the frequency type of Hourly, Daily, Weekly, and Monthly. It is a required field. |
| Description | You can give a brief explanation of the type of visualization. |
Notifications
In this section, you can define the recipients of the report.
To integrate Slack with Dashplots, perform the following steps:
- Create User OAuth Token for Slack with scope files:write and files:write:use. For details, see How to create an app and retrieve OAuth token in Slack and https://api.slack.com/authentication.
- Add the environment variable
SLACK__USER_OAUTH_TOKEN=<user OAuth token>in$AcceloHome/config/docker/addons/ad-notifications.ymland restart ad-notifications.
| Field | Description |
|---|---|
Email To: It is a required field. Enter the email address to which the notification should be sent. CC: It is an optional field. Enter the email address to which the notification should be sent. BCC: It is an optional field. Enter the email address to which you want the notification delivered. When you put email addresses in the BCC field of a message, the addresses are hidden from the recipients. | |
| Slack | Slack Webhook URL: It is a required field. Enter the webhook URL to which the notification should be sent. |
Always give a unique name to the Report Title. Pulse soft deletes a removed report, creating a new report with the same name as previously will result in a constraint error on the report title.
Email Notification
The following is an example of the email notification that is sent to users along with the report.
Slack Notification
The following is an example of the Slack notification that is sent to users along with the report.
