Scheduling Reports
- Matthew Garrett
- Sam Pitts
Article Index
Overview
This article explains how to utilise the new Report Scheduling feature introduced in Framework Version 8.0. The report scheduling tool allows users of Framework to automatically generate and email reports to defined recipients.
All emails are sent out via the Cloud Gateway emailing system.
Scheduling a report
All scheduled reports require a Framework report profile to run, as the profiles set the criteria that will be applied.
To ensure scheduled reports always show the information you need, use dynamic date options like "This Week" or "Next Week" instead of setting specific dates (if/where applicable). This way, your reports will run automatically with the correct timeframe each time.
If criteria customisations are required each time you run the report, this may not work as expected in a scheduled report.
Refer to our existing guides for creating and managing report profiles.
Creating a New Report Profile - Framework - Confluence
Follow these steps to schedule a report.
Select Reports from the Tool bar.
Choose the Category of report.
Click on Schedules.
Click on the report profile that you want to schedule.
Click New.
General Tab
Enter a name for the schedule.
Enter a subject that will be used when emailing the report.
Enter the body text for the report email.
Set the Recurrence of the schedule.
Set the time the report should be run at.
Set the date to start the scheduled reporting.
Criteria Tab
Select the region/division that this report schedule applies to.
Note: All other criteria are specified in the report profile. If changes are required, update the report profile itself.
Recipients Tab
On the Recipients tab you can select the Framework Staff that you want the email to go to. You can also enter non-Framework Staff entities manually.
Viewing the schedule history
To view the history of a scheduled report, open the reports menu.
Select the report you want to view and click on the Schedules tab.
Click on the Schedule that you want to view.
Click Edit or View.
Click on the History tab.
Click on the schedule history record you want to view.
The detailed log for the report schedule will be displayed.
Permissions - ECM Setup
There are new preferences to control access to report scheduling functionality.
Select Security > Permission.
Expand Enterprise Construction Management.
Click on File Menu.
Amend the permissions as required.
Preferences - ECM Setup
There are preferences required to use scheduled reports.
They must be set prior to the scheduled task being created, as the task will not launch without them.
Ensure that you have your Cloud Gateway Emailing setup as this is required.
Framework ECM - Preferences (SMS/Email) - Framework KB - Confluence
Ensure that you have an ‘Email From Address’ specified in your preferences, in the below location.
Framework ECM → Email/SMS Configuration → Master Email Settings
The report scheduler tool requires a UNC path be configured for your Framework folder preferences.
Framework ECM → Configuration → Folders/Paths → Framework ECM Folders
Preferences - Framework - Confluence
Scheduled tasks do not, by default, have access to network drives and a UNC path must be used instead to ensure the scheduler can run, save and send reports.
Setting up the Task Scheduler
A scheduled task is required to be setup to send out the emails on the desired schedule. This uses the Framework application via command-line to initiate the scheduled reports process.
The below steps detail how this report scheduler task should be setup by default.
Only one server/machine is required to be set up with the scheduled task. This does not need to be set up on multiple computers/servers.
This is typically the designated ‘Integration’ server that holds other scheduled tasks for Framework.
Open Task Scheduler
Right-click on Task Scheduler Library (or desired scheduler folder) and press Create Task
Enter the name of the task, e.g., “Framework Scheduled Reports”, and select the “Run whether user is logged on or not” option.
Note that the user the task is running as must have access to the Framework ECM database.
If setting this up for a specific user account, select the Change User or Group option to enter the credentials.Click on the Triggers tab and press New.
Select the Weekly option and tick the days that the scheduled reports should run (recommended: working days)
Enter the start time that it should start generating the reports from (recommended: 7AM)
Repeat the task every 30 minutes for a duration of (recommended: 12 hours, e.g., from 7AM to 7PM)
Stop the task if it runs longer than 25 minutes
It is important that your trigger is setup every 30 minutes during the time period the automated reports are to run.
This is because the task itself will be the mechanism for the reports to be sent.
Given they are setup in 30-minute increments, the task should run every 30 minutes to support this.
Setting up the task to fall within a normal operating window (where these emails should be received) will ensure incorrectly setup schedules will be sent on the first run for the day, i.e., 7 AM.
If the reports are meant to be sent at any time of day, ensure that the task is instead repeated for a duration ‘Indefinitely’.
Click on the actions tab.
Select Browse and navigate to this directory to select the Framework.exe file
C:\Program Files (x86)\Insula Group Pty Ltd\Framework\Bin\Add an argument of /ReportSchedule
On the Conditions tab make sure the following options are selected.
On the Settings tab set it as follows.
