Scheduled Reports
What is it used for (purpose)?
- The Scheduled Reports tab displays a list of all reports for which a schedule was set up and you are a recipient. Each report card will contain: Report Name, Next Run info, Last Execution (date & timestamp), Type of Schedule (Daily, Weekly, Monthly) and Status of Schedule.
What is on this page?
- Your Report Schedules
- Search is enabled for scheduled reports
- Count - total number of scheduled reports
- Sort Options (left pane)
- Last Run Date (default)
- Created Date
- Detail for selected Scheduled Report (right hand pane)
- Detail
- Information
Navigation (How do I get to Scheduled Reports?)
- There are two ways to navigate to this page
- Via the Home page
- Click Reporting on the frequently used Apps or Available Apps
- By default, you will be taken to the Report Catalog page from the Report Catalog page on the upper pane select Scheduled Reports
- Using the Navigation bar
- Click Apps button on the top right corner of the Navigation Bar, and you can see all available apps
- Click the Reporting App
- By default, you will be taken to the Report Catalog page from the Report Catalog page on the upper pane select Scheduled Reports.
- Via the Home page
How do you use the functionality on this page (Scheduled Reports)?
- Select one of the scheduled reports, the Detail page is visible by default
- Collapsible menu items for a selected scheduled report are:
- Detail - see Description Summary, Frequency, Expiry Date, Schedule Set Up (Hour of the day in UTC & Recipient list), Global Report Parameters, Report Parameters (by sheet)
- Information - see Description, Created By, Created Date, Updated By, Updated Date and Last Run Date.
Actions you can take (In default Detail page):
- Archive- allows you to stop a scheduled report. The report will be archived (status badge will update from Active to Archived) and cannot be reactivated. No actions buttons will be available on the Detail page
- Go To Report - permission based - access the report the schedule was created for. Create a new schedule from there or edit the report
- Edit - permission based - an existing schedule can be modified by the owner (change frequency, Day of the week, Hour of the day, Report expiry, Recipients). Click Submit to apply changes.
- Pause - permission based - the selected report can be modified by the owner. Modifications can be any of the following:
- Removal of a sheet
- Removal of a filter
- Removal of a parameter
- Removal of a stored procedure
If any of the above modifications is made to the report, any schedules of the report, will be automatically paused and the owner of the schedules will receive a 'Report Schedule(s) Paused' notification informing which report schedules have been paused due to changes made to the report AND
The schedule owner will be advised to fix/review and then reactivate affected schedules. The notification will contain a link to the help content for Scheduled Reports (this page)
- Where a report schedule is paused (status badge changed from Active to Paused) and a new action button will be available: Reactivate
- Reactivate button prompt will inform: Schedule Has Breaking Changes. Please review before reactivating
- Schedule Name: Cadence, day / time
- Affected Areas e.g. Filters were removed from sheet 'WBL', Filters were removed from sheet 'Sheet'
- Click Ok
- Edit the schedule
- Fix any breaking changes e.g.
- a subsequently deleted parameter was used when the schedule was first set up, so this schedule is 'broken' - click Edit & Submit & Reactivate
- a parameter was added - Click Edit & parameter must be manually added to the schedule too (as the schedule was created before the report was changed), Submit & Reactivate
- Reactivate button prompt will inform: Schedule Has Breaking Changes. Please review before reactivating
-
- If a paused scheduled report is reactivated, the status badge will update from Paused to Active.
How to edit a schedule from Scheduled Reports?
- Click Edit
- A 'Schedule Report' pop up appears
- Existing configuration will be visible
- Make your changes (change frequency, Day of the week, Hour of the day, Report expiry, Add or Remove Recipients OR add a parameter if you are fixing a paused schedule)
- Re report recipients:
- If any selected recipient does not have permission for a report, the system will skip the user and only make the report available to those with permission.
- Submit changes to apply