The defects

The bugs tree gathers all the bugs found on the products/SUTs.
Bugs can be handled directly by XStudio or retrieved from: If your bugs come from another third-party system you can configure them as generic (see Generic bug-tracking settings).


Here is a typical defect tree. It immediately shows a number of useful information:
  • the total number of defects
  • the number of defects in each category
  • the number of defects in each folder
  • the status of each defect (indicated by the color of the icon)
  • the severity of each defect (indicated by the column)
  • the priority of each defect (indicated by the column)


Highslide JS


Executing some tests (running some campaign session) makes you able to generate reports. It’s good to have a static view of what is working and what is not but it would be even better to link the tests that failed to actual defects. Hence, several failing testcases may be due to only one single defect.

At this point, a report analysis must be done by the test operator. This analysis should lead to associate all failed testcases to some defects.


Searching

By name

All the trees in XStudio include an indexing system allowing to search real-time an entity in the tree by his name. To experiment it by yourself just start entering some text in the Search field of the tree

Highslide JS


To automatically select a searched item in the tree, you can move using the arrows keys within the suggestion list and validate by pressing Enter or just click on the item in the list.

By Id

The data model gives unique identifier for each entity managed by XStudio. The Ids are on the form:

template Represents
D_<id> Defect


Ids are also available from XStudio’s GUI (in the Details tab you have an Identifier field that corresponds to <id> in the template.

To search for an entity from its Id, just type the Id in the Search Id field and validate.

Advanced and plain text search

Searching items such as bugs based on a combination of some very specific criteria can be not only very useful but extremely important to control/guarantee the quality of the products.


Procedure:
  • select the root node in the bugs tree
  • click on the Search bugs button
  • the Search bugs window is displayed
  • check all the checkboxes (Status, Severity and Priority) that match your search criteria
  • (opt.) type some text in the Text to search field and press Enter


Highslide JS


Note: The results list is updated real-time and you can reach one particular bug by just clicking on it. The results table can be ordered by clicking on the column headers.

The root node

Tabs

Statistics

A bug tracking system is good only if it provides a simple and efficient way of retrieving information about them. XStudio generates extensive reporting on bugs.

To get those reports,
  • switch to the Bugs tab on the left panel
  • in the tree, select a category
  • on the right panel, select the Statistics tab
  • choose a range of dates using the date pickers


Then a huge number of reports can be retrieved.
  • on the active bugs (New, Assigned, Ack)
    • per user (Assigned to or Reported by)
      • Status, Severity or Priority trends
    • major bugs trends (Blocking, Major)
    • minor bugs trends (Minor, Cosmetic, Enhancement)
    • high priority bugs trends (High)
    • low priority trends (Normal, Low)
  • on the passive bugs (Resolved, Closed)
    • idem
  • on all the bugs
    • idem
  • submission/resolution rates trends


Per-user reports

To get per-user reports,
  • select the tab corresponding to the desired group of bugs:
    • Active Bugs (New, Assigned and Ack)
    • Passive Bugs (Resolved and Closed)
    • All Bugs
  • select if you want some data about bugs Assigned to or of Reported by a specific user
  • select a name in the user list
  • select which kind of information you’re interested in:
    • Status
    • Severity
    • Priority
  • The report will display the corresponding trends and an additional pie chart representing the current status
    Highslide JS


Per-severity reports

To get per-severity reports,
  • select the tab corresponding to the desired group of bugs:
    • Active Bugs (New, Assigned and Ack)
    • Passive Bugs (Resolved and Closed)
    • All Bugs
  • select if you want some data about
    • Major bugs (Blocking, Major)
    • Minor bugs (Minor, Cosmetic, Enhancement)
  • The report will display the corresponding trends and an additional pie chart representing the current status
    Highslide JS


Per-priority reports

To get per-priority reports,
  • select the tab corresponding to the desired group of bugs:
    • Active Bugs (New, Assigned and Ack)
    • Passive Bugs (Resolved and Closed)
    • All Bugs
  • select if you want some data about
    • High Priority bugs (High)
    • Low Priority bugs (Normal and Low)
  • The report will display the corresponding trends and an additional pie chart representing the current status
    Highslide JS


Submission/Resolution rates

To get submission/Resolution rates reports
  • select the Resolution Rates tab


Highslide JS

The top part of the panel shows the progression of the number of Active and Passive bugs as well as the metrics as of now and as of the last record.

The bottom part of the panel shows the submission and resolution rates. These metrics are really essential as they are allowing to determine for instance when the number of bugs submitted per day becomes lower than the number of bugs resolved per day.

Custom fields

We can customize the defect by creating, in "Details" menu (right panel), new fields, combow box, drop-down list... mandatory or not.

Highslide JS

Create custom field
Here is the process to create a custom field for a defect:
  • in the tree, select a root folder
  • on the right panel, click on the create custom field button
  • enter the name, the type, the position, mandatory or not and default values and submit

    Highslide JS
  • the custom field immediately appears in the panel
  • the new field is added at all defect level in "Details" menu.


Highslide JS Highslide JS

Edit custom field
Here is the process to edit a custom field for a defect:
  • in the tree, select a root folder
  • on the right panel, select the custom field
  • click on the edit custom field button
  • Change the name, the type, the position, mandatory or not or/and default values and submit

    Highslide JS
  • the custom field immediately appears in the panel with new values
  • At all defect level in "Details" menu, the field is updated well

    Highslide JS Highslide JS


Delete custom field
Here is the process to delete a custom field for a given defect:
  • in the tree, select a root folder
  • on the right panel, select the custom field
  • click on the delete custom field button
  • confirmation message display and submit

    Highslide JS
  • the custom field immediately disappears from the panel
  • At all defect level in "Details" menu, the field is deleted well

    Highslide JS Highslide JS


Toolbar

Create a folder

A folder can be created only under the root node of the tree or another folder node


Here is the process to create a new folder:
  • select the root folder in the tree
  • on the right panel, click on the create folder button
  • enter the name of the folder and submit
  • the folder immediately appears in the tree


Create a report

It may be interesting to export or to print a global report on all the bugs you have.

To do so:
  • select the root folder in the tree
  • click on the Create report button
  • select the destination folder for the report
    Highslide JS
  • select the extension of the report (HTML or XML).
    If you choose to generate the report in HTML you can select one report template (Type drop-down menu).
    To each template corresponds one specific XSLT transform (one physical .xslt file).
    By default, one XSLT is provided along with XStudio:
    Complete_With_stats
    Highslide JS
  • provide the file name for the report (Save as text field)
  • submit
  • the report is automatically opened:
Highslide JS

TIP: Custom reports
You can customize the requirement reports.
To do that, just edit the following .xslt files located in <XStudio install dir>/export/xsl/ folder (or if you use the web package in /export/xsl/ of the export.zip archive on the server):
  • defectHTML_Lib.xslt: Defect XSLT library
  • defectHTML_Complete_with_stats.xslt: Complete report on the defects with statistics
  • defectHTML_Active_defects_with_stats.xslt: Report on active (Not resolved or Closed) defects with statistics
You can also add your own template if you follow the naming convention of the xslt file.


Search bugs

Search on bug are handled similarly to the search bugs on the searching chapter.

The folder nodes

Tabs

Details

The folder details tab allows you to specify the name of the folder


Highslide JS

Attachments

Attachments are handled the same way than any documents in the documents tree.



Toolbar

Create a folder

A folder can be created only under the root folder node or another folder node.


Here is the process to create a new folder:
  • select a folder node in the tree
  • on the right panel, click on the create folder button
  • enter the name of the folder and submit
  • the folder immediately appears in the tree


Delete a folder

You can delete a folder by just clicking this button and confirming the deletion.
WARNING: deleting a folder will delete all objects linked to this folder (i.e. underlying folders and bugs etc.)


Move a folder

You can move a folder by just clicking this button, selecting the destination folder and submitting.


Create a bug

To create a bug:
  • in the tree, select a folder (create one if necessary)
  • on the right panel, click on the create bug button
  • a dialog box including four tabs is displayed
    Highslide JS Highslide JS
    Highslide JS Highslide JS
  • fill the Details tab with the name, description, steps to reproduce, reproducibility, platform, operating system, status, severity and priority
  • pick one user in the Assigned to tab who will be registered as the one assigned to resolve the bug
  • in the Found in tab, check all the SUTs on which this bug can be observed
  • click on submit
  • the bug immediately appears in the tree

Create a report

It may be interesting to export or to print a global report on all the bugs you have.

To do so:
  • select the folder in the tree
  • click on the Create report button
  • select the destination folder for the report
    Highslide JS
  • select the extension of the report (HTML or XML).
    If you choose to generate the report in HTML you can select one report template (Type drop-down menu).
    To each template corresponds one specific XSLT transform (one physical .xslt file).
    By default, one XSLT is provided along with XStudio:
    Complete_With_stats
    Highslide JS
  • provide the file name for the report (Save as text field)
  • submit
  • the report is automatically opened:
Highslide JS

TIP: Custom reports
You can customize the bug reports.
To do that, just edit the following .xslt files located in <XStudio install dir>/export/xsl/ folder (or if you use the web package in /export/xsl/ of the export.zip archive on the server):
  • defectHTML_Lib.xslt: Defect XSLT library
  • defectHTML_Complete_with_stats.xslt: Complete report on the defects with statistics
  • defectHTML_Active_defects_with_stats.xslt: Report on active (Not resolved or Closed) defects with statistics
You can also add your own template if you follow the naming convention of the xslt file.


The Bugs nodes

Tabs

Details

The bug Details tab allows you to specify the name, the step to reproduce, the description, the status, the severity, the priority of the bug, ...
If some custom fields have been configured, they will appear here as well (positionned as specified).


Highslide JS

Reporter

The Reporter tab allows you to specify the bug reporter.

Assigned to

The Assigned to tab allows you to specify the user assigned to the bug.

Found in

The Found in tab shows you the SUT and the test linked to the bug.

Fixed in

The Fixed in tab shows you the SUT where the bug is fixed.

Impact

The Bugs Impact tab shows the SUTs, the requirements, the specifications and the tests impacted by the bug.

Attachments

Attachments on bug are handled similarly to the attachments on the folders.

CC Emails

The CC Emails tab allows you to ensure some users will receive a notification when the bug status will be changed


Revisions

This tab shows all the revisions of the selected bug.
You can open a specific revision of the bug by selecting a revision in the list and clicking on the open button.

Highslide JS

Changes (audit log)

XStudio allows tracking any changes on a particular object.


To check the history of a bug:
  • select the bug in the tree
  • open the Changes tab on the right panel
  • the panel shows a table gathering all the dated changes.


On a bug you will get a panel similar to this one:

Highslide JS

TIP: You can edit directly the details of a user by clicking on his name in the changes table.


Toolbar

Delete a bug

You can delete a bug by just clicking this button and confirming the deletion.


Move a bug

You can move a bug by just clicking this button, selecting the destination folder and submitting.


Reminder

XStudio allows sending reminder for bug assigned to.
To send a reminder for bug:
  • switch to the Defects tab on the left panel
  • in the tree, select a defect
  • on the right panel, click on the Send reminder button
  • notification mail is sent to developper for remind