AdapTable Version:

Framework:

Scheduling in AdapTable

Summary

Scheduling in AdapTable allows defined actions to be performed at a given point in time
The Schedule can be either a one-off date or an activity to be repeated on specified days of the week
There are a few activities in AdapTable that can be scheduled:
- Reminders - essentially Alerts that fire
- Reports - you can schedule any type of Report to run at a chosen time
- ipushpull Reports (if using the ipushpull Plugin)
- OpenFin Reports (if using the OpenFin Plugin)

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

There are 2 main actions which can be scheduled by AdapTable:

Reminders - essentially scheduled notifications
Reports

Note

Schedules can also be used to export data from ipushpull or OpenFin (if relevant plugins are installed)

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

Reminders

Reminders are provided by AdapTable to ensure that users don't forget important grid actions.

Essentially Reminders are Alerts, but which run according to a predefined Schedule rather than being automatically triggered by data changes.

Note

When invoked, the Reminder is converted into an Alert and displays in the Alert Toolbar, Tool Panel and Status Bar

Reminders can be set to display a Toast Notification when they run.

Find Out More

See Reminders in AdapTable for more information

Reports

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

Hint

This is useful if you need to send a report 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.

Find Out More

See Scheduling Reports for more information

Defining Schedules

All Schedules are defined in Schedule Initial State.

Caution

This means that Report Schedules, for example, are stored in Schedule State (and not in Export State)

This will ensure that the Schedules are re-created each time the Application loads, and that any changes will be stored with Adaptable State.

Developer Guide

Defining a Schedule in Initial Adaptable State

Three properties are required when creating the Scheduling section of a Schedule object.

Note

You will never create a standalone Schedule in practice; instead you will put it in a Reminder Schedule or a Report Schedule

Schedule: {
    DaysOfWeek: ['Monday', 'Friday'],
    Hour: 17,
    Minute: 30,
},

Specify either Days of the Week...

Provide an array of Day Names - specify as many as required.

The Schedule will fire on each day provided every week from now on.

Schedule: {
    OneOffDate: '2022-01-18',
    Hour: 17,
    Minute: 30,
},

...or a One-Off Date

Alternatively provide a Date in format 'yyyy-mm-dd'.

The Schedule will fire only once - on the day provided.

Schedule: {
    OneOffDate: '2022-01-18',
    Hour: 17,
    Minute: 30,
},

Specify the Hour of the day at which the Schedule should Run

This should be a number between 0 and 23

Schedule: {
    OneOffDate: '2022-01-18',
    Hour: 17,
    Minute: 30,
},

Specify the Minute of the day at which the Schedule should Run

This should be a number between 0 and 59

Using Schedules

Run-time access to Schedules is available in the Schedule section of the Settings Panel.

This displays a list of existing Schedules with buttons to edit, suspend, share or delete each item.

New Schedules can be created by clicking the New button and choosing the type of Schedule that is required from the Dropdown - this will start the Schedule Wizard.

Note

Different steps are shown depending on whether Reminder or Report Schedules were selected

Setting UI Entitlements

The UI Entitlements behaviour for Scheduling is as expected for Full and Hidden Access Levels.

The ReadOnly Entitlement behaviour is that Schedules will run normally as defined but Users are not permitted to create, edit, delete, share or suspend them.

FAQ

Can I create Schedules in Initial Adaptable State Yes. Note that all Schedules are stored in the Schedule section rather than with the objects (e.g. Export).

AdapTable Resources

PreviousTechnical Reference NextReminders

Framework: