Skip to main content
Skip table of contents

Schedule Report Download

Intended audience: END-USERS DEVELOPERS

AO Easy Answers: 4.3

Overview

The Easy Answers Schedule Report Download option allows users to set up automatic Download Report tasks on a recurring schedule. Please note that only Public Dashboards can be scheduled for download.

image-20250613-141405.png

Viewing Scheduled Report Downloads

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

  • On the Dashboard page, click the Dashboard Options menu.

  • Select Download > Schedule Report Download to open the Schedule Download dialog.

  • Click either Status or Scheduled Tasks tab.

Status tab

Scheduled Tasks tab

image-20250617-094120.png
image-20250617-093717.png

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 CONCISE or VERBOSE. Concise is a “screenshot” style compressed format, whereas Verbose shows all Apps, and optional Data Summaries and Applied Filters in the PDF output within their respective Layout sections.

  • 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 CONCISE or VERBOSE. Concise is a “screenshot” style compressed format, whereas Verbose shows all Apps, and optional Data Summaries and Applied Filters in the PDF output within their respective Layout sections.

  • 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 Report Download

Settings

The settings page allows users to create a named data download, choose the download format, and select any optional extras. Please note that only Public Dashboards can be scheduled for download.

image-20250617-093829.png

Properties

Label

UI

Defaults

Description

Name

Text Field

 

The Name field allows the user to enter the name of the Dashboard Report.

Download Report Options

 

Select the format below to download the data.

  • Email with PDF Report Attached - Concise Format

Radio-button

Selected

This produces a very Concise format report based on the same layout and formatting as seen on screen. The output can be sent to a printer, a PDF format, or other formats available from the workstation’s Print options.

  • Email with PDF Report Attached - Verbose Format

Radio-button

This creates a PDF file in a Verbose format which will be downloaded to the user’s workstation, including Header information, Sections, Apps, and optional Applied Filters and Data Summaries.

  • Include List of Filters for Dashboard, Sections, and/or Apps

Checkbox

Unchecked

This option will include a list of the Applied Filters in a section for the individual Apps. This option is specific to Verbose Format.

  • Include Data Summaries

Checkbox

Unchecked

This option will include a section for the individual Apps where the output is explained as a Data Summary in plain English. This option is specific to Verbose Format.

Wait Time Before PDF Generation Begins

Number Field

180 Seconds

Larger Dashboards take extra time to load. If the downloaded Report is missing Apps, increase the value to ensure the full Dashboard is loaded before the PDF Report generation begins.

Schedule

On this page, the user can configure the recurring schedule for the Download Report task. The user can configure using either the Basic tab of configuration options, or the 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

image-20250617-095901.png
image-20250617-103903.png

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 the 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 the 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 the 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 the Calendar widget.

  • After - choose a number of occurrences.

Advanced tab

  • At

Read-only Start Time

00:00

Shows the initial start time for the recurrence schedule. This text will update when the Starts property is updated.

  • Tab for different granularity of recurrence schedule

  • - Seconds

Tab w/properties

Includes options to select a specific Second for a recurrent schedule.

  • - Minutes

Tab w/properties

Includes options to select a specific Minute for a recurrent schedule.

  • - Hours

Tab w/properties

Includes options to select a specific Hour for a recurrent schedule.

  • - Day

Tab w/properties

Includes options to select a specific Day for a recurrent schedule.

  • - Month

Tab w/properties

Includes options to select a specific Month for a recurrent schedule.

  • - Year

Tab w/properties

Includes options to select a specific Year for a 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 the Calendar widget.

  • After - choose a number of occurrences.

Share

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

  • Desktop Notifications - these notifications will appear on the screen for immediate feedback on the Scheduled Download Report task.

  • Email Notifications - these notifications will be sent to the users associated with the Roles and Individual Users configured in this screen.

image-20250617-100033.png

Properties

Label

UI

Defaults

Description

Recipients by Role

Dropdown with Tags

 

The Recipients by Role allows the user to select a group to receive a notification upon the execution of the Scheduled Report Download task.

Share with Individual Users

Text Field

The Share with Individual Users option allows the user to identify individual users as recipients for the Scheduled Report Download task.

Email Message

Multi-Line Text Field

 

The Email Message is an optional message to describe what the Scheduled Report Download task includes.

Download Link

 

  • Expires In

Dropdown

 

The Expires In dropdown allows the user to select 1 to 6 days as the expiry of the link post the email timestamp.

Cancel

Button

The Cancel button allows the user to cancel the created Report Download Schedule.

Save

Button

The Save button allows the user to save the created Report Download Schedule.

Examples of Downloaded Reports

In Concise Format (as shown on screen)

In Verbose Format (PDF output)

image-20250320-170659.png


Contact App Orchid | Disclaimer

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.