Schedule Data Download

Intended audience: END-USERS DEVELOPERS

AO Easy Answers: 4.3

Overview

The Easy Answers Schedule Data Download option allows users to set up automatic Download Data tasks on a recurring schedule.

Viewing Scheduled Data Downloads

To view the existing Scheduled Tasks and their most recent Status:

On the Dashboard page, click the Dashboard Options menu.
Select Download > Schedule Data Download to open the Schedule Download dialog.
Click either Status or Scheduled Tasks tab.

Status tab	Scheduled Tasks tab

Properties

Label	Defaults	Description
Status
Last Run Status		Indicates the following… Completed - Green - the task has completed successfully. Suspended - Red - the task execution has failed.
Task Name		The Task Name column displays the Name of the task.
Report Type		The Report Type column displays either CSV or Excel.
Filter Name		The Filter Name column displays any saved and applied Filter View Name.
Last Run Time		The Last Run Time column displays the last run date schedule.
Created By		The Created By column displays the name who created the schedule.
Scheduled Tasks
Task Name		The Task Name column displays the Name of the task.
Report Type		The Report Type column displays either CSV or Excel.
Filter Name		The Filter Name column displays any saved and applied Filter View Name.
Last Execution		The Last Execution column displays the most recent time and date of a specific process.
Next Execution		The Next Execution column displays when the task is scheduled to run next.
Recurrence		The Recurrence column displays the time period with which a scheduled task repeats at regular intervals.
Created By		The Created By column displays the name who created the schedule.

Options menu - Status

History - opens a dialog where all past task executions will be listed. The History page can be downloaded in CSV or Excel file format.
Retry - retries the task in case it has failed to execute.

Options menu - Scheduled Tasks

Edit - opens a dialog where the Scheduled Task can be edited.
Delete - deletes the Scheduled Task. A confirmation dialog will be shown.

Creating a Scheduled Data Download

Settings

The settings page allows users to create a named data download, choose the download format, and select any optional extras.

Properties

Label	UI	Defaults	Description
Name	Text Field		The Name field allows user to enter the name of the dashboard.
Download Format		Excel	Select the below format to download the data.
CSV	Radio-button		The user can choose the CSV format for the download, when downloading a single table. If multiple tables are selected, then the .CSV files will be compressed into a .ZIP file.
Excel	Radio-button		The user can choose the Excel format for the download. Each table will be added to a separate sheet in the file.
Include List of Filters for Dashboard, Sections, and/or Apps	Checkbox	Checked	This option will include a list of the Filters applied to the individual Apps. In the CSV format, this data will be included at the top of each CSV file, whereas in the Excel format, the content will be added onto a separate sheet.

Select Apps

The Select Apps page allows users to select each app on the Dashboard page for individual configuration. This includes Download Data options for Table, Chart, and Map apps.

Properties

Label	UI	Defaults	Description
Apps column			Repeater section listing all Apps on the Dashboard.
Checkbox	Checkbox	Checked	A checkbox to let the user select/deselect an App to be included/excluded in the Data Download.
Icon	Icon		The App Icon.
App Name	Read-only Text Field		The App Name.
Filter Icon	Icon		The Filter Icon is shown if the App is impacted from an applied Filter at Dashboard, Section, and/or App Level.
Details column
Icon	Icon		The App Icon.
App Name	Read-only Text Field		The App Name.
Filter Icon	Icon		The Filter Icon is shown if the App is impacted from an applied Filter at Dashboard, Section, and/or App Level.
Filter Text	Read-only Text Field		The Filter Text is shown if the App is impacted from an applied Filter at Dashboard, Section, and/or App Level.
Data to Download for Tables
Records in Current Page	Radio-button		Select to only download the data shown in the table on current page.
The First 10000 Records	Radio-button	Yes	Select to only download the first 10,000 Records from the data source.
All Records (100000 Maximum)	Radio-button		Select to download all records from the data source (up to the maximum number of records configured in masterdata).
Data to Download for Maps
Select Region	Radio-button		The Select Region radio button option allows users to click the Select Region button to open a dialog with a Map view from which a specific area or region can be selected.
All Records ([100,000] Maximum)	Radio-button		The All Records (100,000 maximum) radio button option allows users to download all records up to 100,000. The 100,000 records are a configurable parameter.
Layers			Repeater section showing one or more Layers in the Map window which can be downloaded.
Layer-n Checkbox	Checkbox	Checked	A checkbox to let the user select/deselect a Map Layer to be included/excluded in the Data Download.
Layer-n Icon			The Layer Icon selected to represent the Layer.
Layer-n Layer Name			The Layer Name selected to represent the Layer.

