You are on page 1of 35

qTrace is a simple, yet powerful defect capture and reporting tool.

qTrace tracks a users interaction with an application and generates defect records as a combination of screenshots and action steps. Users can edit trace files, add annotations, and then share the final result, either by submitting directly to a defect management tool or publishing to a Word, PDF or JPG document. You can report defects with 3 simple steps:

Following are quick and easy instruction for using qTrace: How to Capture Defect Records How to Edit Defect Records How to Share Defect Records How to Configure qTrace

Copyright 2011 QASymphony LLC. All rights reserved.

Record Toolbar Overview

Feature

Description Click the Record button to start a recording session.

1. Record/Resume

Click on the button again to pause the recording session. Click on the same button to resume the recording session. When you have started a recording session and performed some

2. Add Note

actions on a screen, you can add a note to the current step to describe a defect. For simple defect reporting, click the Snap button to take a

3. Take Snapshot

screenshot of your active applications. You can edit the screenshot in the qTrace Editor.

4. Open Trace File

You can open and edit a Trace file, which has .trace extension. The Stop button is enabled when you have a recording session in progress. Click the Exit button to close qTrace.

5. Stop

6. Exit

Copyright 2011 QASymphony LLC. All rights reserved.

7. Help

Click the Help button to launch the help manual. Click the About button to view information about qTrace or to activate a qTrace license.

8. About

Record Toolbar Hotkeys


You can use the following hotkeys on the qTrace Record toolbar: To Do This Record/Resume Pause Stop Add Note Take Snapshot Open Trace File Force Screen Capture Press Hotkeys Ctrl + Alt + R Ctrl + Alt + P Ctrl + Alt + S Ctrl + Alt + N Ctrl + Alt + A Ctrl + Alt + O Print Screen

Editor Overview Main Tool, Annotation Tool, and Defect Description

Copyright 2011 QASymphony LLC. All rights reserved.

Main Tools

Description Submit a defect to a defect tracking system.

Submit

qTrace currently supports integration with JIRA, Bugzilla, and HP Quality Center. See Connect to Defect Tracking Systems . Save recording data to a Trace file for subsequent editing. The file extension is .trace. Save the recording data to a different output format, including Word, PDF, or JPG. Share the recording data via email. You can configure the following settings: Default save location. Default attachment format for email and submit functions. Default annotation format. Defect tracking system settings.

Save

Save As

Email

Settings

Help

View the help manual.

Annotation Tools Callout

Description Use the Callout tool to create a callout text box. Use the Ellipse tool to create a basic ellipse outline with a transparent background. Use the Rectangle tool to create a basic rectangle outline with a transparent background. Use Arrow tool to create a basic line with arrow head. You can change the direction of the arrow head.

Ellipse

Rectangle

Arrow

Copyright 2011 QASymphony LLC. All rights reserved.

Blur Crop

Use the Blur tool to hide sensitive information on a screenshot. Use the Crop tool to remove unnecessary portions of a screenshot. Use the Undo to undo a performed action. The undo command covers all actions related to screens and steps. Use the Redo to reverse the effect of the undo action.

Undo

Redo

Defect Description

Description Title is required to save or submit the defect to a defect tracking system. Enter additional data, such as the expected result and the actual result in the Defect Description field.

Title

Defect Description

Trace Steps Panel and Thumbnail Panel

Copyright 2011 QASymphony LLC. All rights reserved.

Trace Steps Panel

Description Click on the Environment Information link to view system information and target application information. Check the Include Environment Information check box to include this information in the output file. Screen Names are displayed on the Trace Steps panel, according to capture order. Steps of each screen are displayed on the Trace Steps panel, according to capture order. Note is displayed if it is added to a step, either during the recording of the session or during report editing.

Environment Information

Include Environment Information

Screen

Step

Note

Copyright 2011 QASymphony LLC. All rights reserved.

Thumbnail Panel Screen Number

Description Screen Numbers are displayed according to the capture order. Check Include Screen in Output check box to include the screenshot in the output file. To delete a screen, hover mouse on the screen and click the Delete icon.

Include Screen in Output

Delete Screen

Screen View, Step, and Note Icons

Screen View

Description

Copyright 2011 QASymphony LLC. All rights reserved.

Screen View

