wiki:ProjectPlanPlugin

Version 16 (modified by anbo, 5 years ago) (diff)

add an example

Project Plan Plugin

Description

The ProjectPlan plug-in provides visualizations of the ticket set used in the project (filterable). This should overcome the problems that appear while organizing many developers or many tickets. The main contribution of this plug-in is to providing (configurable, graphical) overview of ticket types, states, owners, dates and priorities.

The plug-in introduces three ticket attributes:

  • time to assign: by the project plan at the latest at this date the owner of the ticket should start working on the task
  • time to close: by the project plan at the latest at this date the ticket should be closed
  • dependencies: tickets that have to be closed before the current ticket

These attributes are used to draw, e.g. networks of tickets representing the suggested (topological) order of the tickets. Furthermore, it is a development base for several representations. The architecture enables contributors to add their own visualizations.

  • Current Testing Version is 0.70b (beta)
    • Features
      • GraphViz based MPM Network
      • GraphViz based Hierarchical MPM Network
      • Critical Path Analysis (Simple Workloadbases)
      • Sorted Reports for Delayed Tickets and Slacktimes
      • Other small things
    • Known Problems
      • possible unused Imports in several Modules
      • Other small things in code and documentation

Software Requirements

  • Python 2.5 or 2.6 with Python Standard Library
  • a recent GraphViz Package
  • Trac 0.11 (.1-5)
  • XML Template Engine Genshi 0.51 or compatible (it is part of Trac 0.11)

Basic Setup

1. Install the plug-in

  • run on the shell
    python setup.py bdist_egg
    
  • deploy the created egg either globally or locally (locally is recommended at this point)

2. Setup Ticket-Custom Fields

  • in your projects trac.ini
  • For the case, you already have dependency, assign/close date ticket-custom fields
    • Add the field names (as long as the format is compatible) with
      [pp_options]
      custom_dependency_field = <your dependency fieldname>
      custom_due_assign_field = <your assign Date fieldname>
      custom_due_close_field = <your close Date fieldname>
      
    • This lets ProjectPlanPlugin use these configured fields
  • If you dont have corresponding dependency and date fields, they need to be added as ticket-custom fields
    [ticket-custom]
    dependencies = text
    dependencies.label = Dependencies
    due_assign = text
    due_assign.label = Due to assign
    due_assign.value = DD/MM/YYYY
    due_close = text
    due_close.label = Due to close
    due_close.value = DD/MM/YYYY
    

3. Basic GraphViz Configuration (needed for networks)

  • login with administrative rights, navigate to admin (WebAdmin)
    • select the panel ProjectPlan -> General Settings (on the left)
    • verify the settings for cachepath and dot_executable
  • or set the following options in the projects trac.ini
    [pp_options]
    cachepath = <full path to the cache directory>
    dot_executable = <path to graphviz binaries>\dot.exe
    
    • restart your web server for configuration reload
  • verify access and execution rights for the web server User
  • cachepath should be a separate directory for each project, this reduces possible cache collisions

4. Color Setup

  • login with administrative rights, navigate to admin (WebAdmin)
  • select the panel ProjectPlan -> Color Settings (on the left)
  • set HTML color codes and apply settings

5. Image Setup

  • login with administrative Rights, navigate to Admin (WebAdmin)
  • select the panel ProjectPlan -> Image Settings (on the left)
  • select the images, you'd like to use and apply settings
    • the smaller images (e.g., 16x16 pixel) can reduce the size of the graphical network representation

Daily Usage

  • The cache size can grow quite big because changes in tickets and per user/macro produce a lot of files and images
    • it is recommended to either wipe the cache in intervals or setup a daily cronjob to for cache cleaning

Example

Add ticket dependencies and close/assign Times.

  • Network Graphics
    • Use the ProjectPlan Macro for (mpm like) network graphics with several options enabling project runtime estimation and (workload based) critical path analyses.
  • Special Reports
    • Use special reports which show delays and slacktimes
  • ...

Macro Samples:

  1. Both networks (hierarchical and non-hierarchical) use critical path analysis. This won't work without ticket times for all tickets (either start, end, or both).
  2. The critical path analysis won't work with cyclic dependencies
  3. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>".

    == hierarchical Network ==
    [[ProjectPlan(macroid=1,renderer=gvhierarchical)]]
    
    == hierarchical Network with start and end times==
    [[ProjectPlan(macroid=1,renderer=gvhierarchical,betickets)]]
    
    == filtered (milestone=milestone1) ==
    [[ProjectPlan(macroid=filtered,renderer=gvhierarchical,filter_milestone=milestone1)]]
    
    == non-hierarchical (full network) ==
    [[ProjectPlan(renderer=gvrender,macroid=2,withbuffer)]]
    
    == Network Legends ==
    [[ProjectPlan(macroid=legend,renderer=gvrender,statuslegend,prioritylegend,notickets)]]
    
    == Special Reports ==
    [[ProjectPlan(macroid=report_buffer,renderer=report_buffer,limitlines=4)]]
    [[ProjectPlan(macroid=report_closing_delay,renderer=report_closing_delay,limitlines=10)]]
    [[ProjectPlan(macroid=report_assign_delay,renderer=report_assign_delay,limitlines=10)]]

Devel

Development?

Bugs/Feature Requests

Existing bugs and feature requests for ProjectPlanPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out ProjectPlanPlugin from here using Subversion, or browse the source with Trac.

Recent Changes

[13331] by anbo on 2013-07-07 20:32:10
v2.1.5, patch release

fixes a bug, where the depending tickets are not saved during ticket creation

[13302] by makadev on 2013-06-22 19:25:20
sync to trunk (v2.1.4@r13300)
[13300] by makadev on 2013-06-20 07:33:02
v2.1.4, patch release
fixed

  • b.e. ticket mode for gv renderer: b.e. tickets were still datetime objects, but due times are date objects, so comparision raises an exception
  • added authname to init for DataAccessDependenciesInCustomFields, thought currently unused
  • convert ticket_id to string for str/unicode replace
  • removed false from sqlconstraint, because sqlite (and maybe others) treats both false or FALSE identifier as column name and fails
  • corrected use_fast_save_changes check, since PPBooleanSwitchOption inherits PPSingleSelOption the result is not realy Boolean and needs to be checked against its selectables

refs #11074

Author/Contributors

Author: makadev, anbo
Contributors:

Attachments (3)

Download all attachments as: .zip