Project issue tracking

The Project issue tracking module provides an issue tracker for projects, including email subscriptions, follow-up comments, and customizable status options.

Note: The instructions below were specifically written for Project Issue version 5.x-1.1. For other versions of the module some or all of these instructions may not apply.

Installation

Install the Project issue tracking module as you would any other--put the files in place, go to the modules administration page (Administer > Site building > Modules), and enable the Project issue tracking module. The Project issue tracking module requires the Project module.

Permissions

The following set of permissions controls access to project issues:

access own project issues

Users with this permission will be able to access project issues they create but not issues created by other users.

access project issues

Users with this permission will be able to access (view) project issues on the site. However, users will not be able to access issues that are associated with projects they do not have permission to access.

create project issues

Users with this permission will be able to create project issues.

edit own project issues

Users with this permisison will be able to edit project issues they create.

set issue status [status]

There are several "set issue status" permission types. Each controls what type of users may set that particular status. For example, you may want to allow all users the permission to set the status of an issue as "active" but only certain users to be able to set the status of an issue as "fixed".

Configuration

Project issue settings

Project issue settings are managed on the Project issue settings administration page (Administer > Project administration > Project issue settings).

Issue directory:

Enter the directory where uploads/attachments to project issues should be stored.

Default permitted file extensions:

Enter the default permitted file extensions here. These defaults are used if none of the roles for a given user define their own allowed extensions. Separate the extensions with a space and do not include the leading dot. To prevent users from uploading potentially malicious files, it is a good idea to not allow certain file extensions, such as .php, .html, .js, .exe, .com, etc.

Permitted file extensions:

For each role on your site, you can specify additional file types that users with that role are allowed to upload. You can use these settings to allow more privileged users to attach files with certain extensions that regular users are not allowed to attach.

Project issue status options

Project issue status options are managed on the Project issue status options administration page (Administer > Project administration > Project issue status options).

You can add additional issue statuses from this configuration page. The meaning of each field is displayed at the top of the page.

For each new status added, an additional permission of the type "set issue status [status]" will be created for the Project issue tracking module on the access control administration page (Administer > User management > Access control).

Enabling issues for projects

To enable issues for a project, you must first create the project. Then bring it up again in edit view. You'll see a tab for "issues". Click this to bring up the issue configuration page for this project. Here you can select whether to enable issues, provide a list of "components" that issues can relate to, provide a message for users submitting issues, and also set a number of options about how issue posts and follow-ups are mailed out.

Project versions in the issue tracker

If you have enabled the Project releases module and are browsing or creating issues for a project with at least one release, you will be able to associate issues created for that project with a specific release of the project. In addition, the issue tracker for that project will have a "Version" column and you can then sort issues by the release version with which the issue is associated.