Screen View displays the selected image for preview. You can annotate, blur sensitive elements or crop the screen as desired. The Step icon is placed on the screenshot according to the mouse click position. The Note icon is displayed next to the Step icon to highlight the step in which a defect occurs.

Step icon

Note icon

Editor Hotkeys

To Do This Save Save As Email Submit to Defect Tracking System Close qTrace Editor Edit Screen Name Move Step Up Move Step Down Help Settings Undo Redo Add a New Step to a Screen Edit Screen or Step on Trace Steps Line Break Delete Screen, Step or Note Add Note on Trace Steps Edit Note on Trace Steps

Press Hotkeys Ctrl + S F12 Ctrl + E Ctrl + U Alt + F4 F2 Ctrl + Up key Ctrl + Down key F1 F4 Ctrl + Z Ctrl + Y Insert key F2 Alt + Enter Delete key Insert key F2 8

Copyright 2011 QASymphony LLC. All rights reserved.

Collapse or Expand on Trace Steps

Left key to collapse, Right key to expand

1. If you have not started qTrace, double-click the qTrace shortcut on your desktop to launch the program. 2. The qTrace Record toolbar is displayed in expanded view and automatically collapses after 3 seconds. Hover your mouse on the qTrace handle to expand it.

3. Click the Record button on the Record toolbar. You can also use Ctrl + Alt + R to start the recording session.

4. Select an application to record. You can choose to capture multiple target applications at the same time. 5. Click Refresh to get the latest application list. 6. Click Select to start the recording session.

Copyright 2011 QASymphony LLC. All rights reserved.

7. Click the Stop button on the Record toolbar or use hot key Ctrl + Alt + S to stop the recording session. 8. The qTrace Editor window will be launched to display all captured steps and screens for editing.

Add Note While Recording


When you have started a recording session and performed some actions on screen, you can add a note to a step of the current screen, for example, to highlight where a defect occurs. 1. Click on the Note button or use hot key Ctrl + Alt + N to add a note on the current screen.

Copyright 2011 QASymphony LLC. All rights reserved.

10

2. Enter note in the text box dialog. 3. Click Save to add a note. The note will be added to the most recent step of the current screen.

Pause and Resume Recording


You can pause a recording session to temporarily stop capturing your interaction with the target application, and then resume it at a later time. 1. Click Pause or use hot key Ctrl + Alt + P to temporarily stop a recording session. When the recording session is paused, actions on the target applications will not be captured.

2. Click Record button again to resume the recording session.

Take Snapshot
You can use the Snap function to take a single screenshot of the current application. 1. Click the Snap button on Record toolbar or use hot key Ctrl + Alt + A to take the snapshot. 2. A screenshot of the screen in view will be captured and opened in the Editor window.

Copyright 2011 QASymphony LLC. All rights reserved.

11

Force Screen Capture


Sometimes, qTrace cannot detect automatic or dynamic screen changes, such as video or automatically scrolling panels. In these cases, you can manually force a screenshot using the Print Screen key, which will capture a snapshot of your active application and insert the screenshot into the recording flow. 1. Press the Print Screen key on your keyboard to force the capture of a screenshot of the active application. 2. qTrace will insert the screenshot into the recording flow and continue the recording. You can use Print Screen as many times as needed.

To review the recording data with qTrace Editor and submit the defect: 1. Enter the defect title for the recording. The title field is required to save, email or submit the defect.

2. Enter the defect description, such as the actual result or the expected result.

3. Review screen names and the step description on the Trace Steps panel. 4. Press F2 to edit the screen name or the step description as needed.

Copyright 2011 QASymphony LLC. All rights reserved.

12

5. Click the Submit button to submit the defect to a defect tracking system. See Connect to Defect Tracking Systems.

Annotate Screen
1. Select an annotation tool such as Rectangle, Ellipse, Callout, or Arrow.

2. Draw the selected annotation on screen. 3. Resize, or move the annotation as desired. 4. Format the annotation tool as needed. See Format Annotation Tools.

5. Push the Delete button on your keyboard to delete the selected annotation.

Format Annotation Tools

Annotation Tool

Format Tools Text font Text size Callout border size Callout border color

Callout

Copyright 2011 QASymphony LLC. All rights reserved.

13

Ellipse

Ellipse border size Ellipse border color

Rectangle

Rectangle border size Rectangle border color

Arrow Arrow size Arrow color

Copyright 2011 QASymphony LLC. All rights reserved.

14

Crop Image
1. Select the Crop tool on the Annotation toolbar.

2. Draw a rectangle selection to identify the crop area. 3. Click the Crop button to crop the selected area.

Blur Sensitive Information


You can use the Blur tool to hide sensitive information on the captured screen. 1. Select the Blur tool on the Annotation toolbar.

2. Draw a rectangle selection to cover the sensitive information.

Copyright 2011 QASymphony LLC. All rights reserved.

15

Edit Screen Name


To edit the Screen Name in the Trace Steps panel: 1. Select a Screen Name in the Trace Steps panel and press F2 to edit the Screen Name. You can also press F2 or use the Screen Context menu to edit the screen name.

2. Screen Name is changed to an editable box, ready for modification. 3. Press Alt + Enter to have line breaks. 4. Press Enter key to commit the changes.

Delete Screen
To delete unnecessary screens from Trace files: 1. Hover mouse over a screen on the Thumbnail panel. Delete icon is displayed.
Copyright 2011 QASymphony LLC. All rights reserved.

16

2. Click the Delete icon to delete the screen. All step descriptions and notes associated with the screen will also be deleted. You can also press the Delete key or use the Screen Context menu to delete the screen on the Trace Steps panel.

Add Step to Screen


1. Select a screen on the Trace Steps panel 2. Right click on the screen to access the Screen Context menu. You can also press the Insert key to add a new step. 3. Select Add Step.

4. A new step is added as the last step of the screen on the Trace Steps panel, ready for input. 5. A new Step icon is also added to the current screen in the Screen View. 6. Select the Step icon and move it to the desired position.

Edit Step Description


1. Select a step on the Trace Steps panel and press F2 to edit the step description. 17

Copyright 2011 QASymphony LLC. All rights reserved.

You can also use the Step Context menu on the Trace Steps panel or click on the step description tooltip on the Screen View to edit. 2. The step description is changed to an editable box. 3. Use Alt + Enter to insert line breaks. 4. Press Enter key to commit the change.

Reorder Steps
To reorder steps in the Trace Steps panel: 1. Right-click on the step to view the Step Context menu. 2. Select Move Up or Move Down to move the step to the desired position. You can also use hotkeys Ctrl + Up key or Ctrl + Down key to reorder the steps.

Copyright 2011 QASymphony LLC. All rights reserved.

18

Delete Step
To delete a step: 1. Select the step on the Trace Steps and press the Delete key. You can also delete the step by using the Step Context menu on the Trace Steps panel or by pressing the Delete key on the Step icon on the Screen View.

2. The selected step is deleted. The step icon of the selected step is also removed from the screen. If the step has an associated note, the note is also deleted. 3. Remaining steps are reordered automatically.

Copyright 2011 QASymphony LLC. All rights reserved.

19

Add Note to Step on Editor


Using commands in the qTrace Editor window, you can add notes to steps. Notes can be used to provide additional information, including specifying where in the steps a given error occurs. 1. Select a step on the Trace Steps panel to add a note. 2. Press Insert key. 3. A text box for entering the note will appear. You can also add a note by using the Step Context menu on the Trace Steps panel or by selecting the Note tooltip in the Screen View to edit.

4. Use Alt + Enter to insert line breaks. 5. Press Enter key to commit the change.

Edit Note
1. Select a note on the Trace Steps panel and press F2 to edit. You can also use the Note Context menu on the Trace Steps panel or select the Note tooltip in the Screen View to edit. 2. The text of the note will appear in an editable box.

Copyright 2011 QASymphony LLC. All rights reserved.

20

3. Clicking Save will commit the changes and close the text box.

Delete Note
To delete a note: 1. Select the Note on the Trace Steps panel and press the Delete key. You can also delete a note by using the Note Context menu or by pressing the Delete key on the selected Note icon in the Screen View.

2. The selected note is deleted from the Trace Steps panel and also from the Screen View.

Undo and Redo


When you are working in the qTrace Editor window, you can undo and redo your actions as needed. 1. Select the Undo button to undo a performed action in the qTrace Editor. You can undo all actions related to screens or steps.