Schedule

On this page, the user can configure the recurring schedule for the Download Data task. The user can configure using either a Basic tab of configuration options, or an Advanced tab.

The configuration options are generally broken down into the following three areas:

Start of recurring schedule.
When and how often to repeat.
End of recurring schedule.

Basic	Advanced

Properties

Label	UI	Defaults	Description
Basic tab
Start Date	Calendar Dropdown	Current Date	Select when the scheduled download shall begin.
Repeat Every	Number Field + Dropdown		Select the recurrence schedule. Options include: Number + Repeat On (for Day/Week options). Number + Month. Year.
Repeat On	Buttons representing Day of Week	Default for Day is “every day of the week” (M,T,W,T,F,S,S). Default for Week is “today”.	If Day or Week are selected in Repeat Every property, then select which days of the week the recurrence schedule shall use.
Month	Radio-buttons	On day [current_day_number]	If Month is selected in Repeat Every property, then select the meaning of today relative to the month, including: On day [current_day_number] On the first [current_day]
Year	Radio-buttons	On [current_month current_day_number]	If Year is selected in Repeat Every property, then select the meaning of today in current month, including: On [current_month current_day_number] On the first [current_day] of [current_month]
End Date	Radio-buttons	Never	Select when the scheduled download shall end. Options include: Never - if no End Date, the schedule will run to infinity and beyond. On - select a specific End Date from Calender widget. After - choose a number of occurrences.
Advanced tab
At	Read-only Start Time	00:00	Shows the initial start time for recurrence schedule. This text will update when Starts property is updated.
Tab for different granularity of recurrence schedule
- Seconds	Tab w/properties		Includes options to select a specific Second for recurrent schedule.
- Minutes	Tab w/properties		Includes options to select a specific Minute for recurrent schedule.
- Hours	Tab w/properties		Includes options to select a specific Hour for recurrent schedule.
- Day	Tab w/properties		Includes options to select a specific Day for recurrent schedule.
- Month	Tab w/properties		Includes options to select a specific Month for recurrent schedule.
- Year	Tab w/properties		Includes options to select a specific Year for recurrent schedule.
Resulting Cron Expression	Text Field	0 0 0 ? * * *	The Cron expression changes depending on the properties configured on the tabs. Alternatively, the advanced user can enter a specific Cron expression directly. References: https://en.wikipedia.org/wiki/Cron and https://crontab.cronhub.io/.
Starts	Date and Time Widgets	Today’s Date + Current Time	Select a start Date and Time for the recurrence schedule.
Ends	Radio-buttons	Never	Select when the scheduled download shall end. Options include: Never - if no End Date, the schedule will run to infinity and beyond. On - select a specific End Date from Calender widget. After - choose a number of occurrences.

There are two types of Share options as a result of a scheduled Download Data task:

Desktop Notifications - these notifications will appear on the screen for immediate feedback on the Scheduled Download Data task.
Email Notifications - these notifications will be sent to the users associated with the Roles configured in this screen.

Properties

Label	Defaults	Description
Notification Recipients		The Notification Recipients allows user to select a group to receive a notification upon the execution of the Scheduled Data Download task.
Email Message		The Email Message is an optional message to describe what the Scheduled Data Download task includes.
Download Link
Expires In		The Expires In dropdown allows user to select 1 to 6 days as the expiry of the link post the email timestamp.
Cancel		The Cancel button allows user to cancel the created Data Download Schedule.
Save		The Save button allows user to save the created Data Download Schedule.

Email Template for Scheduled Download Data Notification

In addition to receiving a Desktop Notification when a Download Data task has been executed, the users belonging to the Roles configured on the Notification page will also receive an email notification with a Download Data link.

Contact App Orchid | Disclaimer