wiki:ClientsPlugin

Clients support for Trac tickets

Description

Clients Overview

Many people and organizations use Trac internally or privately to manage tasks they perform for different clients. This plugin adds capabilities to Trac to help manage different clients.

Key features:

  • Add, edit and remove clients via the Trac Admin interface.
  • Define a default "Hourly Rate" for each client, useful when used in conjunction with WorkLogPlugin and TimingAndEstimationPlugin.
  • Adds "Client Work Summary" report for use with TimingAndEstimationPlugin.
  • Flexible Event structure to keep clients selectively informed by:
    • Defining custom events which tie together Summaries and Actions.
    • Defining special blocks (via a WikiProcessor) in which you can embed content that you want to share with a client in ticket descriptions and comments which can be incorporated into Summaries.

Screen Shots

Events

The events system is very flexible and allows you to customise they way you interact with your clients. As it is often convenient to use a single Trac instance for internal management purposes, it is typically inappropriate to give direct access to Trac to your clients. However, using Trac to keep your clients informed is still very desirable.

To do this, the ClientsPlugin contains several Summaries which summarise the current status, or the changes in status over time, for each client into an XML object. This object is then passed on to an Action which can process this summary accordingly and actually do something useful with it.

The current Summaries available are:

  • Milestone Summary: (XML info) Creates a summary of all tickets grouped by milestone (for future milestones with a delivery date attached).
  • Ticket Changes: (XML info?) Ticket changes/comments since the last time the event was triggered.

The current Actions available are:

  • Send Email: (XSLT info) Send an email to the client.
  • Post to Zendesk: Post to a Zendesk forum.

The system allows some key setup parameters to be defined in the event itself (eg an XSLT to reformat the XML object into an HTML email, or a username/password for interacting with Zendesk), and also certain parameters for each event on a per-client basis (eg a list of client specific email addresses to send the summary).

Event Recipes

Here are some detailed examples to help you get started. Please feel free to post your own!

Triggering Events

So how do you trigger an event? This can currently be achieved via a simple script that can be run via a crontab entry or scheduled task. This script is clientsplugin/trunk/cron/run-client-event.

Custom Fields

ClientsPlugin will automatically add some custom fields to your trac.ini file when it is installed.

Bugs/Feature Requests

Existing bugs and feature requests for ClientsPlugin are here.

If you have any issues, create a new ticket.

defect

29 / 37

enhancement

0 / 2

task

1 / 1

Download

Download the zipped source from here.

Source

Check out ClientsPlugin using Subversion from here, or browse the source with Trac.

This plugin is active for Trac 0.11 and was originally developed for Trac 0.10. The Trac 0.10 version is considered obsolete.

Installation

You need the LXML library to use this plugin.

On Fedora perform the following commands to install the LXML Library:

yum install libxml2 libxml2-devel libxslt libxslt-devel

or:

easy_install lxml

Install the plugin, then go through the usual Trac update process to automatically create the necessary database tables and fields.

Recent Changes

15265 by rjollos on 2016-02-11 05:29:08
Remove unnecessary svn:mime-type on js and html files

svn:mime-type was set to "plain" for many files.

15264 by rjollos on 2016-02-11 05:22:34
Remove unnecessary svn:mime-type on py files

svn:mime-type was set to "plain" for many files.

12092 by rjollos on 2012-10-02 07:43:57

Fixes #10260:

  • The client field is hidden if there are no clients.
  • Added unit test infrastructure.
(more)

Author/Contributors

Author: coling
Maintainer: Colin Guthrie
Contributors: rjollos

Last modified 11 months ago Last modified on Nov 18, 2015, 9:50:56 AM

Attachments (5)

Download all attachments as: .zip