2. To revert the effect of the Undo action, select Redo button.

Copyright 2011 QASymphony LLC. All rights reserved.

21

Save Recording Session


You can save your recording session to a qTrace file format for subsequent editing. 1. Enter title of the recording. Title is a required field.

2. Click the Save button to save the recording.

3. Browse for location and click Save. You can set the default save location in Settings. 4. The file is saved with a .trace extension.

Open Trace File


If you have saved your recording session as a Trace file, which has .trace extension, you can open it in the qTrace Editor window to view and edit. 1. Select the Open icon on the Record toolbar.

2. Browse for the Trace file on your computer.

Copyright 2011 QASymphony LLC. All rights reserved.

22

3. Click Open. 4. The selected file is opened in the qTrace Editor window for editing.

Exit Editor
1. Click the Close button to close the qTrace Editor window. The Record toolbar is still available on the right rail of your desktop.

2. Confirm whether to save or discard the changes to the current recording file, if there have been modifications.

After capturing and editing your defect record, you have many ways to share your defect report: Save as Word Save as PDF Save as JPG Email Defect Record Submit Defect Record to Defect Tracking Systems

Copyright 2011 QASymphony LLC. All rights reserved.

23

Save as Word
To save a Trace file as MS Word format: 1. You have a Trace file opened in the qTrace Editor. 2. You can check Include Environment Information check box to include this information in your output file.

3. You can uncheck Include Screen in Output check box on the screen thumbnail or via the Screen Context menu if you do not want to include the screenshot in your output file.

Copyright 2011 QASymphony LLC. All rights reserved.

24

4. Click the Save As button on the Main toolbar.

5. Browse for a save location. 6. Select Word in the save as type. Your selection is saved for subsequent use.

7. Upon completion, the Word document is launched for your review.

Save as PDF
To save a Trace file as PDF format: 1. You have a Trace file opened in the qTrace Editor. 2. You can check Include Environment Information check box to include this information in your output file.

Copyright 2011 QASymphony LLC. All rights reserved.

25

3. You can uncheck Include Screen in Output check box on the screen thumbnail or via the Screen Context menu if you do not want to include the screenshot in your output file.

4. Click Save As button on the Main toolbar.

5. Browse for a save location. 6. Select PDF in the save as type. Your selection is saved for subsequent use.

7. Upon completion, the PDF document is launched for your review.

Copyright 2011 QASymphony LLC. All rights reserved.

26

Save as JPG
To save a Trace file as JPG format: 1. You have a Trace file opened in the qTrace Editor. 2. You can check Include Environment Information check box to include this information in your output file.

3. You can uncheck Include Screen in Output check box on the screen thumbnail or via the Screen Context menu if you do not want to include the screenshot in your output file.

4. Click Save As button on the Main toolbar.

5. Browse for a save location. 6. Select JPG in the save as type. Your selection is saved for subsequent use.

Copyright 2011 QASymphony LLC. All rights reserved.

27

7. Upon completion, a new folder is created to store all images. The folder is launched for your review.

Email Defect
1. Click the Email button on the Main toolbar to email the defect record. qTrace currently supports Microsoft Outlook 2003, 2007 and 2010.

2. A new email window is launched with an attachment in PDF or MS Word format, which includes the detail report of the defect. You can set the attachment format to be either MS Word or PDF in the Settings. 3. Enter additional information as needed and send the email.

Submit Defect to Defect Tracking Systems


You can upload your recording file to defect tracking systems. qTrace currently supports JIRA, Bugzilla, and HP Quality Center. 1. Click the Settings button on the Main toolbar.

2. Enter connection information for the tracking system you want to integrate with qTrace. 3. Click Test Connection button to test the connection.

Copyright 2011 QASymphony LLC. All rights reserved.

28

4. Click Save to save configuration information for subsequent use. 5. Go back to the Main toolbar and click the Submit button to submit the defect record to the defect tracking system specified.

6. You will see a confirmation message when the upload is complete. qTrace will add a defect summary to the description field in the tracking system. A detail report of the defect will also be attached to the tracking system. To configure the submission of the defect records to a defect tracking system, refer to Connect to Defect Tracking Systems

When working with qTrace, you can configure the following settings: Set Default Save Location Set Default Attachment Format Set Default Annotation Format

Copyright 2011 QASymphony LLC. All rights reserved.

29

Connect to Defect Tracking Systems To configure your settings: 1. Click on the Settings button in the Main toolbar.

2. Make changes to default settings as needed.

3. Click the Save button to save your settings. The change will take effect immediately without having to restart qTrace.

Set Default Save Location


You can set a default location to save output files including Trace, Word, PDF and JPG file types.
Copyright 2011 QASymphony LLC. All rights reserved.

30

1. Select Settings on the Main toolbar.

2. Locate General section on the Settings. By default, qTrace saves file to C:\\Users\your user name\Documents. 3. Browse for the location.

4. Click Save to save the settings for subsequent use.

Set Default Attachment Format


You can set a default document format for publishing defect records. The format specified will be the attachment format, which is attached to an email or to a defect record submitted to defect tracking systems. 1. Select the Settings button on the Main toolbar.

2. Locate General section on the Settings. By default, Word 2007 is set as the default attachment format. 3. Select Word 2007 or PDF to be the default attachment format as desired.

4. Click Save to save the settings for subsequent use.

Set Default Annotation Format


You can also set the default format of the annotation tool.
Copyright 2011 QASymphony LLC. All rights reserved.

31

1. Select Settings on the Main toolbar.

2. Locate Annotations section on the Settings. By default, font type is Arial, font size is 12, border is 3px, and color is red. 3. Select font type, font size, border size and border color as desired.

4. Click Save to save the settings for subsequent use.

Connect to Defect Tracking Systems Connect to JIRA


qTrace currently supports JIRA 4.x. 1. Click the Settings button on the Main toolbar.

2. Enter JIRA login information. a. Enter your JIRA Web site URL. (Example: http://jira.qasymphony.com:8080) b. Enter the user name and password for your JIRA account. 3. Click Test Connection button to test the connection.

Copyright 2011 QASymphony LLC. All rights reserved.

32

4. qTrace provides a confirmation message to indicate if the connection was established successfully. 5. Click Save to save the settings for subsequent use.

Connect to Bugzilla
qTrace currently supports Bugzilla 3.6.5. 1. Click the Settings button on the Main toolbar.

2. Enter Bugzilla login information. a. Enter Bugzilla Web service URL. (Example: http://bugzilla.qasymphony.com:3000) b. Enter the user name and password for your Bugzilla account. Bugzilla requires users to install its BZAPI API on the server in order to accept bug reports from external applications. If you have not installed the API, refer to the links below: BZAPI source: http://hg.mozilla.org/webtools/bzapi/file/1424a63c7abd BZAPI installation: http://hg.mozilla.org/webtools/bzapi/file/1424a63c7abd/INSTALL REST API: https://wiki.mozilla.org/Bugzilla%3aREST_API qTrace defect records support Unicode. However, if you need view these defect records with Unicode in your Bugzilla system, you may need to download and install a Bugzilla patch on your Bugzilla system because Bugzilla does not support Unicode by default: Bugzilla patch: http://hg.mozilla.org/webtools/bzapi/file/0d03fbe67e51/patches/xmlrpc-fix.diff
Copyright 2011 QASymphony LLC. All rights reserved.

33

3. Click the Test Connection button to test the connection.

4. qTrace provides a confirmation message to indicate if the connection was established successfully. 5. Click Save to save the settings for subsequent use.

Connect to HP Quality Center


qTrace currently supports HP Quality Center 11. 1. Click the Settings button on the Main toolbar.

2. Enter HP Quality Center login information. a. Enter the HP Quality Center Web service URL. (For example: http://hpqc.qasymphony.com:8080) b. Enter the user name and password for your HP Quality Center account. 3. Click the Test Connection button to test the connection.

Copyright 2011 QASymphony LLC. All rights reserved.

34

4. qTrace provides a confirmation message to indicate if the connection was established successfully. 5. Click Save to save the settings for subsequent use.

If you have trial version of qTrace and would like to activate its license, please start by logging onto www.qasymphony.com to purchase the product. Once the purchase is complete, you can click the activate product link on the About screen, and follow the activation instructions.

Copyright 2011 QASymphony LLC. All rights reserved.

35