Skip to main content

🕒 Cron Job Setup Documentation

📌 Overview​

The CM Cron Job feature allows you to manage scheduled tasks directly within the cm-admin interface. You can create, edit, enable, disable, execute, and view logs for each cron job from a user-friendly dashboard.

✨ Features​

  • 🔍 Filters: Search cron jobs by:

    • Name
    • Status
    • Last run time
    • Last run status

  • 📊 Sortable Columns:

    • Name
    • Updated time
    • Created time

  • ⚙️ Custom Actions:

    • ✅ Enable or ❌ Disable a cron job
    • ▶️ Manually execute a cron job

  • 🔎 Detailed Views:

    • Job information: name, cron string, command, status, last run time, output
    • Access logs for each run

🛠️ Setup Instructions​

1. 📦 Run the CMAdmin Scheduler Generator​

Generate the necessary files:

rails g cm_admin:add_scheduler

2. 🧱 Ensure Required Models Exist​

Your application must include the following models:

  • CmCronJob
  • CmCronJobLog

3. 🔗 Integrate Sidekiq​

  1. Run database migrations:

    rails db:migrate

  2. Start Sidekiq to enable background processing.

💡 Note:

  • All cm_cron jobs are removed from Sidekiq when Sidekiq is shut down.
  • When Sidekiq is started, all enabled cron jobs will be automatically re-added to the queue.

4. 🧩 Use Custom Actions​

Available via the CmAdmin::CmCronJob concern:

  • 🚫 Disable Job – Deactivates an active job.
  • 🟢 Enable Job – Activates a disabled job.
  • 🔄 Execute Job – Runs a job immediately.
  • 🗑️ Delete Job – Removes the job permanently.

⚠️ Note: Newly created jobs are disabled by default. Use the Enable button to activate them.

5. 📄 View Cron Job Logs​

Each job’s Logs tab includes:

  • 🕑 Start and completion timestamps
  • 📈 Execution status
  • 🔍 Links to detailed log output

🧪 Example Usage​

➕ Add a New Cron Job​

  1. Navigate to the Add Cron Job page.

  2. Provide the following details:

    • 🏷️ Name: A unique identifier for the job.

    • 🕰️ Cron String: Set the schedule using a valid cron expression. Common presets:

      • @hourly – Every hour
      • @daily – Every day
      • @weekly – Every week
      • @monthly – Every month
      • @yearly – Every year

    • 💻 Command: The shell command to be executed.

  3. Click Save ✅ to create the job.

✏️ Edit an Existing Cron Job​

  1. Open the Edit Cron Job page for the desired job.
  2. Modify the necessary fields.
  3. Click Save 💾 to update the job.

📜 View Job Logs​

  1. Visit the Logs tab on a cron job’s detail page.

  2. Review:

    • ⏱️ Start and end times
    • 📊 Status of execution
    • 🔗 Link to output logs

✅ Conclusion​

The CM Cron Job feature in cm-admin empowers you to manage scheduled tasks with confidence. With detailed controls, logging, and Sidekiq support, you can automate background operations efficiently and reliably. 🚀