sync-job-expert

Define and configure Sync Jobs within the Frappe Tweaks framework.

1|Updated Jan 16, 2025

Search Tags:#workflow #lifecycle #controller #frappe #enqueue #sync-jobs

Ready to run

npx skills add https://github.com/kehwar/frappe_tweaks --skill sync-job-expert

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sync-job-expert
Source: https://github.com/kehwar/frappe_tweaks/tree/main/.github/skills/sync-job-expert
Command: npx skills add https://github.com/kehwar/frappe_tweaks --skill sync-job-expert

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Provides expert guidance to design, implement, and troubleshoot Sync Jobs within the Frappe Tweaks framework, reducing integration friction and debugging time.

Core Features & Use Cases

Templates for Sync Job Types and doc mappings
Enqueueing, lifecycle hooks, and single/multi-target support
Troubleshooting guidance, best practices, and real-world scenarios

Quick Start

Create a Sync Job Type for your source and target DocTypes, then enqueue a job for a specific source document to begin processing.

Frequently Asked Questions about sync-job-expert

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enqueue a sync job in Frappe for a specific source document?▼

To enqueue a sync job in Frappe, you create a Sync Job Type for your source and target DocTypes, then enqueue a job for a specific source document to begin processing structured data synchronization.

What is a Sync Job Type in the Frappe Tweaks framework?▼

A Sync Job Type in the Frappe Tweaks framework is a structured configuration that defines source and target DocTypes, context, queues, timeouts, retries, and dry-run support for robust data synchronization.

How do I troubleshoot sync jobs not working in Frappe?▼

Troubleshooting sync jobs in Frappe involves examining the structured configuration, checking lifecycle hooks, verifying queue assignments, and reviewing timeout and retry settings to identify and resolve processing failures.

Can I run a dry-run for sync jobs before processing actual data?▼

Yes, you can run a dry-run for sync jobs before processing actual data. The Frappe Tweaks framework enforces structured configuration that explicitly includes dry-run support to validate mappings safely.

What is the best way to configure retries and timeouts for Frappe sync jobs?▼

The best way to configure retries and timeouts for Frappe sync jobs is by defining them within the structured Sync Job Type configuration, ensuring robust job lifecycle management and reducing integration friction.