README

AOE Scheduler for Magento

AOE Scheduler sits on top of Magento's default cron functionality allowing you to manage the jobs, to visualize the timeline and to get some deeper insight on what's going on behind the scenes and to shed some light on what might be going wrong. On top of that AOE Scheduler provides some more functionality like a cli and a web service interface, optimizing cron execution on your server and giving you everything you need to implement complex background tasks including for your Magento store.

NOTE

This documentation is currently being written. Sadly, at this point it's still more an outline and some bullet points than a complete documentation. I'm working on it. If you have any comments feel free to get in touch with me.

Changelog

Version 1.0.0 is a major release. If you're updating from version 0.X please check out the changelog and verify everything is still working as expected after updating.

Changelog

Features

• Timeline visualization: The timeline view visualizes all past, current and future jobs showing their status, results, the runtime and some more details.
• Cron Management: Find a list of all jobs defined in the Magento core or in any module installed. You can enable or disable individual jobs, modify them (e.g. edit their schedule) or even create new crons from scratch
• Parameterized Crons: Sometimes a simple cron run isn't enough. You might want to use the same cron but with different parameters. Example: Use this to create daily reports and weekly reports with the same job, but different input parameters.
• Process Management: Check if jobs are actually still running and kill them through Aoe_Scheduler if required.
• Cron groups: Split you crons into different groups so you can run them in parallel or distribute them on multiple servers.
• Clean API
  • Cli
  • Web Service API
  • Developer API: Create/run/schedule jobs programmatically. Use events to create workflows between jobs.
• Instructions: A new admin modules assists you in settings up your cron configuration.
• Monitoring: Heartbeat, Watchdog, last-seen, verification
• Compatible with Magento's native cron scheduler
• Manuel scheduling and running: Schedule or run your jobs manually or programmatically. This comes in handly during development or if you have actions that might have to be triggered manually at times (e.g. re-import product catalog, re-run statistics,...)

Authors, contributors and maintainers

Author:

• Fabrizio Branca

Major Contributions:

• Lee Saferite
• For a full list of contributors visit AOE Scheduler on GitHub

Ideas, bugs, contributions, comments, feature suggestions?

Please get in touch with us via the issue tracker on GitHub

Compability

• PHP:
  • 5.3
  • 5.4
  • 5.5
• Magento CE:
  • 1.6.2.0
  • 1.7.0.2
  • 1.8.0.0
  • 1.8.1.0
  • 1.9.0.1
  • 1.9.1.0
• Magento EE:
  • 1.11.0.0
  • 1.11.0.2
  • 1.11.1.0
  • 1.11.2.0
  • 1.12.0.0
  • 1.12.0.1
  • 1.12.0.2
  • 1.13.0.2
  • 1.13.1.0
  • 1.14.0.1
  • 1.14.1.0
• Operating System: Linux

Documentation

1. Module Installation
2. Cron Configuration
3. Some Basics (Job? Schedule? Task?)
4. Creating new jobs
5. Faq
6. Admin Interfaces
   1. System Configuration
   2. Job Configuration
   3. List View
   4. Timeline View
   5. Instructions
7. Events
8. Schedule States
9. CLI
10. Web Services
11. Domain Model
12. Cron Processing
13. Unit Tests
14. Features
    1. Heartbeat and Monitoring
    2. Notifications
    3. Custom job parameters
    4. Global enabled/disable
    5. Disable individual jobs
    6. runNow
    7. scheduleNow
    8. Run return values and communication
    9. ETA
    10. Watchdog
    11. Cron groups
    12. Process Management
    13. Output buffering
    14. Bumper to Bumper (REPEAT)
15. Cookbook
    1. How to declutter your timeline
    2. How to integrate into deployments
    3. Distributed cron
    4. Job workflows
    5. Schedule a job programmatically

License

GPL v3

Links

• Aoe Scheduler on Magento Connect
• Aoe Scheduler on Travis CI
• Aoe Scheduler on Packagist
• Blog posts
  • Magento Cron Demystified (www.webguys.de)
  • Magento Cron Scheduler (fbrnc.net)