Erpnext Syntax Scheduler

What it does

This skill provides a deterministic syntax reference for scheduling events and managing background jobs within ERPNext, specifically using Frappe's scheduler and frappe.enqueue functionality. It details how to define scheduler events (like hourly, daily, weekly, monthly, and cron jobs) and enqueue tasks with options for queue selection and timeouts. This allows AI agents to automate repetitive processes and streamline workflows in an ERPNext environment by correctly configuring these scheduling mechanisms.

When to use it

• Automating recurring tasks within ERPNext, such as generating reports or processing data.
• Scheduling background jobs that require longer execution times (e.g., importing large datasets).
• Understanding the differences between scheduler event types and queue configurations in different versions of ERPNext (v14 vs v15).
• Ensuring correct syntax when defining new scheduler events or modifying existing ones.

Key capabilities

• Scheduler Event Syntax: Provides a reference for defining events like "all", "hourly", "daily", "weekly", "monthly", and custom cron schedules.
• Background Job Enqueueing: Explains how to use frappe.enqueue with options for specifying queue, timeout, and deduplication (v15).
• Queue Management: Details available queue types ("short" and "long") and their associated timeouts.
• Version Compatibility: Highlights differences in scheduler tick frequency between ERPNext v14 and v15.

Example prompts

• “Show me the syntax for scheduling a task to run weekly.”
• “How do I enqueue a background job with a timeout of 3600 seconds?”
• "What is the difference in scheduler tick frequency between ERPNext versions 14 and 15?"

Tips & gotchas

• Migration Required: After making any changes to scheduler_events in hooks.py, always run bench migrate.
• Version Awareness: Be mindful of version differences (v14 vs v15) when configuring scheduler events, particularly regarding the "all" event's frequency.
• Queue Selection: Utilize the "long" queue for tasks that require longer processing times to avoid timeouts.