How to Configure the Scheduler Window in iDempiere

Introduction

The Scheduler window lets users automate recurring background processes without manual intervention.

It is used across modules to run routine housekeeping tasks such as clearing old notes, sending recurring reminders, or generating periodic reports.

Scheduled processes run silently at defined intervals, keeping data clean, reducing manual workload, and ensuring notifications reach the right recipients.

Process Flow

TenthPlanet-iDempiere-SystemAdmin-Scheduler-ProcessFlow

Business Rules

  • Only an Active scheduler runs automatically at the defined interval.
  • The Process field determines which task the scheduler executes.
  • The Schedule field decides how often the process repeats.
  • Days to keep Log controls how long execution history is retained.
  • Process Parameters pass required values to the scheduled process automatically.
  • Scheduler Recipients receive notifications about the process outcome.
  • Each run creates a Log record showing success or failure.
  • A failed notification does not stop the scheduled process from running.

Prerequisites

  • A valid User or Role available for notification recipients.
  • Mail Template configured, if email notifications are required.
  • Business Partner or User records set up for Scheduler Recipients.
  • Access rights granted through the System Administrator or relevant role.
  • The underlying background process (for example, Delete Notices) available in the system.

Navigation

Menu → System Admin → General Rules → Server → Scheduler
TenthPlanet-iDempiere-SystemAdmin-Scheduler-1

Opening the Scheduler window displays the list of configured scheduled processes along with three tabs — Parameter, Scheduler Recipient, and Log — used to manage inputs, recipients, and execution history.

TenthPlanet-iDempiere-SystemAdmin-Scheduler-2

Configuration Steps

Step 1: Define the Scheduler

This step sets up the basic identity and timing of the automated process.

Instructions

Enter a descriptive Name, select the Process to run, choose the Schedule frequency, assign a Supervisor, and set Days to keep Log. Mark the record Active to enable execution.

FieldSample ValueDescription
NameDelete Old NotesIdentifies the scheduler for easy reference
ProcessDelete Notices_AD_NoteDeleteBackground task the scheduler executes
Schedule7 DaysFrequency at which the process repeats
SupervisorSystemUser responsible for monitoring the scheduler
Days to keep Log7Number of days execution logs are retained
Mail Template(optional)Template used for notification emails
TenthPlanet-iDempiere-SystemAdmin-Scheduler-3

Step 2: Set Process Parameters

This step supplies the input values the scheduled process needs to run correctly.

Instructions

Open the Parameter tab, add a Process Parameter, mark it Active, and enter a Default Parameter value. Repeat for each parameter the process requires.

FieldSample ValueDescription
Process ParameterDays to keep LogInput value passed to the process
Default Parameter7Value used automatically at execution
Default To Parameter(optional)Upper range value for the parameter
ActiveCheckedDetermines if the parameter is applied
TenthPlanet-iDempiere-SystemAdmin-Scheduler-4

Step 3: Add Scheduler Recipients

This step ensures the right users are notified about the scheduler’s execution outcome.

Instructions

Open the Scheduler Recipient tab, select a User/Contact or Role, and mark the record Active. Enable Upload if attachment output is required.

FieldSample ValueDescription
User/ContactSystemRecipient who receives the notification
Role(optional)Role-based recipient group
UploadUncheckedAttaches process output to the notification
TenthPlanet-iDempiere-SystemAdmin-Scheduler-5

Step 4: Review Scheduler Logs

This step confirms whether the scheduled process executed successfully or failed.

Instructions

Open the Log tab after a scheduled run to check the Summary, Error status, and Text Message for details on the execution result.

FieldSample ValueDescription
Created07/27/2026 11:26 AMDate and time the log entry was generated
SummaryFailed to send scheduler notificationShort outcome description
ErrorCheckedIndicates the run encountered a problem
Text MessageFrom: System To: SystemNotification content sent to recipients
TenthPlanet-iDempiere-SystemAdmin-Scheduler-6

Common Issues and Resolutions

IssueCauseResolution
Scheduler does not runActive checkbox uncheckedMark the scheduler record as Active
Notification email failsMail Template or mail settings not configuredConfigure a valid Mail Template and system mail settings
Wrong data affected by processIncorrect Process Parameter valuesReview and correct the Default Parameter entries
No recipients notifiedScheduler Recipient tab left emptyAdd at least one User/Contact or Role
Logs grow too largeDays to keep Log set too highReduce Days to keep Log to a shorter period
Process runs at the wrong timeIncorrect Schedule frequency selectedUpdate the Schedule field to the desired interval
Duplicate scheduler entriesMultiple schedulers created for the same processDeactivate or remove the duplicate scheduler record
Failures go unnoticedSupervisor field left blankAssign a valid Supervisor to monitor failures

Next Steps

  • Configure the Mail Template used for notification content.
  • Set up User and Role records for Scheduler Recipients.
  • Review the underlying Process window for additional parameters.
  • Confirm System Administrator role access for scheduler management.