Guide to Using PTS

PTS (Problem Tracking System) was developed originally for system administrators to record problems on networks. However, it is extremely versatile, and is used by FreeBMD developers not only for recording problems, but also to record ideas and suggestions for changes and improvement to many aspects of FreeBMD.

Before using PTS you will need to get a username and password from Dave Mayall. When you are ready, go to the PTS login page and enter your username and password to access the system.

Setting Preferences

The Assigned to menu contains a list of developers' names, as well as two other items, 'All' and 'TODO', and what you see here when you access this screen depends on what preferences have been set.

At the bottom right of the screen is a button labelled Prefs. Clicking on this button will take you to a screen where you can change your password and various other options.

The column headed User Value contains a number of boxes which allow you to change settings such as the colour scheme etc. The box we are interested in is the one labelled _tech, which determines what is displayed in the Assigned to menu on the previous page.

The default for all of the boxes is to leave them blank. In this case you will see your own name in the Assigned to menu, followed by a list of tasks assigned to you each time you log in. (If there are no tasks assigned to you, you will see the words: Table 'tasks' contains no entries matching criteria).

Entering 'All' in the _tech box will display all of the tasks currently in PTS, including those assigned to developers. Entering 'TODO' will display all of the tasks awaiting assignment to a developer.

When you have set your preferences, click on the Post button below the boxes to save your selections and then click on the Return button at the top right, to return to the previous screen. Whatever selections you have made here will be seen each time you log in to PTS.

Note: Whatever preferences you have set, you can still see all of the options available on the entry screen by clicking on one of the drop-down menus and then clicking on the Retrieve/Update button.

The options available from the menus are too numerous to list here, but you are advised to experiment with different selections to see the effects. You can't do any harm by doing this.

Projects (PID) and tasks (TID)

The other columns show various details of the tasks such as the date the task was set, a summary of the task, the name of the Requester of the task and the status.

The task numbers are generated as each task is recorded, whilst each project has a fixed number.

For example, the project PID:1122 is for Input Enhancements. If this is your area of expertise, and you want to see all of the tasks within this category, clicking on any PID:1122 listed in the column will display all of the tasks within this category. You can then choose which of these tasks you would like to work on.

Clicking on a TID number will take you to a screen showing the requirements of the task and who the task is assigned to. If the task is assigned to 'todo', then you may assign the task to yourself by clicking on the 'Modify' button at the top right of the screen. (See section 'Allocating requests [Developer]' below).

Important. When a task is recorded in PTS, an email is sent to everyone on the mailing list notifying them of the change. The email contains a link, which when clicked enables the actuator to view the changes.

It is possible to modify a task by clicking on this link. However, changes should not be made in this way. The link should only be used to view the changes, as modifying from the link will just show updated by 'TODO' rather than by the named individual.

If you intend to carry out any changes in PTS, you should always access PTS via the PTS login page, when the change will be recorded under your name.

Recording the Request [Requester]

1. Record the task.
   To record a new task, click on the New Task button at the top right of the screen and you will be taken to the 'Add a new Task' page, which has drop-down menus displaying various options from which to make a selection.
2. Assign to user "TODO".
   From the drop-down menu under the Currently assigned to label, select 'TODO'. This lets developers know that the task is open, and not yet assigned to any individual.
3. Set the Status.
   From the drop-down menu under the Status label, select 'Assigned' (this is because you've assigned the task to 'TODO')
4. Set the project number according to the project table.
   Each project within PTS has a number which identifies it as belonging to a particular category of task. For example, if the task you are setting is a cosmetic one such as a change to a web page, selecting number 1129 would put the task into the category 'Changes that involve adding or changing text, graphics etc'.
5. Set the priority according to the priority table.
   Each task has a priority number from 1-9 as outlined in the priority table, which is self explanatory.
6. Enter a description of the change.
   Without using any double quotes or snippets of broken HTML, enter a one line description of the task in the Summary box. In the Detail box enter a fuller description of the task.
7. Click on POST to add the task.
   Clicking on this button sends an email notification to all the developers, notifying them that a new task has been set.

Note: If you are planning to do the development work on the task yourself, it is advisable not to allocate it (see following section)for at least twenty-four hours. This allows time for the rest of the team to see the proposed changes, and comment on them if necessary.

Allocating requests [Developer]

1. Click on the TID number of the task.
   The next screen you see has details of the task you have selected.
2. Click on the 'Modify' button.
   The next screen has drop-down menus and the name of the originator of the task. From the drop-down menu under Currently assigned to, you will see your name on the list.
3. Assign the task to yourself.
   You should never start work on a task until you have assigned it to yourself.
4. Select 'In progress' from the Status drop-down menu.
5. Click on 'Post' after adding any follow-up information you want to add.
   This will send an e-mail notification of the change to everyone on the mailing list.

Testing Changes [Requester]

1. As the person requesting the change, you will receive e-mail notification that the task has been assigned back to you as tested.
2. Unless advised otherwise, you will be able to test your change on the Test site
3. If you are happy that the change is what you requested, you should set the task status to "Tested OK" and assign the task back to the developer who sent it to you.
4. If you are not happy, you should describe what is wrong in the follow box, set the status to "Re-work needed" and assign it back to the developer.
5. If you are happy, but you would like a second opinion on the readability of a page, set the status to "Proof Read Rqd", assign the task to 'TODO' and click on 'Post'.

Proof Reading [Proof Reader]

1. All members of the project team will receive e-mail notification that a proof-reader is required.
2. If you wish to do this work, access PTS via the PTS login page before making any changes.
3. Click on the 'Modify' button.
4. Assign the task to yourself.
5. Set the status to 'In Progress'.
6. Click on 'Post'.
7. Unless advised otherwise, you will be able to read the module on the Test site.
8. Proof-read the module for spelling, grammatical errors, readability and user friendliness, keeping in mind that readers of the page might not be technically-minded.
9. If after proof-reading you find no errors, you should set the task status to 'Tested OK' and assign it back to the developer (check the follow-up history to find the developer).
10. If you feel that amendments are needed you should set the status to 'Rework needed', add your comments in the task 'follow-up' box noting the suggested amendments and assign it back to the developer.

Note: If you are proof-reading a long document which requires a more detailed response you could copy and paste from the page on the test site to your favourite word processor.

After proof-reading the document you could then cut and paste your suggested amendments into an email and send them to the developer. Finally, set the task status to 'Tested OK' and assign it back to the developer.

FreeBMD Main Page