Scheduler

XCALLY section	Tools → Scheduler
On this page	1 Overview 2 Create a Schedule 3 FAQ

Overview

In this section, you can schedule an automated extraction of default or custom reports available under the Analytics section.

The Scheduler Section is under the Tools Menu:

Clicking the three dots button (⋮) next to the schedule, you can:

Edit the schedule
Run the schedule
Delete the schedule

Create a Schedule

To create a new Schedule:

Click the blue + button located at the bottom-right corner of the interface, under Tools → Scheduler

Enter the Schedule’s details:

Name: title of the schedule
Report Type: type, Default or Custom
Report Folder: folder
Report Subfolder: subfolder
Report: report to be extracted. The proposed list is based on the selected Report Type-Folder-Subfolder.
Output: report format. CSV, PDF or Excel
Active: enable/disable the schedule
Start Time: beginning of the time interval where the schedule is active
End Time: end of the time interval where the schedule is active

Cron: day and/or time to run the report extraction
Last: time range for report result
Unit: units used for the Last time range. Example: Last 4 hours, Last 7 days or Last Month.
Send Mail: if enabled, the extracted report will be forwarded by email for the specified recipient email address.
- Mail Account: outgoing mail account configured under SMTP section or Mail Channel e.g. SMTP)
- Email Address: recipient email addres. Multiple addresses can be inserted separated by comma. CC and BCC recipients can also be defined.
Send if Empty: if this flag is enabled, the report will be sent by email even if the content is empty
Description

Click Add Schedule

A schedule will be executed only if active and within the valid time interval [Start Time : End Time].

The extracted report will be available under Analytics → Extracted Reports section where you can Download or Delete the file.

Example

Active: Enabled
Start Time: 2017-07-01, 06:00:00
End Time: 2017-07-31, 06:00:00
Cron (0 0 * * 6): Every Week On Saturday at 00:00
Last: 5
Unit: days

Considering the above values:

The scheduled report is active from 2017-07-01, 06:00:00 to 2017-07-31, 06:00:00
The scheduled report will be executed every week on Saturday at 00:00 (The time to complete extracting a report depends on the number of records in the report)
The report will contain the last 5 days records up to Saturday, 00:00. This means, from Monday 00:00 up to Saturday 00:00

Scheduler email check

Starting from version 3.45.0 a configuration variable ENV XC_DISABLE_ANALYTICS_SCHEDULER has been added to check the start of the email scheduler in the file motion-server-v3/src/app.js and to provide greater flexibility in the management of email scheduler (particularly for multi-server projects, by allowing it to be enabled or disabled via configuration). So with this variable, it is specified which server should send the e-mail.

By default the variable is disabled: if it is not configured or set on false, the scheduler starts
If it is set on true the e-mail scheduler does not start and a warning like this appears in the log console

Analytics Scheduler disabled! Use XC_DISABLE_ANALYTICS_SCHEDULER=false to enable it

FAQ

No, the scheduler works without the email channel license. You can easily set up your email account directly from Settings-->Email section.

If you didn’t received your monthly report by email, you can check:

Scheduler end date: verify that the scheduler is still active in the configuration
The SMTP account credentials