[[PageOutline(2-5,Contents,pullout)]]

= Scheduled tasks manager

== Description

This plugin provides an extension point for trac plugin developers to manager their scheduled tasks. It polls register plugins, and run matched tasks like '''crontab''' in linux/unix.

Features will be added to this plugin in next version:
 * support crontab format

See:'''ZoomQuiet''' ~ Collection KSPEG Trac hacking

== Bugs/Feature Requests

Existing bugs and feature requests for TracSchedulerPlugin are 
[report:9?COMPONENT=TracSchedulerPlugin here].

If you have any issues, create a 
[/newticket?component=TracSchedulerPlugin new ticket].

[[TicketQuery(component=TracSchedulerPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [download:tracschedulerplugin here].

== Source

You can check out TracSchedulerPlugin from [http://trac-hacks.org/svn/tracschedulerplugin here] using Subversion, or [source:tracschedulerplugin browse the source] with Trac.

== Installation

You can install this software as normal Trac plugin.

 1. Uninstall Trac Scheduler if you have installed it before.
 1. Change to the directory containing setup.py.
 1. If you want to install this plugin globally, install this plugin to the Python path:
  * python setup.py install
 1. If you want to install this plugin to one Trac instance only:
  * python setup.py bdist_egg
  * copy the generated egg file to the trac instance's plugins directory
 {{{#!sh
cp dist/*.egg /srv/trac/env/plugins
}}}
 1. Configure your `trac.ini` file:
 {{{#!ini
[components]
tracscheduler.* = enabled

[tracscheduler]
; tasks poll interval is 60 sec
poll_interval = 60
; task invoke interval is 1 sec
worker_interval = 1
}}}

== Example

This set up will log the latest 2 ticket ids every minute:

{{{#!python
from tracscheduler.web_ui import IScheduledTask

class TracSchedulerTest(Component):
    implements(IScheduledTask)
    def process_scheduled_task(self, parent):
        self.log.debug("TracSchedulerTest")
        sqlString = "SELECT id FROM ticket ORDER BY id DESC LIMIT 2;"
        rows = parent.queryDb(sqlString)
        self.log.debug(rows)

}}}

== Recent Changes

[[ChangeLog(tracschedulerplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:richard] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''