Report schedules allow client_admin users to create and define which reports or exports can be automatically generated and sent on a recurring basis. This functionality must be enabled by a Descartes representative to be visible within the application's Configuration page.
Enabling Report Schedules
The Report Schedules feature is not enabled as default. A user with system_admin role can enable the feature and grant access and capabilities to client_admin and dispatcher_admin users in the Configuration : Parameters : Report / Export section.
Configuring a New Report Schedule
To create a report schedule:
From the System Menu, go to Schedules > Report Schedules.
Report schedules will be listed on a grid, if any. Click Add Report Schedule to open a new schedule configuration form.
Select a Report from the dropdown list that you would like to schedule. Export-type reports will only be generated and sent to locations associated with the respective region.
Give the schedule a Description.
Enter the Email to whom/group the report is to be sent to, if applicable. Entering an email is optional and used when the report is not to be sent to a third-party system. You can enter more than one email by clicking the Add button.
Select the Region(s) or Location(s) from which the report data is to be sourced. You can select a single item or multiple regions/locations simultaneously.
Select the Period Type from the dropdown (Monthy, BiMonthly, Weekly, BiWeekly, Daily) to specify how often the report is to be generated and sent.
Enter the Start Date for when the report should begin to be generated and sent.
Select the Start Day offset to determine what data is to be considered and included in the report. Click
to display examples of how to use this parameter.
Select the Day of Week that the report is generated and sent if the period type is "Weekly" or "BiWeekly".
Enter the Day of Month that the report is generated and sent if the period type is "Monthly" or "BiMonthly".
Enter the Time (in 24-hour format) on which the schedule has to generate and send the report.
Select the Integration Profile that you would like to use with the schedule to send the data to.
Once completed, check I have verified this information to be correct and click Save.
After the Report Schedule is created, the date and the user who created it are displayed in the Created Date and Created User columns of the Report Schedules list.
Configuring a New Report Schedule
To create a report schedule:
Navigate to System Menu > Schedules > Report Schedules.
If any report schedules exist, they will be listed in a grid. Click Add Report Schedule to open a new configuration form.
Select a Report from the dropdown list. Export-type reports will only be sent to locations associated with the respective region.
Enter a Description for the schedule.
(Optional) Enter one or more Email addresses to receive the report. Click Add to include multiple recipients.
Select the Region(s) or Location(s) from which report data should be sourced.
Choose the Period Type (e.g., Monthly, BiMonthly, Weekly, BiWeekly, Daily) to define the report frequency.
Specify the Start Date for report generation.
Configure the Start Day Offset, which determines the data range included in the report. Click ? for usage examples.
If the Period Type is Daily, select the Days of Week on which the report should be generated.
-
If the Period Type is Weekly or BiWeekly:
Select the Day of Week for report generation.
Specify the Week Start Day to define when the reporting period begins.
If the Period Type is Monthly or BiMonthly, enter the Day of Month for report generation.
Set the Time (24-hour format) for the report to be generated and sent.
Select the Integration Profile to be used for data transmission.
Check I have verified this information to be correct and click Save.
Once created, the Created Date and Created User fields in the Report Schedules list will display relevant details.
Editing an Existing Report Schedule
To modify an existing report schedule:
Navigate to Configuration > Report Schedules.
Click the Edit button next to the desired schedule.
Update the necessary fields in the Edit Schedule window.
Check I have verified this information to be correct and click Save.
If no changes are required, click Cancel.
Once modified, the Modified Date and Modified User columns will reflect the update.
Cloning a Report Schedule
Cloning a report schedule is very useful when generating different types of reports using the same schedule settings.
To clone a report schedule:
From the Configuration – View Report Schedules (Configuration > Report Schedules) page, click the Clone button next to the schedule you want to produce a copy of.
Change the applicable settings from within the Edit Schedule report window.
Once completed, check 'I have verified this information to be correct' and click Save.