Versions Compared

Version Old Version 5 New Version Current
Changes made by

XCALLY Knowledge

Product Knowledge

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

ON THIS PAGE:

Table of Contents
Image Removed   In

XCALLY section

Tools → Scheduler

On this page

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printablefalse

📋 What’s about

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

The Scheduler Section

The Scheduler Section is under the Tools Menu:

Image RemovedImage Added


Create a Schedule

💡 How it works

To create a new Schedule click on Image Removed (blue star)

Image RemovedImage Added


Enter the following details and then click on Add Schedule:

  • Name: title of the schedule

  • Report Type: choose between Default or Custom

  • Report Folder: choose one item among the proposed list of folders (the actual list shows all the existing folders)

  • Report Subfolder: choose one item among the proposed list of subfolders (the actual list shows all the existing subfolders in the previously selected folder)

  • Report: the report to be extracted. The proposed list is based on the selected Report Type-Folder-Subfolder. 

  • Output: report format.  CSV, PDF or Excel

  • Active: toggle on/off to 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


Image RemovedImage RemovedImage AddedImage Added

  • Cron: day and/or time to run the report extraction 

  • Last: time range for report result

  • Unit: units used for the Last 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 address (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

Note

A schedule will be executed only if the schedule is active and it's 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.

Info

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:

  1. The scheduled report is active from 2017-07-01, 06:00:00 to 2017-07-31, 06:00:00

  2. 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)

  3. 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

A scheduler can be edited and modified, run or deleted.

Click on Image Removed(blue star)  and choose the command in the menu:

Image Added


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:

Image Removed

  • 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