Scheduling Reports in AdapTable

Summary

Scheduling in AdapTable allows Reports to be run at a chosen time

Scheduling enables actions in AG Grid to automatically happen at a defined time.

One of the main use cases for schedule is to send Reports at defined times.

Each Schedule can be given one of 2 types of dates (and times):

a specified one-off date - e.g. 11 May 2025 at 17:30
reccuring day(s) - e.g. every Friday or every weekday at 9:00

You can use Scheduling to export Reports at specific times and days.

Hint

This is useful if you need to export data at a particular time, e.g. an End of Day report

Both System and User Reports can be scheduled and exported with any Format Type to any Export Destination.

Note

This can also include any Custom Export Destinations which have been specified

Schedules

Fork Fork

This example has 2 scheduled Exports:
- Set to run every Monday at 17:30, it exports the Current Layout Report to Excel
- Set to run 1 minute after this demo opens, it exports a Custom Report (JavaScript Frameworks) to CSV

Try It Out

Change the schedule in the Report so that it exports to a different destination

import {AdaptableOptions} from '@adaptabletools/adaptable';

const today = new Date();
const todayFormatted = today.toLocaleDateString('en-US');
const nowMinutes = today.getMinutes();
const nowHours = today.getHours();
import {WebFramework} from './rowData';

export const adaptableOptions: AdaptableOptions<WebFramework> = {
  primaryKey: 'id',
  adaptableId: 'Report Schedules',
  initialState: {
    Dashboard: {
      ModuleButtons: ['Schedule', 'Export'],
    },
    StatusBar: {
      StatusBars: [
        {
          Key: 'Center Panel',
          StatusBarPanels: ['Schedule', 'Export'],
        },
      ],
    },
    Theme: {CurrentTheme: 'dark'},
    Export: {
      Reports: [
        {
          Name: 'JavaScript Frameworks',
          ReportColumnScope: 'AllColumns',
          ReportRowScope: 'ExpressionRows',
          Query: {
            BooleanExpression: '[language] = "JavaScript"',
          },
        },
      ],
    },
    Schedule: {
      ReportSchedules: [
        {
          Name: 'ReportSchedule-123',
          ScheduleType: 'Report',
          ReportName: 'Current Layout',
          ReportFormat: 'Excel',
          Schedule: {
            OneOffDate: todayFormatted,
            DaysOfWeek: ['Monday'],
            Hour: 17,
            Minute: 30,
          },
        },
        {
          Name: 'ReportSchedule-124',
          ScheduleType: 'Report',
          ReportName: 'JavaScript Frameworks',
          ReportFormat: 'CSV',
          Schedule: {
            OneOffDate: todayFormatted,
            Hour: nowHours,
            Minute: nowMinutes + 1,
          },
        },
      ],
    },
    Layout: {
      CurrentLayout: 'Standard Layout',
      Layouts: [
        {
          TableColumns: [
            'name',
            'language',
            'github_stars',
            'license',
            'has_projects',
            'has_pages',
            'created_at',
            'has_wiki',
            'updated_at',
            'pushed_at',
            'github_watchers',
            'week_issue_change',
          ],
          Name: 'Standard Layout',
          AutoSizeColumns: true,
        },
      ],
    },
  },
};

Using Report Schedules

UI Step by Step Guide

Scheduling a Report in the Schedule Wizard

Configuring Report Schedules

Developer Guide

Providing a Scheduled Report in Initial Adaptable State

There are 3 stages to defining a Report Schedule:

// Create a Schedule for the 'Current Layout' Report
// The Schedule will run on Mondays and Wednesdays at 17:30
const initialState: InitialState = {
    Schedule: {
        ReportSchedules: [
        {
          ScheduleType: 'Report',
          ReportName: 'Current Layout',
          ReportFormat: 'Excel',
          ExportDestination: 'Download',
          Schedule: {
            DaysOfWeek: ['Monday', 'Wednesday'],
            Hour: 17,
            Minute: 30,
          },
        }
      ],
    },
};

Create a ReportSchedule property in Schedule section

Set the ScheduleType property to Report.

Specify the Report Name

Provide the Name of the Report.

Specify the Report Format

Provide the Format of the Report.

Specify the Export Destination

Provide the Export Destination.

Create a Schedule

Specify a one-off date or array of days of the week.

Set the time (Hour and Minute) the Report should run.

Scheduling Custom Reports

(Recorded with AdapTable v14.0)

PreviousProcessing Reports NextConfiguring Reports

Framework: