Ozibug - web based bug tracking


This guide will get you going quickly. Follow its steps carefully.
  1. Install
  2. Configure
  3. Start
  4. Create Modules
  5. Create Users
  6. Congratulations
Back to index
 
Install Ozibug according to the installation guide. You will need a Java Virtual Machine (JVM) and a servlet container (or application server.) The install steps are outlined below, you may not need to do all of these.
  1. Install JVM
  2. Install Servlet Container
  3. Install Ozibug
Back to top
 
Ozibug comes pre-configured and will work straight out of the box without any special configuration. To take advantage of all of the features though you should carry out some basic configuration. To fully configure Ozibug open the .../ozibug/WEB-INF/ozibug.properties file with your favourite editor and make the following changes.
  1. Configure the log files
  2. By default the logging will appear on the console where you started your servlet container. If you don't start your servlet container from a console window then the logging information will end up wherever your servlet container dictates and may even disappear into a black hole. To have the logging information written to specified files, configure the properties log.debug.filename and log.audit.filename.

  3. Configure your default locale
  4. By default the locale will be inherited from your JVM. For non-english locales, you will need to download and install a custom language pack (or resource bundle.) See the FAQ for more information on locales and language packs.

  5. Configure the default mail server information
  6. By default the ozibug application doesn't know about your email settings and thus can't send email. To enable email notifications configure the properties default.domain, default.mailserver and default.email.

Back to top
 
View audit log Start the servlet container. If you have configured the log files then these files are accessible from the system when you are logged in as an admin user (see the next section for the default id and password.) Select the icon shown to see the audit log. You should see audit output in the logfile which looks like the following.

25/09/01 18:04:54  AUDIT  Ozibug initialized (version: 1.0.1)
                            
View debug log You should also see debug output in the debug logfile which looks like the following. This can be selected by pressing the icon shown when logged in as an admin user (if the log files have been configured.)

21/09/01 10:18:49  INFO   Init: Ozibug initialized (version: 1.0.1)
                            
Back to top
 
Create one or more modules for your system. A module is the unit under which issues or bugs are created. For example a software company may have two products, each product would be a module.
  1. Login as admin
  2. Point your browser at http://host:port/ozibug/index.html from where you can navigate to the login page. The default user name is admin and the password is admin. After logging in you should change the password to this account. It's common sense !

  3. Set defaults
  4. Maintain system preferences Select this icon when logged in as the admin user to set the system defaults including any changed values from the properties file.
    Maintain user preferences Select this icon when logged in as the admin user to set the preferences for this admin user (Hint: you may wish to set the background to red to differentiate this user from others.)

  5. Create modules
  6. Select the module reference category from the select box at the top right of the screen. Enter the module name you desire, enter the numeric sort order (eg, 1) and leave the Active field set to True.

  7. Create categories
  8. You can create additional reference data categories which allow you to track additional, specific items of data for the module. Select the --NEW-- item from the select box in the top right corner of the screen. Enter the category name and the input type, fixed list is a select box with entries you can choose, free format is a simple text field, while mixed is a text/select box combination. You can then select the modules that you wish the data item to be displayed in.

Back to top
 
Maintain all users Select this icon to retrieve the users screen where you can create one or more users for your system. The fields are briefly described in the table below.
IdLogin id
PasswordLogin password
NameFull name
EmailValid email address
Role Each user belongs to a role and each role has different types of access which are outlined below.
  • Guest
  • Is allowed READ ONLY access to modules.
    Is allowed UPDATE access to their user details if so allowed by the system preferences.

  • Customer
  • Is allowed CREATE access to modules.
    Is allowed UPDATE access to any issue or bug they create.
    Is allowed UPDATE access to their user details.

  • Developer
  • Is allowed CREATE/UPDATE access to modules.
    Is allowed UPDATE access to their user details.

  • Manager
  • Is allowed CREATE/UPDATE/MASS UPDATE access to modules.
    Is allowed UPDATE access to their user details.

  • Administrator
  • Is allowed CREATE/UPDATE/DELETE access to all user details.
    Is allowed UPDATE access to system preferences.
    Is allowed CREATE/UPDATE/DELETE access to reference data.
    Is allowed READ ONLY access to system audit and debug logs.

Note: Access to individual modules may be further restricted by the administrator.

Active Setting this to false disables the login
 
Back to top
 
Logout You're up and running. Go and tell your users they can login and start tracking issues. Select this icon to logout and don't forget to change your password !
 
Back to top
 
Back to index
Back to Ozibug home