Bugzero User Manual | |
About FAQs |
Home Page The home page lists a user's favorite PR ¹. These are the result of the default query of the user. If the user does not have a default query, all PRs that are not closed and that he is responsible or authored will be listed. A default query can be added in the query result form.
Create and Submit Click on the CREATE button to create a new PR. The state of a newly created PR is always "new" and there is no other choice. The PR will be assigned to a person automatically (based on the Area ²) if no assignee (i.e., responsible) is selected. If an assignee is selected, then the PR will be assigned accordingly. An email notification will be sent if the assignee and the author are a different person.
Edit and View To locate an existing PR, one can either click on the PR number (on the Home or Query result page) or enter the PR number in the "OPEN #" field directly. Some fields of the PR are not editable, and some fields of the PR have to be changed for the PR to be updated. If the new assigned person is not the author, an email notifcation will be sent out.
Automatic Assignment When a new PR is created, by default, it is assigned to a person automatically based on the Area. However, one can specifically select a person to be assigned. A PR can always be re-assigned thereafter.
Description/Response Both Description and Response are a text field used for the detail description of the PR. For a new PR, it is called Description and can be used for things like description, steps-to-reproduce, etc. For all the responses to the PR, it is called Response and can be used for things like work-around, how-to-fix, resolution, etc.
File Attachment Both binary and text files can be attached. File attachment is useful in cases where the content cannot be entered in the Description/Response field (such as an image), or in cases where the file is patchable. File content is not searchable.
CC Mail When a PR is created or modified, email can be sent to certain addresses explicitly. If there are more than one email address, they must be separated with a semicolon(;), a comma(,), or a space. The content of the email is the same as that of the email notification sent to the assignee.
Email Notification An email notification is triggered only when the author of the PR and the assigned person are a different person. The email is sent to the assigned only. The content of the email (as well as the subject) is template based and can be customized.
Find and Search One can do query either with a "Stored Query" or submitting the query form (which can then be saved as a "Stored Query"). The stored query can be set as default, which is then used on the HOME page. Users of group 'guest' can only edit/view PRs they authored.
Reports and Statistics There are three kinds of reports. The summary report has two parameters, such as State verses Responsible, it is rendered as a text form. The current distribution of PR counts and the history trend are a 2D chart. All these reports are displayed in a new window by clicking on the corresponding links.
User Preferences User can change his own account information, which includes password, email address, default project, etc.
Email Signature A user can setup an optional email signature. This signature is appended in the email notification for the PR this user created or modified. Signature is configured in the user's preferences.
System Administration Bugzero provides both a commandline based and a web-based tool for system administration. By login as user 'admin', you can add or remove projects and edit/configure the project setup. You can also add or remove user accounts.
User Groups When the admin creates a user account, a group has to be set to the user. The group is global and is not related to any individual project. There two special user groups called 'admin' and 'guest'. They are system defined and cannot be changed. The admin group is used only for system administration and the guest group is used for users whose access should be limited. All other groups can be configured (add/remove/modify) in the properties file called conf/group.properties.
Guest Group A guest user has certain restrictions by default. He can not view or edit PRs other than those originated from him, in other words, he can only view and edit his own PRs. For a guest user to be able to submit new PRs, an access code of either 'submit' or 'edit' need to be assigned to him (in this case, they are the same). When creating a new PR, guest users do not see the Responsible and the Priority fields. When editing a PR, guest users see these two fields but they are not editable. One can change this policy by editing the _issueform.jsp file. Guest users do not see the Report.
Access Control Access is controlled at the project level. For each project, the admin need assign access codes to the users who are allowed to access. A user with 'submit' access code can only submit new PRs. He can not view or edit PRs other than those originated from him, in other words, he can only view and edit his own PR. This also applies to users in the 'guest' group. A user with 'edit' access code can submit, view, and modify PR. A user with 'view' access code can only view PR but cannot submit or edit a PR.
Area Assignment Area is a mandatory field. For each area added to Area, a user has to be assigned. The admin has to input an area, select a user in the User menu, and click on "Add". This user is the default assignee when a new PR is submitted with this area.
Field Customization For each project, the display name as well as the content of each field can be customized. If a field is left empty (for example, a menu field with no items in it), then the field is not visible on the PR forms and is considered removed. (some fields are mandatory though). While almost all the field display names can be configured by the admin interface for each project, one can also do so by editing the label.properties file.
State and Status There are two mandatory states, namely, "new" and "closed". One can add any other states as needed.
Workflow For each project, workflow can be configured by the admin. Specifically, for each state during the lifecycle of a PR, the next states it is allowed to go can be restricted. For example, for state 'closed', the only allowed next state could be 'reopened'. On the other hand, for state 'new', all states will be allowed except 'new' and 'reopened'. By default, Bugzero allows any states. The second aspect of the workflow is that, when a PR is modified and its state is changed, Bugzero can be configured to let the PR to be automatically re-assigned. Note that, if the user who is modifying the PR explicitly select a new assignee (responsible), this automatic assignment will not take effect. Finally, the next allowed states can also be restricted based on the user group.
Email Management For each project, an email address can be set up to receive PRs submitted through email. An external perl program is required. This email address will also be used as the From address of the notification email. The notification email is template based and can be customized.
¹ PR (problem report) is used here for convenience, it
represents the data record that can be software bugs,
hardware defects, customer support tickets, or any issues or matters.
² Area is used here for convenience, it
represents the project area field that can be area, module, department etc.