Changes between Version 2 and Version 3 of TracTickets


Ignore:
Timestamp:
2023-04-20T18:47:43Z (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracTickets

    v2 v3  
    1 = The Trac Ticket System =
     1= The Trac Ticket System
    22[[TracGuideToc]]
    33
    4 The Trac ticket database provides simple but effective tracking of issues and bugs within a project.
     4As the central project management element of Trac, tickets can be used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues''', among others.
    55
    6 As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''.
     6As with the TracWiki, this subsystem has been designed to make user contribution and participation as simple as possible. Tickets can be edited, annotated, assigned, prioritized and discussed.
    77
    8 As with the TracWiki, this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements.
     8[=#edit-permissions]
     9The default installation doesn't permit to non-authenticated users ("anonymous" users) to change anything, even to comment on an issue, for obvious spam prevention reasons. Check the local contributing policy, or contact your local Trac administrator.
    910
    10 An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
    11 All tickets can be edited, annotated, assigned, prioritized and discussed at any time.
     11== Ticket Fields
    1212
    13 == Ticket Fields ==
     13A ticket contains the following information:
    1414
    15 A  ticket contains the following information attributes:
    16  
    17  * '''Reporter''' - The author of the ticket.
    18  * '''Type''' - The nature of the ticket (for example, defect or enhancement request)
     15 * '''Summary''' — Simple text without WikiFormatting.
     16 * '''Description''' — The body of the ticket. Accepts WikiFormatting.
     17 * '''Reporter''' — The author of the ticket.
     18 * '''Type''' — The default types are `defect`, `enhancement` and `task`.
     19 * '''Component''' — The project module or subsystem that this ticket concerns.
     20 * '''Version''' — Version of the project that this ticket pertains to.
     21 * '''Keywords''' — Useful for searching and report generation.
     22 * '''Priority''' — The default priorities are `trivial`, `minor`, `major`, `critical` and `blocker`. A dropdown list when multiple priorities are defined.
     23 * '''Severity''' — Similar to Priority, but the distinction may be useful for some projects. No severities are defined by default, therefore the field will be hidden from the ticket form.
     24 * '''Milestone''' — Milestone in which the ticket will be resolved. A dropdown list.
     25 * '''Assigned to/Owner''' — Principal person responsible for handling the issue.
     26 * '''Cc''' — A comma-separated list of other users or email addresses to notify when changes are made to a ticket.
     27 * '''Resolution''' — Reason why a ticket was closed. Default values are `fixed`, `invalid`, `wontfix`, `duplicate`, `worksforme`.
     28 * '''Status''' — The statuses are defined in the [TracWorkflow#BasicTicketWorkflowCustomization ticket workflow]. For the default workflow the statuses are `new`, `assigned`, `accepted`, `closed` and `reopened`.
    1929
    20  * '''Component''' - The project module or subsystem this ticket concerns.
    21  * '''Version''' - Version of the project that this ticket pertains to.
    22  * '''Keywords''' - Keywords that a ticket is marked with.  Useful for searching and report generation.
     30'''Notes:'''
     31 - The type, [trac:TicketComponent component], [TracRoadmap milestone], version, priority, severity fields and resolution can be managed using [TracAdmin trac-admin] or !WebAdmin.
    2332
    24  * '''Priority''' - The importance of this issue, ranging from ''trivial'' to ''blocker''.
    25  * '''Milestone''' - When this issue should be resolved at the latest.
    26  * '''Assigned to/Owner''' - Principal person responsible for handling the issue.
    27  * '''Cc''' - A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.''
    28  
    29  * '''Resolution''' - Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
    30  * '''Status''' - What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}.
    31  * '''Summary''' - A brief description summarizing the problem or issue.
    32  * '''Description''' - The body of the ticket. A good description should be specific, descriptive and to the point.
     33== Changing and Commenting Tickets
    3334
    34 '''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [wiki:TracAdmin trac-admin].
     35With appropriate permissions, tickets can be commented and ticket properties changed. When viewing a ticket, the history of changes will appear below the ticket properties box.
    3536
    36 '''Note:''' the [wiki:TicketTypes type], [wiki:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the WebAdmin plugin.
     37By default an authenticated user can edit their own ticket comments. Users with `TICKET_EDIT_COMMENT` can edit any comment.
    3738
    38 '''Note:''' Description of the builtin ''priority'' values is available at [wiki:TicketTypes#Whyistheseverityfieldgone]
     39Comment editing is meant for making small corrections to comments, like fixing formatting or spelling errors. For major edits, you should be adding a new comment instead. Editing a comment will not produce a new entry on [/timeline], while entering a new comment or other changes will do.
    3940
    40 == Changing and Commenting Tickets ==
     41All edits (field changes, new comments, comment edits) update the "last changed" time of the ticket.
    4142
    42 Once a ticket has been entered into Trac, you can at any time change the
    43 information by '''annotating''' the bug. This means changes and comments to
    44 the ticket are logged as a part of the ticket itself.
     43'''Note:'''
     44 - TracLinks and WikiFormatting can be used in the ticket description and comments. Use TracLinks to refer to other issues, changesets and files.
    4545
    46 When viewing a ticket, the history of changes will appear below the main ticket area.
     46 - See TracNotification for how to configure email notifications on ticket changes.
    4747
    48 ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
    49 understanding the motivation behind a design- or implementation choice easier,
    50 when returning to it later.''
     48 - See TracWorkflow for information about the state transitions (ticket lifecycle), and customization of the workflow.
    5149
    52 '''Note:''' An important feature is being able to use TracLinks and
    53 WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
    54 other issues, changesets or files to make your ticket more specific and easier
    55 to understand.
     50== Hiding Fields
    5651
    57 '''Note:''' See TracNotification for how to configure email notifications of ticket changes.
     52Many of the default ticket fields can be hidden from the ticket web interface by removing all the possible values through the !WebAdmin or using [TracAdmin trac-admin]. This only applies to drop-down lists: ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''.
    5853
    59 === State Diagram ===
    60 [[Image(http://trac.edgewall.org/attachment/wiki/TracTickets/Trac%20Ticket%20State%20Chart%2020060603DF.png?format=raw)]]
     54== Adding Custom Fields
    6155
     56Trac lets you add custom ticket fields. See TracTicketsCustomFields for more information.
    6257
    63 == Default Values for Drop-Down Fields ==
     58== Default Values for Drop-Down Fields
    6459
    65 The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:
     60The option selected by default for the various drop-down fields can be set in [TracIni trac.ini]. Refer to the values prefixed with `default_` in the [[TracIni#ticket-section|"[ticket]"]] section. The default value of several fields can also be set through the !WebAdmin.
    6661
    67  * `default_component`: Name of the component selected by default
    68  * `default_milestone`: Name of the default milestone
    69  * `default_priority`: Default priority value
    70  * `default_severity`: Default severity value
    71  * `default_type`: Default ticket type
    72  * `default_version`: Name of the default version
     62If any of these options are omitted, the default value will either be the first in the list, or an empty value when allowed. The [[TracIni#ticket-allowed_empty_fields-option|allowed_empty_fields]] option determines which fields may have an empty value.
    7363
    74 If any of these options are omitted, the default value will either be the first in the list, or an empty value, depending on whether the field in question is required to be set.
     64== Assign-to as Drop-Down List
    7565
     66If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [TracIni trac.ini] to `true`. In that case, Trac will populate the list with all users who **have an authenticated session** and possess the `TICKET_MODIFY` [TracPermissions permissions].
    7667
    77 == Hiding Fields and Adding Custom Fields ==
     68An authenticated session will be created the first time a user authenticates with the project. You can manually add an authenticated session using the ["TracAdmin#?session add" trac-admin] `session add` command. The `:1` suffix on the session id (i.e. username) is the key to creating an authenticated session:
     69{{{#!sh
     70trac-admin /path/to/projenv session add <sid>:1 [name] [email]
     71}}}
    7872
    79 Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [wiki:TracAdmin trac-admin]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''.
     73You may find the dropdown list is //overpopulated// with users that are no longer active in the project. Revoking authentication privileges will not remove the session data that is used to populate the dropdown list. The [TracAdmin trac-admin] command can be used to list and remove sessions:
    8074
    81 Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.
     75 - List all sessions:
     76{{{#!sh
     77trac-admin /path/to/projenv session list
     78}}}
     79 - Remove a session:
     80{{{#!sh
     81trac-admin /path/to/projenv session delete SID
     82}}}
    8283
     84Alternatively, you can just revoke `TICKET_MODIFY` from users that you don't want to be included in the list. However, that will not be possible if you've granted `TICKET_MODIFY` to all //anonymous// or //authenticated// users.
    8385
    84 == Assign-to as Drop-Down List ==
     86'''Notes:'''
     87 - If you need more flexibility, then use subclass `ConfigurableTicketWorkflow` and override the `get_allowed_owners` method (see [trac:#12807 Trac ticket 12807]).
    8588
    86 If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [wiki:TracIni trac.ini] to “true”. In that case, Trac will use the list of all users who have logged in and set their email address to populate the drop-down field.
     89 - Activating this option may cause some performance degradation. Read more about this in the [trac:TracPerformance#Configuration Trac performance] page.
    8790
    88 To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions].
     91== Preset Values for New Tickets
    8992
    90 == Preset Values for New Tickets ==
     93To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with `variable=value` separated by `&`. Possible variables are:
    9194
    92 To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &.
     95 * '''type''' — The type droplist.
     96 * '''reporter''' — Name or email of the reporter.
     97 * '''summary''' — Summary line for the ticket.
     98 * '''description''' — Long description of the ticket.
     99 * '''component''' — The component dropdown list.
     100 * '''version''' — The version dropdown list.
     101 * '''severity''' — The severity dropdown list.
     102 * '''keywords''' — The keywords or tags.
     103 * '''priority''' — The priority dropdown list.
     104 * '''milestone''' — The milestone dropdown list.
     105 * '''cc''' — The list of emails for notifying about the ticket change.
    93106
    94 Possible variables are :
     107Example: `[/newticket?summary=Compile%20Error&version=1.0&component=gui]`
    95108
    96  * '''type''' - The type droplist
    97  * '''reporter''' - Name or email of the reporter
    98  * '''summary''' - Summary line for the ticket
    99  * '''description''' - Long description of the ticket
    100  * '''component''' - The component droplist
    101  * '''version''' - The version droplist
    102  * '''severity''' - The severity droplist
    103  * '''keywords''' - The keywords
    104  * '''priority''' - The priority droplist
    105  * '''milestone''' - The milestone droplist
    106  * '''owner''' - The person responsible for the ticket
    107  * '''cc''' - The list of emails for notifying about the ticket change
     109To set the ticket owner the workflow action may also need to be selected. For the [TracWorkflow#TicketCreateAction default workflow], the //create and assign// action can be selected with `action=create_and_assign` and the owner specified by assigning `action_create_and_assign_reassign_owner`. Alternatively, you could avoid needing to select the action by using the [TracWorkflow#BasicTicketWorkflowCustomization default attribute] to make //create and assign// the default action.
    108110
    109 '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]]
     111For other custom workflow actions, determine the variable names by inspecting the `name` attribute of the //action// radio button and the //owner// input or select element.
     112
     113== Deleting Tickets #deleter
     114
     115Ticket delete and ticket change delete functions are enabled through an optional component. To enable the functionality edit the [TracIni#components-section "[components]"] section of TracIni:
     116{{{#!ini
     117[components]
     118tracopt.ticket.deleter.* = enabled
     119}}}
     120
     121The //Delete// buttons appears next to the //Reply// buttons in the ticket description and ticket change areas. `TICKET_ADMIN` permission is required for deleting tickets and ticket changes.
     122
     123Tickets and ticket changes can also be deleted using the TracAdmin `ticket remove` and `ticket remove_comment` commands.
     124
     125== Cloning Tickets #cloner
     126
     127The ticket clone function is enabled through an optional component. To enable the functionality edit the [TracIni#components-section "[components]"] section of TracIni:
     128{{{#!ini
     129[components]
     130tracopt.ticket.clone.* = enabled
     131}}}
     132
     133The //Clone// buttons appears next to the //Reply// buttons in the ticket description and ticket change areas. The ticket summary, description and properties are cloned, with minor modifications such as changing the ticket reporter to the currently authenticated user.
    110134
    111135----
    112 See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery
     136See also: TracTicketsCustomFields, TracNotification, TracReports, TracQuery, TracRepositoryAdmin#CommitTicketUpdater