AOEpeople / Aoe_Scheduler

Cron Scheduler Module for Magento
http://fbrnc.net/blog/2011/03/magento-cron-schedule
GNU General Public License v3.0
373 stars 202 forks source link

Add descriptions to cron jobs #46

Closed fbrnc closed 9 years ago

fbrnc commented 9 years ago

This feature was suggested by Matthias Zeis:

Allow adding a description text via XML (and via records) to every cron and show that information in the list view (and maybe in the title tag of the timeline view).

<crontab>
    <jobs>
        <aoe_queue>
            <description>Processes generic queue</description>
            <schedule>
                <config_path>system/aoe_queue/cron_expr</config_path>
            </schedule>
            <run>
                <model>aoe_queue/cron::processQueue</model>
            </run>
        </aoe_queue>
    </jobs>
</crontab>
mzeis commented 9 years ago

Thank you for creating the issue.

I thought about how we handle crons in our current project and came the conclusion that it may be useful to expand this idea even a bit more:

Let me know what you think about the name|title (and which one you'd prefer) and short_description.

fbrnc commented 9 years ago

Sounds good. I don't have any preference for name or title. I also like the idea of adding a more verbose description. One of the items on my todo list is a cron single view. This would be a good place to show this information.

mzeis commented 9 years ago

Great. I already started implementing the new columns-

mzeis commented 9 years ago

Please let me know if you have suggestions for improvement.

I'm not a fan of the separated "show column x" settings in System > Configuration. It could be replaced by a multi-select where the columns to be displayed can be selected. This would provide better flexibility.

fbrnc commented 9 years ago

Why do you want this to be configurable at all? I'm a big fan of keeping it simple and this extra column probably doesn't hurt. I'd always show the short_description. But now that it's done you don't have to remove it :) I checked the code (reading, not running), and it looks clean and well done. Also thank you for taking care of the records. Feel free to create a pull request if you think it's ready to go...

mzeis commented 9 years ago

I worked on a 1280x1024 screen yesterday and realized the columns can get very narrow at that resolution, that's why. :-)

I'll remove it and create a pull request tonight, that's no problem.