Let's get started!
Parameters allow dashboard slicers to be linked to scheduled report tasks. This enables users to specify filter values when creating a scheduled task, ensuring the generated report only includes the required data.
Once configured, users can select parameter values each time a scheduled report is created, without needing to edit the dashboard.
Before you begin
Before configuring parameters for scheduled reports, ensure:
The dashboard has already been created.
The dashboard contains one or more slicers.
You have permission to edit dashboards.
Step 1: Create a Parameter
Edit the dashboard (via the ellipsis) report that you want to configure for scheduled reporting.
Click anywhere on the dashboard canvas (outside of any report objects) to select the dashboard itself.
Open the Inspector tab.
Under the GENERAL section, locate Parameters.
Click the Plus button to create a new parameter.
The Parameter window will appear.
Complete the following fields:
Name: Enter the parameter name.
Prompt: Enter the prompt name that will be displayed when configuring the scheduled task.
Show in the scheduled task: Tick this checkbox to make the parameter available when creating scheduled reports.
After enabling Show in the scheduled task, additional configuration options will become available.
In the Available Values section:
Select the appropriate field in the Value Field dropdown.
Verify that the Data Type matches the data type used by the corresponding slicer in the dashboard. This is important to ensure the parameter functions correctly.
Click OK to save the parameter.
Note: It is recommended that the Name and Prompt closely match the name of the corresponding dashboard slicer to make identification easier.
Step 2: Bind the Parameter to a Dashboard Slicer
Select the slicer that you want to link to the newly created parameter.
Open the Inspector tab.
Under the INTERACTION section, locate Default Value.
Open the Default Value dropdown and select the parameter you created.
Once successfully configured, the slicer will display the text:
Bind To <Parameter Name>
This confirms that the slicer has been successfully linked to the parameter.
Click the Save icon on the dashboard toolbar.
When the Save Dashboard window appears, click OK to save the changes.
Close the dashboard.
Step 3: Create a Scheduled Report
Scheduled Reports allow reports to be generated and distributed automatically on a defined schedule, removing the need to run them manually.
Schedules can be created from System Settings or directly from a Customer record when configuring reports for a specific customer.
When creating a schedule, you select the report, define how often it should run, configure any report parameters, choose the recipients, and specify the delivery settings.
Reports can be scheduled to run once or recur daily, weekly, monthly, or at another defined interval.
Note: SSR reports must either be added to your Favourites or stored within an SSR Category before they can be scheduled. If reports are being sent to external email addresses, External Safe must be enabled, and the report must be stored within the External Safe category.
Learn more about the whole process:
Step 4: Complete the Basic Information
In the DETAILS section, enter a description for the scheduled task.
Configure the remaining required settings, including:
Execution: Specifies when and how often the scheduled task will run.
Task History Expiration Time: Defines how long the task history will be retained before it is automatically removed.
Click Next.
Step 5: Configure the Report Parameters
In the Export Settings section, open the Parameters tab.
The parameter created earlier will now be displayed.
Select the desired value for the parameter.
Click Next to continue.
Step 6: Configure Email Delivery
In the Delivery section, configure how the scheduled report will be delivered.
Complete the following fields:
Email To (Required): Enter one or more recipient email addresses.
Reply To: Optional reply-to email address.
Subject: By default, this is set to Scheduled Dashboard, but it can be modified if required.
Body: The email message sent to recipients.
The default email body is:
Here is the &DashboardName dashboard. The update time of referenced datasets is &DataRefreshTime. The dashboard is linked below. &Link
The placeholders are automatically replaced when the email is sent:
&DashboardName: Displays the dashboard name.
&DataRefreshTime: Displays the latest dataset refresh date and time.
&Link: Inserts a link to the dashboard.
Finally, select the desired Attachment Type:
File Attachment: Sends the report as an email attachment.
Online Link: Sends a link to view the report online.
Download Link: Sends a link that allows recipients to download the report.
After completing all required fields, click OK to save the scheduled task.
Result
The scheduled task is added to the Tasks tab.
When the scheduled execution time is reached, SSR generates the dashboard using the selected parameter values and delivers the report using the configured delivery method.
Related Articles