SchedulerS

SchedulerS is a standalone service component part of the CGRateS infrastructure, designed to execute account actions at scheduled times. It is configured via ActionPlans, with FilterS support to limit which accounts are targeted.

SchedulerS can be dynamically started and stopped via the ServiceManager.

Complete interaction with SchedulerS is possible via CGRateS RPC APIs.

Processing logic

An ActionPlan groups one or more ActionTimings, each specifying when a set of Actions should run and on which accounts. When SchedulerS starts or reloads, it fetches all ActionPlans from DataManager and builds a sorted priority queue of ActionTimings.

ActionTimings marked as *asap are not queued and are executed when the ActionPlan is loaded. ActionTimings whose next start time is in the past are discarded.

The scheduler calculates the exact time until the next ActionTiming is due and sleeps until then. After execution, recurring ActionTimings are reinserted into the queue with their next calculated start time. A reload via API causes the loop to restart and rebuild the queue from the updated ActionPlans.

Filters defined in the configuration are applied during queue building, removing non-matching accounts from each ActionTiming before it is queued.

Parameters

It is configured within the schedulers section from JSON configuration via the following parameters:

enabled

Will enable starting of the service. Possible values: <true|false>.

cdrs_conns

Connections towards CDRs used for *cdrlog actions. Possible values: <””|*internal|$rpc_conns_id>.

filters

List of filter IDs applied during queue building. Non-matching accounts are removed from each ActionTiming before it enters the queue.

APIs logic

SchedulerSv1.Reload

Triggers a full queue rebuild from the current ActionPlans in DataManager.

APIerSv1.GetScheduledActions

Returns the ActionTimings currently in the scheduler queue, with optional filtering and pagination. Tenant and Account filters apply only to ActionTimings that have accounts linked to them.

Tenant

Return only ActionTimings with accounts matching this tenant.

Account

Return only ActionTimings with accounts matching this account ID.

TimeStart

Return only ActionTimings with NextRunTime at or after this value.

TimeEnd

Return only ActionTimings with NextRunTime strictly before this value.

Limit

Maximum number of results. All matching records are returned if not set.

Offset

Number of records to skip before returning results.

Each returned record contains:

NextRunTime

When this ActionTiming is next scheduled to run.

Accounts

Number of accounts it will run on.

ActionPlanID

The ActionPlan this ActionTiming belongs to.

ActionTimingUUID

Unique identifier of the ActionTiming.

ActionsID

The Actions set to be executed.

Use cases

• Monthly balance top-ups or resets across a set of accounts.

• Executing account actions at a specific time of day.

• Running multiple ActionTimings within a single ActionPlan at different schedules.

• Limiting scheduled action execution to specific accounts using FilterS.

• Checking the scheduler queue and next execution times via GetScheduledActions.