When Ozibug is first accessed, a login page will be
presented. This page controls access to the Ozibug
application and a valid User Id and Password must be
entered before proceeding.
The login page also displays the current license details
including
The product version number and edition.
Name of licensee.
Expiry date of license.
In the event of a forgotten password, a link is
available to provide assistance. Completing the
forgotten password form with either a user id or
registered email address will result in a temporary
password being sent to the registered email address of
the user (this automated facility cannot be used by
users without a registered email address). A subsequent
login with this temporary password requires a new
password to be chosen before Ozibug can be accessed.
Should the forgotten password request have been
submitted in error (or maliciously!) the current
password is unchanged and can still be used to access
Ozibug.
Note: This is the default Ozibug
authentication behaviour. Optional pluggable
authentication modules can be be configured by the
system administrator, whereby user authentication is
performed against an external source such as a user
management system or LDAP directory. As a result a
custom login procedure may exist.
On successfully logging into Ozibug a welcome page will
be presented. All application pages provide a common
header that contains menu options that are available to
the current user. The user options are described in the
following sections, whereas the administrator options
are described in the
Administrator Guide, with their
availability depending on the role of the user.
User preferences allow a user to personalize the
display of Ozibug by setting such attributes as colours
and the display format of date and time. The
preferences of a new user will be defaulted to match
those set by the system administrator. To customize
your preferences, edit the required preference data and
select the Update button. Alternatively, to
revert your preferences back to the default, select
the Use Defaults button.
Users in the guest role only have access to user
preferences if the system preference
Allow user maintenance by guests
has been enabled.
Note: Attempting to set a preference to
null or clearing its value will result in it being set
to the default value.
Colours can be specified using a variety of notations
decimal rgb notation
hexadecimal rgb notation
named colour notation.
16 colours are officially defined by
The World Wide Web Consortium (W3C),
however most browsers will support a wider range
Where for example the values rgb(128,0,128),
#800080 and purple all represent the
same colour of purple. An unknown colour or invalid
syntax can result in an unspecified colour being used
for display.
Number of bugs per page defines how many bugs are
displayed on the bug summary page for a module.
Note: higher numbers result in slower
download times as the size of the bug summary page
increases with each additional bug displayed. While a
slower download time might not be an issue in an
intranet environment, consideration should be given to
the speed of your Internet connection when setting
this value in an Internet environment.
Date/time format uses the notation defined by the Java
class
SimpleDateFormat.
Use of invalid syntax will cause a error to occur and
the changes not to be recorded.
Email notifications are sent to the creator, updator,
assignee and any other nominated recipients when a
change is made to a bug. The email notification
preference defines whether the notification is
required when the user is creator, updator or
assignee, otherwise the notification is always sent.
Note: this preference is only
displayed for those users that can create or be
assigned bugs (ie., Customers, Developers and
Managers).
Session timeout defines how long a session logged into
Ozibug can be idle for before being terminated. This
is designed to protect your access to Ozibug and
prevent abandoned sessions (eg., due to browsers being
terminated without logging out) from bogging down the
system.
User details display the currently defined personal
details and status. Some details are read only and can
only be updated by the system administrator, however
password, name and email address are updateable by the
user themselves.
Users in the guest role only have access to user details
if the system preference
Allow user maintenance by guests
has been enabled.
No restrictions are placed on the value of the
password. However, the password and its confirmation
value must match when the password is updated.
A name must be specified.
If an email address is specified it must be well
formed, eg., myname@mydomain.com.
At the top right of the screen the key image
shows a link that will display the key that can be used
for single access authentication in a small popup
window. This key is an encrypted version of your user
id and password which is commonly used by one time
report requests such as from an RSS Aggregator or an
automatically scheduled report. Refer to their
respective howtos for further information
(RSS Reporting or
Automatic Scheduled Reports).
Custom reports -
which allows the user
to query the Ozibug database and generate
customized reports.
Summary table -
which shows the
matrix of issues cross referenced by their
status and priority.
Release notes -
which allows the user to
generate release notes from all bugs in the
selected module based on a template.
Note: all reports are created with
the locale of the requesting user. The data contained
within them is also subject to the access control
constraints of that user (the module restrictions,
users role and bug privacy values are checked.)
Custom reports
This page is shown automatically when the user
selects the reports icon. The list of fields
that the current user has access to are displayed
centrally in a table.
The first row of fields select the module(s)
that this report will apply to.
Note: that if no modules are selected
then all modules will be used by the
report.
The last row of fields select the number
of results that this report will return.
Note: that if no results size is
selected then all records found
will be returned by the report.
The rows of each table are broken into three
columns, each column having the following purpose.
Include
Select the fields that you require in the
report with the checkbox in the
include column.
You can select (or deselect) all fields
quickly with the all checkbox in
the title row.
Filter
Select the fields that you wish to place
filter constraints on using the checkbox
at the left of this column.
The field to the right of the checkbox
allows you to enter the appropriate type
of data which is compared against the
list of bugs included in the report.
Comma separated tokens are allowed in
the filter fields which allow you select
several items, for example new,open
is a valid entry for the status field.
Note: the fields filtered on
do not have to be included in the report.
Sort
The last column allows one or more sort
criteria to be placed on the output data.
The checkbox at the left selects the sort
criteria for the field. The next select
box determines which direction the sort
is carried out.
The last select box determines in which
order the specified sort criteria should
be placed on the data.
There are six output formats that can be
selected for the report. These are described
below.
Plain Text (summary)
This produces a simple summary report which
can be displayed in the browser and has
all the data in aligned in columns.
The description and detail fields have
line termination removed and are
truncated to 50 characters.
File Attachment, Comment and Audit Trail
entries are not displayed.
HTML (summary)
This produces an HTML summary report in a format
similar to the bug summary page containing the
selected fields.
File Attachment, Comment and Audit Trail
entries are not displayed.
If the Id field is included in the
selection, it will be displayed as a hyperlink which
can be followed to display the view bug page.
Note: the Back button on
the view bug page returns to the bug summary page
(standard behaviour), in order to preserve the HTML
report for viewing other bugs it is recommended that
you view each bug in a new browser window or tab
using the appropriate action specific to your
browser.
RSS (summary)
This produces a simple summary report in
RSS (Really Simple Syndication) format.
Note: this report is XML which
will not be displayed correctly in your browser.
This report format is intended to be piped
into an RSS aware application. These
applications take a URL and generally fetch
the page themselves.
After you have selected and generated the
report you can take the URL which will be
displayed in the top address bar of your
browser and cut and paste this into your RSS
aware application. The RSS aware application
can then get the report at periodic intervals
without your intervention.
Plain Text (detail)
This produces a detailed text report which
can be displayed in a browser and is
capable of showing all fields.
Simple fields are displayed in two columns,
title then data. Repeating fields are
displayed down the page, title first.
The full text of multi-line fields such
as detail is displayed.
XML (detail)
This produces a detailed report in simple
XML. The XML tags are created from the
title of the data and may be massaged to
remove invalid characters.
The report is sent to browser with the
mime content type of
application/x-ozibug-xml which
can be used to trigger a specific application.
This is done in your browser's configuration.
Note: the tags are locale
dependent.
CSV (detail)
This produces a detailed report in simple
CSV (Comma Separated Values) format.
This can be directly imported
into a spreadsheet application easily.
The report is sent to browser with the
mime content type of
application/x-ozibug-csv which
can be used to trigger a specific application.
This is done in your browser's configuration.
Note: this format cannot
handle multi-line text - this is converted to a
single line.
The report settings can be customized and saved for
recall at another time. The settings also work in
conjunction with the bug summary filter/sort criteria
settings (see below) so that common settings will
appear in both screens. This allows you to define one
named report/filter that can be used in both screens.
If the current user has a default report defined the
report fields are automatically populated with values
according to the report settings. The default can be
identified in the report select box by the presence
of a (*) following the report name.
The following buttons are available to manipulate
these settings.
Default
Select Box (top)
Select the output format of report that is generated.
Select Box (bottom left)
Selects the named report settings.
Apply
Generates a report according to the current settings.
Clear
Clears the current settings.
Reset
Resets the settings to their initial version.
Text Box (bottom right)
Set by the user to define the name of a report.
Default
Set by the user to set the named report as the default.
Save
Saves the current settings in the named report.
Delete
Deletes the named report settings.
To generate a report, choose the required fields
to include, filter on and sort by and then
select the Apply button.
The chosen settings will be applied and the
report generated in a new browser window.
To save the report settings, type in a meaningful
name for your report and then select the Save
button.
The page will be redisplayed and the named report
is now available in the select box at the
left side of the button row.
Selecting a report from this box recalls the
settings which can then be applied by selecting
the Apply button.
You can also change the settings before applying
the report allowing for an adhoc filter/sort.
The Clear and Reset buttons
reset the form to a known state.
To delete a report, simply select it from the
select box and then select the Delete
button.
To activate the Summary Table report page,
first select a module using the select box
at the top left of the page.
All the modules that the user has been granted
access to are available in this box.
Once the module has been selected the page
will automatically populate the summary table
with the module statistics.
Selecting the link for each title in this table
will place the user in the summary page with
filter and sort criteria which correspond to
the cell selected.
Note: only users assigned to the
developer or manager role can access this section.
To generate release notes the required module
must be selected by the select box in the top
left corner of the page.
Once this is done then sort fields that are available
for the module are enabled for selection in the middle
form.
Template name
Select the template that you want the release notes
to be based on. Basic templates are shipped with
Ozibug, however custom templates can also be
defined. Refer to
Creating a Release Notes Template
for further details.
Sort
Select the field on which sorting is to be performed
and the sort direction. The id and priority fields
are always available for sorting, as well as any
custom categories for the module.
Modules provides access to the core of Ozibug, allowing
bug or
defect tracking on a module basis. The select box
contains a list of modules that the system administrator
has defined for tracking purposes. The list of modules
available for selection is restricted to those modules
that the user has been granted explicit access to and
those modules that are unrestricted (ie., those with no
users granted explicit access, behaviour similar to
the access control to the Unix crontab
utility).
The following sections describe the available module features in more detail.
On selection of a module the bug summary is displayed.
VCR style buttons allow navigation though the pages of
the bug summary with each page containing the number of
bugs as specified in the user preferences. A Refresh
button causes the bug summary to be refreshed from the
Bug Repository to capture any changes made by other
users since the summary was first displayed.
The level of access will be dependent on the role
of the user. All read only bugs and modules can
be readily identified by the locked image
at the top of the bug or module detail.
Guest: read only access only.
Restricted to displaying those bugs and comments
that have not been created as private (ie., only
publicly accessible bugs and
comments).
Customer: create new bugs and update bugs they
created.
Restricted to displaying those bugs and comments
that have not been created as private by another
user (ie., only publicly accessible bugs and
comments).
Developer: create and update all bugs individually.
Manager: as per Developer, plus mass update of bugs
from the summary.
In addition, bugs with a status designated as read
only or modules designated as read only can only be
updated by Managers.
Several useful links are displayed at the top
right of the screen which have the following
functions.
will popup a new browser window and display a
printer friendly version of the summary screen
that you currently have displayed.
will popup a new browser window and display the
screen that you currently have displayed in RSS
format. The URL of this report
can then be pasted from the browser's address
bar into an RSS aware application.
The bug summary can be customized by filtering/sorting
on various criteria.
If the current user has a default filter defined the
filter fields are automatically populated with values
according to the filter settings and the filter applied
to the bug summary display. The default can be
identified in the filter select box by the presence
of a (*) following the filter name.
The following buttons are available
to manipulate the filter/sort criteria.
Default
Select Box
Selects the named filter and sets the criteria.
Apply
Filter and Sort on the current criteria.
Clear
Clears the current criteria.
Reset
Resets the criteria to the initial version.
Text Box
Set by the user to define the name of a filter.
Default
Set by the user to set the named filter as the default.
Save
Saves the currently set Filter and Sort criteria
in the named filter.
Delete
Deletes the named filter.
To apply a filter, choose the required criteria,
select the corresponding Active box for each
chosen criteria and select the Apply button.
The chosen criteria will be applied and the
filtered bug summary redisplayed, the filter
details are preserved for further customizing and
summarized at the top of filter/sort section.
To save the chosen criteria, type in a meaningful
name for your filter and then select the Save
button.
The page will be redisplayed and the named filter
is now available in the select box at the
left side of the button row.
Selecting a filter from this box recalls the
criteria which can then be applied by selecting
the Apply button.
You can also change the criteria before applying
the criteria allowing for an adhoc filter/sort.
The Clear and Reset buttons
reset the form to a known state.
To delete a filter, simply select it from the
select box and then select the Delete
button.
The value of the Status, Priority and Assignee
filters are set by selecting each required value
from the corresponding select box or typing a comma
separated list of values into the corresponding
value box.
The value of the Id and Keyword filters are both set
by typing the required value in to the corresponding
value box.
The filter on Keyword can optionally be further
expanded or restricted. Select the Detail box to
expand the search from just the summary description
to the detailed description, comments and audit
trail. Select the Case box to restrict the search
to being case sensitive (default is case
insensitive).
The sort criteria define the order in which the bug
summary is displayed. A chosen sort criteria can be
set to display in either ascending or descending
order and given a rank. eg., to first sort by
Priority and then within that by Status, set the
Rank of Priority to 1 and the Rank of Status to 2.
To create a new bug, select the New button on
the bug summary page. Chose the required values from the
select boxes or type into the edit boxes as appropriate,
and select the Apply button. A new bug will be
created and the view bug page will be displayed.
Creation of a new bug can be aborted by selecting the
Cancel button.
All bugs are initially created with a special Status
of New.
If a default value has been defined for either
Priority or a fixed list Custom category it will be
automatically selected in the corresponding select
list, otherwise the first entry in the list will be
used as the default selection.
A Summary and Detailed Description must be entered.
Customers are not able to assign bugs.
The Notifications field is used to register interest
in the bug so that an email notification will be
sent when a change is made to the bug. The value
should contain a comma separated list of well formed
email addresses, eg., myname@mydomain.com.
Bugs can be designated as private bugs, which means
that they cannot be viewed by Guests or Customers
other than the creator.
An Audit Trail is maintained for the bug, tracking
each change. It can be viewed by selecting the Show
Audit Trail button, to remove it from the
display select the Hide Audit Trail button.
To view an existing bug, click the hyperlink on the id
of the required bug from the bug summary page. The
current details of the bug will be displayed.
Several useful links are displayed at the top right
of the screen which have the following functions.
will popup a new browser window and display a
printer friendly version of the bug that you
currently have displayed.
will trigger your browser to display an email
compose message window containing just the
hyperlink to the bug.
will popup a new browser window and redisplay the
bug that you currently have displayed with a
permanent URL that can be bookmarked to enable
subsequent direct access to the bug.
To edit the bug (if access allows), select the
Edit button. To return to the bug
summary page, select the Back button.
To attach a file to the bug (if access allows),
select the Attach File button.
Editing an existing bug is similar to creating a new
bug.
Id and Summary Description are read only.
Customers are not able to update Status, Priority or
Assignee.
Comments can be designated as private, which means
that they cannot be viewed by Guests or Customers
other than the creator. Private comments are show
as a masked entry in the Audit Trail.
Managers can move a bug between modules by updating
the Module. After moving a bug to another module,
control is returned to the bug summary page. The
details of the bugs previous location are displayed
as a read only field on the bug detail
page.
Mass update of bugs is available to Managers from the
bug summary page. This provides a convenient method of
assigning a number of bugs to a given user, or changing
the status of all new bugs to open, etc, etc. The
Status, Priority, Assignee and Summary Description can
all be updated for any number of the bugs currently
displayed, by making all the required changes and
selecting the Update button. In addition
Managers can move a bug between modules by updating the
Module.
The about page shows the product version number and
edition of Ozibug. It also
provides links to the vendor (Tortuga Technologies) and
product (Ozibug) web sites.
shows a link that will display the key that can be used
for single access authentication in a small popup
window. This key is an encrypted version of your user
id and password which is commonly used by one time
report requests such as from an RSS Aggregator or an
automatically scheduled report. Refer to their
respective howtos for further information
(
at the top of the bug or module detail.
