Erpnext Syntax Hooks

What it does

This skill enables AI agents to automate customizations within ERPNext using syntax hooks (specifically, modifications to hooks.py and associated event files). It streamlines development by allowing custom applications to extend core ERPNext functionality through document lifecycle events, periodic tasks (scheduling), and client-side data injection. This reduces manual effort when tailoring workflows and implementing specific business logic within the ERPNext system.

When to use it

• Automating validation rules for Sales Invoices (e.g., preventing negative totals).
• Scheduling daily cleanup tasks like deleting old log entries.
• Injecting custom data into the client-side boot information for enhanced user interfaces.
• Implementing actions after a document is submitted or cancelled.
• Creating periodic synchronization processes within ERPNext.

Key capabilities

• Document Lifecycle Events (doc_events): Define actions to be performed before/after insert, validate, update, submit, cancel, and trash events for documents.
• Scheduler Events: Schedule tasks to run daily, hourly, weekly, monthly, or using custom cron expressions.
• Extend Bootinfo: Inject custom data into the client-side boot information.
• Custom Task Execution: Define and execute Python functions triggered by document events or scheduled times.

Example prompts

• "Create a syntax hook to prevent Sales Invoices with negative totals."
• "Schedule a daily task to delete logs older than one month."
• "Implement a syntax hook that runs after a new document is inserted and logs the event details."

Tips & gotchas

• Migration Required: After making changes to hooks.py or scheduler events, you must run bench migrate for the changes to take effect.
• Transaction Management: Avoid manually committing database transactions within document event handlers (on_update, etc.) as Frappe handles commits automatically.
• Updating Document Values: To modify a document's value after an on_update hook, use frappe.db.set_value() instead of directly modifying the document object.