Changes between Version 43 and Version 44 of TracCronPlugin


Ignore:
Timestamp:
Mar 4, 2015, 7:26:02 AM (9 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • TracCronPlugin

    v43 v44  
    1515 * Task execution history '''new''' ''rss feed is available''
    1616
    17 So if you have any function for entry point of a Trac related process and you want to add it as a job, Trac Cron Plugin is for you.
     17So if you have any function of a Trac related process and you want to add it as a job, Trac Cron Plugin is for you.
    1818
    1919The plugin provides an administration panel to help with scheduling:
    … …  
    3232
    3333Current stable release is '''0.3.1'''.
    34 You can use easy_install or pip to download the latest package into your Python environment:
     34You can use easy_install or pip to download and install the latest package into your Python environment:
    3535
    3636{{{
    … …  
    4444}}}
    4545
    46 Alternatively, download the distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] for source distributions only.
     46Alternatively, download the distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] for installation from source only.
    4747
    4848== Source
    … …  
    5353== Example
    5454
    55 Simply create in a module (.py) a class that implements the ICronTask and put it inside the plugins directory. Then you can either modify the trac.ini or use the Trac cron admin panel.
     55Simply create in a module (.py) a class that implements the ICronTask and put it in the plugins directory. Then you can either modify the trac.ini or use the Trac cron admin panel.
    5656
    5757=== Writing a task
    … …  
    156156}}}
    157157
    158 This key control the interval between each wake up of the ticker. The ticker thread periodically wakes up to see if there is task to execute. Then the ticker thread go sleep for the amount of minutes specified by this key. You should not have modify this value, except if you have system load issue. Default value is '''1'''.
     158This key control the interval between each wake up of the ticker. The ticker thread periodically wakes up to see if there is a task to execute. Then the ticker thread goes to sleep for the amount of minutes specified by this key. You should not have to modify this value, except if you have system load issues. Default value is '''1'''.
    159159
    160160=== Task settings
    161161
    162 For each task loaded by the Trac Component manager, Trac Cron Plugin have those parameters. Let's look at a heart beat task.
     162For each task loaded by the Trac Component manager, Trac Cron Plugin has those parameters. Let's look at a heart beat task.
    163163
    164164==== Enabling and disabling a task
    … …  
    169169}}}
    170170
    171 This is the second way to enable or disable a task. Since ''ticker_enabled'' is global and so all tasks will be affected, this key only affects one task. If False, whatever schedule the task has, not one will be triggered, so this is a way to disable a task while keeping the schedule in place for the time you will enable the task. Default is '''True'''.
     171This is the second way to enable or disable a task. Since ''ticker_enabled'' is global and so all tasks will be affected, this key only affects one task. If False, whatever schedule the task has, none will be triggered. So this is a way to disable a task, while keeping the schedule in place for the time you will enable the task. Default is '''True'''.
    172172
    173173==== Task scheduling
    … …  
    185185}}}
    186186
    187 The goal of this scheduler is to trigger the task every hour. Provide minute when you want the task to be executed. Accept comma separated list of values. Default is no value.
     187The goal of this scheduler is to trigger the task every hour. Provide the minute when you want the task to be executed. Accept comma separated list of values. Default is no value.
    188188
    189189{{{
    … …  
    192192}}}
    193193
    194 This scheduler triggers a task that needs to be executed once a month. Provide the day in month and the hour when the task will be launched. The day is the index of the day starting at 1. Accepts comma separated value. Default is no value
     194This scheduler triggers a task that needs to be executed once a month. Provide the day in month and the hour when the task will be launched. The day is the index of the day starting at 1. Accepts comma separated value. Default is no value.
    195195
    196196{{{
    … …  
    199199}}}
    200200
    201 This scheduler triggers a task that needs to be executed once a week. Provide the day in week and the hour when the task will be launched. The day is the index of the day starting at 0 (Monday is 0). Accept comma separated value. Default is no value
     201This scheduler triggers a task that needs to be executed once a week. Provide the day in week and the hour when the task will be launched. The day is the index of the day starting at 0 (Monday is 0). Accept comma separated value. Default is no value.
    202202
    203203==== Enabling and disabling a schedule
    204204
    205 Each schedule can individually be enabled or disabled. This the configuration for daily scheduler:
     205Each schedule can individually be enabled or disabled. This the configuration for the daily scheduler:
    206206
    207207{{{
    … …  
    229229=== sleeping_ticket
    230230
    231 This task reminds the reporter about orphaned tickets and the assigned user about sleeping ticket. An orphaned ticket is a ticket in new status since more than a given amount of day. An email notification is sent to the reporter in such a case. A sleeping ticket is a ticket assigned to an user, but the user either did not accept it or did not touch the ticket(make comment for example) since more than a given amount of day. The assigned user is notified in such a case. The delay is an optional parameter associated with each schedule. Default value is '''3 day'''.
     231This task reminds the reporter about orphaned tickets and the assigned user about sleeping tickets.
     232 * An orphaned ticket is a ticket with status New since more than a given amount of days. An email notification is sent to the reporter in such a case.
     233 * A sleeping ticket is a ticket assigned to an user, but the user either did not accept it or did not touch the ticket (add a comment for example) since more than a given amount of day. The assigned user is notified in such a case.
     234
     235The delay is an optional parameter associated with each schedule. Default value is '''3 days'''.
    232236
    233237=== unreachable milestone
    … …  
    235239'''Note''': Since 0.2dev_r9388
    236240
    237 This task scan still opened tickets in near milestone. Such a situation means that those tickets will probably not be part of the milestone. The task send a mail to user defined with ''unreachable_milestone.recipient'' (default is '''empty''') for each milestone with the list of still opened tickets. You may want to set the value to the release manager user. Reporter and owner are notified too but only for their tickets. The task looks for near milestone until '''3 days ahead'''. You can change the value with parameter either by setting ''unreachable_milestone.<schedule>.arg'' or in admin panel.
     241This task scan still opened tickets in near milestone. Such a situation means that those tickets will probably not be part of the milestone. The task sends a mail to user defined with ''unreachable_milestone.recipient'' (default is '''empty''') for each milestone with the list of still opened tickets. You may want to set the value to the release manager user. Reporter and owner are notified too, but only for their tickets. The task looks for the nearest milestone until '''3 days ahead'''. You can change the value with parameter either by setting ''unreachable_milestone.<schedule>.arg'' or in admin panel.
    238242
    239243This is an example of the mail for release manager:
    … …  
    265269=== Auto postpone task
    266270
    267 '''Note''': since 0.2dev_r9390
     271'''Note''': since 0.2dev_r9390.
    268272
    269273Trac allow the administrator to postpone still opened ticket in a given milestone when he closes this milestone. But this is not mandatory. The auto postpone task will help to not forget opened tickets in closed milestone. The task look for such tickets and postpone them in the more recent still opened milestone. Milestone must have a due date.
    … …  
    271275=== Ticket deadline task
    272276
    273 '''Note''': since 0.3
     277'''Note''': since 0.3.
    274278
    275279This task notify to ticket's reporter and owner when its ticket is near the deadline as a custom field. You can add a date field for ticket using [http://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]. Besides scheduler settings, there are the following options to configure when DateFieldPlugin is used: