Using the SDL Online Bug Databaseshbugfix.sheffield.sdl.com/userguides/OBR_UserGuide.pdf · SJones 24/04/2010 3.1 Revision based on BCS text and IEEE standardisation. SJones 31/05/2010

Using the SDL

Online Bug

Database

SDL International Gemini Division Aspect Court, Pond Hill Sheffield, S1 2BG United Kingdom

Incorporating Query and Term

Tracking

Revision History

Author Date Version Comments

SJones 02/04/2008 1.0 Initial set of Instructions for the

Online Bug’s Database.

SJones 17/04/2008 1.1 Amendments to viewing own bugs

section after feedback.

SJones 18/04/2008 1.2 Amendments to bug reporting fields

after feedback.

SJones 29/04/2008 1.3 Process flow added.

SJones 13/05/2008 1.4 Amendments to database after further

feedback.

SJones 02/06/2008 1.5 Updated for SP1


Copying previous bugs.

Preset Comments.


SJones 27/09/2008 1.8 Recall Bugs expanded to other groups.

SJones 20/11/2008 1.9 Re-Worded section for Fixed in Files

option.

Examples of how to correctly use

Incorrect/Correct text fields.

SJones 24/12/2008 2.0 Updated for 2009 SP1.

Step through bugs.

Attachment procedure change.


Ability to Watch bugs

SJones 17/03/2009 2.2 Status filter option

SJones 05/05/2009 2.3 Update on supported browsers

Page view for long Action Lists

SJones 26/05/2009 2.4 Open similar bugs

Created by filter


Filter on External References

List multiple bugs on ID

ASCII char limit on uploads

SJones 19/07/2009 2.6 Last 5 comments


Root Cause

Awaiting Feedback

Attachment Limits

SJones 26/11/2009 2.8 Updated for 2009 SP7

Translation Memory lookups

Source English changed to Source

Text

Test Case information

SJones 29/12/2009 2.9 Amendments regarding Google

Chrome

Root Cause

Order on Severity and Bug ID

SJones 01/04/2010 3.0 Look up selected text in the TM.

SJones 24/04/2010 3.1 Revision based on BCS text and IEEE

standardisation.

SJones 31/05/2010 3.2 iPad comments

CMC 20/09/2010 3.3 PNG previewing

SJones 15/05/2013 3.4 2013 SP1 and SP2

Fields can be re-ordered.

Certain fields can be marked as

required or not.

Additional custom fields

Source Language field

Certain fields only appear once a bug

has been submitted

SJones 11/08/2014 3.5 2014 SP1

Updated screenshots to match re-

branding.

Removal of Knowledgebase

Contents

REVISION HISTORY ................................................................................................................................. 2

CONTENTS .................................................................................................................................................. 4

GETTING STARTED.................................................................................................................................. 6

SYSTEM REQUIREMENTS: ........................................................................................................................... 6 ACCESSING THE DATABASE: ...................................................................................................................... 7 SELECTING THE ACCOUNT:......................................................................................................................... 7 SELECTING YOUR ROLE AND PROJECT: ...................................................................................................... 8

TYPICAL PROCESS FLOW ...................................................................................................................... 9

MAIN MENU ...............................................................................................................................................10

CREATING BUGS AND QUERIES .........................................................................................................12

COPYING A PREVIOUS BUG: .......................................................................................................................12 Key for the header information below: ................................................................................................12

TYPE [CONFIGURABLE/REQUIRED]: ..........................................................................................................12 SEVERITY [CONFIGURABLE/REQUIRED]: ...................................................................................................13 URL [CONFIGURABLE/REQUIRED]: ...........................................................................................................13 FILE NAME [CONFIGURABLE/REQUIRED]: .................................................................................................13 PAGE NUMBER [CONFIGURABLE/OPTIONAL]: ...........................................................................................14 DESCRIPTION [STANDARD/REQUIRED]: .....................................................................................................14 TEST PLAN FILE NAME [CONFIGURABLE/REQUIRED]:...............................................................................14 TEST CASE STEP [CONFIGURABLE/REQUIRED]: .........................................................................................15 STEPS TO REPRODUCE [CONFIGURABLE/REQUIRED]: ...............................................................................15 SOURCE TEXT [CONFIGURABLE/REQUIRED OR OPTIONAL]: ......................................................................15 INCORRECT TEXT AND CORRECT TEXT [STANDARD/REQUIRED OR OPTIONAL]: .......................................15 FIXED IN <ITD/EXCEL/ETC.> [CONFIGURABLE/REQUIRED] ......................................................................17 EXTERNAL REFERENCE [CONFIGURABLE/OPTIONAL]: ..............................................................................17 ROOT CAUSE [CONFIGURABLE/OPTIONAL]: ..............................................................................................17 DUE DATE [CONFIGURABLE/REQUIRED]: ..................................................................................................18 SOURCE LANGUAGE [CONFIGURABLE/REQUIRED]: ...................................................................................18 LANGUAGE [STANDARD/REQUIRED]: ........................................................................................................18 PRODUCT VERSION [CONFIGURABLE/REQUIRED]: ....................................................................................18 CUSTOM FIELD [CONFIGURABLE/REQUIRED OR OPTIONAL]: ....................................................................18 CUSTOM LIST [CONFIGURABLE/REQUIRED OR OPTIONAL]: .......................................................................18 SEND BUG TO... [STANDARD/REQUIRED]: ..................................................................................................19 SUBMIT ......................................................................................................................................................19 ADD ATTACHMENTS ..................................................................................................................................20

ATTACHMENT MANAGER ....................................................................................................................21

ADDING AN ATTACHMENT: .......................................................................................................................21 DOWNLOADING AN ATTACHMENT: ...........................................................................................................22 DELETING AN ATTACHMENT: ....................................................................................................................22

SCREENSHOTS .........................................................................................................................................23

HOW TO TAKE A SCREENSHOT ...................................................................................................................23

YOUR ACTION LIST (VIEWING THE LIST OF BUGS AND QUERIES ASSIGNED TO YOU) ..24

DEFAULT ORDER OF THE BUGS IN YOU ACTION LIST .................................................................................25

ADVANCED SEARCH ...............................................................................................................................26

TEXT SEARCH [STANDARD].......................................................................................................................26 DATE CREATED [STANDARD] ....................................................................................................................26 CREATED BY [STANDARD] ........................................................................................................................26 LAST CHANGED [STANDARD] ....................................................................................................................26 LAST CHANGED BY [STANDARD] ..............................................................................................................26 STATUS [STANDARD] ................................................................................................................................27 FIXED IN <ITD/EXCEL/ETC.> [CONFIGURABLE] ........................................................................................27 LANGUAGE [STANDARD] ...........................................................................................................................27 TYPE [CONFIGURABLE] .............................................................................................................................27 SEVERITY [CONFIGURABLE] ......................................................................................................................27 CUSTOM LIST [CONFIGURABLE]: ...............................................................................................................27 SOFTWARE [CONFIGURABLE] ....................................................................................................................27 HARDWARE [CONFIGURABLE] ...................................................................................................................27 SERVER SOFTWARE [CONFIGURABLE] .......................................................................................................27 SERVER HARDWARE [CONFIGURABLE] .....................................................................................................27 PRODUCT VERSION [CONFIGURABLE] ........................................................................................................28 VERIFIED FIXED IN VERSION [CONFIGURABLE] .........................................................................................28 ROOT CAUSE [CONFIGURABLE] .................................................................................................................28 TEST PLAN NAME [CONFIGURABLE] .........................................................................................................28 BUG ID [STANDARD] .................................................................................................................................28 ACTIONED WITH GROUP [STANDARD] .......................................................................................................28 LIST ONLY BUGS WITH AN EXTERNAL REFERENCE [CONFIGURABLE] ........................................................28 PREVIOUSLY EXPORTED [STANDARD] .......................................................................................................28 SHOW ALL BUGS INCLUDING CLOSED BUGS [STANDARD] .........................................................................28 HIGH ACTIVITY BUGS [STANDARD] ...........................................................................................................29

VIEWING AND EDITING BUGS YOU HAVE PREVIOUSLY RAISED OR CHANGED ...............30

VIEWING AND UPDATING BUG AND QUERY INFORMATION ...................................................31

WITH THE EXCEPTION OF THE STATUS FIELD, PLEASE SEE THE CREATING BUGS SECTION FOR

INFORMATION ABOUT ALL OF THE FIELDS AVAILABLE. ..............................................................................31 NEXT AND PREVIOUS BUG: .......................................................................................................................31 SIMILAR BUGS: ..........................................................................................................................................31 COMMENT [STANDARD/OPTIONAL]: .........................................................................................................31

Preset Comments: ................................................................................................................................31 Last 5 Comments ..................................................................................................................................32

VERIFIED FIXED IN VERSION: ....................................................................................................................32 STATUS:.....................................................................................................................................................32 RESOLUTION [CONFIGURABLE/OPTIONAL]: ..............................................................................................32 ROOT CAUSE [CONFIGURABLE/OPTIONAL/REQUIRED]: ............................................................................33 ATTACHMENTS ..........................................................................................................................................33 WATCH THIS BUG ......................................................................................................................................33 DELETING A BUG .......................................................................................................................................34 EMAIL / LYNC COMMUNICATION ...............................................................................................................34

APPENDIX A - DIFFERENCES BETWEEN THE EXCEL VERSION AND THE ONLINE

VERSION .....................................................................................................................................................35

IF YOU ARE AN ENGINEER:.........................................................................................................................35 IF YOU ARE A TESTER REGRESSING BUGS ..................................................................................................35

APPENDIX B - DIFFERENCES BETWEEN BUG DATABASE AND IEEE 829 INCIDENT

REPORT ......................................................................................................................................................36

Getting Started

System Requirements:

The Online Bug’s Database was designed to be used with either Microsoft Internet

Explorer or Google Chrome on the Windows platform with appropriate languages packs

installed. You may use other browsers or platforms but please check with your SDL

Contact first.

If buttons do not work make sure your security settings are not too

restrictive - Tools > Internet Options > Security.

In IE the default is Medium-High. If you have a custom setting,

make sure Scripting > Active scripting is Enabled

Platform Browser Known issues

WinXP

Vista

Windows 7

IE6.0

IE7.0

IE8.0

None. Note: These browsers are considered old and have not

been re-tested recently.

Vista

Windows 7

Windows 8

IE9.0

IE10.0

IE11.0

None. Note for advanced users - you may experience layout

issues if you manually change the Browser Support

settings in the developer console.

Any FireFox Attachment Previewing has been disabled

because Firefox asks to download the image

rather than displaying.

Apple Mac Safari None.

Any Google Chrome None.

Windows Mobile IE Locale character support only.

BlackBerry Bold,

Javelin or

equivalent.

BlackBerry

Browser

None.

Apple iTouch

Safari Locale character support only.

Apple iPad Safari Use two fingers to scroll within text boxes.

Cannot upload attachments.

Accessing the Database:

Enter your User Name and Password into the login page and press the Submit button.

Note: You will have been sent a User Name and Password either from your SDL Contact.

If you have any problems logging on to the Database you should contact your SDL

Contact in the first instance.

Note: Passwords are case sensitive and must be input exactly as they have been sent to

you. It is important that you retain your User Name and Password in a safe place.

IMPORTANT: Please request your own individual User Name and Password as sharing

login details at the same time may cause conflicts.

Selecting the Account:

Your User Name will have specific SDL

Accounts assigned to it. In this context

each Account is a specific SDL Client.

After the Account name is the number of

bugs assigned to Your Group for each

Account e.g.

Demo – (17 Bugs)

This is based on the total of all of the

Open and Fixed bugs combined for all

Projects and Groups in that Account which you have access to. For example if Demo

Project A has 5 Open bugs and Demo Project B has 12 Open bugs then the total bugs for

the Demo Account will be 17 bugs.

Select your Account from the drop down and click Submit.

NB: Where this doc uses Bug, the system could say Query or Request depending on the

setup. All terms are interchangeable.

Selecting your Role and Project:

Each selected Account will have

associated Projects. For example:

Software, Help and Website etc.

You should also select from your assigned

Groups. In this context each Group is an

assigned role in the Database. Typically

you will only be a member of one Group

i.e. Linguistic Tester or Engineer.

Depending on your rights (Client / Project

Manager) you will be able to see both

Active and Disabled Projects. Active Projects are denoted by a ►.

If you re-assign a bug in a Disabled Project it will then become Active again. Because

Disabled Projects are typically considered delivered and closed by SDL if you are a

Client of SDL please contact your Project Manager when or if further work is needed.

After the Project name is the number of bugs assigned to you for each project e.g.

Help – (12 Bugs)

This is based on the total of all of the Open and Fixed bugs combined for all Groups

which you have access to. For example if you are a member of both Engineering and

Graphics and Engineering has 5 Open bugs and Graphics has 7 Open bugs then the total

bugs shown for the Help will be 12 bugs.

Select both a Project and Group from the lists and click Submit.

NB: Direct links to the Main Menu are possible which will bypass these two settings

screens. You still need to enter your User Name and Password though. A direct link can

be found at the bottom of the Main Menu.

Typical Process Flow

Linguistic Tester

Creates Bugs

Stored on the

SDL Online Database

Sent to the DTP

Department to be Fixed

Bugs exchanged

between departments Progress stored on the

SDL Online Database

Sent to the Engineering

Department to be Fixed

Unable to fix the bug with the

assets we have then the

bug is then Actioned with

the Client

Linguistic Tester regresses Fixed

Bugs or provides further information

to enable bug to be identified.

Bugs verified as Fixed

are Closed.

Open and Fixed Bugs are send back to SDL

to be further Fixed or Regressed.

Bugs which can be

ignored are Closed

Bugs not Fixed correctly or require further information

are sent back to be corrected or Fixed.

Start Testing

Bug Fixing

Client

Regression

Main Menu

The Main Menu will change depending on

your selected Group. However, for the

purposes of testing your Menu options

would be as follows:

NB: Where this doc uses Bug, the system

could say Query or Request depending on

the setup. All terms are interchangeable.

Add new Bugs takes you to the section for

adding bugs or queries to the database, as

explained later in this guide.

The link x Bugs added personally takes you to the section showing bugs or queries you

have personally raised yourself. If you have made a mistake or otherwise wish to change

your bug you can use this to recall the bug. Once you have updated the bug you should

re-assign the bug back to the relevant group.

View your Action List takes you to the section showing which bugs have been assigned

to you. These are the bugs which will need either fixing, regressing or responding to. This

will be explained later in this guide.

The x Bugs requiring attention by your group will not include Closed bugs as these

are considered complete.

The link x Bugs last updated by you lists all of the bugs you have recently changed.

This is useful if you are regressing or bug fixing someone else’s bugs and you

accidentally submitted the bug with incorrect information. Using this list you can recall

the bug, make you changes and re-submit the bug.

Select a different Account allows you to log out of the current Account and select a

different one.

Select a different Project/Group allows you to log out of the current Project and select a

new one. You can also select a new Group to change your role in the database.

Logout allows users to log out of the database. It is important that you always Logout of

the Database!

Watched Bugs takes you to the section showing bugs or query you are currently

watching.

At the bottom of the Main Menu is a direct link to this page using all of the Account and

Group settings currently chosen. You can copy and paste this link in your browser and set

as a favourite if you wish. You will still need to enter your User Name and Password, but

once done you will skip straight to the Main Menu bypassing the Account / Group setting

pages.

Creating Bugs and Queries

(The information and instructions below are meant only as a guide to how to use the

database. Most options are customisable and configurable to the Account or Project you

will be working on. Where this doc uses Bug, the system could say Query or Request

depending on the setup. All terms are interchangeable.)

Select Add new Bugs from the main menu.

The Add New Bug screen is made up of

multiple fields. In all cases, items marked

with a * need to be completed fully.

When used as a Bug Database the system

is designed to guide you through the

process of creating a complete and

consistent bug report. Providing all of the

information required to enable the bugs to

be fixed during the first round of bug

fixing. It is important to note that while

skipping some information may save time

initially, it can cause other departments extra work trying to solve. For time critical

projects this may prevent the bug from even being fixed.

It is important to present bugs in a constructive non-personal way, working together to

deliver a quality product.

Copying a previous Bug:

Your last 10 bugs and queries entered will be listed in this drop down list. If you have a

bug or query you need to repeat for another location select it from the list and the details

will be copied to this bug. You may still edit the bug before submitting it.

Key for the header information below:

[Standard] This field appears in all Bug Report Templates.

[Configurable] This field can be added or removed from a template when the Project

was setup. Therefore you may not have this field to fill in.

[Required] You have to fill in this field to be able to Submit the bug.

[Optional] Please fill in this field if it applies to your bug.

Type [Configurable/Required]:

(Depending on how the Project was setup you might not have this option to change.)

Please select one of the options depending on the type of bug you wish to raise.

Formatting / Layout Select this if you are reporting one of the following:

An issue with text alignment.

Possible font issues.

Truncated text.

Overlapping text.

Functional Select this if you are reporting one of the following:

Software crashes.

Missing buttons or icons.

Buttons, Menus or Hyperlinks which do not do anything.

Linguistic Select this if you are reporting one of the following:

Linguistic issues (i.e. translation change requests).

Severity [Configurable/Required]:

(Depending on how the Project was setup you might not have this option to change and

the options shown below are just the default options and are configurable.)

Please use this field to show bug preference. For example, is it critical that the bug should

be fixed or is it purely preferential change?

Enhancement Request Select this to request an additional feature not currently present

in the software.

Preferential Fix Select this if the Bug is purely a preferential change.

Should Fix Select this if the Bug should be fixed.

Must Fix Select this if this new Bug will cause the Project to be unusable

by the target audience.

Crash / Error Select this if you are reporting one of the following:

The software has crashed and/or or generated an error.

A website or HTML page has produced a Javascript

error or missing page.

A Hyperlink is broken on a Website / HTML page /

Help system.

Note: Typically all bugs raised would be fixed. However, there may be some occasions

where time will only allow for the major bugs to be fixed. Therefore, while it is not

critical that this is filled in correctly, it could prove very helpful when schedules are tight.

URL [Configurable/Required]:


Please use this field to enter the URL of the page you are looking at.

File Name [Configurable/Required]:


Please use this field to enter the File Name of the document you are looking at.

Page Number [Configurable/Optional]:


Please use this field to enter the page number of the document you are looking at.

Description [Standard/Required]:

Please describe the bug you have found. It is best to describe what is wrong here than in

the screenshot itself. This would be both quicker to do and quicker to read.

You can keep the description short so long as it is concise enough for someone else to

know what you mean and yet still unique e.g. “Incorrect Translation in the Options

dialog”. There is no need to write “Please replace X with Y” as you should enter that into

the Incorrect / Correct fields.

Tip: It is important to bear in mind however that the Description is all you will see in the

list of bugs. It is more useful to have some unique information in this field like:

Incorrect Translation - Wheel

Incorrect Translation in the Switchboard.

Next button is truncated in the Installer

If you just use the same Description for all bugs i.e. “Linguistic Issue” then it will be

harder to find a specific bug amongst all of the other bugs described as “Linguistic Issue”

Note: It is important to always raise bugs separately rather than to put multiple issues into

the same bug.

Functional Issues These should always be raised separately.

Untranslated Items It is preferable to raise these separately, but where multiple

issues appear on the same window it is more practical to raise

them together. Do not mix these and issues with translated items

into the same bug.

Linguistic Issues and

Incorrect Text

Please always raise these issues separately.

Character Corruption Where practical, please raise these bugs separately along with a

screenshot. However, if the corruption is across the entire

software or a section of the software then one bug will be

sufficient.

As with all testing, if you find a lot of the same type of bugs, you should discuss the

situation with your Project Manager as soon as possible. It may be an issue that can be

resolved quickly that will make testing go much quicker for you.

Test Plan File Name [Configurable/Required]:


Please enter the file name of the test plan you where testing from. This would typically be

a Word Doc or Excel Sheet for example. Do not enter the path, just the file name.

Test Case Step [Configurable/Required]:


Please enter the test case id, number or name from the test plan where you identified the

bug. For example:

2.4.54

Section 5 Step 8

Steps To Reproduce [Configurable/Required]:


Please enter as much information as you can with regard the location of the bug.

This is so both the people fixing the bug (Engineers / DTP / Client) can find it to fix,

verify it is fixed and it will help you find the bug again at the regression stage.

Note: Not everyone will have access to the same information that you have. The person

fixing the bug may not have access to see the Software, Device, or Website that you are

testing on, or be as familiar with the software as you are.

Source Text [Configurable/Required or Optional]:

(Depending on how the Project was setup you might not have this option to change.

Required if field has a * next to it)

Please write the source text (i.e. English) equivalent of the translated text you wish to

correct in the Incorrect / Correct fields.

Note: Please do not write comments or descriptions in this field! Please treat them as you

would segments in an ITD. The Bug Database performs analysis on the text you write in

here which will not work if you enter more than just the source text.

Tip: The Characters used field shows you how long the text is you are entering. You

can use this to help calculate shorter translations if asked to provide this to fix truncated

text.

If available, you can use the TM Lookup button to search an offline TM for the Source

Text. The TM is an offline version and may not contain all translations, it is purely

provided as a convenience. You can also highlight text on the page and perform a lookup

on that.

Incorrect Text and Correct Text [Standard/Required or Optional]:


Required if field has a * next to it)

Please write the incorrect text you want to replace and the text you want to replace it with.

The more you copy type in here from the software the easier the text is to find.

Sometimes the text contains hotkey characters or other placeholders which can make text

hard to find. Therefore a complete sentence is better than one word where possible.

Tip: It is important not to enter this information onto the screenshot as the Engineers will

need to copy the text. Please do not assume other people can copy type and read all

character sets.

Note: Typically the Incorrect text will be replaced directly with the Correct text in the

files so make sure the content matches, even down to the punctuation.

Note: Please do not write comments or descriptions in this field! Please treat them as you

would segments in an ITD. The Bug Database performs analysis on the text you write in

here which will not work if you enter more than just the Incorrect and Correct text.

Good Examples:

Account Management

Account Man-

agment

Page breaks and section breaks

Bad Examples:

“Account Management” should be translated.

(Write this in the Description and just enter Account Management in the Incorrect

/ Correct text fields).

Screenshot is in English

(Write this in the Description and either copy type the text from the Screenshot

into this field or just leave the fields blank).

Screenshot should be translated

(Write this in the Description and either copy type the text from the Screenshot

into this field or just leave the fields blank).

Account Management is truncated

(Write this in the Description and copy type the text as it appears, including the

truncation into the Incorrect Text field and a shortening, if possible, into the

Correct Text field).

Same as Source Text

(If the text is the same as the source, please copy it into the Incorrect Text field.

By writing “Same as Souce Text” or equivalent prevents the database accurately

identifying common bugs.)

Tip: The Characters used field shows you how long the text is you are entering. You

can use this to help calculate shorter translations if asked to provide this to fix truncated

text.

If available, you can use the TM Lookup button to search an offline TM for the

Incorrect Text or the Correct Text. The TM is an offline version and may not contain

all translations, it is purely provided as a convenience. You can also highlight text on the

page and perform a lookup on that.

Fixed in <ITD/Excel/etc.> [Configurable/Required]


During your handoff you will have been told if you should also update another file with

any corrected translations as you test. This could be an ITD or a separate Excel Sheet

with translations in. This will be reflected in the Bug Report options you have.

Tip: If you do not see this option it means the bugs you raise will be fixed into the final

files by Engineering and not from the ITD. Please do not make fixes into your ITDs

without documenting them on the assumption the ITD will be re-used.

For each bug you raise you need to say if you have fixed the bug in the file(s) you have

been sent. This will allow Engineering to skip these bugs as it should be Fixed once the

files have been re-integrated. Engineering can then process the remaining bugs in the

normal way. You still need to report the bug so you can regress the bug later on.

Tip: More often than not, formatting issues can be fixed in the ITD by double checking

the format painting and making sure the colour matches.

Note: You should still always update your TM with any Linguistic Changes.

External Reference [Configurable/Optional]:


Please use this field to reference another bug reporting system. For example, occasionally

we have to incorporate bugs from the client and these are numbered or contain a unique

reference i.e. SDR1234. If you enter that here we can better track these types of bugs as

they go through the different stages.

Note: Please do not use it to reference another bug in this bug report e.g. Same as Bug 6.

Please also do not use this to refer to a screenshot.

Root Cause [Configurable/Optional]:


You should use this field to identify what caused the bug. This field is fully customisable

when the project is setup, but typical examples would be:

Strings not in resources This bug occurred because the text was hardcoded.

3rd

party application This bug occurs in a application which is not owned by the

Client, i.e. pulled from the operating system.

String concatenation This bug occurred because two, or more, strings where

joined together during runtime.

Mistranslation The string was not translated correctly when seen in

context.

String length exceeded This string truncation occurred because the length

restriction could not be ascertained during translation i.e.

display limitations; dynamic text in a dialog; static

component (no control over co-ordinates).

Note: If you do not know the cause, leave this option blank.

Due Date [Configurable/Required]:


This allows you to specify when the bug needs to be fixed for, or when a query needs to

be answered by. Defaults to the next day, you should change accordingly.

Source Language [Configurable/Required]:


This allows you to specify the source language of the bug for projects with multiple

source languages.

Language [Standard/Required]:

(After you have filled this field in once the information will be duplicated into future bugs,

you can change this at any time.)

You must select the language of the bug you are reporting.

Tip: If you need to raise the same bug against multiple languages at the same time you

can Ctrl+Click the required Languages.

Product Version [Configurable/Required]:


After you have filled this field in once the information will be duplicated into future bugs,


Please select the version of the product you are testing.

Custom Field [Configurable/Required or Optional]:


There is the facility for the Database to be setup with a custom text box for project

specific use.

Custom List [Configurable/Required or Optional]:


There is the facility for the Database to be setup with a custom drop down box with pre-

set selectable options for project specific use.

Send bug to... [Standard/Required]:

(After you have filled this field in once the information will be duplicated into future bugs,


Please select an appropriate group to send your bug to. The Groups you can send (or

Action) a bug with will depend on which Group you have selected when you logged in.

These are some typical scenarios:

Linguistic Tester Linguistic Tester (i.e. yourself)

Engineering (i.e. Open bugs)

DTP (i.e. Open bugs)

Engineering Engineering (i.e. yourself)

DTP (i.e. Open Bugs which do not apply to

Engineering bug are for DTP)

Client (i.e. Open bugs we cannot fix here)

Linguistic Tester (i.e. Fixed bugs ready for

regression)

Client Client (i.e. yourself)

Engineering

DTP

Linguistic Tester (i.e. Fixed bugs ready for

regression)

Submit

To create your bug, click the Submit button. You may receive automated requests for

further information, please provide where appropriate. Please do not ignore these; they

are there to help Engineers / DTP / Client to fix.

Note for Google Chrome users: Chrome will give you an option to ignore future

messages from this page. Please do not tick the box as you will not be able to submit the

bug.

Add Attachments

On the next page you will be asked if you

wish to attach any files (Screenshots /

Logfiles / etc.)

Note: Adding Screenshots is an important

requirement when creating bugs.

Attachments are covered later in this guide.

IMPORTANT: Do not use the Back button to return to the previous page as this may

create duplicate bugs. Always make sure to press Submit on this page to compete adding

the bug. If something goes wrong while on this page you can find your bug in your

Action List ready to be re-assigned manually.

Attachment Manager

When you click on the Attachment button

you will either open up the Attachment

Manager or go straight to the Add

Attachment page. You use this feature to

add screenshots or other useful files to

your bug.

Note: When adding bugs you will now go

straight to the Add Attachment page.

Tip: You can add more than one attachment per bug but they must be uploaded

separately.

Adding an Attachment:

Click on the Add button to add an

attachment. Click on the Browse button

and search for the attachment (screenshot

or file) you want to upload.

You can enter a short description for the

file you want to upload and this will be

displayed in the Attachment Manager. If

you do not add a description, the name of

the file will be used instead.

Note: Due to a limitation of the file uploader, accented characters in the filename or

description are not allowed. Please only use ASCII characters [A-Z; 0-9;etc.]

Click on the Upload button and your screenshot will be uploaded.

Note: Please do not try to select more than one file and do not zip multiple screenshots

and upload those.

The Account may have been setup to

block large screenshots and attachments. If

you receive an error that your screenshot is

too large please make sure to save it as a

JPG (and not a BMP) or to crop the image.

Downloading an Attachment:

In the Attachment Manager, select the attachment (screenshot or file) that you wish to

download and click on the Download button. You will be prompted to save your file

using the standard Browser File > SaveAs... dialog.

Deleting an Attachment:

In the Attachment Manager, select the attachment (screenshot or file) that you wish to

delete and click on the Delete button.

Screenshots

There are many ways to take a screenshot of the Software, Website or Help system you

are testing.

Tip: Screenshots in JPG format are preferable as the filesize is much smaller than a BMP

for the same size screen. This will save you time when uploading the screenshots to the

Online Database using the Attachment Manager.

How to take a Screenshot

To capture a screenshot, make sure the Window

or Dialog is active and press Alt+Print Scrn.

Open Microsoft Paint and make sure you resize

the previous images to be really small before

pasting in the screenshot.

Tip: Versions of Windows Vista can come with

its own screenshot taking program called

“Snipping Tool”. Feel free to use that as well!

Highlight the area where the bug is with a red box by clicking on

the box tool, ensuring red is selected in the colour palette and

drag selecting around the area of the bug. You do not need to add

text to the image as that should be in the bug report.

Save the file out using a meaningful filename or just name it with

an incremental number.

In the File > Save dialog of

MS Paint make sure to

save the file as a jpg.

Add the screenshot to the Bug using the Attachment Manager.

Note: Never rename a Windows Bitmap image (.bmp) to a .jpg.

Note: Please try not to test or take screenshots on too high a resolution. It is not normal

for example, that a help system would be viewed full screen on a 1280 by 1024 desktop.

A screenshot of a Dialog or Window is always preferable to your entire desktop.

Your Action List (viewing the list of bugs and queries assigned to you)



will be working on.)

From the Main Menu select View your

Action List.

Your Action List is based on all of the

bugs or queries assigned to your Group

(rather than you personally).

Note: For Linguistic Testers, you should always filter the list on your own language

before answering bugs.

The list is ordered from the first bug to the last bug but you can reorder your list by the

following:

Click on:

The date the bug was last changed. Last Changed

The current bug Status i.e. Open / Fixed. Status

The language the bugs were raised against. Language

Who logged the bug. The drop down menu and select

Logged By

Who last updated the bug. The drop down menu and select Last

Changed By

Severity of the bug (when severity is used) The drop down menu and select

Severity

Bug ID (when File Name, URL or Test Case is

used).

The drop down menu and select Bug

ID

You can filter your list by the following:

Click on:

A specific date the bug was last changed. ...the date you wish to filter in.

A specific bug status i.e. Open / Fixed ...the status you wish to filer on.

A specific language ...the language you wish to filter on.

A specific person ...the person you wish to filter on.

A specific URL ...the URL you wish to filter on.

A specific file name ...the File Name you wish to filter on.

A specific version ...the List only Version dropdown menu

and select the appropriate version

number you wish to filter on.

Note: There is the facility for the Bug Database

to be setup with a custom text box for project

specific use. If this is the case then you will be

...the custom field.

able to filter on that as well.

Tip: Click on the item you have filtered with again to remove that from the filter.

To view the details of the bug, click on the View Details link.

If you need to filter on more options you can use the Advanced Search.

There is an imposed limit on the number of bugs which can be shown at any given time

in one page. You can still view them page by page or use the Advanced Search to filter

them down.

If an External Reference number is available this will be displayed just below the View

Details link.

Default order of the bugs in you Action List

Depending on the Project Options, the bugs may not appear in the order they were

created but grouped in the following order.

1. URL - If there is URL field then bugs will be grouped first into the pages the bugs

where raised against.

2. File Name - If there is File Name field then bugs will be grouped into the files the

bugs where raised against.

3. Test Plan Name / Case - If there is Test Plan field then bugs will be grouped first

into the test plan and then the test case the bugs where raised against.

Advanced Search




You can use this option to search based on multiple criteria.

Text Search [Standard]

Use this field if you need to search within

any of the textboxes.

This will search within the following bug

fields:

URL

File Name

Description

Test Plan Name*

Test Case Step

Steps to Reproduce

Source Text

Incorrect Text

Correct Text

Comment

External Reference

Resolution

Custom text fields

* You can also search and filter on Test Plan Names separately below.

Date Created [Standard]

You can search for bugs created before, on or after the date you select.

Created By [Standard]

You can search for bugs created by a particular user.

Last Changed [Standard]

You can search for bugs changed or updated before, on, or after the specified date.

Tip: As a shortcut to searching for all bugs changed on a specified date just click on the

date shown in your Action List.

Last Changed By [Standard]

You can search for bugs last changed by a particular user.

Status [Standard]

You can search for bugs with a specific status.

The bottom three options allow for group filtering of the Status.

Open Bugs group - Shows all Open, Awaiting Feedback and Suspended /

Deferred bugs

Fixed Bugs group - Shows all Fixed - Ready for Regression and Closed -

Verified as Fixed bugs.

Closed/Cancelled Bugs group - Shows all Closed -Verified as Fixed, Not a

Bug - Closed and Duplicate bugs

Tip: As a shortcut to searching for all bugs with a particular Status just click on a Status

shown in your Action List.

Fixed in <ITD/Excel/etc.> [Configurable]

You can search for bugs which have or have not been fixed directly in the assets.

Language [Standard]

You can search for bugs reported for a specific language.

Tip: As a shortcut to searching for all bugs reported for a specified language just click on

the language shown in your Action List.

Type [Configurable]

You can search for bugs of a particular type

Severity [Configurable]

You can search for bugs with a specific severity.

Custom List [Configurable]:

There is the facility for the Database to be setup with a custom drop down box with pre-

set selectable options for project specific use. You can search for bugs with those options

here.

Software [Configurable]

Search for bugs raised on a specific Software platform.

Hardware [Configurable]

Search for bugs raised on a specific Hardware platform.

Server Software [Configurable]

Search for bugs raised with a specific Software server platform.

Server Hardware [Configurable]

Search for bugs raised on a specific Hardware server platform.

Product version [Configurable]

Search for bugs raised against a specific version of the Software / Help / Documentation.

Tip: As a shortcut to searching for all bugs raised against a specific version use the

Version dropdown menu at the top of your Action List.

Verified Fixed in version [Configurable]

Search for bugs verified as fixed for a specific version of the Software / Help /

Documentation.

Tip: If you find a particular search useful you save it in your browser favourites. Once

logged into a Project you can then use this saved search in the future.

Root Cause [Configurable]

Search for bugs with either identified or unidentified root causes.

Test Plan Name [Configurable]

Search for bugs raised against a specific test plan.

Bug ID [Standard]

Search for a particular Bug ID.

Tip: You can search on multiple IDs by separating them with a semicolon - ; or comma - ,

Actioned with Group [Standard]

Search for bugs raised with the specified group, e.g. all bugs with Engineering.

List only bugs with an External Reference [Configurable]

Search for bugs with a reference number to another bug database system. You can list

either:

Yes - Only list bugs with a reference to another bug database system.

No - Only list bugs which need a reference to another bug database system.

All - List all bugs as normal.

Previously Exported [Standard]

(This is only available if you have the Export feature)

You can filter on bugs which have or have not been exported yet. To reset which bugs

have been exported you can use the Reset "Exported Bug" flag option under

Copy/Change Bugs.

Show all bugs including Closed bugs [Standard]

By default all Closed bugs (i.e. Not a Bug, Duplicate, Closed Verified as Fixed) are

hidden from your action list as they are considered complete. They would normally only

appear if you specifically search for a Bug ID or a relevant closed Status. For

convenience you can check this option if you wish to see all bugs at the same time.

High activity Bugs [Standard]

This option allows you to filter bugs which have been actioned repeatedly between

Groups. Low would be considered bugs which were raised and simply fixed. Medium

would be bugs which were returned for additional information and then fixed. High

would be bugs repeatedly passed around.

Note: This is based on a typical workflow, the more Groups you have the more times you

would have to action a bug between Groups.

Viewing and Editing bugs you have previously raised or changed




From the Main Menu select X Bugs added personally (it is just below the Add new bugs

option). Or if you have just edited someone else’s bug you can use x Bugs last updated

by you.

Your created Bugs list is based on all of the bugs you have personally raised previously.

Your last changed Bugs list is based on all of the bugs you have just edited. Once

someone else has Actioned the bug afterwards you can no longer recall it.

Tip: Please see Your Action List for information on how to filter or order your list.

What you can do will depend on your normal rights, the current status of the bug and who

it is currently assigned to:

You where the last

person to edit the

bug.

If you click on the View Details link you

can view a read only copy of the bug.

If you need to edit a bug you have

previously created or edited you can

click on the Recall Bug link.

This will then re-assign the bug back to

your group and enable you to edit it.

Bug has been

edited or Actioned

by someone else.

If you click on the View Details link you

can view a read only copy of the bug.

You cannot Recall a bug which has been

previously worked on. This is to

maintain the integrity of the Bug

Reporting process.

If it is important you can either raise a

new bug or contact you Project Manager.

Bug is any Status If there is no Recall Bug link then this

bug is assigned to your Group and you

can edit this bug as normal.

Viewing and Updating Bug and Query Information

The information and instructions below are meant only as a guide to how to use the


will be working on.

To view the bug information click on the

View Details link in your Action List.

With the exception of the Status field,

please see the Creating Bugs section for

information about all of the fields

available.

Tip: Providing you have rights to change

the details of a bug or query you can edit

all of the fields.

Next and Previous Bug:

By clicking on the << and >> buttons you can skip onto the next or previous bug in your

Action List.

Similar Bugs:

When you view a bug the system will also list similar bugs based on matching the

Incorrect Text. This uses the same rules as the Automated Comments that are flagged on

matching bugs but is also forward looking. This way you can tell if any fix should be

applied elsewhere.

Comment [Standard/Optional]:

Please use this field to add any other information not covered by the fields/options you

have. Add your comment into the bottom box and click on the Add Comment button.

Tip: You do not have to add a comment for every issue.

Preset Comments:

Because we use certain popular Comments in our correspondence you can select them

from the drop down list below the Comments field. You can still edit the comment before

submitting.

Last 5 Comments

You can also reuse your last 5 Comments from the drop down list below the Comments

field. You can still edit the comment before submitting.

Verified Fixed in Version:

You only need to change this option if you are regressing fixed bugs... see below.

