All Products
Search
Document Center

Microservices Engine:Import a custom calendar

Last Updated:Mar 11, 2026

When jobs must run only on specific dates---such as weekdays, trading days, or custom business dates---or must be paused during events like major promotions, use a custom calendar to control the scheduling. A custom calendar defines which dates a job is allowed to run on for an XXL-JOB instance in Microservices Engine (MSE).

Import a calendar

Use the ImportCalendar API to create a custom calendar for your XXL-JOB instance.

  1. Open the ImportCalendar page in OpenAPI Explorer.

  2. Set the parameters based on the displayed fields.

  3. Click Submit to import the calendar.

OpenAPI Explorer interface for importing a calendar

Assign a calendar to a job

After you import the calendar, assign it to a job in the XXL-JOB console so that the job runs only on the dates defined in the calendar.

  1. Log on to the XXL-JOB console.

  2. Select a region from the top navigation bar, then open the target XXL-JOB instance.

  3. In the left-side navigation pane, click Task Management.

  4. Locate the target job and open its Edit Task panel.

  5. In the Timing Configuration step, expand Advanced Configuration.

  6. In the Calendar section, click Specify Calendar and select the imported calendar.

Calendar configuration in the Edit Task panel

The job now runs only on dates defined in the selected calendar.

Update a calendar

To update a calendar, re-import it with the same name. The new calendar overwrites the existing one.