| 1 |
// $Id: README.txt 5 2007-10-25 09:43:15Z SerialGraphics $
|
| 2 |
|
| 3 |
CONTENTS OF THIS FILE
|
| 4 |
---------------------
|
| 5 |
|
| 6 |
* Introduction
|
| 7 |
* Installation
|
| 8 |
* Case Tracker Caveats!
|
| 9 |
* Case Tracker URLs
|
| 10 |
* Mail Sending and Receiving
|
| 11 |
* XML-RPC Connections
|
| 12 |
* Case Tracker Terminology
|
| 13 |
|
| 14 |
|
| 15 |
INTRODUCTION
|
| 16 |
------------
|
| 17 |
|
| 18 |
Current Maintainer: zero2one <http://drupal.org/user/105066>
|
| 19 |
|
| 20 |
Original Sponsor: Digital202
|
| 21 |
Original Developers: India-based team
|
| 22 |
Oversight: DaveNotik (http://drupal.org/user/18129/contact), killes, zero2one
|
| 23 |
|
| 24 |
This module enables teams to track outstanding cases which need resolution.
|
| 25 |
It provides e-mail notifications to participants about updates to cases and
|
| 26 |
is similar to many issue tracking systems.
|
| 27 |
|
| 28 |
This is a rewrite of the project.module and is very similar to that module
|
| 29 |
but varies in important ways. The project.module is specific to software
|
| 30 |
development and the need for a more generic issue tracker had been expressed.
|
| 31 |
As such, the casetracker.module only includes relevant functionality, but
|
| 32 |
also uses regular Drupal comments and integrates cleanly with Views, Organic
|
| 33 |
Groups, Mailhander, CCK, XML-RPC, and more.
|
| 34 |
|
| 35 |
|
| 36 |
INSTALLATION
|
| 37 |
------------
|
| 38 |
|
| 39 |
1. Copy the files to your sites/SITENAME/modules directory.
|
| 40 |
|
| 41 |
2. Enable the casetracker module at admin/modules.
|
| 42 |
|
| 43 |
3. Assign the project and case node type and other relevant case options at
|
| 44 |
admin/settings/casetracker. Case Tracker ships with simplistic "Project"
|
| 45 |
and "Case" types in its casetracker_basic.module; although you can use
|
| 46 |
these, you will get stronger flexibility by assigning it to a CCK or
|
| 47 |
Flexinode content type of your own creation, or an Organic Group.
|
| 48 |
|
| 49 |
4. Customize case types, priorities, and states at admin/casetracker.
|
| 50 |
|
| 51 |
5. Enable permissions in admin/access.
|
| 52 |
|
| 53 |
Note: for more project.module-like functionality, try installing the
|
| 54 |
comment_upload.module and enabling comment attachments for case nodes.
|
| 55 |
|
| 56 |
|
| 57 |
CASE TRACKER CAVEATS!
|
| 58 |
---------------------
|
| 59 |
|
| 60 |
Some common gotchas which are, at the moment, "by design":
|
| 61 |
|
| 62 |
* The "Last modified" value of Case Tracker cases is determined by the
|
| 63 |
timestamp of the last comment attached to them (or, in the absence of
|
| 64 |
a single comment, the node creation time). This requires that the
|
| 65 |
comment.module (and node_comment_statistics table) are enabled and
|
| 66 |
created. We CAN think of some use cases for not requiring comments on
|
| 67 |
a case, but we think them edge cases and not enough to cater to. If
|
| 68 |
you feel otherwise, don't hesitate to voice your opinion.
|
| 69 |
|
| 70 |
* If you have node types with existing content (like already created
|
| 71 |
Organic Groups), setting the Organic Group node type to be a Case
|
| 72 |
Tracker project will NOT convert your existing content - the change
|
| 73 |
will only apply to newly created Organic Groups. This may get fixed
|
| 74 |
in the future: see http://drupal.org/node/65571 for the latest.
|
| 75 |
|
| 76 |
|
| 77 |
CASE TRACKER URLS
|
| 78 |
-----------------
|
| 79 |
|
| 80 |
The project based URLs we provide are briefly described below:
|
| 81 |
|
| 82 |
/casetracker/projects
|
| 83 |
/casetracker/projects/all
|
| 84 |
Displays a list of all projects.
|
| 85 |
|
| 86 |
/casetracker/projects/my
|
| 87 |
Displays a list of projects created by the current user.
|
| 88 |
|
| 89 |
Case URL filtering is far more powerful, and supports a wide variety of
|
| 90 |
filters. "Unkeyed" filters are simply words or numbers that attempt to
|
| 91 |
satisfy the most common and relevant searches. For example, the word "my"
|
| 92 |
restricts the search to projects and cases the user has created, whereas
|
| 93 |
another unkeyed filter, "all", doesn't. Numbers like 13 or 15 usually refer
|
| 94 |
to a project or case ID: whatever makes the most sense at the time.
|
| 95 |
|
| 96 |
"Keyed" filters, however, have a name (the "key") and a value. To search
|
| 97 |
for cases that are of node type "casetracker_basic_case" only, you'd use a
|
| 98 |
keyed filter of "type:casetracker_basic_case". To show all cases that have
|
| 99 |
been created by users 23 and 35, you'd use "author:23,35", and so on.
|
| 100 |
|
| 101 |
The basic format of a Case Tracker case filter is:
|
| 102 |
|
| 103 |
/casetracker/cases/PROJECT_FILTERS/CASE_FILTERS
|
| 104 |
|
| 105 |
The available project filters are described below:
|
| 106 |
|
| 107 |
all - show cases from all available projects.
|
| 108 |
my - show cases from projects the current user has created.
|
| 109 |
## - show cases from only these project IDs.
|
| 110 |
|
| 111 |
The available case filters are described below:
|
| 112 |
|
| 113 |
CASE UNKEYED FILTERS:
|
| 114 |
all - show all cases that match the project filters.
|
| 115 |
my - show current user's cases that match project filters.
|
| 116 |
assigned - show current user's assigned cases that match project filter.
|
| 117 |
|
| 118 |
CASE KEYED FILTERS:
|
| 119 |
assigned - a comma separated list of uids that are assigned a case.
|
| 120 |
author - a comma separated list of uids that created a case.
|
| 121 |
state - a comma separated list of state IDs to filter by.
|
| 122 |
type - a comma separated list of node types to filter by.
|
| 123 |
|
| 124 |
Some EXAMPLES of these filters are below - these examples DO NOT
|
| 125 |
show every possible variation (as that would be rather timeconsuming):
|
| 126 |
|
| 127 |
/casetracker/cases
|
| 128 |
/casetracker/cases/all
|
| 129 |
/casetracker/cases/all/all
|
| 130 |
Display all cases for all projects.
|
| 131 |
|
| 132 |
/casetracker/cases/my
|
| 133 |
/casetracker/cases/my/all
|
| 134 |
Display all cases in projects created by the current user.
|
| 135 |
|
| 136 |
/casetracker/cases/all/my
|
| 137 |
Display all cases created by the current user in all projects.
|
| 138 |
|
| 139 |
/casetracker/cases/my/my
|
| 140 |
Display all cases and projects created by the current user.
|
| 141 |
|
| 142 |
/casetracker/cases/all/assigned
|
| 143 |
Display all cases assigned to the current user in all projects.
|
| 144 |
|
| 145 |
/casetracker/cases/14
|
| 146 |
/casetracker/cases/14/all
|
| 147 |
Display all cases assigned to project node ID 14.
|
| 148 |
|
| 149 |
/casetracker/cases/all/state:1
|
| 150 |
Display all cases with a state ID of 1.
|
| 151 |
|
| 152 |
/casetracker/cases/my/state:4
|
| 153 |
Display cases from my projects with a state ID of 4.
|
| 154 |
|
| 155 |
/casetracker/cases/14/state:12
|
| 156 |
Display cases from project node ID 14 with a state ID of 12.
|
| 157 |
|
| 158 |
But that's not all. To make things more deliciously confusing, you can
|
| 159 |
space-separate multiple filters and comma-separate values of a keyed
|
| 160 |
filter to get even more fine-turned searches:
|
| 161 |
|
| 162 |
/casetracker/cases/all/assigned my
|
| 163 |
Display cases from all projects which the current user
|
| 164 |
has either opened, or which have been assigned to them.
|
| 165 |
|
| 166 |
/casetracker/cases/my/my state:1
|
| 167 |
Display cases in projects created by the current user that
|
| 168 |
the current user has opened and which have a state ID of 1.
|
| 169 |
|
| 170 |
/casetracker/cases/all/assigned my state:12,13
|
| 171 |
Display cases in all projects that have been opened by the
|
| 172 |
current user or have been assigned to the current user, and
|
| 173 |
which have state IDs 12 or 13.
|
| 174 |
|
| 175 |
|
| 176 |
MAIL SENDING AND RECEIVING
|
| 177 |
--------------------------
|
| 178 |
|
| 179 |
Case Tracker, and specifically casetracker_mail.module, has the ability to
|
| 180 |
send out custom emails whenever an issue is created or a comment posted, as
|
| 181 |
well as receive messages and post them as new cases or comments. In practice,
|
| 182 |
this works great for simple node types, but breaks down under advanced configs
|
| 183 |
with CCK and Flexinode (specifically, emails are sent and received, but you
|
| 184 |
are unable to use any of your created fields as values). Additional funding
|
| 185 |
and development are required to hammer those issues out.
|
| 186 |
|
| 187 |
Creating cases or leaving comments through email requires the Mailhandler
|
| 188 |
module to be installed and configured properly. A new case can be created
|
| 189 |
with the following sample email sent to your Mailhandler mailbox:
|
| 190 |
|
| 191 |
project_number: 500
|
| 192 |
type: casetracker_basic_case
|
| 193 |
case_title: This is a case title!
|
| 194 |
assign_to: Morbus Iff
|
| 195 |
case_status: open
|
| 196 |
case_priority: 1-high
|
| 197 |
case_type: bug
|
| 198 |
|
| 199 |
This is the case body.
|
| 200 |
|
| 201 |
Emailed comments have no special characteristics, save that they must be
|
| 202 |
in reply to the original sent Case Tracker case email (the message IDs are
|
| 203 |
calculated and stored as a reference).
|
| 204 |
|
| 205 |
|
| 206 |
XML-RPC CONNECTIONS
|
| 207 |
-------------------
|
| 208 |
|
| 209 |
Very rudimentary support for creation of Case Tracker cases via XML-RPC is
|
| 210 |
available. This has not been tested much, and it is certainly not a fully
|
| 211 |
featured XML-RPC server (you can only create new cases, not retrieve or
|
| 212 |
edit existing cases, etc.). If you'd like to fund future development on the
|
| 213 |
XML-RPC capabilities of Case Tracker, don't hesitate to contact one of the
|
| 214 |
developers listed in at the beginning of this README.txt.
|
| 215 |
|
| 216 |
For an example of the XML-RPC capabilities:
|
| 217 |
|
| 218 |
1. Enable the casetracker_xmlrpc.module as you would any other.
|
| 219 |
|
| 220 |
2. Give the "create cases via XML-RPC" permission to a user role.
|
| 221 |
|
| 222 |
3. Modify the xmlrpc_example.php included in the Case Tracker distribution
|
| 223 |
with the correct connection information, then run it from the command
|
| 224 |
line or via your browser. This example requires the "XML-RPC for PHP"
|
| 225 |
open source library from http://sourceforge.net/projects/phpxmlrpc/.
|
| 226 |
|
| 227 |
The example defaults to creating a node of type "casetracker_basic_case",
|
| 228 |
which is only available from the casetracker_basic.module. We assume that
|
| 229 |
those who are interested in XML-RPC capabilities are planning to write their
|
| 230 |
own client, and probably have enough know-how to "make things work" (such
|
| 231 |
as modifying the client to create node types of CCK or Flexinode variety).
|
| 232 |
|
| 233 |
|
| 234 |
CASE TRACKER TERMINOLOGY
|
| 235 |
------------------------
|
| 236 |
|
| 237 |
Case Tracker assigns every project a unique project number that starts at 100
|
| 238 |
and increments by another hundred for each new project (200, 300, 400, etc.).
|
| 239 |
Similarly, cases receive individual case numbers that are unique to the
|
| 240 |
project and start at 1, incrementing by 1 for each new case (2, 3, 4, etc.)
|
| 241 |
within the project. Together, these two numbers combine to create a unique
|
| 242 |
case number in the Case Tracker system, such as 300-4 (project number 300,
|
| 243 |
case number 4). These numbers have no correlation to the Drupal node system.
|
| 244 |
|
| 245 |
We have attempted to standardize on the following terminology:
|
| 246 |
|
| 247 |
* project ID: the node ID of the project.
|
| 248 |
* project number: 100, 200, 300, as above.
|
| 249 |
* case ID: the node ID of the case.
|
| 250 |
* case number (individual): 1, 2, 3, etc. as above.
|
| 251 |
* case number (combined): 100-1, 200-43, etc. as above.
|
| 252 |
|
Parent Directory
| 
Revision Log
| 
Revision Graph