Status:

All new bugs are given the default status of Open.

If you have taken any action with the bug you need update the Status correctly.

You should also make sure you send the bug to an appropriate group.

Failure to assign a bug correctly or set the correct status can mean the bug will not be

handled correctly.

See the following table for more information.

Different Statuses and their expected meanings:

Open The bug is currently Open and needs investigating or fixing.

Fixed – Ready for

Regression

The bug has been fixed and the fix needs to be regressed.

Once regressed the bug should either be Closed – Verified

Fixed or changed to Open.

Not a Bug - Closed After investigation this bug was not actually a bug and should

be ignored.

Awaiting Feedback The bug needs further information to be fixed.

Suspended / Deferred This bug should be temporarily ignored in the current version.

Duplicate This bug is a duplicate and the earlier bug takes priority.

Closed – Verified Fixed The bug has been completed.

Important: If the bug was not fixed correctly and the latest screenshot does not correctly

reflect the current issue please add a new updated screenshot - see Attachments below.

Note: If you receive a bug with a Status of Awaiting Feedback you must provide a

Comment before returning the bug. A bug with a Status of Awaiting Feedback means that

further information is required to fix or process the bug. Please see the Comment for

instructions and add further information to the appropriate fields or include any

attachments as requested.

Also please note that these options are configurable but above are the default settings.

Resolution [Configurable/Optional]:


If you mark a bug as either Fixed – Ready for Regression or Closed – Verified Fixed

then you need to enter a Resolution into this field. Use this field to describe how you

fixed the bug and which file you fixed.

Root Cause [Configurable/Optional/Required]:


You should use this field to identify what caused the bug (see Creating bugs for examples)

Note: If you mark a bug as either Fixed – Ready for Regression or Closed – Verified

Fixed then you need to select the Root Cause.

Attachments

Any screenshots which have been uploaded will be displayed on the page. If they are

large you may have to scroll around the Preview Box.

Any recognised file attachments will be displayed with an icon, click on the

icon to download the file. Other attachments can be downloaded by clicking on

the Attachments button. The Attachment button opens the Attachment

Manager where you can add, download or delete attachments at any time. See

Attachment Manager for more information.

Note: If you cannot use the Attachment Manager you may not have the correct rights

assigned to your Group.

Tip: You do not have to click on the Update and Submit bug button for any changes of

the Attachments to be saved, that information is saved in the Attachment Manager. You

can skip >> onto the next bug if you have to repeat the process.

Watch this bug

If you have found a bug which is critical to a build or of special interest you can watch it.

Tick the checkbox to watch this bug - the number of bugs you are watching will appear in

the Main Menu screen.

Tip: You do not have to click on the Update and Submit bug button for this setting to

be remembered. You can skip >> onto the next bug if you want to watch another bug.

To view your watched bugs you should click on the link on the Main Menu and the use

the list as normal.

Deleting a bug

(Depending on how the Project was setup you might not have this option.)

Clicking on the X will delete the bug from the Database. You should use Not a Bug as a

Status for bugs which are not required.

Email / Lync communication

(Depending on how the Project was setup you might not have this option.)

Click on the email or Lync icon to contact the person who Raised, Fixed or Last Changed

the bugs.

Note: Lync functionality requires access to the SDL Outlook address book.

Appendix A - Differences between the Excel version and the Online

version

If you are an Engineer:

What you would

have pressed in

the Excel Sheet

Send bug to… Status.

You have been able to

incorporate the requested

change into the files.

Fixed Linguistic Tester Fixed – Ready

for Regression

You could not make the

change because you do not

have the assets etc.

Raise with the

client

Client or Client

Holding Stage

(you will only

have one)

Open

This issue is for a

screenshot.

Send to DTP Graphics Open

Not a bug <Any> Not a bug -

Closed

You could not understand

the issue.

Request more

information from

the tester

Linguistic Tester Awaiting

Feedback

If you are a Tester regressing Bugs

What you would

have pressed in

the Excel Sheet

Send bug to… Status.

You can see the bug has

been fixed correctly.

Ok - Close Bug <Any> Closed - Verified

as Fixed

The bug has not fixed or

fixed incorrectly.

Return to

Engineering

Engineering Open

You have been asked for,

and can provide, more

information for this Bug.

Return to

Engineering

Engineering Open

Appendix B - Differences between Bug Database and IEEE 829

Incident Report

Section

No.

Heading Details Bug Database Equivalent

1 Test incident

report identifier.

The unique identifier

assigned to this test

incident report.

Bug ID - automatically

assigned.

2 Summary Summary of the incident,

detailing where expected

and actual results differ.

Description field.

3 Incident

description

A detailed description of

the incident, including:

Inputs Steps to reproduce field.

Expected results If linguistic, this should be the

Correct Text field.

If functional this should be part

of the Description.

Actual results If linguistic, this should be the

Incorrect Text field.

If functional this should be part

of the Description.

Anomalies Description field.

Date and time Automatically recorded.

Procedure step Steps to reproduce field.

Environment Choose one or more of the

Software/Hardware/Server

fields

Attempts to repeat There is no comparable

reproducibility field.

Testers’ comments Tester’s initial comments

should go into the Description.

Subsequent comment should

go into the Comments field.

Observers’ comments Comments field.

Should also include any

information regarding

possible causes and

solutions.

Tester’s initial comments




4 Impact What impact the incident

has on progress.

Tester’s initial comments




Documents

Using the SDL Online Bug Databaseshbugfix.sheffield.sdl.com/userguides/OBR_UserGuide.pdf · SJones 24/04/2010 3.1 Revision based on BCS text and IEEE standardisation. SJones 31/05/2010