QAC User Guide

QAComplete Documentation
QAComplete is a comprehensive test management and execution tool that provides the ability to plan,
organize, and schedule all of the tests associated with your release.
Using QAComplete General Information

n Getting Started n Introducing QAComplete
n User Guide n What's New in Release 11.0
n Home Dashboard n Support and Resources
Organizing Testing
n Releases n Defects
n Requirements n Test Management
n Agile Tasks n Automated Tests
Configuring More
n Administrator’s Guide n Reports
n Lists (Custom Tables) n Integrations (JIRA, Automated Test-
n On-Premises (Enterprise) ing, API)
Features n Shared Documents
ALMComplete | QAComplete User's Guide
General Information
About QAComplete
QAComplete is a comprehensive software test management tool. QAComplete provides you with the
ability to plan and organize all test cases, user stories, and defects associated with your release or user
stories in a single place. As a web-based application, you can access your data anywhere you have an
internet connection.
With QAComplete you can:
l Re-purpose and reuse assets across your testing cycles.
l Customize the tool to your development methodology.
l Determine test coverage and ensure tests exist for all requirements.
l Establish clear traceability across requirements, test cases, and defects.
QAComplete is offered as Software as a Service (Cloud) version or as an On-Premises version, for those
interested in hosting the web application and database on your own servers.
Managing the Software Lifecycle

You can manage the entire life cycle of your Releases, including tracking Requirements, Tasks, Tests,
Test Runs, and Defects. Items can be linked together to ensure maximum visibility into the testing
cycle and results.
SoftwarePlanner
You’ll find the term SoftwarePlanner in several places in this guide and in other documentation. Soft-
warePlanner refers to the engine and database of all QAComplete and ALMComplete features.
ALMComplete
ALMComplete features are being retired as of Release 11. You'll find information about the ALMCom-
plete specific features in the Legacy Features section. All QAComplete features are included in ALMCom-
plete.
Two ALMComplete features, Lists and Shared Documents, are now available in QAComplete.
Page 2 of 308
2015 SmartBear Software, All Rights Reserved. Visit us at www.smartbear.com
System Requirements
Browser Support
Recommended browsers for QAComplete Release 10.1 and above:
l Firefox
l IE 9, 10, 11 or Edge
l Chrome
Screen Resolution
l We recommend a screen resolution of 1280 by 1024 or greater.
On-Premises System Requirements

For information on On-Premises system requirements, please see Specifications.
Page 3 of 308
What's New
New in Release 11.0
NEW FEATURES in QAComplete
l QAComplete has a new LOOK.

l The top navigation menu has been completely redesigned, allowing you more room on every
screen and easier navigation.
l Access Help Center and Log Out from the silhouette icon on the new menu.
l Access Setup from the gear icon on the new menu.
l New DASHBOARD CHARTS are available on the home tab, and you can pick and choose the charts
that are critical to you.
Drag and drop your selected charts onto the Home dashboard page.
For more details, see About Dashboards.
l New REPORTS allow you to select and order columns, filter, and save your report criteria.
l Reports can be exported to PDF, RTF, XLSX, XLS, and CSV.
l For more details, see About Reports.
Strong Password Enforcement
l Security Administrators can enforce stronger password rules.

l Enforce a combination of alpha, numeric and non-alphanumeric characters.
l Set a minimum password length (no less than 8).
l Set the password re-use policy.
l Set the password expiration time.
Reminder: Update your shortcuts to the new URLs:
l New Login URL: https://login.qacomplete.smartbear.com
l New SOAP URL: http://soap.qacomplete.smartbear.com/psWS.asmx
l New REST URL: https://rest.qacomplete.smartbear.com/rest-api/service
Interested in the history of features? See Version History.
Interested in information on fixes? See Fixes by Release.
Page 4 of 308
Support and Resources

If you have questions, problems, or need assistance with QAComplete or ALMComplete, please check
out these resources:
l Recorded Videos: Video Tours & Demos.
l Community Forums: SmartBear Community Forums.
l Articles: QAComplete Resources.
l SmartBear Software – www.smartbear.com.
l Contact Support: Contact Customer Care.
l API: Using the API.
l Data Dictionary: Using the Data Dictionary.
Page 5 of 308
Getting Started with QAComplete

QAComplete is a full Test Management system to aid you in documenting, organizing and tracking
your development and testing cycles. QAComplete includes modules to track Requirements, Tasks,
Test Management and Defects. Related items can be linked together with Traceability. The List Man-
ager provides further customization, where you can configure Lists tables to hold additional inform-
ation.
New trials include a Sample Project as an example of how you could organize your data. Use the
Sample Project to get familiar with the process and to help determine how best to organize the system
to suit your specific business needs.
To get started with QAComplete, your system administrator will do the following:
System Administrator Steps

Create Security Groups
QAComplete's security model allows you to fully control your team members permission to your data.
Once you create a security group, you can then determine what rights people in that group have to
QAComplete modules and data. For example: you may want one team to have read-only permission
to Requirements, but full access to Defects and Test Management.
To create a security group:
1. Click the Setup icon at the far right of the top menu bar.
2. In the left navigation panel, select Security > Security Groups.
3. Click Add New.
4. Name the security group (such as "Developers" or "Test Team") and click Submit.
5. The new group appears on the list of Security Groups. Click the Manage Security Rights icon next
to the group.
6. Use the check boxes to grant or remove permission for this group.
7. Scroll down and click Submit to save your settings.
Add Users
Now that you have defined your Security Groups, you are ready to add users and put them in the
desired group.
1. Click the Setup icon at the far right of the top menu bar.
2. In the left navigation panel, select Security > Users.
Page 6 of 308
3. Click Add New.
4. Enter the user's information (Name, Email, etc.)
5. Select the desired Security Group for the user and click Submit. The user will be added to this group
for the currently selected Project.
Your new users automatically get an email with login details.
To change your user's security permissions, click the he Manage Security Rights icon next the user.
Create a Project
Projects allow you to fully control what permissions your users have to specific data. Grant permission
to a Project by assigning a user to a Security Group for that project. Also, QAComplete comes with a
Sample Project that your team can use to explore the application. If you select the Sample Project as
you add users, the new users automatically have permission to use it.
1. Click the Setup icon at the far right of the top menu bar
2. In the left navigation panel, select Projects (Open & Create).
3. Click Add New.
4. Enter a Project Name and click Submit.
To grant users permission to Projects:
1. Click the Setup icon at the far right of the top menu bar
2. In the left navigation panel, select Projects (Open & Create).
3. Click the Manage Security Rights icon next to the Project.
4. Use the drop down list of Security Groups to assign your team members specific permission to the
selected Project.
Once you have your login credentials from your Security Administrator, you can log in to QAComplete
and start creating your data.
QAComplete comes with a Sample Project with some example data for you to explore. Your Security
Administrator can grant you permission to the Sample Project or any other Projects that your team
creates.
Page 7 of 308
Select a Project
Select a Project from the left side navigation panel on any of the main tabs (for example, Releases,
Agile Tasks, Requirements and so on). If you cannot see the left side navigation panel, click the double
chevron on the left to open the panel. Use the drop down list of Projects to select the Sample Pro-
ject or any other Project that you have access to.
Create your Data
You can navigate through the modules using the top menu bar. If you start with creating a Release,
items can automatically be linked to the Release or Sprint by simply selecting the desired Release in the
left side navigation panel - as you add items, they are linked to the selected Release. You can organize
your data into Folders, create Custom Fields, and link related items together with Traceability.
Releases
Organize your data by Release, Iteration and/or Build with the Releases module.
To start creating Releases:
1. Select Releases from the top menu bar.
2. In the left side navigation, select the Folders tab and click Add.
3. Enter a name for your first Release Folder (such as "My Application") and Submit.
4. Highlight the folder in the left, and in the right panel, click Add New.
5. Give your release a name and date range and Submit. If you want the dates to be calculated from
sprints below the release, check the Auto Adjust Est Dates box.
After creating your first Release, you can add Sprints or Iterations to it.
1. In the left navigation panel, highlight the desired Release.
2. In the right, click Add New.
3. Choose if you want to add an Iteration (Sprint) or a Build (typically you would add the Build to the
Iteration or Sprint).
4. Fill out the name, status, and estimated dates.
5. Click Submit.
Track Requirements
Track your feature requests and enhancements with the Requirements module. Here, you can doc-
ument, estimate and approve features and then link them to your Release or Sprint. You can edit,
search and filter from the list of Requirements.
Page 8 of 308
1. On the top menu bar, hover over Requirements and select Show Requirements from the drop
down menu.
2. Click Add New.
3. Enter the details for your first Requirement and click Submit or Submit/Add another to continue
adding Requirements..
To manage the appearance of Requirements, click the Setup icon at the far right of the top menu
bar, then select System Configuration > Screen Layouts in the left navigation panel and select Require-
ments. Here, you can design the order of the appearance of fields on the add / edit form, manage
workflow and custom fields.
See Requirements Overview video.
Track Tests
Test Management provides full traceability to can ensure complete test coverage of your Require-
ments and retesting of your Defects. Tests are organized into Test Sets, where your team can run the
Tests in a consistent, logical order. Tests Sets can be linked to Configurations, so you can track envir-
onment details for each run, such as browsers or operating systems.
First, create your Tests:
1. On the top menu bar, hover over Test Management and select Test Library. This is where you
define your re-usable tests.
2. Click Add New.
3. Complete your Test description and other details and Submit.
4. You will be placed on the Steps tab. Define your test steps and expected results and click Save and
Exit or Save/Add another.
5. Continue defining your test cases.
Next, define your Test Sets:
1. On the top menu bar, hover over Test Management and select Test Sets.
2. Click Add New.
3. Complete your Test Set description and other details and Submit.
4. The Tests tab opens. Use the right side panel to navigate to your Tests Folder or Filter and click Go.
5. Drag Tests into the Test Set, and arrange them in the desired order.
Page 9 of 308
6. Click Save and Exit.
7. Click Add New to continue defining Test Sets.
Now your team is ready to run the Test Sets and post the results. If a Test in the run fails (any step
within the test is marked Failed), you will have the opportunity to automatically create an associated
Defect.
To manage the appearance of Tests or Test Sets, click the Setup icon at the far right of the top
menu bar, then select System Configuration > Screen Layouts in the left navigation panel and select
Tests or Test Sets. Here, you can design the order of the appearance of fields on the add / edit form,
and manage custom fields.
For working with automated tests, please start here: See "About Automated Tests". Also see the Test
Management video.
Defects (Bugs)
Defects can be added the same way you added Requirements or Tests, or they can be automatically
generated as your team runs manual Test Sets and fails Tests. If the Defects is automatically generated
during a run, it is also automatically linked to the failed Test, Test Set and Release / Iteration.
To add a Defect:
1. Select the Defects tab.
2. Click Add New.
3. Define the Defect details, including description and steps to reproduce.
4. Use Link to Items at the bottom of the form to link the Defect to an existing Test.
5. Click Submit or Submit/Add another and continue adding your Defects.
To manage the appearance of Defects, click the Setup icon at the far right of the top menu bar,
then select System Configuration > Screen Layouts in the left navigation panel and select Defects.
Here, you can design the order of the appearance of fields on the add / edit form, manage workflow
and custom fields.
See the Defect Management video.
Traceability
Use Traceability to link related items together.
To view linked items:
1. From any module, click the Actions drop down.
2. Check the Show Traceability box.
Page 10 of 308
The list now shows the count of various linked items. Click on the links to drill into the linked items.
Alternately, you can open the item in Edit mode and scroll to the bottom to see the link items.
See the Requirements Traceability video for examples.
Reports
The Reports tab provides report templates that you can use to build out your reports.
FAQs
What do we do with a closed Release? You don't want to get rid of the history of a Release, but you
can mark it "Inactive" so that it is out of the way. The navigation panel for each module allows you to
view or hide Inactive Releases.
Can I archive other data? You can move data out of the way using Folders. Put the data into a folder,
then make the folder Inactive. The folder and all the data in it are moved down to the bottom of the
navigation panel, out of the way. You can get back to the data by simply making the folder Active
again.
Can we import data? Yes, you can import data from a flat CSV file. Go to the desired module, click the
Actions drop down and select Import from CSV file and follow the import wizard. You can also get to
the import wizard from Setup. To ensure your CSV file is formatted correctly, you can first perform an
Export to CSV and use the exported file as a template.
Can we export data? Yes, you can export your data into a flat CSV file. Go to the desired module, click
the Actions drop down and select Export (visible fields) or Export (all fields). Export (visible fields)
exports only the columns you've selected on the list.
Can we attach documents and images? Yes. Open the item in question, click the Files tab and click
Add New. Navigate to the document and upload it.
Can we add comments or notes? Yes. Open the item in question, click the Notes tab and click Add
New. You'll see a new text box open up where you can make your comments.
Can we create our own values for the list of Statuses? Yes, choice lists values are customizable. Go
to the desired module, click the Actions drop down and select Choice Lists. You can add or change the
values for any drop down list to suit your needs.
Do you keep an audit trail of changes? Yes. Each item has a History tab where you can see when
changes were made, what the changes was, and who performed the action. The Test Library also has a
Version function that saves complete versions of tests as they are changed.
Can we create our own custom fields? Yes. From the desired module, click the Actions drop down
and select Custom Fields. You can create up to 90 different custom fields for each module. You can also
access Custom Fields from Setup > Screen Layouts.
Page 11 of 308
How do I locate specific items? You can use Quick Search or create a Filter in any module to find the
desired items. Click Quick Search, enter a phrase, and select the field to search and then Submit. Click
Filters, give your filter a name, then use the drop downs to select the Fields, Conditions and Values to
use in the search, then click Submit.
Can I sort and modify the list of items? Select the module, then click the header of a column to sort
ascending or descending order. To sort by multiple columns, click the Actions drop down and select
Sort. You can change the columns and order of the columns by clicking the Choose Fields button. The
system will "remember" your selections the next time you log in and go to the same tab.
For More Information
Visit our Community Forums, peruse the User Guide, and check out additional videos on the
SmartBear Software website.
Page 12 of 308
User’s Guide
Getting Familiar with the User Interface
Most modules have a very similar interface. Once you learn the basic layout and how the screens
work, you have learned how all screens work across areas. The sections below discuss how the
screens work, how to navigate the user interface, etc.
Menu Bar
Across the top of the display is the Menu Bar, where you navigate between modules. Hover over the
desired module to see the available options, then select what you need from the drop down menu.
Working with the Navigation Panel

After you select an option, you will see the list of available items and a left navigation panel. This panel
will show what Release you are working in, and allows you to build out a Folders structure for organ-
izing your data.
On the entities affected by Releases, the Navigation Panel has three tabs.
Page 13 of 308
The Releases tab allows you to select a Release / Iteration and Build. When you select a Release, the
data in the List on the right is filtered to items linked only to the selected Release, Iteration and Build.
To view data across All Releases, click the “root” at the top of the list that says “Releases”. To view data
unrelated to a Release, click (No Releases).
l With a Release selected, as you add data, your new items are automatically linked to the selected
Release.
l The Folders tab allows you to organize your data into logical folders and subfolders.
l The Groups tab allows you to group your data by selected fields.
Using Folders
Another organization tool is Search folders. Folders allow you to organize your data into logical areas.
For example, you can create Folders for Backlog items or other logical grouping.
Page 14 of 308
If you are managing defects, requirements, or tests, you may want to organize them in additional
ways.
To create a new Folder, click the Folders tab, then click Add:
If you wish to create a subfolder of an existing folder, choose the Parent Folder name from the drop
down. Enter a Folder Name and Description (optional) and press Submit. The folder will appear in the
left side navigation panel.
Next to each folder, you will see a count of the items in the folder. Parent Folders roll up all items
within the subfolders below, allowing you to view all items in subfolders by selecting the parent folder.
The number of items in each folder appears next to the folder name. If you are filtering for data, the
number changes to the count of items found by the filter within that folder.
Click the highest or root level to see all items across all folders.
Page 15 of 308
Deleting a Folder
If you Delete a folder, the data in the folder is NOT deleted . The folder name is simply removed from
the records, and you will find them in the “root” section with no folder name. Use Fast Edit to move
the records from one folder to another.
Archiving Data
If you wish to archive (hide) the folder, simply edit the Folder by going to the Folders, highlighting the
folder and pressing Edit, then uncheck the Is Active flag. This moves the folder to the Archive section,
out of the way. No data is deleted. You can come back and check the Is Active checkbox to make the
folder active again and access the data.
Copying Folder Structure

You can copy a folder / sub folder structure to other locations by selecting the parent folder, right-click
and select Copy Folder Structure. You can paste the folder structure into another parent folder or into
another entity, allowing you to easily configure your folder organization and duplicate it from Require-
ments to Defects to Test Library, or to other projects.
Using the Grouping Tab

You can also use the grouping feature to organize data based on up to 3 levels of grouping. To do this
in the table of contents, choose the Groups tab then click the Group By button and choose the level 1,
level 2 and/or level 3 grouping. Below is an example of Defects grouped by Assigned To and Status:
Page 16 of 308
Page 17 of 308
Working with the Home Page

The Home Page is displayed when you log in for the first time and provides valuable dashboards that
allow you to quickly spot trends and inspect the status of items. From the Home drop down menu,
you can select Dashboards, Team Task Board, and manage Email Alerts.
Home Dashboards
On the Home > Dashboards page, you can select the dashboards that are important to you.
The charts show data for the project selected at the top left.
l To add a chart to your dashboard page, click ADD DASHBOARD CHARTS. The available charts appear
on the right. Drag your selections onto your dashboard page.
l To remove a dashboard chart, click the Menu icon on the chart, and click the Delete icon.
l To change the selected Release or Folder, click the Menu icon on the chart and click the Filter icon.
Available charts are organized into categories:
Requirements
l My Requirements by Status (Active Projects)
l Open Requirement Trending Past 14 Months
l Percentage Complete by Requirement
l Requirement Test Coverage
l Requirements by Assignee, Folder
Page 18 of 308
l Requirements by Assignee, Release
l Requirements by Group
l Requirements by Owner, Folder
l Requirements by Owner, Release
l Requirements by Status,Folder
l Requirements by Status, Release
l Requirements Trending
Defects
l Defect Trending
l Defects by Assignee
l Defects by Priority, Folder
l Defects by Priority, Release
l Defects by Requirement, Release
l Defects by Severity, Folder
l Defects by Severity, Release
l Defects by Status, Folder
l Defects by Status, Release
l My Defects by Status (Active Projects)
l Open Defect Trending Past 14 Months
Agile Tasks
l Agile Task Burndown
l Agile Task Resource Allocation by Assignee
l My Slipping Agile Tasks (Active Projects)
l Slipping Agile Tasks by Assignee
Releases
l Release Status
l Release Velocity Monthly Velocity
Page 19 of 308
l Release Velocity Past 2 Weeks
l Resource Allocation by Assignee
l Release Burndown
QA
l Tests by Last Run Status
l Test Library by Assignee
l Test Runs by Assignee
l Test Runs by Configuration
l Test Runs by Requirement
l Test Runs by Test Set
Team Task Board

The Team Task Board is available not only from Home but also from the other modules. The Team Task
Board provides a quick snapshot of the assignments for members of your team. Assignments are dis-
played on color coded Task Cards. The To Do column lists tasks not yet started, In Progress lists the
tasks in progress, and Completed shows the tasks finished within the selected Date Range. You can
change the date range at the top of the Completed column.
Each column has a plus/minus icon that will expand or collapse everything in that column. Individual
items can also be expanded or collapsed. Click on the item's numeric ID to open it in a new Edit win-
dow.
Task cards are color coded: white background tasks are on target or not yet due, tasks that are past
due are red, and tasks that are due today are green.
You can easily change the Project, Release, Team Member and Artifact in the drop downs to filter the
display.
Page 20 of 308
A summary of tasks across all Projects appears at the bottom of the screen and can be collapsed or
expanded by clicking the double chevron at the lower right.
The Project and Team Member default to the current project and the current user. Each column
shows a list of task cards representing assignments for the team member. To Do contains items not
started. In Progress contains items currently being worked, and Completed shows assignments com-
pleted within the selected date range.
Each type of Artifact is represented by an icon:
Agile Tasks
Requirements
Defects
Team members can post hours directly to any assignment by clicking the Post Hours link. This goes to
the Post My Hours screen, automatically fills in the selected Task and default to the current date.
If not posting hours, your team member can drag assignments from To Do to In Progress to Com-
pleted based on certain rules. Since you are not posting hours, drag and drop will change the percent
complete automatically.
If you drag a Task Card from To Do to In Progress¸ the percent complete is changed to 1%.
If you drag from In Progress to Completed, the task is now 100% complete and the Completion Date is
today.
If you drag from Completed to In Progress, the task is now 99% complete.
Page 21 of 308
Dragging from In Progress back to To Do is only allowed if there are no actual hours posted to the task.
If there are no actual hours posted, the task can be moved and the percent complete is zeroed out.
Email Alerts
Email Alerts will send you an automatic email when items are added or changed. Click the to turn
on a selected alert. The icon will switch to a green check , showing you that the alert is turned on.
If you want to receive alerts when you make changes, click "Click here to receive email alerts when you
make changes". Toggle this option on or off by clicking on the text.
For more information on Email Alerts, see See "Email Alerts" in the Administrator's Guide section.
Page 22 of 308
About Releases
Organize your data by release, iteration or build using the Releases page.
Requirements, tests, test sets, agile tasks, and defects can be associated with a release, iteration or
build, providing you with in-depth analysis of the progress, status and success of a release of your
product.
If you define release link types, items can be linked to releases by release link type. This allows you to
link a defect to several releases, using release link types such as Found In Release, Fixed In Build,
Deployed In Release. The release link type is defined for each module from the Actions menu in Man-
age Choice Lists.
Defining Release, Iterations and Builds
When organizing your releases, first start with a folder structure. Generally, the folder represents your
application or product. Within the folder, you will organize your releases with iterations (sprints) and
builds.
Go to the Releases page.
The left side of this screen is the Navigation panel. This is where you add and edit folders for your
release. You can use the plus symbol to expand the folder to view the releases within.
The right side of the screen lists your releases.
Use the icons in the Actions column to:
Page 23 of 308
l Edit releases,
l Generate detailed release drill down reports,
l View iterations and builds of a release,
l Access items linked to a release.
Example: Let’s step through creating a folder for an application, then set up the Beta Release followed
by Release 1.0.
First, open the Folders tab, then click Add and add a folder for your application.
Select your new folder, and on the right panel click Add New:
On the Add Release form, specify your release's name and status. You can also enter additional
descriptive information.
Page 24 of 308
If you want to specify the Start and End Dates, enter them here. If you want to leave the dates blank
and let the system calculate the dates from your iterations or sprints, select the Auto Adjust Est
Dates? check box.
Click Submit.
You have created your first release.
Creating Iterations or Sprints

After you define your core release, you can set up the schedule of iterations or sprints. How you define
these depends on your development method, such as Waterfall or Agile.
Access the Add Iteration or Build function by either selecting the release under the folder on the left, or
by clicking on the View Hierarchical Release icon next to your release on the listing.
Page 25 of 308
The listing form changes to display the release hierarchy. Notice the icons have changed, and you can
add iterations or builds in the hierarchy of your release.
When you click Add New, the Add dialog asks if you want to add an iteration or build to the release.
Click Add Iteration.
Page 26 of 308
Complete the information for the first sprint in this release and click Submit.
If you track builds within either the release or the sprint, click the green plus icon again and select
build.
Page 27 of 308
Now the hierarchy shows the release, the first sprint, and the first build:
The icons in the action columns allow you to edit the item. Click the green plus icon to add another iter-
ation or build. Click the red X icon to delete an iteration or build. Click the Drill Down Report icon to
generate the detailed drill down report.
Linking Items to a Release

After you define your release, iteration or build, you can tag requirements, tests, test sets and defects
as belonging to a specific release. Link the items to a release on the Releases page or on the Require-
ments, Test Management or Defects pages.
On the Releases page, use the Link To icon to navigate to the traceability screen, where you can link
items to the release.
Click Link Items to navigate to the traceability screen.
Page 28 of 308
On the Items panel, find the items and drag them on to your release.
When you work with items in other QAComplete modules (for example, with requirements in the
Requirements module), the Navigation panel shows releases. You can filter the items to view data for
all releases, data not linked to releases, or data linked to a specific release:
Select the release that you want to work with.
When you link a test or test set to a release, you can run the test or test set for any iteration or build
below the linked release.
Note: If you seem to be missing data on any list, check the left side navigation panel to see if you have
a release selected. Only data associated with the selected release will display on the list. To view all
data, go to the Releases tab on the left and select the highest ‘root’ folder.
Page 29 of 308
Release Link Types

Requirements, agile tasks, test sets and defects can be linked to your release by various link types.
Each area that can be linked to a release has a unique set of user-defined Release Link Types.
For example, you may want to link defects to a release in which it was found (Found In link type) or to
a build in which it was fixed (Fixed In link type).
To set up release link types for defects, go to the Defects > Show Defects page. Click Actions and then
click Manage Choice Lists.
Release link types are completely user-defined. Add release link types that you will use when ref-
erencing items to the release.
Page 30 of 308
Once release link types are defined, you can use them to explain the relationship between the defect
(or other items) and one or many releases.
You can filter your items by release link type on the left navigation panel. For example, you can view
defects found in the selected release or fixed in the selected release.
Page 31 of 308
Release Roll-Up
As you link items to your release or iteration, the release rolls up the total number of linked items by
item type. You can view the number of linked items by adding columns to the Releases list with
Choose Fields, or have your system administrator add them to the Release Add/Edit form in Setup -
Screen Layouts.
The system rolls up the number of linked requirements, tests that are linked to the requirement, tests
linked directly to the release, test sets, defects and agile tasks.
If you enter Estimated Hours on Requirements, Agile Tasks or Defects, these values will also be rolled
up to the release. As your team posts work hours, the release calculates the variance between your ori-
ginal estimates and actual hours.
Variance calculations:
Total Estimated Hours less (Estimated Hours Remaining plus Actual Hours posted) equals Variance in
Hours
(Variance in hours divided by Total Estimated hours) times 100 equals the Variance Percent.
Dashboards
As your release progresses, you can analyze it with our built in dashboards. To view release dash-
boards, go to the Home > Dashboards page.
Page 32 of 308
Dashboards can be filtered for all releases or a specific release.
To learn more about working with dashboards, please see "Dashboards".
Drill Down Reports

The drill down report is available from the Releases listing screen. Click the Drill Down Report icon to
see a detailed report that shows the details of the release and all items linked to the release.
Page 33 of 308
Organizing Your Release

Releases can be organized using your team's development method. Two common methods are Agile
and Waterfall.
This section describes those methodologies and provides hints on how to setup QAComplete foster
best practices of the methodology your team is using.
Working with Waterfall
The Waterfall methodology has been used for years to deliver software projects. With Waterfall, you
work the project in sequential order, first collecting requirements, doing designs, coding, testing, and
then move to production. Graphically, it looks like this:
Normally Waterfall projects are shipped in Releases (e.g. Release 1.0, Release 2.0, Release 3.0) and
these release cycles can be months in duration.
If your team is using the Waterfall method, you’ll define your Release and Release schedule based on
the Waterfall workflow, possibly with an Iteration for each phase of development below the Release.
You will also need to keep track of feature and requirements. We suggest creating a Product Backlog
folder under the requirements area to keep track of future enhancement requirements. Below is an
example of setting up a Waterfall environment:
Page 34 of 308
You can create Agile Tasks to break down the Requirements, then create Tests to cover each Require-
ment in your cycle.
Working with Agile
With Agile, software development is done in “iterations” or “sprints” which normally a given number
of days, depending on what Agile methodology you are using. Unlike Waterfall, Agile defines the
requirements for a smaller set of functionality and implements it quickly so that critical functionality is
delivered quickly and it allows the client to work out issues with the design without waiting long peri-
ods before they are able to actually use the software to ensure their design assumptions were correct.
Graphically, it looks like this, where each sprint is a version of the software that could be moved to pro-
duction, if you elect to do that:
Notice that Release 1.0 above is not achieved until several iterations (or sprints) is performed. If your
team is using the Agile methodology, on the Releases tab create a folder for your application or
product, then create a Release with Iterations under the Release for each Sprint.
You will also need to keep track of future requirements; we suggest creating a Product Backlog folder
under the requirements area to keep track of future enhancement requirements. Below is an example
of setting up Releases an Agile environment:
Page 35 of 308
Templates
If you need templates for the Agile methodology (like Work Orders, etc), check out http://s-
martbear.com/community/resources/templates/.
Page 36 of 308
Agile Tasks
Agile Tasks can be used to break down requirements into smaller tasks, or for tracking any other
assignment that you may need.
To access the simple project management feature, go to the Agile Tasks page.
Once here, you will see a list of agile tasks.
Organizing your Agile Tasks
You can organize your agile tasks in any way you need. For example, you may consider organizing
them by software release and agile sprint, then by product lines, and so on.
Posting Time to Agile Tasks
Team members can post hours to agile tasks, the same way you can post hours to any other assign-
ment. Tasks assigned to you have a clock icon. Click on the icon to post hours worked.
Agile Task Dashboards
Agile Task Dashboards allow you to quickly view slipping agile tasks. To view agile tasks dashboards, go
to the Home > Dashboards page.
Page 37 of 308
To learn more about working with dashboards, see "Dashboards".
Agile Task Reports

You can analyze your agile tasks with our built-in reports. To run reports, go to the Reports > 11.0
Reports page and choose Agile Task Detail Report.
See "Reports".
Page 38 of 308
Managing Requirements and Specifications

Before a software project can begin, you must first know what features (or requirements) are neces-
sary for the software project, which could include new features or enhancements to existing features.
Using the requirement status, you can analyze the number of requirements that are new, awaiting
approval, awaiting estimate, approved, rejected, closed, etc.
To access requirements, select Requirements > Show Requirements. You will see a list of require-
ments.
Organizing your Requirements

Organize your requirements by release or sprint. Use folders for another layer of organization. For
example, you will organize requirements by software release and sprint or iteration, then define a
folder structure for an additional layer of organization.
Requirements include a special feature to allow you to auto-number your requirement in the Title. This
can be used for a numbering scheme that makes sets of related requirements easy to identify. A com-
mon way to do this is to come up with a standard naming convention. Use an abbreviation to identify
the team, application code, or client, followed by a 4 digit number that identifies the number of require-
ments you have done for that team.
For example, let’s say you have a Web Manager team and a Sales Engineer team. You might want to
identify requirements for the Web Team separately from the Sales Engineer team.
When creating requirements, use your abbreviation in the Title of the requirement. The requirements
will be auto-numbered sequentially for that abbreviation.
For example, here are two requirement titles with different abbreviations and a numbering scheme:
l WEB-0001 Implement Web Designers’ new splash screen
l SAL-0006 Create new Sales Breakdown dashboard for Sales Engineers
The auto numbering is triggered by typing your abbreviation followed by a dash and four X’s: AAA-
XXXX where AAA is any alphanumeric value followed by a dash and four Xs. The four Xs are replaced by
the next sequential number when you click Submit.
In the examples above, if you enter “WEB-XXXX My New Requirement” in the title of the requirement,
on Submit, it will change to "WEB-0002 My New Requirement" since 0002 is the next available sequen-
tial number.
Below is an example of an organized set of requirements that also have good naming conventions:
Page 39 of 308
In the example above, requirements are organized in this manner:
l Product Backlog – This is a list of requirements for consideration and review. These items are pri-
oritized when planning new releases and stay in this folder until they are approved for work in a soft-
ware release.
l Iteration Backlog – This could be a list of ‘groomed’ requirements ready for pulling into a sprint or
iteration.
l Urgent – The decision has been made to move forward with this critical requirements.
l From CAB – These are requests directly from the customer base for analysis and prioritization.
The organization above is just an example; feel free to organize your requirements in a way that works
best for your team.
Creating Requirements
To add a new requirement, select Requirements > Show Requirements. In the left side navigation
panel, click Releases and select the release or iteration that owns the requirement. Then click Add New
at the top of the screen.
To update an item, click Edit for the desired item, make your changes and click Submit.
To delete an item, click Edit for the desired item, scroll to the bottom of the page and select the Delete
This Record check box, click Submit.
If you do not have security rights to update or delete items, those buttons will be hidden. To learn
more about security settings, please refer to the Administrators’ Guide.
Tip: To add a new item that is similar to an existing item you recently added, choose the recent entry
to auto-fill the data on the screen:
Page 40 of 308
You can reorganize the edit screen by adding custom fields, change the position in which fields appears
on the edit screen, and you can arrange the edit screen in 1 or 2 column formats. You also specify
which fields are shown, required or optional. Customizing the appearance of the Requirements screen
is covered in the Administrator’s Guide.
You can attach files (like requirement documents, contracts, etc) to requirements. Click Edit for the
requirement, open the Files tab, then click Add New. To keep a running set of notes or comments on
an item, open the Notes tab, then click Add New.
Creating Requirement Documents

Your requirement documents describe the feature or user story being developed. Requirements can
contain attached files for prototypes, screen mockups, or detailed specifications for your team.
A requirement can be emailed to your client for approval.
A requirement can be used by your quality assurance team to create tests to ensure traceability and
test coverage for the feature.
A requirement can be used by your development team to fully understand the feature.
If you are using attachments, you can version the attachment files so that changes can be reviewed.
A Requirement Document is normally broken into sections, contains an overview, details, rules and
screenshots. You can obtain examples of a Requirements Document and other document templates at
SmartBear Templates.
Once you develop the requirement document, attach the file to the requirement (edit the require-
ment, click Files, then click Add New). Use the Replace existing files option, save original as a prior ver-
sion if you want to keep previous versions of the requirement document available to your team.
Requirement Reporting and Dashboards

Once your requirements are entered, you can analyze them with our built-in reports and dashboards.
Page 41 of 308
To view requirement dashboards, go to the Home > Dashboards page.
Some charts are drillable. Click the chart to view the details.
To learn more about working with dashboards, see Dashboards.
To run reports, go to the Reports > Reports page.
Configure a needed report and click Run Report.
To learn more about working with reports, see See "Reports".
Page 42 of 308
About Test Management

Test Management is where you document your tests, including steps and expected results. You can
organize Tests into folders, and place related Tests into Test Sets. Tests and Test Sets can be associated
with a Release, Iteration and/or Build.
Test Sets allow you to document what Tests need to run together in what order. Tests in the Test Set
should be a logical collection of Tests that you run sequentially. Test Sets can be associated with a
Release, Iteration or Build so your team can track when the Test Set was run, whether it and the tests
within passed or failed in a selected Sprint.
If you run a Test Set against different environments or browsers, create Configurations to represent
those environments. Link the Configurations to your Test Set. Then when your team runs the Test Set,
they document which Configuration was used.
If you prefer to run Tests individually, without organizing them into Test Sets, you can do so directly
from the Test Library.
If you use one of the supported tools for automated testing or unit testing, you can associate Test
Library Tests with your automated tests. Then you can run the Automated Tests on demand from Test
Management, and set up Schedules to run your Automated Tests on the desired schedule auto-
matically.
Results from your Automated runs post directly into the associated Tests, so you can get a complete
picture of test coverage and run results. Please see Creating Automated Tests for more information.
Test Library
In Test Management, you can organize your tests into a Test Library, build test sets to run for a
release, and then run sets for a release and configuration. Tests in the library can be manual tests, with
details step by step instructions, or automated tests with an associated test automation script.
To get started with Test Management, determine the organizational structure for your Test Library,
then build your tests. The Test Library can include custom fields specific to your needs, plus the stand-
ard built in Test fields.
Open the Test Management > Test Library page.
Page 43 of 308
In the left side Navigation panel, click the Folders tab to start organizing the folder structure for organ-
izing your Test Library. Your folder structure can represent any logical organization that suits your
style: you may want to organize by application and functional area, type of test (regression, smoke),
etc.
Once you have the folder structure defined, select the desired folder for adding your tests.
Creating Manual Tests

Adding New Tests
On the Test Management > Test Library page, click Add New. The Add Test form opens:
Give the test a Title and complete any required fields and other data. Use the Description or Notes
fields to give additional instructions or information about this test. At the bottom of the Add Test form
Page 44 of 308
you will see the Link to Items function, where you can use Traceability to link your Tests to Require-
ments so that you have full understanding of your Test Coverage.
Click Submit to go to the Test Steps:
On the Steps tab, add each step and expected result that needs to be taken within the Test. Use Tab to
move from Step to Expected Result to the next row. New rows are automatically opened up as you
write your steps.
NOTE: Rich text is disabled by default for Test Steps. You can enable rich text on the Steps in Setup to
provide basic formatting, but rich text is NOT available when editing steps during a test run.
On the Steps tab, you will see a Test Selection panel on the right. This allows you to select an existing
Test and copy Steps into your new test. Use the Folder and Filter drop downs to navigate to any other
Test that you have created. If you have steps that you need to repeat for many tests, such as a login
routine, this makes it simple to grab and repeat:
Page 45 of 308
You can move the Test Selection panel out of the way by clicking the double-chevron in the light blue
bar.
In the Step Edit area, you can insert a step with the green plus symbol, delete a step with the red X,
and drag and drop steps into the desired order.
The Critical check box flags a step as one that must pass in order for the Test to pass. If a critical step
fails, the entire test fails.
Cancel closes out of the Steps without saving your changes. Save will save your work and let you con-
tinue working on this Test in Steps, Save/Add Another saves your Test and Steps and goes back to the
Add New form. Save and Exit saves your work and returns to the Test Library.
Page 46 of 308
Adding New Tests from a Recent Entries
Adding a test from a recent entry allows you to quickly create a duplicate test, then make any changes
you may need.
On the Test Management > Test Library page, click Add New.
At the top of the form there is the Auto-fill from Recent Entry drop-down list. Click the list to see tests
that you have recently created. You can select a test that is close to how you want the new test
defined.
The Auto-fill loads the Tests and Test Step fields on you new test, duplicating the selected test.
Make your edits to the new Test. When you click Submit, you will see that the Auto-fill has pre-filled
the Steps on the new test copies from the selected Auto-fill test. Make your adjustments and edits,
then Save.
Adding New Tests from Requirements
You can also create a test directly from a requirement.
Go to the Requirements > Show Requirements page and edit the desired requirement. On the Edit
form, look for the Add Linked Item icon on the toolbar.
Page 47 of 308
The Add Test form opens in a new window. The Title and Description are auto-filled from the Require-
ment.
The new test is automatically linked to the requirement, and you can use Submit/Add Another to keep
adding tests to the requirement.
Page 48 of 308
After creating tests through the requirement, return to the Test Management > Test Library page to
define the steps for your tests.
Creating Tokenized (Parameterized) Tests

If you have a manual test that needs to be repeated using different sets of values, you can create a
Tokenized Test. By using distinctly formatted TokenNames in Steps and Expected Results and an
attached CSV file of values, the Test Runner will build duplications of the test for each set of new val-
ues.
This allows you to repeat the test multiple times with different parameters, or input values. You can
create up to 30 TokenNames within a Test. Each TokenName will be replaced with a value from an
attached CSV file. The CSV file must also be in a specific format, with TokenNames in a header row and
values in each column (example below).
To create a Tokenized Test, go to the Test Management > Test Library page. Click Add New to create
the new Test.
When you are writing the Steps and Expected Results for the new Test, enclose the name of the Token
in square brackets. Include a question mark after the open bracket before the name. .
For example, if you want to create a token that represents your users’ First Names, it might look like
this:
[?FirstName]
Token Names can ONLY contain valid alpha/numeric characters and the underscore (no symbols,
spaces, extended or special characters).
Values for the Token Names must be in a plain text CSV file attached to the Test. The CSV file must con-
tain a column for each Token Name found in the test. The values in these columns will replace the
Token Names at run time.
Example: You want to enter a series of First Names, Last Names, and User Passwords in your Tokenized
Test.
When you create the Test, define the required Steps. In the Steps, use the formatted Token Name for
each of the values you want to pass in when you run the test.
Page 49 of 308
In the Step where the tester needs to enter specific First Names, use:
[?FirstName]
as the new token.
In the Step where the tester needs to enter specific Last Names, use:
[?LastName]
as the new token.
And in the step where the tester needs to enter the specific Password, use:
[?Password]
as the new token.
Your test will look something like this:
Page 50 of 308
Adding Token Values
After you define your Steps and Expected Results, click the Token Values tab. This tab provides the abil-
ity to upload a CSV file containing the actual values you want to use when running the Test.
About the Token Value CSV File
The CSV file must be in a specific format:
l Plain text, comma delimited
l All data enclosed in double quotes
l Columns separated by a Comma
l First row contains TOKEN NAMES (without the square bracket and question mark)
l Second and subsequent rows contain the VALUES that will replace the Token Names when running
the test
Example:
To pass values into a test with the three tokens [?FirstName], [?LastName], [?Password] the CSV file
would look like this:
"FirstName", "LastName", "Password"

"Ann", "Smith", "12345"
"Bob", "Brown", "b0b3&"
Page 51 of 308
"Carol", "Crump", "C$@ll"

"David", "Downer", "12345"
Notice that each value is enclosed in double quotes followed by a comma. There is a value for each
Token Name in each row. The Token Names are enclosed in double quotes in the first row of the file.
Attach the file to your Test
On the Token Values tab, you will see a list of the Tokens found in the Steps on the Test.
This allows you to double check your CSV file to make sure you have covered all the Tokens in the Test.
When you have the correct CSV file, click the Browse button, locate the file and attach it. Then click Sub-
mit to save your change.
Page 52 of 308
When uploading your CSV file, the upload verifies that there are no more than 30 Token columns. If
you attempt to upload a CSV file with more than 30 columns, you will see an error. Tokens are limited
to a maximum of 30 per Test.
The Delete button on the Token Values tab will delete the attached CSV file.
You do not need to provide a Token Value CSV File. If the Test Runner does not find the CSV file, or
does not find matching Tokens and Token Values, it simple displays the Token Name, allowing you to
fill in the values as you run the test.
Note: you cannot upload Token files to Automated Tests. Tokens are used for manual testing only.
Importing and Exporting Tests

Tests in your Test Library can be imported from a plain text CSV file. The Export offers CSV or XML
formats.
Importing Tests
The import process requires that your test data be in a plain text CSV file. Your file needs a header row
with the column names. The import will match up the column headers to field names, but you can also
change the mapping if required.
The CSV file must be formatted correctly in order to create the appropriate Steps within your Test.
There are two different CSV layouts that can be imported, controlled by a system setting: one where
each row represents a single test, with Steps in one cell, or one where each row represent a step within
a test. The default setting is for one row per step.
Page 53 of 308
Import Profile 1: Multiple Steps in one cell

If Test Steps are combined in one field, this import profile will identify line breaks in the field and create
separate Steps within the new Tests. If you are exporting Test from the Test Cases tab and importing
into Test Management – Test Library, this is the profile for you.
If your CSV file contains multiple steps in one cell, it might look something like this if you open it in a
spreadsheet application:
To import this file into your Test Library, go to the Test Management > Test Library page. Click the
Actions drop down and select Import Tests from CSV file.
Browse to your file and click Next Page. If your column headers match Test field names, the import will
map the column to the Field Name. Use the drop down under Field Name to map any columns that
were not automatically recognized. Verify the mapping, then click Import Now.
Page 54 of 308
The import breaks the single Step field into separate Steps.
Import Profile 2: One row per Step

The default import profile handles CSV files where each Test is represented in multiple rows, one row
for each Test Step within the Test. It is critical that all TEST level details match in order for the import to
recognize that these STEPS belong together. The import will combine matching TEST data (Test Title,
Test Description, and all other core Test fields) into one Test with multiple steps.
When using Import Profile 2, the import process reads the CSV rows in order. If consecutive rows have
the same Test Title, Test Description, and any other Test level data, the consecutive rows will be rolled
into one Test with multiple Steps.
Page 55 of 308
In this example, we’ve opened the CSV file in a spreadsheet application. The header row consists of
labels that match the corresponding fields in Tests and Test Steps.
As the import reads this example, it recognizes rows 2 through 8 belong together because the title and
all Test level details EXACTLY match from row to row. The Test related rows are combined into a single
Test, and the Steps are added to the Test.
The rows for each test must be consecutive. The import process goes through the rows in consecutive
order to match up the Tests and the appropriate Steps.
All Test data must match exactly. Any change in Test data (Title, Assigned To, Etc.) tells the import to
create the next Test.
When you select a CSV file to import, verify the fields are mapped the way you need them.
Switching Import Profiles

It is possible to switch the default profile if you prefer. Software as a Service customers can request a
change through our Support Team. Simply click on Help Center, then Submit a Support Ticket. Attach
an example of your CSV file so our support team can advise you on the best option.
Page 56 of 308
On-premises customers' Security Administrators can access this without going through support.
Please See "On-Premises Setup Options ".
Exporting Tests
When Exporting, use a Filter to select the Tests that you’d like to export, or select a specific Folder of
tests. The records selected by the current Filter or in the selected folder will be the records in your
exported CSV or XML file.
Export Tests XML

Export Tests to XML creates an XML formatted document of your test data.
There are two options when exporting Tests to XML format: (visible fields only) and (all fields). Both
exports will include all Step related data for the Test. Export (visible fields only) will include Test related
fields currently displayed on the Test Library Listing. Export (all fields) includes all Test related fields and
all Step related fields.
Export Tests (visible fields only)

Export Tests (visible fields only) creates a CSV file for your test data that includes the columns displayed
on the listing and all Step related data. Each Test is split into multiple rows: one row per Step within the
Test. Test related data is repeated per row. Steps and Expected Results are included.
Export Tests (all fields)

Export Tests (all fields) creates a CSV file for your test data that includes all Test related data and all
Step related data. Each Test is split into multiple rows: one row per Step within the Test. Test related
data is repeated per row. Step and Expected Results are included.
About Test Versioning

If you want to track all changes made to Tests in your Test Library, you can turn on Test Versioning.
Versioning stores a complete, historical copy of a Test as you make specific updates. You can review
Page 57 of 308
prior versions of your Tests. You can revert to any selected Version, should you want to use an earlier
version as your current Test.
Test Versioning Security
Test Versioning is controlled by security settings, like any other area. To enable Versioning, go to Setup
/ Security and click Manage Security Rights for the desired Security Group. Scroll down to the Test Man-
agement section and check the boxes related to Versioning.
Test Version Triggers
Any change to Steps and Expected Results will trigger a new Version of your Test. You can also flag
other fields to trigger a new Version.
Go to Setup > System Configuration and select Test Versioning (this only appears for users in a Secur-
ity Group with full permission to Versioning).
Select the fields that are critical to you and click Submit. Notice that your Test Library Custom Fields are
included in the selection, so if a change to a custom field should trigger a new version, you can select
those fields as well.
Steps and Expected Results do not display on the selectable fields, since changes to Steps and Expec-
ted Results always trigger a new version.
Page 58 of 308
Test Version Generation
In the Test Library, as you edit Tests, any changes to the fields selected in Setup will generate a new ver-
sion. Versions are automatically numbered in the “Version” field on the Test.
Go to the Versions tab to view Versions of the test.
Page 59 of 308
On the Versions tab, the current Version is designated with a green arrow.
Should you wish to roll back to a previous version, click the Roll Back icon.
Versions that have never been in a Test Run can be deleted by clicking the red X. The delete option will
not appear if the version has run history behind it.
Test Library Custom Fields

In the Test Library, like other entities, you can define Custom Fields to store special data. You can also
check a box on the Test Library Custom field, and your custom field data will display when the test is
run.
In the Test Library, click the Actions drop down and select Manage Custom Fields.
Page 60 of 308
This example shows two fields with the Show in Run? checkbox checked. The information in these two
fields will display when running your Test.
Note: Once custom fields are defined, they automatically display on the Add/Edit form. Note: The pos-
ition of the fields can be re-arranged in Setup / System Configuration / Screen Layouts.
Now, when you run the Test, whether from the Test Library or in a Test Set, your selected Custom
Fields display at the top:
Page 61 of 308
For more information on custom fields, See "Customizing the System to Your Needs"
About Automated Tests

Test Management's Automation feature allows you to run tests with little to no human interaction.
You can perform testing from remote computers as often as needed - for example, after a build or on a
daily schedule.
By using the QAComplete integration with various testing tools, you can fully track tests and test res-
ults across Test Management's manual and automated tests. You can run automated tests from the
desired computers and post results for full tracking of your testing coverage and progress.
Supported Automated Testing Tools
l SmartBear's TestComplete. For more information about TestComplete, please see TestComplete by
SmartBear.
Page 62 of 308
l SmartBear's Ready! API. For more information about Ready! API, please see Ready! API by
SmartBear.
l SmartBear's SoapUI. For more information on SoapUI, please see SoapUI by SmartBear.
l Selenium WebDriver for the following unit testing frameworks:

l JUnit
l TestNG
l NUnit
For more information about Selenium, please see Selenium - Web Browser Automation.
You can also automate the running of ordinary JUnit and NUnit unit tests (that do not use Selenium
modules).
Note: Starting with version 10.50, TestComplete supports integration with Selenium tests. In TestCom-
plete, you can run Selenium tests created by using JUnit, TestNG, NUnit, PyUnit, Ruby Test::Unit and
PHPUnit unit testing frameworks.
You can add your Selenium tests to your TestComplete project, and then integrate the project with
Test Management.
How Test Automation Works
l In your automated testing tool, create automated tests that will perform the needed actions to test
your application or feature.
l Pack your automated test files into a .zip archive. You can store the zipped test on a shared network
folder or web site. You can also upload the files directly to your Tests in the Test Library.
l Install and configure Test Agent on the test lab computers that will run your automated tests.
l In Test Management, associate your automated tests with Tests in the Test Library, whether point-
ing to the shared drive or uploading directly to the Test Library tests.
l In Test Management, you can also create Automation Schedules to run the automated tests on a
desired schedule, or submit the Tests to run on demand.
l When the Automated Tests run, the Test Agent on the Test Host:
l Connects to the QAComplete web service.
l Gets automated tests assigned to the test.
l Starts the needed automated testing tool on the Test Host.
l Runs the test.
Important: The Test Agent can be set to log off of Windows on the Host machine. This effectively
Page 63 of 308
closes any open applications, logs out, then logs back in with the credentials from the Test Agent
configuration. There is an option on the configuration form to first check if that user is currently
logged in, and avoid the log out process.
l After the test run is complete, results are posted to the Test and/or Test Sets in Test Management.
You can review the results on the Test Management Dashboards and in reports.
The Test Agent

The Test Agent is the communication tool between QAComplete's Test Management modules and
your automated testing tools. Currently, the following testing tools are supported:
l TestComplete (TestExecute) by SmartBear.
l Ready! API by SmartBear.
l SoapUI by SmartBear.
l Selenium WebDriver for the following unit testing frameworks:

l JUnit
l TestNG
l NUnit
The Test Agent needs to be installed and configured on each computer that will run automated tests
so that results are posted to Test Management. The Agent is also used for scheduled automation runs.
When you install the Test Agent on a Host machine, the Agent will automatically create a Test Host
record in Test Management.
Note: You can also use Selenium Test Agents to automate running of ordinary unit tests (that do not
use Selenium modules) created with JUnit, TestNG and NUnit unit testing frameworks.
Requirements
To install the Test Agent, your test machine must meet the following requirements:
l Have an active internet connection.
l To run TestComplete automated tests:

l TestComplete or TestExecute version 9.0 or later installed.
l To run automated API tests:

l Ready! API version 1.2.0 installed.
-- or --
l SoapUI version 5.1.2 installed.
Page 64 of 308
l To run tests with a Java unit testing framework:

l Java Runtime Environment (JRE) 5 - 8 installed.
l Appropriate Java unit testing framework, JUnit or TestNG, installed and configured.
l To run Selenium automated web tests created with an appropriate Java unit framework:
l Selenium WebDriver modules installed and configured in your JUnit or TestNG framework.
l If you want to use Maven to run tests:

l Maven 3.2.3 or later modules installed and configured.
l The PATH environment variable on the test machine must specify the path to the Maven
modules.
l To run tests with NUnit testing framework:

l NUnit unit testing framework installed.
l To run Selenium automated web tests created with NUnit:

l Selenium WebDriver modules installed and configured in NUnit framework.
Active Directory Authentication Restriction (On-Premises Only)
To register the Test Agent on a computer, do not use an account with Active Directory Authentication.
Use a non-Active Directory user account.
You can enable and disable Active Directory Authentication for a user in Setup > Security > Users in
QAComplete.
Default Ports
By default, the ports used by the Test Agent and related processes are:
l TestComplete (and TestExecute) license manager: Port 1947.
l For TestComplete and TestExecute Network Suite, the port depends on the product version:
l In TestComplete (and TestExecute) version 11: ports 6090-6092.
l In versions 10.20 - 10.60: ports 6020-6022.
l In versions 9.10 - 10.10: ports 6090-6092.
To find the ports used by Network Suite in TestComplete (or TestExecute), see the documentation
for your version of TestComplete (or TestExecute).
l Test Agent: Ports 80 and 443.
Page 65 of 308
Installing the Test Agent
l Download the Agent installation file:

l Log in to QAComplete.
l Go to the Test Management > Test Hosts page.
l Click Download Test Agent.
l Run the installation and follow the Installation Wizard instructions.
l On the Register Test Agent in QAComplete page of the wizard, register the agent in QAComplete.
l In the Web text box, enter the address of your QAComplete web service.
l For SaaS clients, the address is https://rest.qacomplete.smartbear.com/rest-api/service
l For On-Premise clients, the address is: http://[your server name]/rest-api/service (where [your
server name] is your QAComplete server).
l In the User and Password text boxes, enter the email address and the password that will be used to
log in to QAComplete account.
Note For On-Premises Only: You cannot register the Test Agent with an account that uses Active Dir-
ectory Authentication. Register the Test Agent using a non-Active Directory account.
l If a proxy server is used in your network, configure Test Agent to connect to the network through
that proxy server:
l Click Proxy Settings.
l In the Proxy Settings dialog, enter the network name or IP address, and the port of the proxy
server that Test Agent will use to connect to QAComplete. For example, 192.168.100.50:8888.
l If your proxy server requires user authentication, enter the name and password of the user
account under which you will connect to the proxy server.
l Click OK to close the dialog and continue installing Test Agent.
l Click Next to continue.
Page 66 of 308
l If the specified QAComplete account belongs to multiple departments (that is, this user sees a list of
departments when logging in), the Select Department page appears. Select the department whose
tests you want to run on this computer and click Next.
l On the Logon page of the installation wizard, enter the credentials of the user that will run your auto-
mated tests on this machine.
l In the User Name and Password text boxes, enter the name and the password of the user
account.
l Click Next to complete the installation.
After you install Test Agent on your test computer, the Agent will automatically add information about
the host computer to the Test Hosts screen in QAComplete's Test Management.
During the installation, Test Agent checks whether TestComplete or TestExecute is installed on the
Test Host computer. If any of them is, that information will appear in Agents field. JUnit (Selenium),
NUnit (Selenium), TestNG (Selenium), Ready! API / SoapUI tools are always considered as installed,
so Test Agent automatically adds information about them to the Agents field of the corresponding
Test Host without any checking.
You cannot run Selenium or Unit tests without initial configuration. For information on configuration
process, see Configuring the Test Agent.
Configuring the Test Agent
Once the Test Agent is installed on your test computer, you can check or modify the Agent con-
figuration.
Page 67 of 308
On your Test Host machine:
l Go to Start - All Programs - SmartBear - Test Agent - Test Agent Settings.
Configuring QAComplete Web Service Address

l In the Web Service URL field, enter the Address of the REST Service:
l For Software as a Service customers, the address is
l https://rest.qacomplete.smartbear.com/rest-api/service
l For On-Premises customers, the address must point to the Agent on your server
l http://[your server name]/rest-api/service
l To change the QAComplete login credentials, click Change and enter the email address and pass-
word to use to log in to your QAComplete account. Note: for security purposes, when you click
Change, you must enter new credentials.
l Click Submit.
Note: If the specified QAComplete account belongs to multiple departments, you will be prompted
to select a department to use this computer with.
Configuring Test Host Credentials

l To change login credentials to the Host machine, under Local User Credentials, enter the name and
password for the Windows user account that will run the automated test from this machine. If the
Page 68 of 308
account belongs to a domain, make sure to enter the domain name along with the user name ([my
domain/my domain user name]).
l Set the Use active session option by checking or unchecking the box.
l If checked: the Test Agent will check if the Local User is currently logged in to the Host machine.
If so, it will not perform the logout process. If this user is not logged in, the Agent will close any
open applications, log out of the Host machine, log in as the user specified here, run the test,
and log out.
l If not checked: the Test Agent will always close open applications on the Host machine, log out,
log in, run the test, and log out.
l Click OK to save your changes.
Configuring Test Agent to Run Selenium and Unit Tests with JUnit and TestNG
l To set paths needed to run tests with Java unit testing frameworks, click Advanced Settings.
l In the Advanced Settings dialog, open the Test Runners page.
l Enter the path to the Java Runtime executable (java.exe).

For example, if you have several Java versions installed, specify the path to the Java Runtime version
you will use to run tests.
l In the Java Class Path field, enter the path to the required framework library (junit-n.nn.jar or
testng-n.n.n.jar). (You can skip this step if you are going to use Maven to run tests).
l Click OK to save your changes.
Configuring Test Agent to Run Selenium and Unit Tests with NUnit
l To set the path needed to run tests with NUnit testing framework, click Advanced Settings.
l Enter the path to the NUnit executable (nunit-console.exe).
l Click OK to save the changes.
Configuring Test Agent to Run Ready! API/SoapUI Tests

l To set the path to the Ready! API or SoapUI test runner tool, click Advanced Settings.
l Enter the path to the test runner tool (testrunner.bat) that is installed with Ready!API or SoapUI.
By default, Test Agent will search for the test runner tool in the folder where Ready! API/SoapUI is
installed.
Page 69 of 308
Configuring Test Agent to Use Proxy

l To configure Test Agent to communicate with QAComplete Test Management modules through a
proxy server, click Advanced Settings.
l In the Advanced Settings dialog, open the Proxy Settings page.
l Select the Use Proxy for connection check box.
l In Proxy Address, enter the network name or IP address, and port of your proxy server. For
example, 192.168.100.50:8888.
l If your proxy server requires user authentication, enter the user name and the password of the user
account under which you will connect to the proxy server.
Configuring Test Agent to Send Usage Information

If you want to help us to improve Test Agent, please allow it to collect information on how you use
Test Agent and to send that information to SmartBear.
l In Test Agent Settings, click Advanced Settings.
l In the Advanced Settings dialog, open the Misc page.
l Select the Send usage data to help improve TestAgent check box.
If you permit data collection, Test Agent will collection information on how you use the product and
will send it to our server every time Test Agent closes or when an error occurs. SmartBear will not share
the collected information with any third-parties.
Test Agent will not collect any personal information, like password, logins and other sensitive inform-
ation.
Information on how you work with our product will help us to understand how we can improve it.
About Test Hosts

A Test Host is a computer that runs your automated tests. Each Test Host must have a supported auto-
mated testing tool and the Test Agent installed and configured.
Once the Test Agent is installed and configured on your Test Host, information about the computer is
automatically relayed to Test Management as a new Test Host. You can view the list of Test Hosts from
Test Management / Test Hosts.
Other than the Test Host Description and Notes, you cannot add nor edit Test Hosts from within Test
Management. The Test Agent provides all information about the Test Host directly to QAComplete
when the Test Agent is configured on the machine.
Page 70 of 308
Note: it is important to ensure that any dependent libraries, data for data driven tests, etc. exist on the
appropriate Hosts so that your automated test can locate all necessary pieces to run successfully.
To include automated test results on Test Management reports that are filtered by Configurations, link
your Hosts to the appropriate configuration.
l Open your Test Host record
l Click Show Linked Items or scroll to the bottom of the form
l Click Link to Items
l Configurations should be selected in the Select Item Type
l Click the drop down in Select Item Title and check the Configurations that you want associated with
the Test Host.
l Click Close, then click Submit.
l Click Submit to close the edit Test Host form.
Note: Only one Configuration will be used for reporting, so match one Test Host to one Configuration.
Configuring Virtual Machine Hosts
If you run your TestComplete automated tests on a virtual machine, we recommend that you disable
automatic log opening after test runs to improve performance.
l If you have TestComplete, select Tools | Options from the main menu.
l If you have TestExecute, right-click the TestExecute icon in the notification area and select Options.
Page 71 of 308
l In the dialog that opens, select Engines | Log.
l Clear the Activate after test run check box and click OK.
Creating Automated Tests

In the Test Library, you create Automated Tests by assigning automated or unit tests created with one
of the supported testing tools or frameworks to your Tests.
Learn how to assign the following test types to your Test Library Tests:
l TestComplete Tests
l Ready! API and SoapUI Tests
l JUnit Tests and Selenium JUnit Tests
l TestNG Tests and Selenium TestNG Tests
l NUnit Tests and Selenium NUnit Tests
When you associate an automated (or unit) test with the Test, Test Management automatically recog-
nizes that the Test is Automated and selects the Automated check box. You can use the choice list for
Execution Type to also designate a test as Automated, or modify the Execution Type choice list values
for anything that is meaningful to you.
Note: When running Automated Tests, any Steps that may be on the Test are ignored.
To run your Automated Test on demand, please see Running Automated Tests.
To Schedule your Automated Test to run automatically, please see Scheduling Automated Tests.
Assigning TestComplete Tests to Tests
1. Prepare Your TestComplete Project Suite

l Create tests in your TestComplete project.
l Create and organize test items that will run those tests.
l If needed, zip up your TestComplete project suite. Include all files and folders that belong to the pro-
ject suite.
l Make note of where the project suite or the archive (zip) file resides.
You can place the project suite or the archive on a local folder on the test host where it will run or in
a shared network folder. Make sure that the project suite can access all need test files.
Alternatively, you can upload the archive to the server (see below).
Page 72 of 308
2. Prepare Your Test Library Test

l In Test Library, open an existing Test for the TestComplete project suite or add a new Test.
l Select a Default Host Name. If you skip this step, after you assign an automated test and click Sub-
mit, the system will remind you that the Test Host is missing.
l Save the changes.
3. Assign TestComplete Test to the Test

l On the Automations tab, click Add New to add an automated Test.
l In the Agent drop-down list, select TestComplete/TestExecute.
l You can leave the Title blank, and the system will use the name of the specified TestComplete file, or
you can enter a meaningful Title.
l Enter a time out value in seconds. If the test takes longer than the given time out, the test runner
will stop running.
l The Test Runner passes the timeout value to TestComplete/TestExecute as a run parameter.
The minimum value is 30 seconds: if you specify a lower value, it still uses 30 seconds. If the test
takes longer than the specified time out, it will log an error and end. For more information
about how TestComplete uses the time out, please see TestComplete Command Line.
l In Url, UNC or local path, enter the path to your TestComplete project suite or to the archive (zip)
that contains the project suite.
The path format depends on the project suite location. Below are examples of possible values:
Page 73 of 308
Value Description
C:\MyTests\MyProjectSuite.pjs A project suite (.pjs) residing in the
-- or -- local folder on the test host.
file:///C:\MyTests\MyProjectSuite.pjs
C:\MyTests\ A local folder on the test host where
-- or -- a project suite resides.
file:///C:\MyTests\ Note: if there is more than one pro-
ject suite in the folder, an error will
occur.
C:\MyTests\MyProjectSuite.zip An archive (zip) file that contains
-- or -- the project suite and resides in a
file:///C:\MyTests\MyProjectSuite.zip local folder on the test host.
\\Tests-PC\SharedFolder\MyProjectSuite.pjs A project suite (.pjs) residing in a
-- or -- shared folder on a computer in
file:///Tests-PC\SharedFolder\MyProjectSuite.pjs your network.
\\Tests-PC\SharedFolder\ A shared network folder where the
-- or -- project suite resides.
file:///Tests-PC\SharedFolder\ Note: if there is more than one pro-
ject suite in the folder, an error will
occur.
\\Tests-PC\SharedFolder\MyProjectSuite.zip An archive (zip) file that contains
-- or -- the project suite and resides in a
file:///Tests-PC\SharedFolder\MyProjectSuite.zip shared network folder.
http://downloads/mytests.com/MyProjectSuite.zip A web site URL path to the archive
(zip) file that contains the project
suite.
Note: If path you enter is incorrectly formatted, QAComplete will highlight the path in red.
l Or, simply use File Attachments to upload the archive (zip) file that contains the project suite. Click
Browse and navigate to the zipped file.
l The Run Mode specifies how the test agent will get your TestComplete test files and run the test.
l To copy test files to the test host and run the test in a temporary folder there, choose Copy the
test project to and run it in a temporary folder in the Run Mode drop-down list.
If the Url, UNC or local path specifies the UNC path to a project suite file (.pjs), all the contents
Page 74 of 308
of the folder where the project suite file resides will be copied to the test host.
l To run the test directly in the folder where the test files reside, choose Run the test project in
place (if possible) from the Run Mode drop-down list. If the test files reside in a shared net-
work folder or in a local folder on the test host, the test agent will run the test directly in that
folder.
l The Entry Point is used if you want to run a portion of your TestComplete project suite:
l To run the entire project suite, leave Entry Point blank.
l To run a specific project within the project suite, enter the project name.
l To run a specific keyword test, script or project item, enter the path to the item.
Below are examples of possible Entry Point values:
Value Description
(no value) All test items in all projects in the project suite.
TestProject1 All test items in the TestProject1 project.
TestProject1\KeywordTests\Test1 The Test1 keyword test in the TestProject1 project.
TestProject1\Script\Unit1\Test1 The Test1 script routine in the Unit1 script unit of the
MyProject project.
l In the Custom Args field, you can enter custom command line parameters to pass to TestComplete
(TestExecute).
l Click Submit.
Assigning Ready! API and SoapUI Tests to Tests
1. (Optional) Configure the Test Agent

On the Test Host that will run the test:
l Launch the Test Agent Settings tool (Start | All Programs | SmartBear | TestAgent | Test Agent Set-
tings).
l Click Advanced Settings.
l If needed, specify the path to the test runner tool (testrunner.bat) that will run the API tests.
The tool is installed with Ready! API or SoapUI and resides in the folder where Ready! API or SoapUI
is installed.
Page 75 of 308
2. Prepare Your API Test

l If needed, zip up your API test project.
l Make note of where the project or the zipped project resides.

You can place the project or zipped project in a local folder on the test host machine that will run the
project or in a shared network folder.
Alternatively, you can upload the project or an archive to the server (see below).

l In Test Library, open an existing Test for the Ready! API or SoapUI test or add a new Test.
l Save the changes.
4. Assign the API Test to the Test

l On the Automations tab, click Add New to add an automated test.
Page 76 of 308
l In the Agent drop-down list, select Ready! API / SoapUI.

Note: If the Default Host assigned to the Test does not support the selected automated testing tool,
the test will not run.
l You can leave the Title blank, and the system will use the name of the attached test, or you can
enter a meaningful Title.
l Enter a time out value in seconds. If the test takes longer than the given time out, the test runner
will stop running.
l To run a specific test suite in your project, enter its name in Test Suite. For example, Simple
TestSuite.
l To run a specific test case in your project, enter its name in Test Case. For example, Search
TestCase.
l In Report Type, choose the format for exporting the test results report. If you use SoapUI Free to
run API tests, choose No Report.
l In Custom Args, enter additional command line arguments to pass to the testrunner tool that will
run your test. You can find information on command line arguments in the Ready! API or SoapUI
documentation.
l In Url, UNC or local path, enter the path to your Ready! API or SoapUI project (.xml) or to the
archive (.zip) that contains your project.
Below are examples of possible paths:
Value Description
C:\MyTests\MySOAPProject.xml A project (.xml) residing in the local
-- or -- folder on the test host.
file:///C:\MyTests\MySOAPProject.xml
C:\MyTests\ A local folder on the test host
-- or -- where the project to run resides.
file:///C:\MyTests\ Note: If there is more than one pro-
ject in the specified folder, an error
will occur.
C:\My Tests\MySOAPProject.zip The archive (zip) file that contains
-- or -- the project, and resides in a local
file:///C:\My Tests\MySOAPProject.zip folder on the test host.
\\Tests-PC\SharedFolder\MySOAPProject.xml A project (.xml) residing in a shared
Page 77 of 308
Value Description
-- or -- folder on a computer in your net-
file:///Tests-PC\SharedFolder\MySOAPProject.xml work.
-- or -- project resides.
file:///Tests-PC\SharedFolder\ Note: If there is more than one pro-
ject in the folder, an error will
occur.
\\Tests-PC\SharedFolder\MySOAPProject.zip The archive (zip) file that contains
-- or -- the project, and resides in a shared
file:///Tests-PC\SharedFolder\MySOAPProject.zip network folder.
http://downloads/mytests.com/MySOAPProject.zip A web site URL path to the archive
(zip) file that contains the project.
l Or, simply upload your project or zipped file using File Attachments. Click Browse and navigate to
the desired file.
l The Run Mode specifies how the test agent will get your test files and run the test.
folder.
l Click Submit.
Assigning Selenium JUnit and JUnit Unit Tests to Tests
Important: You can use JUnit (Selenium) Test Agent to automate running of both Selenium JUnit tests
and ordinary JUnit unit tests that do not use Selenium modules. The procedure of assigning tests to
Test Library Tests is the same for both test types.
This instruction demonstrates how to assign a Selenium JUnit tests to a Test Library Test. Use the same
procedure to assign an ordinary JUnit unit test to a Test.
1. Configure the Test Agent

Page 78 of 308
tings).
l If needed, specify the path to the Java Runtime executable (java.exe). For example, if you have sev-
eral Java versions installed, specify the path to the Java Runtime version you will use to run tests.
l Specify the path to the junit-n.nn.jar file location (you can skip this step if you use Maven to run
tests).
2. Prepare your Selenium WebDriver Test

l If needed, zip up the folder where your Selenium WebDriver tests created with JUnit reside.
l Make note of where the test files or archive (zip) file reside.
You can place the test files (or the zip file that contains the test files) in a local folder on the test host
where the tests will run or in a shared network folder.
Alternatively, you can upload the archive file to the server (see below).

l In Test Library, open an existing Test for the Selenium WebDriver test or add a new Test.
l Save the changes.
Page 79 of 308
4. Assign Selenium WebDriver Test to the Test

l In the Agent drop-down list, select JUnit (Selenium).

l You can leave the Title blank, and the system will use the name of the attached Selenium test, or
l The Timeout tells the Test Runner how long to let the test run. Enter the time out value in seconds.
If the test takes longer than the given time out, the test runner will stop running.
l In Url, UNC or local path, enter the path to the folder where your Selenium WebDriver test files
reside or to the archive (.zip) that contains the test files.
Below are examples of possible paths:
Value Description
C:\MyJUnitTests\ A local folder on the test host where
-- or -- tests reside.
file:///C:\MyJUNitTests\
Page 80 of 308
Value Description
C:\MyJUnitTests\MyJUnitTest.zip The archive (zip) file that contains the
-- or -- test files and resides in a local folder on
file:///C:\MyJUnitTests\MyJUnitTest.zip the test host.
\\Tests-PC\SharedFolder\ A shared network folder where tests
-- or -- reside.
file:///Tests-PC\SharedFolder\
\\Tests-PC\SharedFolder\MyJUnitTest.zip The archive (zip) file that contains the
-- or -- tests and resides in a shared network
file:///Tests-PC\SharedFolder\MyJUnitTest.zip folder.
http://downloads/mytests.com/MyJUnitTest.zip A web site URL path to the archive (zip)
file that contains the test files.
l Alternately, upload your zipped file using File Attachments. Click Browse and navigate to the zipped
test files.
folder.
l If you want to run your Selenium test by using Maven, select Use Maven Project.
l Enter the test case class name in Test Class field.

If you use Maven to run tests, you can leave the field empty to run all test cases defined in your Sel-
enium test.
l Click Submit.
Assigning Selenium TestNG Tests to Tests
Important: You can use TestNG (Selenium) Test Agent to automate running of both Selenium TestNG
tests and ordinary TestNG unit tests that do not use Selenium modules. The procedure of assigning
tests to Test Library Tests is the same for both test types.
Page 81 of 308
This instruction demonstrates how to assign a Selenium TestNG tests to a Test Library Test. Use the
same procedure to assign an ordinary TestNG unit test to a Test.

tings).
l If needed, specify the path to the Java Runtime executable (java.exe). For example, if you have sev-
eral Java versions installed, specify the path to the Java Runtime version you will use to run tests.
l Specify the path to the testng-n.n.n.jar file location (you can skip this step if you will use Maven to
run tests).
2. Prepare your Selenium WebDriver Test

l If needed, zip up the folder where your Selenium WebDriver tests created with TestNG reside.
l Make note of where the test files or the archive (zip) file reside.
You can place the test files or the archive file on a local folder on the test host where the tests will
run or in a shared network folder.
Alternatively, you can upload the archive to the server (see below).

l In Test Library, open an existing Test for the Selenium WebDriver test or add a new Test.
l Save the changes.
Page 82 of 308
4. Assign Selenium WebDriver Test to the Test

l On the Automation tab, click Add New to add an automated test.
l In the Agent drop-down list, select TestNG (Selenium).

l In Url, UNC or local path, enter the path to the folder where your TestNG test files reside or to the
archive (zip) file that contains the test files.
Below are examples of possible path values:
Value Description
C:\MyTestNGTests\ A local folder on the test host where
-- or -- tests reside.
file:///C:\MyTestNGTests\
C:\MyJUnitTests\MyTestNGTest.zip The archive (zip) file that contains
-- or -- the test files and resides in a local
Page 83 of 308
Value Description
file:///C:\MyJUnitTests\MyTestNGTest.zip folder on the test host.
\\Tests-PC\SharedFolder\ A shared network folder where tests
-- or -- reside.
file:///Tests-PC\SharedFolder\
\Tests-PC\SharedFolder\MyTestNGTest.zip The archive (zip) file that contains
-- or -- the tests and resides in a shared net-
file:///Tests-PC\SharedFolder\MyTestNGTest.zip work folder.
http://downloads/mytests.com/MyTestNGTest.zip A web site URL path to the archive
(zip) file that contains the tests files.
l Alternately, upload your zipped file using File Attachments. Click Browse and navigate to the zipped
test files.
folder.
l If you want to run your test by using Maven, select Use Maven Project.
l Enter the test case class name in Test Class.

If you use Maven to run tests, you can leave the field empty to run all test cases defined in your Sel-
enium test.
l Click Submit.
Assigning Selenium NUnit Tests to Tests
Important: You can use NUnit (Selenium) Test Agent to automate running of both Selenium NUnit
tests and ordinary NUnit unit tests that do not use Selenium modules. The procedure of assigning
tests to Test Library Tests is the same for both test types.
This instruction demonstrates how to assign a Selenium NUnit tests to a Test Library Test. Use the
same procedure to assign an ordinary NUnit unit test to a Test.
Page 84 of 308

tings).
l If needed, specify the path to the NUnit executable (nunit-console.exe).
2. Prepare Your Selenium NUnit Test

l If needed, zip up your Selenium NUnit test project (together will all libraries and files the project
uses).
l Make note of where the project or the archive (zip file) resides.
You can place the project (or the zip file containing the project) on a local folder on the test host
where it will run or in a shared network folder. Make sure that the project can access all need test
files.
Alternatively, you can upload the archive file to the server (see below).

l In Test Library, open an existing Test for the NUnit test or add a new Test.
l Save the changes.
Page 85 of 308
4. Assign Selenium NUnit Test to the Test

l In the Agent drop-down list, select NUnit (Selenium).

l In Url, UNC or local path, enter the path to your NUnit project (.nunit) or to the archive (.zip) that
contains your project.
Below are examples of possible values:
Value Description
C:\MyTests\MyNUnitTest.nunit The NUnit project (.nunit) residing in
-- or -- the local folder on the test host.
file:///C:\MyTests\MyNUnitTest.nunit
C:\MyTests\ The local folder on the test host where
Page 86 of 308
Value Description
-- or -- the NUnit project resides.
file:///C:\MyTests\ Note: If there is more than one pro-
ject in the folder, an error will occur.
C:\MyTests\MyNUnitTest.zip The archive (zip) file that contains the
-- or -- NUnit project and resides in a local
file:///C:\MyTests\MyNUnitTest.zip folder on the test host.
\\Tests-PC\SharedFolder\MyNUnitTest.nunit The NUnit project (.nunit) residing in a
-- or -- shared folder on a computer in your
file:///Tests-PC\SharedFolder\MyNUnitTest.nunit network.
-- or -- NUnit project resides.
file:///Tests-PC\SharedFolder\ Note: if there is more than one project
in the folder, an error will occur.
\\Tests-PC\SharedFolder\MyNUnitTest.zip The archive (zip) file that contains the
-- or -- NUnit project and resides in a shared
file:///Tests-PC\SharedFolder\MyNUnitTest.zip network folder.
http://downloads/mytests.com/MyNUnitTest.zip A web site URL path to the archive
(zip) file that contains the NUnit pro-
ject.
l Alternately, upload your zipped files using File Attachments. Click Browse and navigate to the
zipped Selenium test files.
l The Run Mode specifies how the test agent will get your Selenium test files and run the test.
folder.
l To run a specific test case, test fixture or a namespace, enter its full name in Test Case, Test Fixture
or Namespace.
l Click Submit.
Page 87 of 308
Scheduling Automated Tests
You can configure Automated Tests or Test Sets to run independently of any user interaction by put-
ting them on a Test Schedule. The Schedule can be a one-time scheduled run, or it can be a recurring
schedule repeated on specific days of the week.
Select Test Management > Test Schedules.
On the Test Schedules listing form, click Add New to create a new schedule.
On the Add Test Schedule form, enter the information for the new schedule.
l In Title, give the schedule a meaningful title.
l In Run On, choose the days of the week to run the Automated Test.
l In Start Time, select the hour of the day when you want the Automated Test to run.
l Use the Start Date and End Date to define the date range that the schedule will be active. The sched-
ule won't run until your start date, then will run as scheduled until the end date.
l In the Agent list, select an automated testing tool you want to use to run tests:
l TestComplete/TestExecute
l Ready! API/SoapUI
l JUnit (Selenium)
Page 88 of 308
l TestNG (Selenium)
l NUnit (Selenium)
l In the Hosts list, select the Test Host that will run the automated test. The list is populated with the
machines where the Test Agent is installed and running. For more information on Test Agents and
Hosts, please see About Test Hosts and The Test Agent.
l In Items to Run, link your Automated Tests or Test Sets. These Tests or Test Sets will run on the Test
Host in the order of selection.
Click Submit to save the schedule. At the scheduled time, the Test Agent will kick off the associated
Test or Test Set on the Test Host selected for the Schedule.
Note: If the Tests are associated with a Test Host, the Host on the Schedule takes precedence: your
test run on the Test Host on the Schedule, not the Host associated with the Test in the Test Library.
Test Sets
Use Test Sets to organize tests from the Test Library into groups.
Once you have your tests defined in the library and your configurations defined, start building your
test sets:
l Go to the Test Management > Test Sets page. It shows the list of test sets.
l On the left navigation panel, select a release and sprint on the Releases tab. The test set will be asso-
ciated with the selected release automatically.
l If needed, select a folder on the Folders tab. The test set will be added to that folder.
Page 89 of 308
l Click Add New.
l Create a Title, select a Status and enter a description for your test set.
l If the tests in this set must be run in sequential order, select the Check if all tests in this set must
be run in sequential order check box. The Test Runner will process the tests only in the defined
order.
l Click Submit.
A form where you select and sequence tests that belong in the created test set will be opened.
On the right, use the Folder and Filter drop-down lists to navigate to the desired tests, then drag and
drop them into the test set.
Page 90 of 308
You can re-sequence the tests, remove them with the unlink icon, and mark them as critical with the
Stop on Failure check box. If this box is checked and the test fails during a run, the rest of the tests will
be blocked. The Is Active check box allows you to temporarily exclude a test from being included when
running the test set.
You can change the Assigned To by clicking the user name. A drop-down list of team members
appears:
Page 91 of 308
Note: Assigned To is not a required field. This is for reference only. All team members with access to
test sets can run a set, and the Test Runner will record who actually ran the test within the set.
If you are missing a test, click Add New Test – you can add tests to the library on the fly and include
them in the test set.
You can add the same test multiple times, which allows you to repeat a test within the test run.
Click Save and Exit to save the changed to the test set and return to the Test Set list. Click Save to save
the changes and continue working with the test set.
To close the form without saving your changes, click Cancel.
Linking Test Sets
Test sets can be associated with Releases, Configurations and other items.
To link a test set, open it, click Link to Items, and select the desired item type and items.
Page 92 of 308
Make your selections, Close and then Submit. Your selected items will be linked to the test set.
Once linked, you can run the test set against any linked release using any linked configuration.
Test Set Listing
As you build your test sets, they appear on the Test Set listing. Information on the listing can also tell
you how many tests are in the set and how many times the test set has been run.
Click on the number in the Run History or Tests column and you’ll go directly to that tab on the Edit
Test Set form.
Page 93 of 308
Editing a Test Set
Once defined, you can make changes to your test set by clicking on the desired test set. The set opens
up in Edit mode, so you can make changes. You can also change the tests within the set from the Tests
tab.
Click Add or Edit Tests at the bottom of the Tests tab:
Note: If the test set has an incomplete Run pending, the tests in the open Run are not changed.
Changes to the test set will be in effect for the next Test Set Run.
After clicking Add or Edit Tests, you can make changes to the sequence, add or remove test from the
set, and modify the Assignee on the test within the set.
Page 94 of 308
Deleting a Test Set
Should you no longer need a particular test set, you can open the set to edit it and click Delete. If the
test set has any Run History associated with it, the delete is a “soft delete” – the test set is marked
Inactive and can only be seen on the Test Set list by clicking the Actions and checking the Show Inact-
ive Test Sets box.
Configurations
You may need to repeat the exact same test or test set under various configurations. For example, if
building a web application, you will want to repeat your tests using different browsers. Desktop applic-
ations may need to be tested under several different operating systems, or it may be a combination of
both.
Use configurations to define the variety of environments you will use to repeat your testing.
Go to the Test Management > Configurations page. It shows the configuration list.
Page 95 of 308
Click Add New to create your configurations. In this example, we’ve defined multiple configurations
for the desktop operating system and browser combinations.
For automated tests and test sets, you can associate a configuration with a test host for reporting pur-
poses. See See "About Test Hosts".
Running Tests
You can run tests directly from the Test Library, or you can run your test sets.
Running Single Tests from the Test Library
If running a single test directly from the Test Library is allowed, you will see a Run Now icon in the
Actions column.
The Test Runner window opens up.
Page 96 of 308
If your test is linked to a release, select the Release. You can select any Iteration or Build below the
linked Release.
Then, if your test is linked to configurations, select the Configuration. If you have no links on the Test –
or only one Release – you will go directly to the Run Test form.
Click Run.
Click the Run icon to run your test.
Page 97 of 308
Running Test Sets
On the list of Test Sets, there is a blue Run Now icon.
When you click Run Now, the Test Runner grabs a snapshot of the tests in the set and prepares the
Test Run.
The Test Runner opens up in a new, sizeable window.
Select the Release first. If the Test Set is linked to Configurations, check the boxes for the desired Con-
figurations.
Click Run to start the Test Runner.
If the test set is associated with only one – or no – Release and Configuration, it will skip this step and
continue to the Test Runner.
If the test set is linked to multiple configurations, you can select on or more. The Test Runner will open
a separate window for each configuration.
Page 98 of 308
Note: The Test Runner takes a 'snapshot' of the tests and test sets as they exist when you click Run.
This means if you edit the test or test set after starting a run - but not finishing the run - the active run
has only what it saw when you started it. You won't see changes until the run is completed and you
start the next run.
Running Manual Tests

When you run a Manual Test or Test Set, you will see the Test in the Test Runner form. Tests in a Set
are in sequential order.
The Assigned To column is a drop down choice list of team members that can be changed.
Note: When you start a Test Run, the Test Runner takes a snapshot of the tests within the run. Should
another team member change any test included in the run, the new changes do not affect the run in
progress.
When you start your first Test in the Set, the Runner starts a timer to track the time it takes to run
each test. This becomes part of the test run history. The Test Set Progress bar shows the percent com-
plete for the tests within the test set. The Pause button at the bottom allows you to stop and restart
the timer.
Recording Actual Results
As you progress through each Step on the Tests, enter your Actual Results. Each step has a pass icon
and a fail icon so you can pass / fail as you proceed through each step.
Page 99 of 308
The buttons at the bottom also allow you to Pass or Fail an individual step. Pass All Steps marks all
steps Passed. Fail All Steps marks all steps Failed.
Once the steps are completed, click Next Test to continue to the next Test in the Test Run or to com-
plete the run.
Ending or Pausing a Test Run
A Test Run can be Paused or completely Ended using the End Run dialog.
l Pause the run to continue at a later time or hand the run to another team member to complete.
l End the run to quickly mark all incomplete tests as Passed, Failed or Incomplete. If you end the run,
all items in the run are considered finished.
Use the PAUSE options if you will be completing this test at another time.
To Pause the run, click the End Run button. The End Run dialog appears.
Page 100 of 308

IMPORTANT: If you select any of the END options on the End Run form, the test run is COMPLETED
and cannot be continued. This effectively FINISHES the run of the Test or Test Set. Use this with cau-
tion.
l Pause - The Test Set Run is Paused and Last Run Status on the Set is In Progress. You can continue
the Test Set Run from the Test Set / Run History tab.
l Pause and mark Blocked - The Test Set Run is paused and Last Run Status on the Set is Blocked.
Tests that are not completed or not started yet are marked Blocked. Steps within the blocked Tests
that have not been passed or failed remain Awaiting Run. You can continue the Test Set Run from
the Test Set / Run History tab.
l End as Passed – The Test Run is ended. Any Tests that were not run are marked Passed in the Run
History. The Last Run Status on the Test Run depends on the status of the individual tests in the
run: if all Pass, the Test Run is passed; if any Fail, the Test Run is Failed.
Page 101 of 308

l End as Failed – The Test Run is ended. Any Tests that were not run are marked Failed in the Run His-
tory. The Last Run Status on the Test Run is Failed.
l End as Incomplete – The Test Run is ended. The Last Run Status on the Test Set is Incomplete. Any
Tests that were not completed are marked Skipped. Steps within the skipped Tests that have not
been passed or failed are marked Skipped.
Continuing a Paused Test Run
If you ended a test run and marked it either Paused or Paused and Blocked, you or another team mem-
ber can continue the run from the Test Set - Run History tab. On the Test Listing grid, click the number
in the Run History column to go directly to the Run History tab on the set. If the Test Run can be con-
tinued, you will see the Run Now icon.
Continue by clicking the Run Test icon for the Test on the Run History tab.
Automatically Creating a Defect from a Failed Test
When a Test Step in the Test Run is failed, you have the option to automatically create a linked Defect.
If you failed any step, when you click Next Test, the Auto Create Defect dialog appears.
Page 102 of 308

The Auto Create Defect message appears. Select the desired action:
Do not automatically create defects for this Test Run: Do not create a Defect. Any failed
test during the rest of this run will not auto-create a defect.
Never automatically create defects for any Test Run: Do not create a Defect. Turn off
the automatic creation of defects across all test runs for the current user. This can be
turned on or off in Setup > System Configuration > System Options under Your Personal
Preferences.
Yes: Create a new Defect and open the Defect add form.
No: Do not create a defect. Continue the Test Run.
If you selected Yes, the new Defect opens up in an Add Defect form. You can make changes to the
Defect so that all details are ready for your team to address.
Page 103 of 308

Steps to Reproduce on the Defect will default to the Step, Step Status and Expected Result of the Steps
within the failed Test.
At the bottom of the Add Defect form, you’ll see that Auto Create Defect has also automatically linked
this Defect to the Test, the Test Set, and the Release.
Click Submit when the Defect is complete. If you need to create multiple defects linked to the Test,
click Submit and Add Another. Each Defect created will be automatically linked to the Test, the Test
Set and the Release.
Editing Test Steps During a Test Run
Based on a security setting, you may be able to edit the test steps during a test run.
If your security group does not have permission to edit tests during a run, the test runner does not dis-
play the editing icons:
Page 104 of 308

Team members with permission to edit steps during the run will see an Actions column:
Page 105 of 308

Use the Actions column to make changes on the fly to the steps in the run. Click the edit icon, and the
step opens in an Edit Step window.
Page 106 of 308

You can make adjustments to the Step and Expected result and click OK.
If you made changes to the Steps, you can push your changes to the Test in the Test Library. When
you click Next Test, a dialog pops up asking “Do you want to update the Test Library with your
changes?”
Click Yes, and the changes you made will be made to the original Test in the Test Library. Click No, and
the changes you made are recorded as part of this test run only and will not affect the original Test.
NOTE: Rich text is not available when editing Test Steps during a Test Run. If you use any formatting in
Steps, consider carefully if you want to update the library: you will lose the formatting.
Page 107 of 308

Running a Tokenized Test

Add your Tokenized Test to a Test Set as you would any other Test. When you run the Test Set, the
Test Runner automatically replaces the Token Names in the Steps with the corresponding values from
the attached CSV file.
The Test is duplicated within the Test Runner for each row of values found in the associated Token
Value CSV file. In this example, we have four user log ins that we want to test.
Click the Run icon on the first test.
The Test Runner displays the values that you set up to use when running the test the first time (the
first row of data in the CSV file):
Page 108 of 308

Step through your Test Run, posting your Pass/Fail and actual Results. When you click Next Test, the
next test will display the values from the next row in your Token Value CSV file.
Missing Token Values

If your Test has Tokens defined in the Steps or Expected Results, but you do not have a Token Value
CSV file attached, you can still run the Test.
Instead of replacing the Token Names with values, you will see the formatted Token Names during the
Test Run. It is up to you to edit the Test Step and manually enter the desired Value as you run the test.
Page 109 of 308

Note: Tokenized Tests can be edited during the Test Run, but changes will NOT be updated to the Test
Library.
If a Tokenized Test is missing a CSV file, or if the CSV file is missing values for Token Names, this does
not prevent you from adding the Test to a Set and running the Test. We recommend you edit the
Steps during the run to document the values used at run time.
Only one Token Value CSV file can be attached to a Test. You can remove the CSV file from the Token
Values tab and re-upload if changes need to be made.
TokenNames must be plain alpha/numeric text only (no punctuation, no extended characters).
If any Step or Expected Result on a Test has a TokenName (in the format [?tokenname]), the test is
flagged as a Tokenized Test in a system controlled checkbox field called ‘Is Tokenized?’. This allows you
to filter and sort for Tokenized Tests in the Test Library.
Running Automated Tests

Now that you have installed and configured the Test Agent, linked it to a Configuration, associated an
automated test with a Test Management Test and Test Host, you can run the Automated Test on
demand from Test Management. Automated Tests and fully automated Test Sets can also be run unat-
tended by using Test Schedules.
Page 110 of 308

Like Manual Tests, you can run the Test directly from the Test Library or you can run the Test as part of
a Test Set. Tests or Test Sets can be linked to the desired Release, Release/Iteration or Release/Iter-
ation/Build and to the desired Configurations (for more information about Releases, please see About
Releases. For more information on Configurations, please see Configurations.
l To run the Test as part of a Test Set, create a Test Set and add your automated Test to the Set. Click
the Run button in the Actions column on the Test Set List.
l The Test Set can be linked to your Release, Iteration or Build.
l To run the Test independently of a Test Set, you can click the Run button in the Actions column on
the Test Library List.
l A Test can also be linked to a Release, Iteration or Build.
The Test Runner window opens. If the Test or Test Set is linked to a Release, select the desired Release
First. Select the Test Host in the Run By Host drop down, and click Run.
Your tests will run immediately on the associated Test Host. The Test Agent on the selected Test Host
will perform the following steps:
l Connect to the QAComplete web service.
l Retrieve the automated tests associated with the Test.
l Start the appropriate automated testing tool (TestComplete/TestExecute, Ready! API, SoapUI or a
unit testing framework).
l Run the automated test.
When complete, the results are posted as Run Results to the Test and/or Test Set.
Important Notes:
l If you assign TestComplete automated tests to your Tests in Test Management, TestComplete or
TestExecute must NOT be actively running on the Test Host when the Automated Test is run. Other-
wise, the test will return an error. TestComplete/TestExecute will be automatically started up by the
test runner.
l If the required testing tool is not installed on the Test Host or the Test Agent is not configured prop-
erly to run that testing tool, the test will fail.
l If your Test Host has an earlier version of Test Agent that does not support the assigned automated
test, the test will not run.
l The Test Agent can be set to log off of Windows on the Host machine. This effectively closes any
open applications, logs out, then logs back in with the credentials from the Test Agent configuration.
There is an option on the configuration form to first check if that user is currently logged in, and
avoid the log out process.
Page 111 of 308

Running Combined Tests
You can combine both manual and automated tests in the same test set. When you kick off the test
runner, the automated tests are submitted on the associated Hosts, and you can continue running
the manual tests as usual.
Test Run History

You can view test run history from several different directions.
Test Management / Run History
Go to the Test Management > Run History page. You will see a list of all runs, across all team mem-
bers, test sets and tests:
The test run history is color coded:
l Green for Passed
l Red for Failed
l Black for all other statuses
From here, you can drill into the details of each test run.
Click Printer Friendly to view a printable format of the run history.
Click View Run to see a read-only version of the Test Runner, where you can drill into each test in the
run and into the test steps to view results.
When you delete test run history, the deletion will clean up and recalculate the Average Run Time for
the tests and test sets involved. If you are deleting the most recent run for a Test Set, it will also clean
up the Last Run information on the set and on the tests.
Page 112 of 308

Run History from the Test Library
To drill into run history for a specific test, you can go to the Test Library, open the test in Edit mode,
then click the Run History tab.
Click View Run to bring up read-only version of the Test Runner.
If the test was run as part of a test set, you will see the full view of the test set, where you can drill into
each test in the run and into the test steps to view results.
Run History from the Test Set
To drill into run history for a specific test set, you can go to Test Sets, open the test set in Edit mode,
then click the Run History tab.
Click View Run to bring up read-only version of the Test Runner, where you can drill into each test in
the run and then into the steps to view detailed results.
Run History - Automated Tests
When you submit automated tests, the test runner will post the top level of detail from the auto-
mated test result. From run history, you can drill into the detailed results:
l If you use TestComplete, Ready! API or SoapUI to run automated tests, the test runner will post the
appropriate log file. Open the attached log file or download the file and view the detailed test res-
ults.
l If you use NUnit to run Selenium automated tests or unit tests, the test runner will post NUnit test
project log file. Download the file and view test results on your computer.
l If your Selenium automated test or unit test fails, the test runner will post the console output of the
appropriate unit testing framework (JUnit, TestNG or NUnit) as Test Step Results.
Test Management Reports and Dashboards

You can analyze your tests, test sets and test results with reports and dashboards.
To view test dashboards, go to the Home > Dashboards page.
Page 113 of 308

You can add test and tests set charts to your dashboard.
To learn more about working with the dashboard and with charts in QAComplete, please see "Dash-
boards".
To generate test reports, go to the Reports > Reports page.
Configure a needed report and click Run Report to run it.
To learn more about reports in QAComplete, please see "Reporting".
User Interface Reference

Test Library List
Test Management / Test Library
Page 114 of 308

The Tests on the Test Library List can be sorted, filtered, and edited. As you select a Folder in the left
navigation panel, the Tests that reside in the folder are displayed.
Available columns depend on how your administrators have configured your Test Library in Setup. If
you do not have any of the following columns available, it is likely due to how your Test Library was ori-
ginally set up. Use Choose Fields to add or removed columns.
Note: Only columns that are less than 100 characters wide are available on the List. Others are avail-
able on the Add/Edit form.
Column Description
Actions Actions you can perform on a Test
Assigned To Team member assigned to the Test
Attachments and Navigate directly to the Attachments or Notes tab of the
Notes Test
Avg Run Time Average time it's taken to run the Test, based on Test Run
History
Date Created Date the Test was created
Date Last Escalated Date that an Escalation Rule last touched the Test
Date Last Run Date of the most recent Run for the Test
Date Updated Date the test was last Updated
Execution Type Execution Type for this Test. Execution Types are defined
under Choice Lists
Folder Name Folder/subfolder where the test resides.
ID Unique Identifier for the Test
Import Id If the Test was imported from a CSV file, this identifies all
Tests imported at the same time from the same CSV file.
Tokenized Indicates if the Test is includes parameters (tokens). See
"Creating Tokenized (Parameterized) Tests"
Iteration Count If the Test includes a token file, this is the number of iter-
ations of the test based on the values in the file.
Last Escalation Rule The name of the Escalation Rule that most recently
touched the Test.
Last Run By Team member that last executed the Test
Last Run Config The configuration used with the last execution of the Test
Last Run Release Release/Iteration/Build used with the last execution of the
Test
Last Run Status Status of the last execution of the Test (Pass/Fail)
Last Run Test Set If the Test was run as part of a Test Set, the name of the
last Test Set used when executing the Test
Nbr Escalations Number of times an Escalation rule has touched the Test
Page 115 of 308

Column Description
Owner Team member who owns the Test (typically the person
who created the Test)
Priority Priority of the Test. Priorities are defined under Choice
Lists
Status Status of the Test. Status values are defined under Choice
Lists
Automated Indicates that the Test is associated with a TestComplete,
Ready! API, SoapUI, Selenium, or unit test, and is auto-
mated. See: See "Creating Automated Tests"
Active Test Indicates if this is an Active or Disabled Test. Inactive Tests
will not be run.
Test Type Test Type. Values are defined under Choice Lists
Title Short descriptive name of the Test
Token File Title Name of the Token CSV file associated with the Test
Updated By Team member who last updated the Test
Version Current Version of the Test. See "About Test Versioning"
Working with the Test Library
Creating New Tests

l Click Add New on the Test Library toolbar.
l On the Add Test screen, specify the test parameters and click Submit.
l On the Edit Test screen, specify other information on the test, for example, create test steps or
assign an automation to the test, and click Save.
Editing Tests
l On the Test Library listing screen, find the test you want to edit and click the button in the Actions
column.
l On the Edit Test screen, make the desired modifications to the test.
l Click Save.
Running Tests
To run an individual test without adding it to a test set:
l Find the test you want to run and click the button in the Actions column.
For information on how to run a test set, See "Running Manual Tests"
Page 116 of 308

Creating Test Sets from the Test Library

l Filter the Test Library listing screen so that it displays the tests for which you can create a test set.
l Click Create Test Set on the Test Library toolbar.
l Click Yes in the confirmation dialog.
l Specify the new test set parameters in the Add Test Set window and click Submit.
Importing and Exporting Tests

To import test data from a CSV file:
l Select Import Tests from CSV file from the Actions menu.
l On the Import Wizard screen, click Browse and browse for the CSV file that stored the data.
l Click Next Page.
l On the next page of the wizard, you map data in the source file to the appropriate columns in the
Test Library listing screen.
l Check that all columns are mapped correctly, then click Import Now.
Important: To import tests into your Test Library, format your source CSV file in a special way. To learn
more about it, see See "Importing and Exporting Tests"
To export test data to an external file:
l Filter tests in the Test Library listing screen so that the screen shows only the tests you want to
export.
l Select Export Tests XML to export tests to an XML file.
-- or --
l Select Export Tests to export tests to a CSV file.
l Open or save the exported data.
Viewing Test Traceability

To view all items linked to tests:
l Select Show Traceability from the Actions menu.
l The Test Library screen will display defects, releases and configurations linked to each test.
l To hide linked items, clear the Show Traceability check box in the Actions menu.
Managing Workflow
To configure workflow for your tests:
Page 117 of 308

l Select Manage Workflows from the Actions menu.
l On the Workflow and State Transitions screen, configure the Status changes that Tests can take and
rules that describe how tests can move from one state to another.
l Click Submit Changes.
This can also be done from Setup / Screen Layouts. See "Customizing the System to Your Needs"
Adding Custom Fields

To add custom fields to the Test Library:
l Select Manage Custom Fields from the Actions menu.
l On the Custom Fields form, configure the columns you want to add:
l In the Field Name, enter the name of your column.
l Choose the type of the data that the column will show in the Field Type list.
l In the Field Size, enter the number of characters the data in your custom column can take.
l If you want your custom column also to appear in the Test Runner window during the test run,
select the Show in Run? check box.
Test Sets Listing Form

Test Management / Test Sets
Test Sets groups Tests into a logical order, so you can run related Tests in a single Test Run. On the
Test Sets listing form, you can view, create and run Test Sets. Use the Navigation panel to filter for Test
Sets associated with a given Release, or organized into Test Set Folders.
Available columns depend on how your administrators have configured Test Sets in Setup. If you do
not have any of the following columns available, it is likely due to how your system was originally set
up. Use Choose Fields to add or removed columns.
Column Description
Actions Actions you can perform on the Test Set
Assigned To Team member assigned to the Test Set
Attachments and Navigate directly to the Attachments or Notes tab of the Test Set
Notes
Avg Run Time Average time it's taken to run the Test Set, based on Test Run History
Date Created Date the Test Set was created
Page 118 of 308

Column Description
Date Last Run Date of the most recent Run for the Test Set
Date Updated Date the Test Set was last Updated
Execution Type Execution Type for this Test Set. Execution Types are defined under Choice Lists
Folder Name Folder/subfolder where the Test Set resides.
ID Unique Identifer for the Test Set
Is Active? Indicates if this an Active or Disabled Test Set. Inactive Test Sets cannot be run
Is Sequential? Indicates of Tests in the Test Set MUST be run in sequential order
Last Run By Team member that last executed the Test Set
Last Run Config The configuration used with the last execution of the Test Set
Last Run Release Release/Iteration/Build used with the last execution of the Test Set
Last Run Status Status of the last execution of the Test Set (Pass/Fail)
Owner Team member who owns the Test Set (typically the person who created the Test
Set)
Priority Priority of the Test Set. Priorities are defined under Choice Lists
Status Status of the Test Set. Status values are defined under Choice Lists
Title Short descriptive name of the Test Set
Updated By Team member who last updated the Test
Working with Test Sets
Creating New Test Sets

l Click Add New on the Test Set toolbar.
l On the Add Test Set screen, specify the Set information and click Submit.
l On the Add Tests, select the Tests that belong to the Test Set.
l Click Save.
Editing Test Sets

l On the Test Sets listing, find the Set you want to edit and click the button in the Actions column.
l On the Edit Test Set screen, make the desired modifications to the test.
l On the Tests tab, make the desired modifications to the Tests in the Set
l Click Save.
Running Test Sets

To run a Test Set:
Page 119 of 308

l Find the Set you want to run and click the button in the Actions column.
l Select the Release/Iteration and Configuration linked to the Test Set.
Viewing Test Set Traceability

To view all items linked to Test Sets
l Select Show Traceability from the Actions menu.
l The Test Set List display defects, releases and configurations linked to each test.
l To hide linked items, clear the Show Traceability check box in the Actions menu.
Managing Workflow
To configure workflow for your Test Sets:
l Select Manage Workflows from the Actions menu.
l On the Workflow and State Transitions screen, configure the Status changes that Test Sets can take
and rules that describe how tests can move from one state to another.
l Click Submit Changes

To add custom fields to the Test Sets:
Configurations List
Test Management / Configurations
Configurations represent the various environments or test lab machines that you will use to run your
Tests or Test Sets.
Available columns depend on how your administrators have set up Configurations in Setup. If you do
not have any of the following columns available, it is likely due to how your system was originally set
up. Use Choose Fields to add or removed columns.
Page 120 of 308

Column Description
Actions Actions you can perform on the Configuration
Attachments and Navigate directly to the Attachments or Notes tab of the Configuration
Notes
Configuration Name Short descriptive name of the Configuration
Folder Name Folder/subfolder where the Configuration resides.
ID Unique Identifier for the Configuration
Is Active? Indicates if this an Active or Disabled Configuration
Owner Team member who owns the Configuration (typically the person who created the
Configuration)
Updated By Team member who last updated the Configuration
Working with Configurations
Creating New Configurations

l Click Add New on the Configurations toolbar.
l On the Add Configuration form, specify the information and click Submit.
l Click Save.
Editing Configurations
l On the Configurations list, find the Configuration you want to edit and click the button in the
Actions column.
l On the Edit form, make the desired modifications to the Configuration.
l Click Save.

To add custom fields to Configurations:
Page 121 of 308

Run History List

Test Management / Run History
Run History shows you information on all Tests Sets or individual Tests that were run. A Run might be
an individual Test run from the Test Library, or the Run of a Test Set. The list shows you who started
the run, the related Release, configuration, and other historical information. Use Choose Fields to
select and order the desired Columns.
Column Description
# Awaiting Run Number of Tests that have not yet been run
#Blocked Number of Tests that were blocked in this run
#Failed Number of Tests that failed in this run
#Passed Number of Tests that passed in this run
#Tests Number of Total Tests in this run (Tests in the Test Set)
Actions Actions you can perform for the Run
Date Finished Date and time when this run was completed
Date Started Date and time when this run was started
Is Sequential Indicates if the Tests in the Test Set had to be run in sequential order
Release Name The Release the Test or Test Set was run against
Run by Id User ID of the team member that started the run
Run by Name Name of the team member that started the run
Run Time Time it took to complete the run
Run Time Formatted Time it took to complete the run, in 00:00:00 format
Status Status of the run (pass/fail/incomplete)
Test Run Id Unique identifier for this run
Test Set Id Unique identifier of the Test Set that was run
Test Set Name Name (Title) of the Test Set that was run
Working with Run History
Drilling into the Details

l Click the printer friendly icon to bring up a formatted view of the details of the test run, including res-
ults for each test and test step in the run.
l Click the View Run icon to bring up a display-only version of the Test runner, where you can also drill
into the detailed results.
Page 122 of 308

Deleting a Run
l To remove the Run History entirely, click the Delete icon next to the run. Delete will force a recal-
culation of the average run time for the Tests and Test Sets within the run. This action cannot be
undone.
(continued in Test Schedules)
Test Schedules
Test Management / Test Schedules
Test Schedules shows you a list of scheduled automated tests that will run on your Test Hosts at spe-
cific times. From here, you can view, add, edit and delete the defined schedules. The list shows you the
Host, Title and schedule information. Use Choose Fields to add, remove and re-order the columns.
Available columns are based on your system configuration.
Column Description
Actions Actions you can perform on the selected Schedule
Attachments and Notes Navigate directly to the Attachments or Notes tab of the Test
Agent The automated testing tool:
l TestComplete or TestExecute
l Ready! API or SoapUI
l JUnit (Selenium)
l TestNG (Selenium)
l NUnit (Selenium)
Created By Team member who created the Schedule
Date Created Date the Schedule was added
Date Last Launched Date of the most recent run for this schedule
Date Update Date the schedule was last updated
Enabled Indicates if the Schedule is currently enabled
End Date End date for the schedule.
Host Name Name of the remote machine that will run the test
Id Unique identifier of the schedule
Run on Days of the week the schedule will run
Start Date Date the schedule will start
Start Time Time the schedule will run the test
Title Title of the schedule
Updated By Team member who last updated the schedule
Page 123 of 308

Working with Test Schedules
Creating New Automation Schedules

l Click Add New on the Test Schedule toolbar.
l On the Add Test Schedule screen, specify the Schedule details.
l Click Submit.
Editing Test Schedules

l On the Test Schedule listing, find the Schedule you want to edit and click the button in the Actions
column.
l On the Edit Test Schedule, make the desired modifications.
l Click Submit.
Disabling Schedules
Instead of completely deleting a schedule, you can disable it. The schedule will no longer run, but you
can view it for historical purposes.
l On the Test Schedules list, find the Schedule you want to disable.
l Open the Schedule to edit it.
l On the Edit Test Schedule form, uncheck the Is Active box.
l Click Submit.
Deleting Schedules
To view all items linked to Test Sets
l On the Test Schedules list, find the Schedule you want to delete.
l Open the Schedule to edit it.
l On the Edit Test Schedule form, click the Delete button.
l On the "Do you want to delete this record" dialog, click Yes.
Test Hosts List

Test Management / Test Hosts
Test Hosts shows you a list of machines discovered by the Test Agent, when it was installed on your
test machines. From here, you can view the available Hosts, add descriptions, notes and attachments.
Available columns depend on your system's configuration.
Page 124 of 308

Column Description
Actions Actions you can perform on the selected Test Host
Attachments Navigate directly to the Attachments or Notes tab of the Test
and Notes Host
Agents The automated testing tool:
l TestComplete or TestExecute
l Ready! API or SoapUI
l JUnit (Selenium)
l TestNG (Selenium)
l NUnit (Selenium)
Information about TestComplete and TestExecute will
appear only if one of these tools is installed on the Test Host.
Other tools will be added to the Agents field automatically
during the installation of the Test Agent.
Created By Team member who created the Host
Date Date the Host was added
Created
Date UpdateDate the Host was last updated
Host Name Host name as discovered by the Test Agent
Id Unique identifier of the Test Host
Is Active? Indicates if the Test Host is currently available and running
OS Operating System on the Host machine, as discovered by the
Test Agent
Updated By Team member who last updated the Test Host
Working with Test Hosts
Test Hosts are created when you install the Test Agent on your test machines. The Host Name, OS,
Agent, Is Active and Configuration are all controlled by the Test Agent and are not editable. Descrip-
tion, Note and custom field are input capable. You cannot add Test Hosts manually.
Editing Test Hosts

l On the Test Host list, find the Host you want to edit and click the button in the Actions column.
l On the Edit Test Host form, make the desired modifications.
l Click Submit.
Page 125 of 308

Disabling Test Hosts

If the Test Agent has been removed from a machine, the Test Host will automatically be marked Inact-
ive. The Agent checks for active Hosts at regular intervals, and if the Host cannot be contacted, the
Test Host will be disabled.
Deleting Test Hosts

l On the Test Host list, find the Host you want to delete and click the button in the Actions
column.
l At the bottom of the edit form, click Delete and confirm by clicking Yes.
Legacy Test Cases and Test Automation
l Test Cases
Prior to Release 9.6.0, the Test Cases module provided a basic test management feature. If you are still
using Test Cases, please continue to About Test Cases (Release 9.6.0) and earlier
l Automation Bridge
Prior to Release 9.9.0, the Test Automation Integration featured an Automation Bridge for posting
automated results to a separate area in Test Management. If you were using the legacy Automation
Bridge, your legacy data remains available in Projects where data exists. You can continue using the
bridge in these projects, but we strongly encourage you to give the new TestComplete - Test Man-
agement integration available with Release 9.9.0.
To use the updated version:
l Install the Test Agent on your test computers. See "Installing the Test Agent".
l Create Tests in the Test Library, and associate your TestComplete projects with the Tests. See "Creat-
ing Automated Tests".
l Add your Tests to Test Sets (optional) and run them either on demand or on a schedule. See "Run-
ning Automated Tests" and Scheduling Automated Tests.
About Test Cases (Release 9.6.0) and earlier

If you were using an earlier version of QAComplete | ALMComplete, you may still be using the legacy
Test Cases module instead of Test Management. This module provides very basic test case man-
agement only, without the full functionality of Test Management, available in Release 9.7.0 and higher.
You can migrate from Test Cases to Test Management and can use security settings to turn off the Test
Cases tab when the module is no longer required.
Page 126 of 308

Organizing your Test Cases (Release 9.6.0 and earlier)
Software Planner allows you to organize your test cases any way you wish. For example, you may con-
sider organizing test cases by software release, agile sprint, etc. Or you may decide to do it by product
line, component or functional area, etc. For more information on organizing your data, refer to this
section of the document: User’s Guide à Organizing Your Data.
Using a Test Library in Test Cases (Release 9.6.0 and earlier)
You can re-use Test Cases from Release to Release by organizing them into release folders, using Fast
Edit to copy them to new folders for each release. In this scenario, you may wish to store master ver-
sions of your Test Cases in a Test Library folder, separated by Functional Area.
First, create a Folder for your Test Cases. Organize your Test Cases in subfolders as needed.
Use Fast Edit to copy from your Test Library into your Release folders.
If at any time, you need to change the Steps or Expected Results in the Test Library, Software Planner
will recognize the Test Cases in the Release folders that are related to the Test Library, and ask if you
want to synchronize.
Page 127 of 308

Click Yes, and you will see a list of related Test Cases.
The Test Case Id is a clickable link that takes you to the Printer Friendly version of the Test Case, where
you can review the Test Case details.
Select any or all of the Test Cases to synchronize. Click Submit, and the Test Case Steps and Expected
Results will be updated with your changes to the original Test Case in the Test Case Library.
Page 128 of 308

Organizing Regression Test Cases
If your team is using manual test cases for regression, it is good practice to house a set of regression
test cases that can be used from release to release. To do this, simply create a folder named Regres-
sion Template in Test Cases and store your regression test cases there. At the end of each release, it is
good practice to review test cases for new features that were added in the subsequent release and con-
vert test cases from that to your regression set.
Below is how your Regression Template might look:
Maintaining Test Cases (Release 9.6.0 and earlier)
To add a new Test Case, go to the Test Case tab and click the ADD NEW button at the top of the screen.
To update an item, click the EDIT button for the desired item, make your changes and press SUBMIT.
To delete an item, click the EDIT button for the desired item, scroll to the bottom of the page and
check the DELETE THIS RECORD checkbox, press SUBMIT.
You can attach files (like test plans, etc) by editing an item, then clicking the FILES tab, then clicking Add
New. You can keep a running set of notes on an item by editing an item, then clicking the NOTES tab,
then clicking Add New.
Test Case Traceability (Release 9.6.0 and earlier)
When developing test cases, it is important to ensure that you are prepared to fully test all features of
a specific requirement. The act of linking test cases to a Requirement with the goal of ensuring
adequate test coverage is called Test Case Traceability. Software Planner has several ways to ensure
your test cases have traceability.
The first step is to link the test cases back to a requirement(s). To do this, click Requirements / Trace-
ability.
Page 129 of 308

Linked Test Cases are organized by Test Case Folder.
Click the plus symbol next to Test Cases to view how many test cases are in each folder.
This allows you to analyze Test Case coverage for the requirement.
To link test cases, click Link Items…
Page 130 of 308

An alternative way to link test cases to a requirement is to edit the requirement and click Link to
Items…
Click the Remove Linked Item icon to de-link the items.
Page 131 of 308

To run a traceability report for a specific requirement, edit the requirement and click the Traceability
Report.
Another way to see traceability is to run a Test Case to Requirement Traceability report. Do this by
clicking the Reports tab / Test Case Reports / choose Test Case to Requirement Traceability report.
This report lists each requirement and all the associated test cases (with their current status):
Page 132 of 308

Test Case to Requirement Traceability Report
Other reports that aid in traceability are in the Requirements Reports section of the Reports tab:
Requirements Missing Test Cases Traceability – Shows each requirement that has no associated test
cases.
Requirements Missing Test Cases Traceability by Folder - Shows each requirement that has no asso-
ciated test cases, grouping this by folder.
Automatically Creating Defects from Failed Test Cases (Release 9.6.0 and earlier)
Software Planner can save your QA staff time by automatically generating defects when test cases fail.
To do this, edit a test case and change the status to Failed. At the bottom of the screen is a checkbox
named “Automatically Generate Defect upon Failed Test Case?” If this is clicked, it will create a defect,
automatically filling in details from the test case (like steps to reproduce, expected results, etc).
Once you check (or uncheck) the box and fail a Test Case, that sets the default for the next time you
open a Test Case.
It will also create a linkage between the failed test case and the associated defect. When the defect is
Closed, the Test Case will automatically be Passed. You can quickly see which defects were linked from
test cases by clicking Defects / Traceability. Once this is done, it shows the test case(s) linked to the
defect and you can drill into the list of test cases by clicking the link:
Page 133 of 308

You can also manually link a test case to a defect by editing a test case and clicking the NEW DEFECT
button at the top of the screen. Conversely, you can automatically create a test case from an existing
defect by editing a defect and clicking the NEW TEST CASE button at the top of the screen.
Failed Test Case: Defect to Requirement Traceability (Release 9.6.0 and earlier)
A Defect can be automatically linked to a Requirement if it is associated with a Test Case linked to the
Requirement.
First, link your Test Cases to a Requirement.
When you run the tests, use Automatically Generate Defect Upon Failed Test Case. When you fail the
Test Case, Software Planner looks for a link between the Test Case and Requirement. If it finds a linked
Requirement, it will then link the Defect not only to the Test Case but also to the Requirement.
About Legacy Test Automation

Prior to Release 9.9.0, the legacy Automation Bridge provided a method of posting TestComplete test
results to QAComplete | ALMComplete's Automation module.
The following information applies to Release 9.8.7.1 and earlier and is for reference only.
Automated Testing Bridge

The legacy Automation Bridge was used to post TestComplete results to Test Management's Auto-
mation Runs. From Automation Runs, recurring schedules for tests can be configured to run the
TestComplete projects unattended.
Installing and Configuring the TestComplete Integration

On you TestComplete machines, where you've downloaded the Automation Bridge, TestComplete will
have the automation plugin.
Page 134 of 308

l Start TestComplete.
l Open a Project.
l Look for the Automation Bridge icon in the toolbar and click on it:
The Automation bridge registration form opens:
l Enter the Web Service Address. For Software as a Service customers, this is http://soap.qa-
complete.smartbear.com/psWS.asmx
Page 135 of 308

l On the TestComplete Bridge tab, enter the Email that you use to log in to QAComplete or ALMCom-
plete and your password, then click Load Projects. The registration will validate your credentials,
then load the Project drop down with your QAComplete projects.
l Select the Project that will store your Automation results.
l Use the ellipse next to the PJS Directory field to navigate to the folder that holds your TestComplete
project suites (PJS Files).
l The Host Name will be auto-filled with the TestComplete machine name. You can modify this value
to make it easy to recognize your machine.
l In Run With, select TestComplete or TestExecute.
l The Active checkbox should be checked. You can uncheck this to disable the automation bridge.
l Click OK.
Automation Scheduler
Once the automation bridge is configured, you can set a schedule for the TestComplete tests from the
Test Management / Automation / Automation Scheduler.
Click on Automation Scheduler.
Use the drop down lists to select the Automation Type, Host Name, Project Suite and Project.
Page 136 of 308

The scheduler will check approximately every 5 minutes, looking for an active scheduler. When it finds
something to run, it will start up TestComplete on the Host and run the project suite. Results will post
back to Automation.
Automation Runs
Once automated tests have been run, you can view the results in Automation Runs
TestComplete logs (that are smaller than 30 Mg) can be viewed from the Automation Runs results list.
Analyzing the Test Runs

Use the Automation Runs dashboard for your Automation Results:
Page 137 of 308

Creating Defects Directly from TestComplete

You can also generate a Defect directly from a TestComplete log.
As with the automation bridge, first the connection has to be configured.
Open TestComplete, open a project, and navigate to the log. Look for the Create Defect icon in the
toolbar:
Click Settings to configure the connection:
Page 138 of 308

Enter the Web Service Address and Application Host as pictured, then your login email address and
password. Click the Check button. Your login will be verified, and a list of Projects loaded. Select the
Project that will store the Defects. Check the Save Settings box and click OK.
Then fill out the Defect form and Submit. The new defect will be added to the selected Project.
Legacy Test Management Report
in Reports, under Test Management, the Automated Test Runs report returns information about
the hosts, tests, date of test runs and status of the runs:
Page 139 of 308

Page 140 of 308

Managing Defects, Bugs and Issues

Track defects that are found by your team members and clients and manage the resolution of those
defects. As defects are logged, team members can be alerted via email as items are assigned to them
or as items they own are changed.
Organizing your Defects

Organize your defects any way you wish. For example, you may organize your Defects by Release, Iter-
ation and Build, and then into logical folders and subfolders by functional area, etc. If using a Support
Manager, you may have your support tickets flow into a folder named Support Tickets.
Below is an example of an organized set of defects:
Defects can be organized in any manner that suits your process.
Defects associated with a Release / Iteration can be Defects generated by failing a manual Test during a
Test Run. They are automatically linked to the Release / Iteration for the Run, the Test Set and the
Test.
Folders can be organized by feature or functional area. You can create a folder structure for any organ-
ization method.
If using the Support Management feature, you can set up a folder specific for the Defects that are cre-
ated through the Support Manager.
Using the Grouping Tab
In addition to organizing your defects, you can also use the grouping feature to quick find defects
based on up to 3 levels of grouping. To do this, in the table of contents, choose the Groups tab then
click the Group By button and choose the level 1, level 2 and/or level 3 grouping. Below is an example
of defects grouped by status, severity and assignee:
Page 141 of 308

To add a new defect, go to the defect listing screen and click the ADD NEW button at the top of the
screen. To update an item, click the EDIT button for the desired item, make your changes and press
SUBMIT. To delete an item, click the EDIT button for the desired item, scroll to the bottom of the page
and click the DELETE button. If you do not have security rights to update or delete items, those but-
tons will be hidden.
Tip: To add a new item that is similar to an existing item you recently added, notice you can choose a
recently entry to auto-fill the data on the screen:
You can reorganize the edit screen by adding custom fields, change the position in which fields appears
on the edit screen, and you can arrange the edit screen in 1 or 2 column formats. You also specify
which fields are shown, required or optional
You can attach files (like screen shots, etc) by editing an item, then clicking the FILES tab, then clicking
Add New. You can keep a running set of notes on an item by editing an item, then clicking the NOTES
tab, then clicking Add New.
Creating a Test from a Defect

If you have a defect that would make a great test (to ensure it is tested in subsequent releases), you
can edit a defect then click the Add Linked Item button at the top of the screen. This allows you to cre-
ate any type of item with details from the Defect and automatically link them.
Page 142 of 308

A new Add Test form pops up. Some of the information from the Defect will be auto-filled for you. You
can edit the information and complete the defect, then Submit and the new Test will be automatically
linked to the Defect.
After you’ve stubbed out the Test, go to the Test Library to add the detailed steps.
Page 143 of 308

Shared Documents
Shared Documents allows you to create folders and subfolders and upload documents (brochures,
marketing materials, detail designs, and so on), replacing the need for FTP. You can secure folders so
that only certain people have security to certain folders. Folders can be private or public, company
wide or project specific. As you upload documents, you can track new versions based on a setting on
the folder. Teams can check out and check in documents to ensure documents are not accidentally
overwritten.
Creating a Shared Document Folder
To create a new folder, click Shared Documents > Manage Folders, and then click Add New.
Securing a Shared Document Folder
When a folder is created, it can be created as public or private. If public, it automatically grants security
to all users that have rights to the shared documents area. For example, if you create a new folder and
make it public and you have 2 security groups, one with full rights to shared documents and the other
with read-only rights to shared documents, it will grant full rights to all users in the security group with
full rights and read-only to those in the group with read-only rights. As new users are added, they are
automatically given rights to existing PUBLIC shared document folders, if they participate in a security
group that has rights to the shared documents feature.
Page 144 of 308

If a folder is created as private, it provides full rights to the creator of the folder but does not give secur-
ity access to any other users for the folder. As new users are added to QAComplete, they are not given
any security rights to private folders, but the creator of the folder can grant rights to individuals manu-
ally.
Once a folder is created, the creator of the folder can adjust security rights by clicking Shared Docu-
ments > Manage Folders then clicking the Security Privs button for the folder they wish to secure.
Once here, they can choose to give any individual read, upload, replace and/or delete rights:
Uploading Documents
To upload documents, click Shared Documents, choose a folder, and then click Upload Wizard at the
top of the screen. Windows Internet Explorer users can upload using drag-and-drop operation by click-
ing Actions / Turn Drag and Drop Upload On.
Once the Upload Wizard is clicked, the upload screen appears:
Page 145 of 308

Click Continue and browse to the location of your document. You can enter a Title and Description for
the document, then click Submit.
If you are versioning documents, new versions are attached to the original and numbered.
Click the pen icon on the original document and select the Files tab to view the versions.
Page 146 of 308

Downloading Documents
To download one or more documents, click the Download Wizard button from the Shared Docu-
ments screen, then choose the files to download:
Page 147 of 308

Checking Out and Checking In Documents
Checking out a file allows you to prevent others from overwriting the file while you have it checked
out. It still allows others to download and view the file; it just does not allow overwriting of the file until
it is checked out. To check out a file, click the Lock button from the Shared Documents screen.
Page 148 of 308

About the List Manager

The List Manager is a powerful feature that allows you to track custom information specific to your
own business needs. For example, you may want to track a list of hardware in your office along with
the service keys and warranty information, a set of knowledge base articles or a list of feature areas to
use in a custom field.
To create a new list, go to the Lists page. Click Manage Lists in the left Navigation panel, then click Add
New:
For example, let’s create a list of features or functional areas. Once you click Add New, enter the name
of the list (e.g. Features) and make it Company Wide (this means that the contents of the list will be
seen in all projects). If you make the list Project Specific, the List can be seen across Projects, but the
data in the list is unique to the Project where the data was entered, allowing you to have different sets
of data in different Projects.
Defining List Columns

Once the list is created, you can then define the fields (or columns) of information to track.
Click Manage Lists again and look for your new list. Click the Manage Fields next to your new List.
Page 149 of 308

Once the Fields link is clicked, define the field type for each column on your List. For our example
Feature list, we want the following:
l Feature Name: Text, 100
l Description: Text, 8000
l Owner: Choice List (List of Project Users)
The field types are the same as you see when defining Custom Fields.
On your list, you can define the fields as Text, CheckBox, Choice Lists, Currency, Date, Numeric, and
Percentage, giving you full control over the data you want to store.
Once the new List has been created, you must grant security permissions to the list so that specific
people have rights to the list. You can do this on the Setup tab under Security.
Page 150 of 308

Adding Items to your List
Once you have permissions set for the list, it appears in the navigation panel, allowing you to view,
add, update and delete items from the list.
Ad-hoc reports are automatically created for the list.
List Title Setup

The first time you add a record to the list, you will see a Title Setup pop-up:
Page 151 of 308

The fields selected here appear when searching for list items. Your list items will be sorted by the fields
you select here on Link to Items.
If you need to change the title setup, you can get back to this from any Traceability screen – from any
module, click the Actions drop-down list and turn on Traceability. Click Link to Item and in the Linkages
To: drop-down list, select your List. A link to the Setup Title option will appear.
Page 152 of 308

Page 153 of 308

Reports
11.0 Reports
With Reports, you can create customized ad-hoc detail reports for Defects, Agile Tasks, Requirements,
and Tests. When creating a report, select the columns and filter for the data that you require.
QAComplete comes with several report templates. Use these templates to create your customized
reports.
When you build your report, the report criteria is automatically saved for you so you can re-submit the
same request without re-building the report.
You can export the generated report to PDF, XLS, XLSX, RTF and CSV.
To work with Reports:
Go to Reports > 11.0 Reports.
Click the blue Plus button to start building your report. The Create a Report page opens.
Page 154 of 308

Select a template to start building your report.
Page 155 of 308

l On the report criteria form, enter a unique Report Name. The report will be saved under Saved
Reports with this name.
l Select or create a filter.
l Select the Project and Release.
l Select the Fields (columns) that you want to appear on the report. Use the Shift-click or Ctl-click to
multi-select the fields, then move them onto the report by clicking the right arrow . Remove
fields from the report with the left arrow .
l You can sort the report by up to 5 fields. Toggle from ascending order and descending order
by clicking on the icons.
After you complete your report criteria, click .
Report Filtering
Filter the data on your report by using the Report Filter to select an existing filter.
To create a new filter, click .
Page 156 of 308

l To modify an existing filter, select the filter in the Saved Filter drop down list.
l To create a new filter, enter a filter name in Create New Name.
l Select the filter criteria by choosing fields in the drop down list of available fields. Select the filter cri-
teria in the next column, using the drop down list (Not Equal, Greater Than, etc.). Enter the search cri-
teria in the next column.
l Logical criteria can be grouped using open and closed parenthesis around the desired rows.
l Add rows by clicking the blue plus icon.
l Click the lock icon to mark the filter private, for your use only.
l Click the project icon to mark the filter company wide. The filter will be available in all projects.
l Keep in mind that custom fields may not be available in all projects before your mark a filter as
company wide.
After defining your filter criteria, click Save to return to the Edit Report page.
Report Results
The report renders in a table like format. The tool bar provides navigation, printing and exporting func-
tions.
Toolbar options:
Icon Function
Toggle between single or multiple page view.
Zoom in or out.
Print report.
Page 157 of 308

Icon Function
Print page.
Export report.
Search report.
Export your report
Click Export to view the available export formats. Choose from PDF, XLS, XLSX, CSV or RTF to generate
the desired output.
Legacy Reports
If you used the legacy Ad-Hoc or Crystal based reports, they are still available under Legacy Reports.
Please see See "Legacy Reports"
Export Options
Use the gear icon on the Report Results page to set options for the CSV, PDF, RTF, XLS, and XLSX
export formats.
Below is a quick overview of the possible export options for each format.
CSV Export Options
Encoding Defaults to Windows-1252. We recommend accepting the default or

using UTF-8.
Text Export Mode Defaults to Text. All data fields are exported as strings.
Quote Strings with Separators Defaults to Checked. If your separator character appears in a field, the
data will be surrounded by quotation marks.
Separator Defaults to comma (,) to generate standard comma separated files.
Page 158 of 308

Skip Empty Rows Not Applicable.

Skip Empty Columns Not Applicable.
PDF Export Options
Convert Images to Jpeg Not Applicable.

Show Print Dialog on Open Defaults to not checked. If checked, the Print PDF dialog opens as soon as
the exported data is generated.
Compressed Defaults to checked. Generates smaller PDF files when applicable.
Never Embedded Fonts Not Applicable.
Image Quality Not Applicable.
PDF A Compatibility Defaults to None. The standard PDF export is compatible with Adobe
Acrobat® version 4.0.
Page Range Defaults to empty. Generates all pages.
Document Options Optional. Set the following options for the PDF file:
Author
Application
Title
Subject
Keywords
PDF Password Security Optiona. Sets PDF security controls on the exported file:
OpenPassword
PermissionsPassword
PDF Permissions Options
PrintingPermissions
ChangingPermissions
EnableCopying
EnableScreenReaders
RTF Export Options
Export Mode Defaults to Single File and generates tables in the output, with a single header at
the beginning and a single footer at the end of the document.
Page 159 of 308

Single File Page by Page generates frames in the output and is not recom-
mended.
Page Range Defaults to all page. Only used when Singe File Page by Page is selected.
Export Watermarks Not Applicable
XLS Export Options (Microsoft Excel® 2000-2003)
Export Mode Defaults to Single File. Generates all output into one single XLS
file, with a single header at the beginning and a single footer at
the end.
Export Hyperlinks Defaults to checked. Data recognized as links will be hyperlinks in
the XLS output.
Page Range Not Applicable
Raw Data Mode Not Applicable
Sheet Name Defaults to empty (default sheet name). Optional: enter a specific
name for the worksheet in the XLS workbook.
Show Grid Lines Defaults to not checked. If checked, the XLS file will display stand-
ard gridlines around cells.
Suppress 256 Columns Warnings Defaults to not checked. If checked, the warning that appears if
the resulting XSL file has more that 256 columns will be sup-
pressed.
Suppress 65536 Rows Warnings Defaults to not checked. If checked, the warning that appears if
the resulting XSL file has more that 65536 rows will be sup-
pressed..
Text Export Mode If the content contains recognizable XLS format strings, set to
Value so that XLS can recognize the content. Otherwise set to
Text (recommended).
Workbook Color Palette Compliance Not Applicable.
XLSX Export Options
Export Mode Defaults to Single File. Generates all output into one single XLS file, with a single
header at the beginning and a single footer at the end.
Export Hyperlinks Defaults to checked. Data recognized as links will be hyperlinks in the XLS output.
Page Range Defaults to empty (all pages). Only used if Export Mode is Single (not recommended).
Raw Data Mode Not Applicable
Sheet Name Defaults to empty (default sheet name). Optional: enter a specific name for the work-
sheet in the XLS workbook.
Show Grid Lines Defaults to not checked. If checked, the XLS file will display standard gridlines around
cells.
Text Export Mode If the content contains recognizable XLS format strings, set to Value so that XLS can
recognize the content. Otherwise set to Text (recommended).
Page 160 of 308

Legacy Reports
QAComplete's Legacy Reporting system provided ad-hoc reports and standard reports (driven by Crys-
tal Reports 2008) to analyze your data.
Standard reports can be exported to several different formats. Ad-Hoc reports can be saved as spread-
sheets.
Standard Reports
Standard reports are organized by module (Agile Task Reports, Defect Reports, Requirement Reports,
etc). Most of these reports were created via Crystal Reports, and On-Premises clients that own the
Crystal Reports tool can create their own custom reports. Many of the Crystal based reports are also
drillable, allowing you to drill into the data that makes up the report.
To access reports, hover over Reports in the top menu and select Legacy Reports. Below is an example
of a Test Coverage report:
Here is an example of a graphical report that has drill down capabilities:
Page 161 of 308

Ad-hoc Summary Reports
Ad-hoc Summary reports are great for identifying distribution of data for status meetings. Each area of
the software comes with ad-hoc summary reports (Agile Tasks, Requirements, Defects, etc). To run an
ad-hoc Summary report, hover over Reports in the top menu and select Legacy Reports.
Below is an example of showing the number of Defects by Status and percent complete:
Page 162 of 308

Ad-hoc Detail Reports
Ad-hoc Detail reports are great for creating custom reports that pull back specific fields of data based
on selected filter criteria. Each area of the software comes with ad-hoc detail reports (Agile Tasks,
Requirements, Defects, etc). To run an ad-hoc Detail report,hover over Reports in the top menu and
select Legacy Reports.
Below is an example of an ad-hoc Defect report, notice you can specify what fields to show on the
report, the position of the fields, the sort order, and the filter criteria. You can also email the report to
others.
When using Filters on an ad-hoc report, be sure to give the Filter a name.
Here is an example of how the report might look once generated:
Page 163 of 308

A Defect Summary report returns the data grouped into a graph format:
You can save your ad-hoc detail selection criteria by giving the report a Name in the Save As Personal
Report field. This stores your Chosen Fields, Sort Order and Filter so you can run exactly the same
report again without going through the report criteria selection process.
Page 164 of 308

ALMComplete Legacy Features

Prior to QAComplete Release 10.2, additional features were available in ALMComplete. If you use
ALMComplete you may still have access to some of these retired features.
See "Working with the Home Page"
See "Empowering Collaboration between Team Members"
About Project Management
See "Project Management"
See "Managing Support Tickets"
Working with the Home Page

The Home Page is displayed when you log in for the first time and provides valuable dashboards that
allow you to quickly spot trends and inspect the status of items. Across the top are options to select
Dashboard, Team Task Board, or Email Alerts.
Home Dashboards
The Home Page Dashboards are organized onto tabs: Bulletins, Project Management, QA and My
Assignments. This gives you a quick and easy place to see an overview of assignments and progress.
Bulletins Tab
Your appointments and bulletins are shown in this tab.
Page 165 of 308

Based on security settings, you may have permission to edit the Project Bulletin and Company Bul-
letin.
Project Mgt Tab
The Project Management dashboards shows status of Requirements, Tasks and Project Plans. Some
charts a drillable – click on the chart to view the details.
Requirements by Status (Current Project)
Project Plan Status (Current Project)
Slipping Agile Tasks by Assignee (Current Project)
Slipping Project Plan Tasks by Assignee (Current Project)
QA Tab
The QA dashboard shows dashboards critical to coverage analysis, test and defect status. Graphs
include trending and drillable status graphs.
l Manual Test Case Trending (Current Project)
l Automation Tests Trending (Current Project)
Page 166 of 308

l Defect Trending (Current Project)
l Test Runs by Requirement
l Defects by Requirement
My Assignments Tab
The My Assignments dashboard shows a quick view of your assigned items: Agile Tasks, Project Plan
Tasks, Requirements and Defects.
l My Slipping Agile Tasks (Active Projects)
l My Slipping Project Plan Tasks (Active Projects)
l My Requirements by Status (Active Projects)
l My Defects by Status (Active Projects)
Page 167 of 308

Burndown Tab
The Burndown dashboard shows how you are progressing in your Release or Agile sprint. Velocity
charts show estimates (Est. Hrs), actual hours, and estimated hours remaining. Burndown chart shows
your progress.
Page 168 of 308

Team Task Board
The Team Task Board is available not only from the Home tab but also from the other tabs. The Team
Task Board provides a quick snapshot of the assignments for members of your team. Assignments are
displayed on color coded Task Cards. The To Do column lists tasks not yet started, In Progress lists the
tasks in progress, and Completed shows the tasks finished within the selected Date Range. You can
change the date range at the top of the Completed column.
Each column has a plus/minus icon that will expand or collapse everything in that column. Individual
items can also be expanded or collapsed. Click on the item's numeric ID to open it in a new Edit win-
dow.
Task cards are color coded: white background tasks are on target or not yet due, tasks that are past
due are red, and tasks that are due today are green.
You can easily change the Project, Release, Team Member and Artifact in the drop downs to filter the
display.
Page 169 of 308

A summary of tasks across all Projects appears at the bottom of the screen and can be collapsed or
expanded by clicking the double chevron at the lower right.
The Project and Team Member default to the current project and the current user. Each column
shows a list of task cards representing assignments for the team member. To Do contains items not
started. In Progress contains items currently being worked, and Completed shows assignments com-
pleted within the selected date range.
Each type of Artifact is represented by an icon:
Agile Tasks
Project Plan Tasks
Requirements
Defects
Team members can post hours directly to any assignment by clicking the Post Hours link. This goes to
the Post My Hours screen, automatically fills in the selected Task and default to the current date.
If not posting hours, your team member can drag assignments from To Do to In Progress to Com-
pleted based on certain rules. Since you are not posting hours, drag and drop will change the percent
complete automatically.
If you drag a Task Card from To Do to In Progress¸ the percent complete is changed to 1%.
Page 170 of 308

If you drag from In Progress to Completed, the task is now 100% complete and the Completion Date is
today.
If you drag from Completed to In Progress, the task is now 99% complete.
Dragging from In Progress back to To Do is only allowed if there are no actual hours posted to the task.
If there are no actual hours posted, the task can be moved and the percent complete is zeroed out.
Project Management
Project Management provides a hierarchical features that allow you to manage all software projects
across all teams and obtain visibility and metrics across all your projects. You can use this to track the
status, hours logged, variances and percentage complete of all projects and individual tasks within
each project. You can quickly identify slipping tasks and who is causing the slippage – so that you can
give them help before it impacts others.
To create a new project plan, click the Project Management tab and select Project Plans. In the left nav-
igation panel, click Releases and select your Release, then click Project Plans and choose Manage
Plans. From here you can create a project plan from scratch or you can use the wizard to create a pro-
ject plan from a list of existing requirements, tests and/or defects.
Project Management - Manage Plans
From Manage Plans, you Add New Plans, maintain existing plans, add or remove Team Members.
Once a Project Plan is 100% complete, it will drop off the Navigation panel. To view complete or inact-
ive projects, use Manage Plans. The Manage Plans list provides access to the Hierarchical View, My
Tasks, and Security Rights for all Project Plans.
Below is an example of a project plan Hierarchical View:
Page 171 of 308

Use the left side Navigation panel to manage and navigate your Project Plans. Select the Hierarchical
View to see the example as pictured. My Tasks displays only your assignments.
Use Manage Security Rights to select the team members for the Project Plan.
On the Hierarchical View, use the green + icon to add new tasks under existing ones or the red X icon to
delete tasks. Use the left and right orange arrows to indent or un-indent tasks. Once a task is entered
with an associated estimated hours and assignee, the estimated finish date is automatically calculated
based on dependencies, and resource availability.
If assigning an item will over-allocate a resource, you will notice a red exclamation icon next to the
assignment. When clicked, this brings up the Resource Availability Report, showing the assignments
for your team members.
To move items from this project plan to another, click the Fast Edit button at the top of the screen. To
add additional Requirements or defects to the project plan, click the ADD WIZARD button from the top
of the screen. You can also use this to create additional tasks based on task template.
Over Allocation
If a Team Member’s time has been over allocated, you will see the Over Allocation item next to the
Assigned To field. This is calculated by the Team Members Work Time, tasks assigned to the Team
Member, Estimated Start Date and Estimated Hours on the Tasks.
Page 172 of 308

Click on the over-allocation icon to see the Resource Availability Report.
Linking to Project Plan Tasks
You can also link requirements and defects to an existing project plan from the hierarchical project
plan screen. Once the items appear on the project plan, you can decompose your requirement into
tasks that must be completed and assign them to the appropriate people, and then link each of the
tasks to the requirement.
Once tasks are added to the project plan, the project manager can level resources, set assignment
information, set predecessors, etc.
Page 173 of 308

Project Management: Work Time and Hourly Rates
To set the working hours, billing rates, holidays and vacations for a resource, click the Work Time but-
ton at the top of the project plan hierarchical view. You can set up work days, hours, rates, and non-
work days for your team member.
Rates are used to calculate costs on the project plan tasks.
Posting Hours
Once tasks are added to the project plan, the project manager can level resources, set assignment
information, set predecessors, etc. As team members work on items associated with the require-
ment, they can edit the specification, go to the Tasks tab and click My Hours to enter the hours they
worked on the item:
Page 174 of 308

Click Post My Hours and select the Date Worked, Project Plan Task, and enter Hours Worked and
either Hours Remaining or Percent complete.
Based on a Security Group setting, Project Managers can view, edit and post time for team members
from the My Hours link.
After you select a user, you can edit existing Work Hours or post new Work Hours:
Page 175 of 308

Importing and Exporting Project Plans
Using a plugin to MS Project, you can send MS Projects to Project Management, and copy Project
Plans into MS Project. You can download the plugin from a link in Project Management / Hierarchical
View:
Install the plugin: Go to our Downloads Page, and select the plugin for either MS Project 2007 or MS
Project 2010, whichever version is on your desktop.
Page 176 of 308

l Download the ZIP file
l Extract to a folder on your desktop
l Open the folder
l Double click on setup.exe to start the installation
l Follow the prompts
Once installed, open up MS Project, and you’ll see the Import and Export on the Add Ins tab.
Configuring the Plugin
Set up the plugin with your log in email and password.
Page 177 of 308

In MS Project, click on Add Ins and select “Export to Software Planner”. On the Export window, look
for the Settings button.
Page 178 of 308

The Settings fields appear:
For our SaaS clients, the Web Service Address is http://soap.qacomplete.smartbear.com/psWS.asmx.
For our Enterprise clients, the Web Service Address must point to psWS.asmx on your server (http://
[yourserver]/psws/psws.asmx).
Enter the email and password you use to log into ALMComplete:
Page 179 of 308

Click Load Projects.
In the message box, you should see “List of projects was loaded successfully”.
Close the window with the X in the upper right corner.
Importing from ALMComplete into MS Project
Once you’ve entered your Settings, you can import and export Project Plans.
In MS Project, open a new Project.
Click SoftwarePlanner and select Import Project Plan.
Page 180 of 308

On the Import window, select your Project Plan from the drop down and click Import.
Your Project Plan will be loaded into the current MS Project form, where you can review, edit, or use
any MS Project function and save the Project Plan as an MS Project MPP file.
Exporting from MS Project to ALMComplete
In MS Project, select the MPP file that you’d like to export to ALMComplete.
Click on SoftwarePlanner and select Export Project Plan.
On the Export window, give the Project Plan a new name.
Page 181 of 308

The Owner drop down will display ALMComplete users that have permission to Project Plans. Select an
owner. The Assignee field is optional: use the drop down to select the Assignee for the main Project
Plan.
Page 182 of 308

The table lists the Resource Names on your MS Project file. You can map the Resources to Project Plan
Assignees by selecting the Assignee from the drop down.
If the names match exactly (“Sam Smith” matches “Smith, Sam”), this mapping will be done auto-
matically for you. You can make adjustments and change assignees here as needed.
Click Export.
Page 183 of 308

The message box confirms that your Project Plan was created, and it gives you the new Project Plan Id
number.
The next time you log in to ALMComplete and go to the same Project that you selected in the Plugin
Settings, your new Project Plan will appear, ready for you to link up your Requirements, work with
your schedule, and post hours to the Project Plan Tasks.
Page 184 of 308

Project Management Dashboards
When you open the Project Management tab, you will notice a dashboard button that shows a num-
ber of dashboards related to the project management area. Dashboards are organized on two tabs,
one for Project Plans (Advanced Project Management) and one for Agile Tasks.
Below are some standard Project Management dashboards. Most of the dashboards can be filtered,
run for a specific folder (release/etc), and drilled into to see details.
Project Plan Dashboards
Project Plan dashboards allow you to analyze all projects at a glance and can be selected for all project
plans in progress or a specific project plan.
Project Plan Burndown
Project Plan Status (Current Project)
Project Plan Velocity (Current Project) – Past 2 Weeks
Project Plan Velocity (Current Project) – Monthly Velocity
Slipping Project Plan Tasks by Assignee (Current Project)
My Slipping Project Plan Tasks (Active Projects)
Page 185 of 308

Drillable Dashboards
Some of the project management dashboards are drillable. Click the chart to drill down into the
details.
Page 186 of 308

Project Management Reports
Resource Availability Report
On this chart, you can drill down to the Resource Availability Report for a selected user.
You can run this report for any time frame by changing the Date Range. It defaults to starting with
today and ending in 30 days.
The report shows the Team Member’s normal Work Hours per day, if any Vacation or Holidays are
within the Date Range, total Available hours, how many of those hours are assigned and how many
are still available.
Each day is listed on the report. The date is red for days that the Team Member is over allocated, black
for unassigned or not working, green for properly allocated.
Click on the plus sign to see the details for the day:
Page 187 of 308

The day is expanded to show you what Project, Project Plan, Task, Estimated start and finish dates,
allocated hours, estimated and actual hours. This is reported across Projects so you can see exactly
what the Team Member has been assigned.
Additionally, you can access the following reports by going to the Reports tab / Project Management.
Gantt Chart – This report shows the tasks in a graphical format to allow you to determine the depend-
ency between tasks and the progression towards completion. The Gantt chart can be run across pro-
jects, for specific project plans and/or assignees and by date range.
Project Plan Task Index Cards – Run for a specific release, this returns a quick view of assigned project
plan task in index card format.
Project Profitability Report by Project Plan Assignee (Project Manager) – Run for a specific time period,
this report analyzes all completed project plans (percentage complete of 100%) and shows the prof-
itability of each task on the project plan. The profitability is calculated as the external costs minus the
Page 188 of 308

internal costs (what you sold it for vs. what it cost you). This specific report is grouped by project man-
ager, allowing you to compare one project manager’s profitability to another’s.
Project Profitability Report by Project Plan Owner – Run for a specific time period, this report analyzes
all completed project plans (percentage complete of 100%) and shows the profitability of each task on
the project plan. The profitability is calculated as the external costs minus the internal costs (what you
sold it for vs. what it cost you). This specific report is grouped by owner, allowing you to compare one
owner’s profitability to another’s.
Release Report – This report shows everything associated with a specific release (requirements, test
runs, defects, project plan task and agile tasks).
Resource Allocations by Assignee – This report shows all tasks assigned to each employee beginning on
a specific date.
Resource Allocations by Project, Project Plan, Assignee – This report shows all tasks assigned to each
employee beginning on a specific date for a specific project and project plan.
Variance by Project, Project Plan, Assignee – This report shows estimates vs. actual for each project,
project plan and assignee. This can be used to determine what project plans were delivered below, on
or over their estimates and what individuals on the team came in below, on or above their estimates.
This can be used to help team members improve their estimating skills.
Variance by Project, Project Plan, Owner – This report shows estimates vs. actual for each project, pro-
ject plan and owner. This can be used to determine what project plans were delivered below, on or
over their estimates and what owners (this is normally the product manager or supervisor) on the
team came in below, on or above their estimates. This can be used to help team members improve
their estimating skills.
Timesheet Reports
Timesheet reports show who worked on what and are found under Reports / Timesheets.
Timesheets by Project Plan, Week – This report shows all timesheets entered for each project plan and
separates them by week. It can be run to begin showing timesheets at any week desired.
Timesheets by Week – This report shows all timesheets entered for each week, regardless of what pro-
ject plan they were applied to. It can be run to begin showing timesheets at any week desired. This
can be used to determine what each individual has worked on for each week.
Page 189 of 308

Variance Reports
Variance Reports show estimated vs. actual hours and costs.
Project Management Additional Security Settings

The Project Management module has additional Security Setting specific to that feature.
Page 190 of 308

Project Plans (Project Management)
In the Project Plan block, use the top row to set Read, Add, Update and/or Delete privileges for Project
Plan Maintenance.
l Allow access to Project Plans other than mine – check this box if the users are allowed privileges to
Project Plans owned by or assigned to other users.
l Allow assigning of Project Plans – check this box if the users are allowed to assign Project Plans to
other users
l Project Plan Task Templates – check this box if the users are allowed to maintain Task Templates
l Project Plan Tasks (Project Team Members) – set Read and/or Update privileges to Project Plan
Tasks
l Allow viewing of costs – Check this box if the users are allowed to view Actual Cost fields on the Pro-
ject Plan Task
Click Submit to save the Security Settings for the Security Group.
Empowering Collaboration between Team Members

Creating a Discussion Forum
To create a new discussion forum, click Discussions / Manage Forums then click Add New.
Page 191 of 308

Securing a Discussion Forum
When a forum is created, it can be created as public or private. If public, it automatically grants secur-
ity to all users that have rights to the discussion forums area. For example, if you create a new forum
and make it public and you have 2 security groups, one with full rights to discussion forums and the
other with read-only rights to discussion forums, it will grant full rights to all users in the security group
with full rights and read-only to those in the group with read-only rights. As new users are added,
they are automatically given rights to existing PUBLIC discussion forums, if they participate in a secur-
ity group that has rights to the discussion forums feature.
If a forum is created as private, it provides full rights to the creator of the forum but does not give
security access to any other users for the forum. As new users are added, they are not given any secur-
ity rights to private forums, but the creator of the forum can grant rights to individuals manually.
Once a forum is created, the creator of the folder can adjust security rights by clicking Discussions /
Manage Forums then clicking the Security Privs link for the folder they wish to secure. Once here, they
can choose to give any individual read, upload, replace and/or delete rights:
Page 192 of 308

Posting a Discussion Forum Thread
To post a forum thread, click Discussions, choose a forum, and then click the Add New button at the
top of the screen.
Once the posting is sent, it emails everyone in the forum (if they have their messages email alert set).
You can respond through the emails by using the Send Reply Now link in the email, or from the forum
post in Collaboration.
If you view the thread within ALMComplete, it shows the entire thread:
Page 193 of 308

Collaboration: Calendar Management (Appointments, To Do List, Calendar Sharing)
The calendar feature allows teams to share calendars and keep all their appointments and to-do list
items online.
To view your calendar, click Collaboration, and then click Calendar. Click Add New Appointment to add
a new appointment.
Page 194 of 308

Contact Management
The contact management feature allows sales teams to track prospects and other teams to track
vendors and other contacts.
To track contacts, click the Contacts tab.
To add new contacts, click the Add New button at the top of the page.
Sending Email from the Contacts Listing Screen
The Contacts tab has a special email function so that you can send a mass email to a distribution list.
This function is also available on the list of Users in Setup.
Filter the list to the desired distribution list, then use the Send Email icon on the toolbar:
Page 195 of 308

The mass Send Email panel appears.
The “To” email addresses are based on your filter criteria. You can use CC or BCC to copy in additional
addresses. Select an email template or just enter the email body. The email body field accepts most
formatting, including Tags that provide a list of applicable tokens.
Bulk Emails and Templates
You can create email templates so that your team can re-use emails that have been well thought out
and can be sent out frequently. You can send bulk emails immediately or you can schedule them to be
sent at a later date. If you enter URLs inside the email, it will track who clicked on each link within the
email, providing excellent marketing information – you can determine exactly what email recipients
were interested in.
Page 196 of 308

To send a bulk email, click the Contacts tab, and then filter for the list of people to send to. Once this is
done, click the Send Email link:
From here, you can create a template or type your email then send it:
Click on View Prior Email Statuses to see a history of clicks.
Page 197 of 308

You can also see the campaign clicks from the dashboard (click Contacts / Dashboard):
If you click the graph, you can see the click activity:
Managing Support Tickets

ALMComplete provides a customizable Support Ticket Management tool that allows your clients and
internal staff to log support issues and enhancement requests. It allows the customer to track the
status of each ticket. Once you configure your Support Ticket feature, you can add a support link from
your website, allowing clients to enter support tickets.
Page 198 of 308

Details about configuring the Support Ticket Manager can be found in the Support Manager User’s
Guide: Support Manager Configuration and Users Guide
Calendar Sharing
If you would like to share calendars between team members, you can set up automatic rules for giving
specific groups of people rights to each other’s calendars. When a security group is setup, you will
notice a Calendar Delegation button. When this is clicked, it allows you to set the rules for allowing
this set of users in the security group to share their calendar with others.
For example, in the Channel Manager Consultants security group, we have decided to automatically
give read access to the calendar for our Channel Manager Consultants:
When adding users to the Channel Manager Consultants, they will automatically have permission to
all calendars for all users in all projects.
Page 199 of 308

Discussion Forums
Discussion forums allow teams to create forums and post messages, automatically alerting the recip-
ients via email. This can greatly increase team communication. Many software development teams
will create a discussion forum for each release of the software they are working on. Then each day,
team members post questions in the forum. Everyone enrolled in the forum receive an email regard-
ing the forum posting (assuming their email alerts are setup) and the person knowing the question will
answer the forum and everyone sees this collaboration in action. It is also beneficial to post daily
updates to the forum so that team members know what code modules were changed, what spe-
cifications they related to, and the status of how the coding in that area is progressing.
Creating a Discussion Forum
To create a new discussion forum, click Discussions / Manage Forums then click Add New.
Securing a Discussion Forum
When a forum is created, it can be created as public or private. If public, it automatically grants secur-
ity to all users that have rights to the discussion forums area. For example, if you create a new forum
and make it public and you have 2 security groups, one with full rights to discussion forums and the
other with read-only rights to discussion forums, it will grant full rights to all users in the security group
with full rights and read-only to those in the group with read-only rights. As new users are added,
they are automatically given rights to existing PUBLIC discussion forums, if they participate in a secur-
ity group that has rights to the discussion forums feature.
If a forum is created as private, it provides full rights to the creator of the forum but does not give
security access to any other users for the forum. As new users are added, they are not given any secur-
ity rights to private forums, but the creator of the forum can grant rights to individuals manually.
Page 200 of 308

Once a forum is created, the creator of the folder can adjust security rights by clicking Discussions /
Manage Forums then clicking the Security Privs link for the folder they wish to secure. Once here, they
can choose to give any individual read, upload, replace and/or delete rights:
Posting a Discussion Forum Thread
To post a forum thread, click Discussions, choose a forum, and then click the Add New button at the
top of the screen.
Once the posting is sent, it emails everyone in the forum (if they have their messages email alert set).
You can respond through the emails by using the Send Reply Now link in the email, or from the forum
post in Collaboration.
Page 201 of 308

If you view the thread within ALMComplete, it shows the entire thread:
Collaboration: Calendar Management (Appointments, To Do List, Calendar Sharing)
The calendar feature allows teams to share calendars and keep all their appointments and to-do list
items online.
To view your calendar, click Collaboration, and then click Calendar. Click Add New Appointment to add
a new appointment.
Page 202 of 308

Contact Management
The contact management feature allows sales teams to track prospects and other teams to track
vendors and other contacts.
To track contacts, click the Contacts tab.
To add new contacts, click the Add New button at the top of the page.
Sending Bulk Emails
If you wish to send bulk emails (newsletters, marketing promotions, etc), you can do that via the con-
tact manager. You can create email templates so that your team can re-use emails that have been well
thought out and can be sent out frequently. You can send bulk emails immediately or you can
Page 203 of 308

schedule them to be sent at a later date. If you enter URLs inside the email, it will track who clicked on
each link within the email, providing excellent marketing information – you can determine exactly what
email recipients were interested in.
To send a bulk email, click the Contacts tab, and then filter for the list of people to send to. Once this is
done, click the Send Email link:
From here, you can create a template or type your email then send it:
Page 204 of 308

Click on View Prior Email Statuses to see a history of clicks.
You can also see the campaign clicks from the dashboard (click Contacts / Dashboard):
Page 205 of 308

If you click the graph, you can see the click activity:
Page 206 of 308

Administrator’s Guide
Page 207 of 308

Backups
Software as a Service customers can sign up for our automatic backup service. The backup service will
send you a link to a zipped file. The zipped file contains CSV formatted Agile Tasks, Requirements,
Tests, Defects, Contacts, and List data. Access to configuring Automatic Backup Service is controlled by
a Security permission in your Security Group.
To configure the backup, go to Setup and choose Automatic Backup Service. Select the desired fre-
quency in the drop down. Enter the email address that will receive the link to the zip file.
You can also set a password on the zip file, so that the CSV files can only be opened with a password.
If you enter a Confirmation Email, the system sends a notification that the backup was enabled to this
address.
NOTE: Due to bandwidth and CSV limitations, History, Attachments and Shared Documents are not
included. The CSV file is the equivalent of the Export to CSV (All Fields).
Page 208 of 308

Security
Security allows you to grant your team members different permissions for different Projects. For
example, you may want to grant one team Read Only access to data in one Project, but full permission
to all data in a different Project.
The first step in establishing security is to determine the roles of your teams. You have different types
of teams in your organization (security administrators, project managers, analysts, programmers, test-
ers, sales people, marketing personnel, documentation specialists, etc.). Each of these team roles may
have different security needs: a project manager may need full rights to all areas, where a sales person
may need more limited rights.
NOTE: New features are frequently controlled by a new security setting. Security permission is off by
default when new features are deployed, since we cannot predict which of your security groups should
have access. When new features are available, have your Security Admin enable permission to the fea-
tures for your security groups.
Setting up Security Groups

Once you determine the various roles for your teams, define the Security Groups that represent those
roles. Each group is a set of security rights for that role. You may have a few security administrators, a
few project managers, many programmers and testers. Each team member will be assigned to a spe-
cific Security Group for each Project.
To establish a new security group:
l Click Setup .
l In the left navigation panel, select Security > Security Groups.
The list of your existing Security Groups appears.
Page 209 of 308

The number of users in the group appears under # Users column.
Click Add New to create a new security group. Give your Security Group a name and an optional
description, and click Submit.
Once a security is created, you can set the security rights for that security group. Click the Manage
Security Rights icon for the group:
The detailed Security Group Privileges form appears. Here, you define the permissions for this group:
Page 210 of 308

When setting Security Privileges, each area has a block of check boxes for Security Settings.
The top row of checkboxes is used for Full Access, Read, Add, Update and Delete privileges.
Another set of checkboxes determine additional privileges:
l Allow access to items other than mine? – check this box if the users are allowed privileges to items
owned by or assigned to other users.
l Allow approving of items? – Check this box if the users are allowed to change the status to Approve
or Reject. If not checked, the user cannot see nor select any status that contains the text “Approve”
or “Reject”.
l Allow assigning of items? – Check this box if the users are allowed to assign items to other users.
Page 211 of 308

l Allow closing of items? – Check this box if the users are allowed to change the status to Closed. If not
checked, the user cannot see nor select any status that contains the text “Closed”.
The next two rows of checkboxes determine the privileges for Escalation Rules and Folder Main-
tenance. You can set the privileges to Full, Read, Add, Update, Delete for Escalation Rules and Folder
Maintenance for each area.
After you complete defining the security permissions for the group, click Submit. You can now put
your users into the new group for the desired Projects.
Additional Security Settings

Some areas have additional Security Setting specific to that feature.
Releases
In the Releases block, you can set privileges for Release, Iteration and Build Maintenance and for
Releases Folder Maintenance.
NOTE: All users will need at least Read permission to Releases.
List Manager
In the List Manager block, you can set privileges for List Maintenance and for each List that you’ve
built. Once you create a List, it will be displayed here where you can set privileges to the list.
Shared Documents
In the Shared Documents block, there is an additional check box for Skip document review process
(post in final status). If this box is unchecked, the users in this Security Group upload documents as
“Preliminary”. Check this box if the users are granted permission to upload documents as “Final”
Page 212 of 308

Test Management
Test Management controls permission to the Test Library, Test Runs, Test Sets and Configurations, Ver-
sioning, Test Automations, Hosts and Schedules, and the Run History.
Test Library
l Allow access to items other than mine? – Select this check box to allow users access items owned by
or assigned to other users.
l Allow assigning of items? – Select this check box to allow users to assign items to other users.
l Allow running tests from the test library? – Select this check box to enable a Run Now icon from the
Test Library. This bypasses the creation of a Test Set and allows your team to run single tests directly
from the test library list.
l Automation Runs – Select this check box to enable the Automation screen.
Test Automation controls permission to the Automation tab on Tests in the Test Library, where you
associate your Test with automated or unit tests created with supported testing tools.
Test Hosts controls permission to Test Hosts used by Automated tests.
Test Schedules controls permission to Schedules used by your Automated tests
Test Runs
Page 213 of 308

l Allow editing Steps during Test Run? Grants permission to change Test Steps on the fly, during a
Test Run. Users with this permission can change, add or delete Steps within a Test while in the midst
of a Test Run; the changes can update the original Test in the Test Library or only affect the current
Test Run.
Test Versioning
l Test Versioning: This enables the Test Versioning feature. With this permission, users can read or
delete Test Versions in the Test Library. You will need to enable this for your Security Administrator
group at a minimum to enable the Versioning feature.
l Allow Test Version Rollback: With this permission, you can select a previous version of a Test in the
Test Library, and turn it into the currently active version.
Test Sets
l Allow deleting Test Run History? Grants permission to delete historical data for Test Runs. This can
be useful if Test Sets were run in error, or against an incorrect build.
NOTE: Deleting Test Run History will recalculate average run time and change Last Run details on the
Test and on the Test Set.
Configurations
l Allows standard Read, Add, Update and Delete to Configurations and Configuration Folders.
Management Features
Management Features control the administrative type security settings. Here, you can grant the Secur-
ity Group authority to create and maintain Projects and User Accounts. All users need at least Read
privileges to the first two items: Project Creation and Setup and User Accounts.
Page 214 of 308

Additional checkboxes control permission to global settings that affect all areas.
l Manage and view traceability: allows viewing links between items
l Manage choice lists: allows maintaining choice list values
l Manage custom email alerts: allows maintaining custom emails alerts, found on the Home Page
l Manage custom fields: allows the creation and maintenance of custom fields.
l Manage workflow and state transitions: allows maintaining workflow, found on Setup / System Con-
figuration / Screen Layouts
l Manage Automatic Backup Service: allows selection of the optional automatic backup service, avail-
able to Cloud / Software as a Service customers only.
l Manage License: grants permission to post updates to your license (number of users)
Page 215 of 308

l Manage Team Member Work Hours: grants permission to post hours for other team members.
Without this, you can only post hours to items assigned to you.
l Override records locked by other users: grants permission to override a lock on a record currently in
use by another team member. Allowing this gives the user permission to override edits in progress
by other team members and should be used with caution. Please refer to Record Locking for addi-
tional information.
l View administrative reports: grants permission to view and run Administrative Reports.
l View timesheets reports: grants permission to view and run Timesheet Reports.
Click Submit to save the Security Settings for the Security Group.
NOTE: Additional Security Administrator permissions are controlled by the "Security Admin?" check
box on the user. See Security Administrator Checkbox.
Working with Users

Adding Users
Once your Security Groups are established, start adding your team members as QAComplete users.
To add a user:
l Click Setup at the upper right of the menu bar.
l Select Security > Users.
l Click Add New.
Fill in the details for the new user, including the email address they will use to log in.
Notice the Security privileges choice list shows all the security groups you set up previously. Select a
security group, and the new user will be granted permissions for the current project based on the selec-
ted group.
Page 216 of 308

The new user will receive an email with a link to set a new password and then log in.
Security Admin
The Security Admin check box grants specific administrative rights to the user beyond what is con-
trolled by Security Groups. These permissions are system wide, across all projects.
If this is checked, the user has permission to:
l System Configuration > Screen Layouts
l System Configuration > Sync Project System Options
l System Configuration > System Options that affect all users
l System Configuration > System Preferences (on-premises only)
l Security > Users
l Security > Users > Log User Off
l Security > Security Groups
l Security > Permanently Delete Users (on-premises only)
NOTE: Make sure this box is checked for your Security Administrators.
Page 217 of 308

Deleting a User (Revoking all Rights)
If you wish to delete a user and remove all rights, go to the Setup tab and choose Security / Users,
then click Edit on the user you wish to delete. At the bottom of the edit form, click the Delete button.
The delete returns a validation message: click Yes if this is the user you want to removed.
When a user is deleted, it does a “soft delete”, which means all rights and log in permission are
removed, but the actual user record is not physically deleted. This ensures that data (defects, test sets,
requirements, etc.) assigned or owned by the user, audits and history are preserved properly.
Restoring a Deleted User
If you deleted a user and wish to restore their rights, go to Setup, then click Security, then click Users,
then choose Actions / Show Deleted Users:
Once this is done, the inactive users will appear on the list of users. You can select the inactive user and
edit the record.
IMPORTANT: Before you make any other changes to the user, you must first Restore the user.
Page 218 of 308

Click Restore this user and then Submit.
Once restored (after Submit) you can edit and make further changes. The user is now re-instated and
you can grant permission using Security Groups.
You may want to review their security permissions to ensure they have the correct access to the cor-
rect Projects.
(continued in About Projects)
Logging Users Off

If a user forgets to log off and keeps a license locked up, a Security Administrator can log the user off.
Use this with caution: the user will be immediately logged off and will lose any unsaved data.
Page 219 of 308

To log a user off:
l Click Setup and go to Security > Users.
l Find the user in the list.
l In the Actions column for the user, click the Log User Off icon.
l A confirmation message appears. To log the user off, click Log User Off. To cancel the
action, click Cancel.
The Log User Off icon is enabled only for users shown as currently logged in. The user will see the mes-
sage "Your security administrator has logged you off to free a license" and will be re-directed to the
login page.
Inactivity
If a user does not interact with the system over a two hour time period, he or she will be automatically
logged out for both security purposes and to free up a license.
Password Administration
As a Security Administrator, you can enforce stronger passwords using Advanced Security settings.
To enable and configure Advanced Security, go to Settings > Security and select Password Admin-
istration.
Page 220 of 308

Check the Use Advanced Security box. The Advanced Security Options will appear, and you can
modify the default values.
l Password Minimum Length: Set the minimum length of passwords. For example, passwords must
be at least 8 characters long.
l Password Reuse Policy: Prevent the re-use of old passwords. Set how many passwords to store,
and prevent users from re-using the passwords on this list.
l Password Expiration: Set the password expiration in number of days. Users must change pass-
words within this time period.
l Require Alphanumeric: Passwords must contain at least one character from three of the four cat-
egories:
l Latin UPPER CASE letter (A through Z).
l Latin lower case letter (a through z).
l Digit (0 through 9).
l Non-alphanumeric character, such as _ ! + or other US keyboard characters.
Once complete, click Save Changes to apply your changes.
Page 221 of 308

Note: All passwords are always encrypted at the database level with 128-bit encryption.
Record Locking
A built-in security feature prevents your team members’ from unintentionally stepping on each oth-
ers’ changes.
When a team member selects a Requirement, Test, Defect, or other object for editing purposes, the
record is “locked”. Should a second team member happen to open up the same record, they will see a
“read only” version. The name of the person who has the record locked appears in the heading.
For example, one of your team members opens a Defect. A second team member tries to open the
same Defect and sees this:
The second team member can click OK to view the defect, but will not be able to make any changes to
it. The name of the team member with the lock appears up in the green bar. All fields are display only.
If the team member has permission to unlock records (based on a security setting), the Override read
only icon will be available in the upper right corner next to the Refresh icon.
Page 222 of 308

This allows the team member to open up the Defect for editing, but must take care when saving the
Defect, since changes in process by the first team member may be overwritten.
Record Locking Security Entity
If you need to allow certain users to override a lock, click Setup , go to Security and select the
desired Security Group. Scroll down to Management Features and check the box for Override records
locked by other users.
Page 223 of 308

Use this with caution: keep in mind that this will open up the selected item for editing by multiple users
at the same time. The last person to save the item will override any changes made by the other users.
Page 224 of 308

About Projects
Think of a Project as a workspace that divides your data for security purposes. Your team will determ-
ine if it is best to use one single project, or if separating the data into multiple projects makes sense.
Using a Single Project
The simplest way to store your data is in a single project. You can use filters to return information
within the project based on specific criteria. A single project also reduces maintenance, as you can
setup your choice lists, custom fields, and screen layouts once without worrying about synchronizing
those in multiple projects.
Your teams can be assigned to different security groups within the project.
Using Multiple Projects
If you have different departments or teams within your organization that will work with the features in
a different ways, such as different custom fields, workflow, screen layouts and/or choice list values,
you may want to define more than one project.
You may also prefer to use multiple projects to secure the data so that some teams can access certain
projects and features but not others. For example, if you have multiple departments and you do not
want one department to see another department’s information, you can accomplish this by using mul-
tiple projects and setting security to prevent unauthorized project access, or you may have a team
that needs read-only access to one project but update and delete in another.
Finally, you may want to separate your data into multiple projects for business reasons (by product
line, etc).
Creating a New Project
To create a new project, click Setup , then select Projects (Open & Create).
Click Add New.
Page 225 of 308

Fill in the new Project Name.
You can create the new project by copying from another project. This copies the security rights,
folders, choice lists settings, custom fields and Agile Tasks from an existing project to your new project.
IMPORTANT: When copying from another project, be SURE to add the correct users from the Copy
these Users list.
Page 226 of 308

Check the boxes to generate the desired information - Folder Structure, Choice Lists, Custom Fields,
Agile Tasks.
Check your list of Selected Users and Submit.
If you are not copying from another project, you will be the first user on your new project. Use Man-
age Security Rights to add team members to the new project.
Securing a Project
To manage security permissions for a Project, click Setup , then select Projects (Open & Create).
Notice the Manage Security Rights button next to each Project; use this to maintain your team's per-
mission to the Project.
From the list of users, use the Security Group drop down to select each team member's security level.
Page 227 of 308

Click Submit.
Synchronizing Projects
The Sync Project feature will copy Custom Fields and Choice Lists from one project to another. If you
use a standard set of Custom Fields and Choice Lists across multiple projects, this allows you to keep
the values in sync across project in one step.
IMPORTANT: all existing Custom Fields configuration and Choice list values on the target "To" project
will be replaced by the Custom Fields and Choice lists on the Source Project. This action cannot be
undone.
Click Setup , then select System Configuration > Sync Project System Options.
Page 228 of 308

For Source Project, select the project that holds the desired Custom Field and Choice List definitions.
Use the check box in Copy To This Project to select that Projects that need Custom Fields and Choice
Lists updated.
When you click Submit, the Custom Fields and Choice Lists are copied from the Source Project and
replace all values in the target Copy To projects.
Archiving a Project
If you are done with a Project, you can archive it to prevent any further modification or data, without
actually deleting it. This allows you to hide the Project from further use, and if necessary, open it up
again later.
To archive a Project, click Setup , select Projects (Open and Create), then open the Project.
Uncheck the Active Project? checkbox and click SUBMIT.
This archives the Project: it disappears from view in the Projects drop-down lists, reports, etc. You can
come back later and check the Active Project checkbox to remove the archive flag, should you want to
view or report on the Project again.
IMPORTANT: DELETING a project with Delete this record (are you sure) REMOVES all data in the pro-
ject, then deletes the project. The project and project data cannot be recovered.
ARCHIVING the project removes it from the project drop down selector, but keeps all project related
data intact.
Assigning Projects Rights to a User

You can set up one or more Projects and secure each project separately. Once Projects have been
setup and users are added via the method above, you can give specific users different rights for each
project and can restrict a user from accessing specific projects.
Page 229 of 308

To control access to Projects for your team members, click Setup , go to Security > Users, and click
the Security Privs button for the user.
On the Security Maintenance > User Security form, you will see a list of Projects. Choose the Security
Group that has the correct permissions for the team member for each Project. If you want to restrict
the user from accessing the Project completely, choose (None – Cannot access).
The Security Admin? is the same box that is on the user record. This grants the user administrative per-
missions and updates the field on the user's record. The user will be allowed to edit users, security
Page 230 of 308

groups, and security settings across projects. Make sure this box is checked for your Security Admin-
istrators.
Page 231 of 308

Customizing the System to Your Needs

You can create custom fields for each module. Custom fields can be defined as text, choice lists, check-
boxes, dates, or numeric.
You decide what fields appear in what order on the Add / Edit form, what fields are required, and what
fields might need default values in Setup under Screen Layouts.
You can setup customized workflow and specify how one workflow state can transition to another, set
rules for automatically assigning items to a specific person depending on the status the item goes to,
set rules for determining if each field on the screen is read only, updatable, hidden, required or
optional – depending on the status the item is in.
Create Custom Fields

Each area allows you to create custom fields. Custom fields allow you to track any additional data that
you want to collect.
You can access the custom fields feature in several ways:
l Click Setup and select System Configuration > Screen Layouts.
l From each module: Click the Actions drop down list and select Manage Custom Fields.
For example, if you wish to setup custom fields for the Defects screen, go to Show Defects.
Click Actions > Manage Custom Fields. You will see a screen similar to this:
Page 232 of 308

You can create custom fields of varying types:
l Check Box – This provides a custom field that is shown as a checkbox (on or off).
l Choice List (Based on Another Field) – This allows you to create a custom field that derives the items
in the combo box from another feature area.
l Choice List (List of all Project Users) – This allows you to create a custom field whose combo box is
filled with a list of all the users that have access to the project you are working in.
l Choice List (List of all Users) – This allows you to create a custom field whose combo box is filled with
a list of all users, regardless if they have access to the project you are working in.
l Choice List (List of Values) – This allows you to define a list of selectable values in a drop down box.
l Choice List (Multiselect) - This allows you to define a list of selectable values that appear in a drop
down box, with a checkbox on each value for multiple selections.
l Date – This provides a date entry field with a clickable button to allow choosing the date from a cal-
endar popup.
l Numeric – This provides a custom field whose values must be numeric.
l Phone – This provides a custom field whose values must be in phone format (xxx-xxx-xxxx).
l SSN – This provides a custom field whose values must be in social security number format (xxx-xx-
xxxx).
l Text – This provides a custom field that can be regular text entry. Custom fields 1 through 10 can be
up to 8000 characters and allow basic formatting. You turn off rich text editing and restrict the field
to plain text only by using underscore [ _ ] in the field name. This overrides the automatic rich text
editor formatting and creates a plain text field. Custom 11 through 90 are limited to 100 characters
max.
l Choice List (Based on SQL) – On-Premises feature. You can enter a SQL statement that will return a
list of items based on your query. These display in a choice list drop down. (Note: This type of field is
not compatible with Fast Edit or Import.)
l Choice List (List with Sublist based on SQL) - On-Premises feature. You can enter a SQL statement
that will return a list of items based on a SQL query and put those into a drop down choice list.
Using Values from other Modules in a Choice List

You can create a custom field that displays the values from another field in a drop down list. For
example, you can create a List that contains a standard set of values to use across other modules, then
associate the List with a Custom Field. (To create a List, see See "About the List Manager".)
For example, let's create a custom field in Requirements and link it to an existing List.
Page 233 of 308

NOTE: Be sure the values in the selected field are all unique; otherwise your drop down selection list
will not serve its purpose.
Go to Requirements > Actions > Manage Custom Fields.
Create a custom field that is Choice List (Based on Another field).
Page 234 of 308

Then enter the field name and select Choice List (Based on Another Field):
Click Set choice list based on another field to associate the field with your List.
Page 235 of 308

Once you press Submit, the new field will be available on your Requirement add/edit form as a drop
down list, where you can select a value from the defined List.
Page 236 of 308

Managing Choice Lists

Choice lists are the items that appear in drop down combo boxes. You can change the list of items in
any combo box. For example, if you wish to update a combo box on the any screen, go to the listing
screen, click Actions then select Manage Choice Lists.
Page 237 of 308

From here you can edit, add or remove items from the choice list:
Setting Screen Layouts

If you wish to set the position in which fields appear on the screen, change the default screen layout to
1 or 2 columns, you can do this via Screen Layouts. To access this, click Setup at the top right and
select System Configuration > Screen Layouts.
Choose the area that you want to customize.
Page 238 of 308

On the Listing Screen tab, select the default fields that will appear on the list of items. You can select
any field, except for text fields larger than 255 characters.
All team members can modify the appearance of the listing screens for themselves. For example, once
you select the default fields for the listing screen for Defects, when your team members go to the
Defects tab, they can use the Choose Fields options to change the list for themselves. These changes
do not affect other users.
The Column Layout Preference is a default value. Your team members can modify the number of
columns for themselves.
Page 239 of 308

The changes you make to the Add/Edit Screen affect ALL users. You can select any field including large
text and custom fields, and place them in the desired order.
Fields that you make Required will show as always Required in Workflow. If a field is required only
when the item has a certain Status, see the Workflow section.
Email Alerts
There are three standard types of email alerts:
Page 240 of 308

l Assignment Alerts: Notifies you when things are assigned to you or when something assigned to you
is changed..
l Ownership Alerts: Notifies you when something owned by you is changed.
l All Changes: Notifies you when any changes are made.
To manage which email alerts you receive, hover over the Home menu and select Email Alerts.
Once here, you can choose the area to set the alert for (Defects, Contact Manager, Agile Tasks, etc),
then toggle the alert on or off.
A security setting controls who can and cannot manage alerts for other users. To toggle alerts on or off
for other users, select Update Email Alerts for Multiple Users.
Custom Email Alerts
You can also create custom alerts. For example, if you want to receive an alert when the Priority on a
Defect changes to 1-Fix ASAP, you can define a custom alert to do so.
Click Add New at the top of the Email Alerts page and complete the Add Alerts form.
Page 241 of 308

l Email Alert Type: select Send email when specific field is updated
l Entity Code: select the module for the alert.
l Field Name: select the field that will trigger the alert.
l Title: is filled automatically, but you can modify it to something more descriptive. This will be your
email subject line.
l Description: is filled automatically, but you can modify it to something more descriptive.
l On Update Value: You can leave this default to ANY change (alert is triggered whenever there is a
change to the field) or you can type in a value (alert is triggered when the field changes to this spe-
cific value. Be sure to enter the value exactly as it appears in your choice list.
l Email Message: enter the content for the body of the message.
When complete, click Submit. Your custom email alert is now available for your team members.
Creating Custom Email Templates

You can create custom email templates used for the Send Email function and for escalation rule emails.
Use Tags to include specific information from the record (like the ID, Title, Status, Description, etc).
You can access Custom Email templates from two ways:
Page 242 of 308

l Click Setup and select System Configuration > Escalation Rules > (module) > Email Templates,
then click Add New.
Or:
l From the Send Email form on any module, click Templates and then Add New.
Enter a name for the template and subject line. You can select and insert values from the items by click-
ing the Tag drop down. Select the fields you want to include in the email.
If you check Make Public, anyone on your team can use the template. If unchecked, only you can use
it.
Creating Escalation Rules

Escalation rules allow you to escalate the priority, assignment and other information for requirements,
tests, defects, contacts, and tasks once specific criteria is met. For example, you might consider cre-
ating an escalation rule that is invoked when an active defect is assigned but not updated for 2 days.
When the rule is triggered, it can automatically send an email to the owner, assignee, or specific people
Page 243 of 308

on your team. You can also set the rule up so that it automatically changes information on the defect
record (like the assignee, priority, etc.).
Escalation Rules will fire daily. You can turn off the automatic emails by week day in global System
Options if you do not want the automatic emails to fire on weekends.
To define Escalation Rules, click Setup , then click System Configuration > Escalation Rules, and
then choose the area you wish to create the rule for: [e.g. Defects].
To get started, click on an area (e.g. Defects), then click Add New Rule.
This will take you into a wizard that allows you to define your escalation rule. From the first page of
the wizard, name the rule and set the status and the duration in which the item stays in that status
that will cause the escalation rule to be triggered. For example, if you wish to have the rule triggered
when a defect has been in Active status for 2 days, you will set it up as shown below.
Page 244 of 308

Then click Next and go to the next page of the wizard. From here, you can add additional criteria for
the escalation. In our case, we will add criteria to the rule to exclude any items that have been escal-
ated today and whose last update has been made in the past 2 days:
Page 245 of 308

Then click Next and go to the next page of the wizard. From here, you can choose to send an email
when the rule is triggered. If you have created an email template (from System Configuration > Escal-
ation Rules > (Area) > Email Templates), you can use that email template. Otherwise, you can simply
enter an email subject and choose who to notify. If you do not wish to send an email when the escal-
ation rule is triggered, leave this screen blank and press Next.
Then click Next and go to the next page of the wizard. From here, you can have the escalation rule
automatically update any field(s) on the record upon triggering the rule. In the example below, it will
automatically update the assignee when the rule is triggered.
Page 246 of 308

Managing Workflow and State Transitions

With Workflow, you can set rules about how items can move from one status to another, what data
items are collected along the way, and set rules for automatically assigning items to specific team mem-
bers depending on what status they transition to.
Define your Workflow
Before setting up your workflow, first map out your workflow definition. For example, let’s assume
you wanted to have a custom workflow for tracking Defects. You have decided to implement this
workflow model:
l Status of New: A new defect is reported, you will require that the title, description, status and pri-
ority of the defect is entered. If the defect is reviewed and it is not really a defect, it can be closed.
l Status of Assigned: Once the new defect has been reviewed, it is assigned to a developer to be fixed.
At this point, you want the title, description, priority and severity to be locked, and the assigned to
field to be required.
l Status of Resolved: Once the developer fixes the defect, the status is set to Resolved and the res-
olution code and description is required.
This is how your workflow planning map might look:
Page 247 of 308

Setting up Workflow
There are a number of different ways to get to Workflow maintenance:
l From any Listing, click the Actions drop down and select Workflow
l From an Edit form, click Choice Lists, then click Workflow and State Transitions
l From Setup, go to System Configuration -> Screen Layouts. Select any module and then click Work-
flow and State Transitions.
For this example, go to the Defects Add/Edit screen and click Choice List. Then click Workflow and
State Transitions:
Page 248 of 308

From here you can set the options to match your workflow you defined graphically:
Setting up Temporal (Temporary) Transitions
In some cases, you may want to modify the add/edit form and only display the absolute minimum of
required information for your team. In our example above, when a developer resolves a defect, we
may want to clear the screen of everything but the defect id, title, resolution code and description, so
that it is clear about what needs to be entered and all extraneous information is temporarily hidden.
To create this type of workflow, you will use a temporal transition. Temporal simply means “tem-
porary”, so it will use a temporary status to collect the information needed at the time, and then it will
save that information and automatically set the status to the next logical state. In this case, it would
be the Resolved status.
So to set this up:
Create a new status called Resolve Now
Choose that status and set the “Upon saving, automatically transition to this status:” to Resolved.
Set the “Can Transition To” to Resolved
In the list of fields, set all fields to hidden except Title, Id, Resolution Code and Description (make these
required).
Here is how it might look:
Page 249 of 308

Then once a programmer sets a status to Resolve Now, it will prompt them for only the Resolution
Code and Description. Once they enter that and press Submit, it will save the record and auto-
matically set the status to Resolved.
Setting up Automatic Assignment
If you wish to have an item automatically assigned to a specific person once it reaches a specific status,
you can update your workflow rules for this. To do that, choose the status, and then choose the per-
son to assign it to. For example, notice below that you can choose any team member to automatically
assign to when a defect enters the New status:
Page 250 of 308

Notice that you can also set the “automatically assign to” to [Remove Assignment]. If this is set, it will
automatically remove the assignment when it enters that status. This can be helpful for removing
assignment when items are closed, etc.
Setting up Automatic Assignment based on Functional Areas (Defects Only)
The Defects workflow has a special type of auto-assignment feature that allows you to automatically
assign defects based on the functional area of the defect. To use this feature, you must first setup
your Defect Functional Areas from the Choice Lists area. If you don’t see Functional Area as one of
your Defect Choice lists, check Screen Layouts in Setup to add Functional Area to the Defect Add/Edit
screen. Then you can define a list of values for your Functional Areas.
Once that is done, you can setup the assignment rules for each functional area:
Once clicked, you will see a list of each Functional Area and can associate each with an assignee:
Page 251 of 308

Once this is done, set the “automatically assign to” to [Functional Area Assignee]:
Page 252 of 308

Setting System Options

System Options allows you to configure a set personal preferences and system wide preferences. To
access System Options, click Setup at the top right of the menu bar, then select System Con-
figuration > System Options.
The screen is divided into 2 sections.
Personal Preferences
These preferences only affect you; other team members can change the settings for their own login.
l Your Date Format: Choose your preferred date format.
l Your Time Zone: Choose the desired time zone.
l Your Email Alerts: Click Update my Email Alerts to go to the Email Alert configuration page. This
page can also be accessed from the Home tab.
l Confirmation: Turn on or off the default confirmation messages.
l Linked Items: Check this box if you prefer that the system remember the items you last selected
when linking items.
Note: You may need to re-login in order for changes you make to take effect.
Global System Options
These preferences affect the entire application and all team members and can only be configured by
administrators.
You can set text boxes by module to plain text or enable formatting with the Rich Text Editor check
boxes.
Page 253 of 308

You can change the height of large text fields by setting the Text Field Height in pixels. The height can
be between 48 and 300 pixels. The default is 150 pixels.
Security Settings: Allow all users to see list of project users determines if team members other than
Security Administrators can see the “Users on this project” list in Setup.
Escalation Non Working Days allows you to switch off the automatic emails sent from Escalation Rules
for selected week days. If you do not need the escalation reminders to be sent on weekends, check off
Sat and Sun to switch it off. If you want the rule to fire but not send email, then use the Rules Fired
check boxes – the escalation rule will run but the email will not be sent.
Page 254 of 308

Importing and Exporting Data

The following sections discuss importing and exporting data.
For importing and exporting Tests, please refer to Test Management – Importing and Exporting
Importing Data
Importing data is easy. Simply save your data in comma-separated (CSV) format using any spread-
sheet system and use the import wizard to import the data.
NOTE: Importing Tests into your Test Library requires a specific format for your CSV file. Please refer to
the Importing Tests section in Test Management.
You can access the Import Wizard either from the specific module (Defects, Requirements, etc.) or
from Setup. If you go to any module, click the Actions drop down list and select Import. If you go to
Setup, select Import, then Import Wizard.
Page 255 of 308

Once Import Now is pressed, it imports the items.
Page 256 of 308

If you wish to delete an imported batch (in case of an error), you can go to the Setup tab, choose
Import, then choose Delete Imported Batches. From here, choose the area you imported into (such
as Defects). It will show you the batches you have imported. Select the batch and choose Delete Now.
Exporting Data
Export generates a comma-separated file of your data. You can export only the columns selected on
the listing screen, or All Fields, which includes all available fields on the Edit form plus the latest note.
(Export does not include attachments, multiple notes, nor links.)
To export data, go to the listing screen and click Actions / Export. For example, to export your defects,
go to the Defects Listing screen and click Actions/ Export:
Select either Export (visible fields only) or Export (All Fields)
Page 257 of 308

Open or save the new exported data.
Page 258 of 308

Integrations
Both On-Premises and SaaS clients can integrate some features with third party tools.
For information on integrating with Atlassian JIRA with the QAComplete - JIRA Connector, please see:
Integration With JIRA
For information on integrating Test Management with test automation tools, please see:
Integrating Automated Testing Tools
You can request information about additional third party integrations from:
OpsHub Integrations
Accessing the API

The API enables you to directly access the data and write code that reads, adds, updates and deletes
information from the database. It includes coding examples of using the API to access the data.
For information on using the API, please see:
QAComplete Web Service API
Using the Data Dictionary

The Data Dictionary describe the base tables, views and fields for each major feature.
For information on using the Data Dictionary, please see:
Using the Data Dictionary
Page 259 of 308

Integration With JIRA

JIRA is an issue-tracking system by Atlassian. You use JIRA to manage your projects and track bugs,
issues, use cases and requirements.
Use the QAComplete - JIRA Connector to synchronize JIRA issues with QAComplete Defects or Require-
ments modules to:
l Integrate issues you create in JIRA into your application/testing lifecycle in QAComplete.
l Track and report on JIRA issues in QAComplete.
l Track QAComplete entities in JIRA.
QAComplete - JIRA Connector Service

Use the QAComplete - JIRA Connector service to integrate JIRA issues with QAComplete Defects or
Requirements.
While the service is running, it connects to your QAComplete and JIRA instances at specified intervals
and synchronizes items:
l The service loads data from the source system that was created or edited after the last syn-
chronization.
l The service checks the fields of the source system items and updates the fields of the target system
so that they match the source items.
l If the same field has been changed both in the source item and in the target item, the service will
update the target item's field only if the source item's field has been edited last. Otherwise, it will
leave the target item's field unchanged.
l If you attach a file to an item in a source system, the service will copy the attachment to the appro-
priate item in the target system.
Note: If you change the attachment in the source system, the service will replace the attachment
in the target system as long as the file name remains the same.
l If you comment on an item in a source system, the service will copy the comment to the appro-
priate item in the target system.
l The service does not synchronize cross-referencing links between items. For example, if a JIRA item
is linked to other JIRA items, the relationship between these items is not part of the syn-
chronization.
Page 260 of 308

The synchronization can be bi-directional, where both systems share updates to items, or one dir-
ection, where an item in the source system changes, the service updates the corresponding item in the
destination system.
Synchronization Profiles specify synchronization parameters for each pair of items.
About the Configuration Tool

To configure and control the service, you use the QAComplete- JIRA Connector Configuration Tool.
The tool is shipped and installed together with the synchronization service.
To start the synchronization, click Run Service.
To run the synchronization on demand:
l Select the profile in the Synchronization Profiles list.
l Click Synchronize Now in the drop-down menu.
The service will synchronize items specified by the profile and then stop.
To restore links between synchronized items (you may need this, for example, after you re-install the
service):
Page 261 of 308

l Select the profile in the Synchronization Profiles list.

Note: To use a profile stored in an external file, import the profile data first. See Synchronization Pro-
files
l Click Repair Database in the drop-down menu, under Synchronize Now.
The service will connect to the databases and restore the links between items using the existing syn-
chronization information.
You can view information about synchronized items in the Synchronized Items tab of the con-
figuration tool's main window.
To stop the service, click Stop Service.
Requirements and Prerequisites

To integrate QAComplete with Atlassian JIRA, the following requirements must be met:
l Atlassian JIRA 5.0 - 7.0 must be installed on the server that hosts your JIRA database, or you can use
JIRA Cloud 7.0.
l JIRA must accept remote calls. For information on how to enable JIRA for remote API calls, please
see the JIRA documentation.
l The QAComplete account you use for the integration must belong to a security group that has all
privileges for items you synchronize with JIRA.
l The JIRA account you use for the integration must have Administrator privileges.
l The computer, where the QAComplete - JIRA Connector service runs, must have access to the
QAComplete SOAP service and JIRA REST service.
l The computer cannot have SQL Server installed due to a conflict with SQL Compact used by the con-
nector.
Note: QAComplete do not support extended nor Unicode characters. If items in your JIRA projects
include extended or Unicode characters, the service may fail to synchronize the text in these items cor-
rectly.
Exporting JIRA Workflow Data
To synchronize your workflow across QAComplete and JIRA, export your JIRA workflow to an .xml file
and import it into the QAComplete - JIRA Connector.
To export JIRA workflow:
1. In your JIRA client, login to your JIRA project.
2. Click and then click Issues.
Page 262 of 308

3. Select the Workflows section and find the workflow you need to export.
4. In the Operations column, click View.
5. Click Export and then click As XML.
6. In the Opening Your Workflow dialog, click Open With or Save File.
7. Locate the file and make sure it has an XML extension.
You can import the workflow data when you create a new synchronization profile or on the JIRA Work-
flow page when you edit a profile.
Preparation in QAComplete
1. Create Status Codes in defects or requirements that correspond to your JIRA Statuses.
2. Create a text Custom Field to use for the JIRA Key. Make note of the custom field number (such as
"Custom1").
You will need the custom field number when defining the mapping between the JIRA issue and
your QAComplete defect or requirement.
Note: Use a name for the custom field that identifies it as the JIRA Key. Do not use the word "Cus-
tom" in the custom field name.
On-Premises Only: Allowing Large Attachments
If items you want to synchronize include large attachments, you can adjust the file size limit on your
QAComplete server to allow the larger files.
l When you install QAComplete, you configure IIS on your server to allow a maximum file size. (See
QAComplete Installation Guide.) If you experience issues with synchronizing items with large files
attached you can adjust the IIS setting.
1. On your QAComplete server, open IIS Manager console. Click Start, select Run, type inet-
srv/iss.msc and press Enter.
2. In the Navigation panel, select Default Website.
3. In the Features panel, select Request Filtering.
4. On the Action pane, click Open Feature.
5. Right-click the feature and then click Edit Feature Settings.
6. Make sure that the Maximum allowed content length (Bytes) is set to 100000000.
7. Click OK to save the changes and close the dialog.
Page 263 of 308

l Make sure that your QAComplete web service allows uploading large files.
1. On your QAComplete server, navigate to the C:\inetpub\wwwroot\psWS\web.config file and
open it for editing. (It is an XML file that you can open in any XML or Text editor such as Note-
pad.)
2. Find the system.webServer node in the file.
3. Make sure that the node has the httpRuntime subnode and that the subnode's
maxRequestLength attribute is set to 122800.
4. If needed, add the httpRuntime subnode manually and set the maxRequestLength attribute to
122800. For example:
<configuration>
<system.webServer>
<httpRuntime maxRequestLength="122800"/>
<validation validateIntegratedModeConfiguration="false"/>
</system.webServer>
...
5. Save the file.
Restoring Synchronization Data on Updating or Re-Installing the Service
Before you update or re-install the QAComplete - JIRA Connector service, we recommend that you
store your synchronization profiles in external files:
l In the configuration tool, stop the service and click Manage.
l In the Synchronization Profiles dialog, select the needed profile and click Export.
l Specify the file that will store the data.
After you update or re-install the tool, you can restore the existing links between synchronized items
instead of creating and configuring the synchronization anew. (Otherwise, synchronized data may be
duplicated).
l In the configuration tool, stop the service.
l Import your existing synchronization profile:

l Click Manage and then click Import.
l Browse for the file storing your synchronization data.
Or create and configure a new profile.
l On the main window of the configuration tool, select the profile in the Synchronization Profiles list.
l Select Repair Database from the drop-down menu.
The service will connect to the databases and restore the existing synchronized data.
Page 264 of 308

QAComplete - JIRA Connector Installation

Download the JIRA Connector installation package from our web site.
Note: If you are an on-premises customer, check for your QAComplete Release number and download
the corresponding JIRA Connector:
l QAComplete Release 10.0: JIRA Connector 1.0
Copy the installation package to the machine that will run the synchronization. This needs to be a
machine that can connect to both your JIRA instance and QAComplete.
Unzip the file and run QAComplete JIRA Connector 20 Release.exe.
Note: If you do not have SQL Server Compact 3.5 SP2 on the machine, the installation will offer to
install it for you. Click Yes. Read Microsoft's EULA and click Next to continue installation.
If you have a previous version of JIRA Connector installed on the computer, the installation will offer to
upgrade it. Click Yes.
Read SmartBear's EULA, Click I Accept, then click Next to continue installation.
If needed, change the installation folder for JIRA Connector.
Page 265 of 308

Click Install to confirm the installation.
Note: If you are installing on a machine with SQL Server 2008, there may be a conflict with SQL Server
Compact if exists on the machine. To work around the conflict, first uninstall SQL Compact 3.5 (x86 and
x64), run the connector installation and select Repair, and re-install SQL Server Compact from the con-
nector installer.
Synchronization Profiles
For each pair of items you synchronize, you create a separate synchronization profile. A profile stores
the information that QAComplete - JIRA Connector uses to connect to your QAComplete and JIRA
instances with rules describing how the service copies data from one system to the other.
Starting from QAC - JIRA Connector version 1.2, you can synchronize QAComplete Defects and Require-
ments with JIRA issues of any type.
The profile you create describes how items in a QAComplete project are synchronized with items in a
JIRA project and how fields are mapped between the two.
Create and configure profiles with the QAComplete - JIRA Connector Configuration Tool.
To set up a synchronization profile:
l In the configuration tool, stop the service and click Manage.
l In the Synchronization Profiles dialog, click Add to create a new profile. To copy settings from the
default profile to your new profile, select Default profile in the Copy settings from drop down list.
For a description of the default profile, See "Default Profile"
l To edit an existing profile, select the desired profile in the list and click Edit.
Creating and configuring a synchronization profile includes the following steps:
Page 266 of 308

1. Creating a New Synchronization Profile
2. Configuring General Settings of the Synchronization Profile
3. Configuring QAComplete Connection Settings
4. Configuring JIRA Connection Settings
5. Synchronizing Item Fields and Values
6. Synchronizing Users
7. Synchronizing Workflows
You can create multiple profiles to synchronize different items in different projects. For example, cre-
ate a profile to synchronize JIRA bugs with QAComplete defects and a second profile to synchronize
JIRA user stories with QAComplete requirements.
To disable a profile temporary, clear the check box next to the profile name in the list.
To export profile data to a file for later use, click Export and specify the target file that will store the
data.
To import profile data from an external file, click Import and browse for the need file.
Default Profile
The QAComplete - JIRA Connector comes with two default synchronization profiles to use as a starting
point: one that links defects in QAComplete with JIRA issues of the Bug type and another that links
Requirements to JIRA Stories. The profiles map default fields and choice list values in QAComplete to
the corresponding default fields and values of JIRA bugs.
When creating your customized profile, use the default profile as a starting point by copying it to your
new profile.
Note: if you have customized JIRA or QAComplete choice list values, the values will be different for
your instance. You will need to modify the values to match your choice lists.
Importing Profiles
If you do not see the default profiles in the configuration tool, you can import them from the Program
Files location.
l Start the configuration tool.
l Stop the service.
l Click Manage, then Import.
Page 267 of 308

l Navigate to the location where the configuration tool is installed (c:/Program Files (x86)/Sm-
nartBear/qacJIRAConnector).
l In this folder look for the two profile template XML files:
templateProfileBugs.xml
templateProfileRequirements.xml
l Select the profile and click Open. The default template will be imported and available for use.
Configuration
Once you have copied the Default Profile, complete the Settings, ALM/QAComplete and JIRA tabs.
After you have configured the profile, click the Field Mapping tab.
Mapping
The default profile maps the following values between QAComplete Defects and JIRA bugs.
ALM/QAComplete Field JIRA Field Field Type

Custom1 Key String
Title Summary String
StatusCode Status Status Lookup
PriorityCode Priority Priority Lookup
ResolutionCode Resolution Resolution Lookup
OpenedBy Reporter User
Description Description RichText
AssigneeUserId Assignee User
JIRA KEY
The default mapping assumes that Custom1 in Defects maps to the "key" field in JIRA. Change this to
the correct custom field used in your system.
Status Mapping
QAComplete Status Codes are mapped to default JIRA status values. You can modify the mapping for
changes you may have in either system.
ALM/QAComplete Value JIRA Value

New Backlog
Active In Progress
Closed Closed
Active Reopen
Resolved Resolved
Page 268 of 308

Priority Mapping
QAComplete Priority Codes are mapped to default JIRA priorities. You can modify the mapping for
changes you may have in either system.

1-Fix ASAP Blocker
1-Fix ASAP Critical
2-Fix Soon Major
2-Fix Soon Normal
3-Fix If Time Minor
4-Fix If Time Trivial
Resolution Mapping
QAComplete Resolutions Codes are mapped to default JIRA resolutions. You can modify the mapping
for changes you may have in either system.

By Design Won't Do
Duplicate Duplicate
External Won't Do
Fixed Done
Fixed Fixed
Not Repro Cannot Reproduce
Not Repro Invalid
Postponed Workaround Exists
Will Not Fix Won't Fix
Mapping is fully customizable, so you can add mapped fields and modify the mapping as needed.
Important: If you use required fields in either JIRA or QAComplete, make sure that all required fields
are fully mapped.
Creating a New Synchronization Profile

Create a synchronization profile for the items you want synchronized.
You can create separate profiles for various item types. You can also create separate profiles to syn-
chronize items in various QAComplete projects with issues in various JIRA projects.
To create a new profile, in Synchronization Tool, click Manage and then click Add.
Note: To create a new synchronization profile (or edit an existing one), stop the service first. When you
are done creating or editing the profile, restart the service.
Page 269 of 308

In the Add Synchronization Profile dialog, set up a new profile:
1. Enter the new profile name.
2. (Optional) Enter a description for the profile.
3. To synchronize your item workflow in QAComplete with the JIRA workflow, import the JIRA work-
flow data:
l Click Load JIRA Workflow.
l Browse for the .xml file storing the exported workflow. For information on how to export JIRA
workflow to a file, please see Requirements and Prerequisites.
l Select the needed file and click Open.
Note: You can import the workflow data later on the JIRA Workflow page by editing the profile.
4. Click OK.
To copy settings from an existing profile, select the desired profile in the Copy settings from list and
click OK. For ease of configuration, select one of the default profiles as a starting point to creating your
new profile.
To configure or edit an existing profile, select it in the Synchronization Profiles dialog and click Edit.
Configuring General Settings of the Synchronization Profile

On the Settings tab of the Synchronization Profile Properties dialog, you define the synchronize dir-
ection and configure notification emails:
Page 270 of 308

1. In Synchronization direction list, choose how the synchronization should work:

l Choose Both to enable a bidirectional synchronization. When an item in either QAComplete or
JIRA changes, the service updates the corresponding item in the other system.
l Choose JIRA -> ALM\QAComplete or ALM\QAComplete -> JIRA to enable the one-way syn-
chronization. When an item in the source (first) system changes, the service updates the cor-
responding item in the destination (second) system.
l JIRA -> ALM\QAComplete: JIRA issues are pushed to QAComplete items. When the JIRA
issue is changed, the change is pushed to QAComplete. If the QAComplete item is

changed, it does NOT update the JIRA issue.
l Note: Changes made in QAComplete will be overwritten by changes made later in
JIRA.
l ALM\QAComplete -> JIRA: QAComplete items are pushed to JIRA. When the QAComplete
issue is changed, the changed is pushed to JIRA. If the JIRA issue is changed, it does NOT
update the QAComplete item.
l Note: Changes made in JIRA will be overwritten by changes made later in QACom-
plete.
Page 271 of 308

2. In Max size of attachment, enter the maximum size limit for your attachments in Kb. The default
value is 2048 Kb and the upper limit is 30 Mb.
3. To configure the service to send email notifications on synchronization results:

l In From, enter the email address to use as the "From" address for notifications.
l In Server, enter the address of the mail server used to send notifications.
l In User Name and Password, enter the account name and password used to connect to the
email server.
l In To, enter the email address to receive the notifications. To send notifications to several recip-
ients, enter their email addresses separated by comma.
Configuring QAComplete Connection Settings

On the ALM/QAComplete tab of the Synchronization Profile Properties dialog, specify the location of
your QAComplete web service and login information for the project you want to synchronize with
JIRA.
Note: the Department ID, Project ID and User ID are the unique numeric identifiers found in QACom-
plete.
Page 272 of 308

1. In Server endpoint, enter the URL of your QAComplete web service.

For SaaS clients, the URL address is http://soap.qacomplete.smartbear.com/psWS.asmx.
For On-Premises clients, the URL address is http://[yourserver]/psws/psws.asmx.
2. In appropriate fields, enter the following authentication information:

l In AppCode, enter the application code.
For SaaS clients, use agSP.
For On-Premises clients, use agSPEnt.
l In Department Id, enter the numeric ID of your department.
l In User Id, enter the numeric ID of the user that the service will use to access QAComplete
items. This user must have full permission to the items in the desired Project.
l In Password, enter the password for the user.
l In Project, enter the numeric ID of the QAComplete project that you want synchronized with
JIRA.
You can find the numeric IDs in QAComplete:

To get the application code
l In QAComplete, click to open the Setup page.
l Note down the AppCode value.
To get the project ID and department ID
l In the tree on the left, select Projects (Open & Create).
l Note the values in the ID and Dept Id columns for the desired Project.
If the columns are hidden, click Choose Fields and add the columns to the Chosen Fields list.
To get the user ID
l In the tree on the left, select Security | Users.
l Find the desired user and note the value in the UserId column.
If the column is hidden, click Choose Fields and add the column to the Chosen Fields list.
3. The Item type is the QAComplete module to synchronize with JIRA. Choose Bugs or Requirements
from the drop-down list.
4. The Item data culture is the locale used in QAComplete. Leave the default value of en-US.
5. In Synchronized tool name, enter an identifying name for the JIRA instance that you are syn-
chronizing with QAComplete. Enter JIRA. This name is used in synchronization messages.
Page 273 of 308

6. To open JIRA items directly from the synchronized item in QAComplete, enter the location of your
JIRA instance and the custom field that you defined in QAComplete to hold the JIRA Id in Syn-
chronized item URL pattern. Use the Custom Field number preceded by "Custom" as "CustomX"
Example: http://myteam.atlassian.com/browse/{Custom2}.
The service will use the pattern to generate proper links to each synchronized JIRA item.
Click Test Connection to verify the credentials.
Configuring JIRA Connection Settings

On the JIRA tab of the Synchronization Profile Properties dialog, specify the JIRA database that you
want to synchronize with QAComplete:
1. In Rest host, change [jira server host] to your JIRA server.
2. In User name and Password, enter the name and password for user account used to access and
update JIRA items.
3. In the Project drop-down list, select the JIRA project that you want to integrate with the QACom-
plete project. The list contains all JIRA projects that the specifiied user has access to.
Page 274 of 308

4. In Item type, select the type of JIRA issues you want to synchronize with the specified QAComplete
items.
5. In Item data culture, leave the default locale of "en-US".
Click Test Connection to verify the credentials.
Synchronizing Item Fields and Values

On the Field Mapping tab of the Synchronization Profile Properties dialog, you set up syn-
chronization rules for each individual field. These rules define what the service copies from specific
fields in one system to corresponding fields in the other.
Notes:
l Make sure you know of all required fields in both QAComplete items and in JIRA issues. You need
to map all required fields for a successful synchronization
l If you have synchronization rules set in QAC - JIRA Connector version prior to version 1.2, you
may get the "Some fields in Field Mapping are not supported by JIRA service" warning.
This happens because earlier versions of the tool used JIRA SOAP service to work with JIRA. Start-
ing from version 1.2, the tool uses the JIRA REST service. The format of issue fields the JIRA REST
service uses may differ from the format the JIRA SOAP service uses. As a result, some fields in your
field mapping may be missing. Please check your field mapping and fix the missing fields.
Synchronizing Fields
1. In the table, click in an ALM/QAComplete Field cell to open a drop-down list of fields. Select the
desired field to synchronize with the corresponding data in JIRA. You can set synchronization rules
for both the built-in and custom fields.
2. Click in the JIRA Field cell to open the drop-down list of JIRA fields for the selected item type. Select
the field that corresponds to the QAComplete field.
Page 275 of 308

Note: If you change the JIRA item type, the JIRA Field column will be cleared and you need to recon-
figure the field mapping.
3. In the Field Type column, choose the type of the QAComplete field.
l For lookup fields (fields that take values defined in a choice list), choose the Lookup field type.
(See below.)
l For fields that store information on a user, for example, AssigneeUserId, choose the User field
type.
Note: In order for the service to copy information on users properly, first synchronize the
account information. See Synchronizing Users
l For fields, that store information on the item status, priority and resolution, choose the Status
Lookup, Priority Lookup or Resolution Lookup types. (See below.)
l For JIRA fields that accept multiple string values (for example, the Labels field), choose the
String Array field type. The service will copy values from JIRA to QAComplete as string values
separated by a comma.
Page 276 of 308

lFor JIRA fields that accept multiple predefined values (for example, the Component/s field),
choose the Lookup Array field type. (See below.)
Important: Make sure that the selected field type can be converted to the appropriate JIRA field
type explicitly.
4. Map the QAComplete custom field for the JIRA Key using the custom field ID such as Custom1 to
the Jira Key field.
5. Continue in the next row, selecting corresponding fields to map.
Synchronizing Status, Priority and Resolution Fields
If the field to be synchronized contains the status, priority or resolution, set the mapping rules for
each possible value:
1. In the ALM/QAComplete Field, select the field that holds the item status, priority, or resolution.
2. In the JIRA Field, select the field that corresponds to that QAComplete field.
3. In the Field Type, choose the Status Lookup, Priority Lookup, or Resolution Lookup field type.
4. Click in the ALM/QAComplete Value cell to open the list of possible item statuses (or priorities, or
resolutions) in QAComplete. Select the needed value.
Page 277 of 308

5. Click in the JIRA Value column to open the list of item statuses (or priorities, or resolutions) in JIRA.
Select the value that corresponds to the value in QAComplete.
Synchronizing Lookup Fields
If a field to be synchronized is a lookup field (values are defined in a choice list), set the mapping rules
for each value:
1. On the Field Mapping tab page, select the lookup field.
2. In the ALM/QAComplete Value column, enter a value from the choice list in QAComplete.
Page 278 of 308

3. In the JIRA Value column, for each value, set the corresponding value used in JIRA.
Synchronizing Lookup Array Fields
If a field to be synchronized is a multi select field in JIRA (accepts multiple predefined values), set the
mapping rules for each value:
1. On the Field Mapping tab page, select the lookup array field.
2. Click in the JIRA Value cell to open the drop-down list of available values. Select the needed value.
Page 279 of 308

3. In the ALM/QAComplete Value column, enter the corresponding value used in QAComplete.
The service will copy the values from JIRA to QAComplete as string values separated with comma.
Synchronizing Users
On the User Mapping tab of the Synchronization Profile Properties dialog, you associate user
accounts in QAComplete with JIRA user accounts. It enables the service to synchronize fields that hold
information on users.
1. In the User Mapping table, click in the ALM/QAComplete Account cell and select an email address
of an QAComplete user account from the drop-down list.
Page 280 of 308

2. Click in the JIRA Account cell and select the JIRA user that you want to associate with the QACom-
plete user. The list contains the users that have access to the specified JIRA project.
After you link the user accounts, synchronize the fields that holds user information:
1. Open the Field Mapping page.
2. In the ALM/QAComplete Field column, select the field that holds the information on the QACom-
plete user.
3. In the JIRA Field column, select the field that holds the information on the JIRA user.
Page 281 of 308

4. In the Field Type column, choose the User field type.
Synchronizing Workflows
A workflow defines what stages an item passes during its lifecycle in the system. You can synchronize
your QAComplete workflow with JIRA workflow so that when an item transfers to a new state in one
system, it automatically transfers to the appropriate state in another system.
To synchronize workflow, first you must export the workflow from JIRA. See Exporting JIRA Workflow.
The JIRA Workflow tab of the Synchronization Profile Properties dialog displays the imported
JIRA workflow.
Page 282 of 308

Important: To view the JIRA workflow, upload the workflow data first. Click Load JIRA Workflow and
browse for the exported XML file storing the JIRA workflow. You can also load the workflow data in the
Add Synchronization Profile dialog when you create a new profile.
To synchronize your QAComplete workflow with your JIRA workflow, synchronize the statuses the
item can have:
1. Open the Field Mapping page. The page defines synchronization rules for the fields.
2. In the ALM/QAComplete Field column, select the field that holds the item status in QAComplete.
3. In the JIRA Field column, for that field, set the field that holds the item status in JIRA.
Page 283 of 308

4. In the Field Type column, choose the Status Lookup field type.
5. Click in the ALM/QAComplete Value cell to open the list of item statuses in QAComplete. Select a
status.
Page 284 of 308

6. Click in the JIRA Value cell to open the list of item statuses in JIRA. Select the item status that cor-
responds to the item status in QAComplete.
Configuring the Synchronization Intervals

To configure when and how often the service will connect to databases and synchronize items:
l In QAComplete - JIRA Connector Configuration Tool, click Service Settings.
l In the Service Settings dialog, set the interval (in minutes) for the service to perform the syn-
chronization.
l Use the Period Start Time and Period End Time to set the period during which the service will be act-
ive.
Configuring Proxy Settings

If you connect to your JIRA and QAComplete servers through a proxy:
l In QAComplete - JIRA Connector Configuration Tool, click Service Settings.
l In the Service Settings dialog, click Proxy Settings and configure the proxy settings in the resulting
dialog:
Page 285 of 308

l No proxy - Select this option to connect to your JIRA and QAComplete servers directly.
l Use system proxy settings - Select this option to connect to your JIRA and QAComplete servers
through the proxy configured for your operating system. You can find the proxy and proxy set-
tings in the Local Area Network (LAN) Settings dialog. (Open Internet Explorer and click Tools
| Internet options | Connections | LAN settings.)
l Custom proxy - Select this option to set the proxy server that you want to use manually:
In Proxy address, specify the network name or IP address and (optionally) the port of the
proxy server you use to connect to your JIRA and QAComplete servers. For example,
192.168.100.50:8888.
If your proxy server requires authentication, enter the user name and the password to con-
nect to the proxy server.
l Click OK to save the changes and close the dialog.
Viewing Synchronization Logs

To view synchronization logs, go to the Synchronization Log tab from the main window of the QACom-
plete - JIRA Connector Configuration Tool.
Page 286 of 308

The page lists all synchronization events that occurred for profile selected in the Synchronization Pro-
files list. Check the status column to see whether the synchronization event passed or failed.
To update the log, click Refresh log data.
To view synchronization actions performed during a specific time period, set the From and To dates.
To remove the filter, click Clear filter.
To view information only for the most recent synchronization action, select View last synchronization
only.
To export the log to review and save it outside of the QAComplete - JIRA Connector Configuration Tool:
l Click Export Log.
l Specify the path and file name for the exported log.
l The service will export the log data to a .log file in the specified folder.
To view information on synchronized items, switch to the Synchronized Items tabbed page.
Page 287 of 308

The page lists all QAComplete items synchronized with appropriate JIRA issues by ID.
Working With Synchronized Items

In QAComplete, items synchronized with JIRA issues are marked with the Synchronized with note and
a link to open the item in JIRA.
You configure the link in the synchronization tool (See Configuring URL Pattern).
Important: The link is available only if the initial synchronization between JIRA and QAComplete was
completed successfully. (Examine the log to review the synchronization status.)
Click the link to open the item directly in JIRA.
Page 288 of 308

Using the On-Premises Features

If you purchased the On-Premises solution (self-hosted, formerly "Enterprise" version), you have
access to a few additional features. The on-premises version requires your own hardware and IT
resources.
On-Premises:
l Requires your own hardware. Please see System Requirements.
l Requires management by your own IT team
l You can modify the built in Crystal based reports (Requires your own Crystal Report
license and resource)
l You can create custom Dashboards (Requires your own resource)
l You can use Active Directory integration
l Updates are scheduled approximately twice a year (Requires your own resources per-
form the update)
Software as a Service solution
l Requires no investment in hardware nor IT resources other than a computer with a

browser
l Requires no investment in an IT team at your site
l Updates are seamless and regularly scheduled, requiring no effort on your part
Page 289 of 308

Active Directory Authentication (On-Premises / Self-Hosted

only)
Clients that are using our On-Premises solution have the option of using Active Directory (AD) for pass-
words, allowing them to reduce the number of passwords each user needs to remember for each sys-
tem they access.
Understanding Active Directory Authentication

When Active Directory Authentication is configured, your team members can use Active Directory
Authentication instead of QAComplete's built in password authentication.
A checkbox on the user’s profile record tells the log in process if the user authenticates with Active Dir-
ectory instead of QAComplete's authentication. If using Active Directory, the log in takes the Lookup
Value for the user from their user profile, checks Active Directory to find out what attribute to use to
validate the value (the Lookup Value in the Query Attribute that you’ve decided on) and performs the
authentication.
To set up Active Directory Authentication, you will need to gather certain information: your LDAP Con-
nection URL, User Base, and a Lookup User Name and Password that we can use to access Active Dir-
ectory and perform the authentication. The setup also needs to know a default Project, Security
Group and Time zone for new users created from Active Directory, and who needs to be notified when
the users are added.
If using an email address as the Query Attribute, you can add an additional layer of security: if the user
is not found in Active Directory but is found in Security > Users, the email login address can be auto-
matically disabled in Users. This allows you to switch completely over to Active Directory and turn off
any existing logins that you no longer want.
In another scenario, if the user is found and authenticated in Active Directory but is not a QAComplete
user, you can elect to automatically create a valid user.
Managing Active Directory Authentication - Security

To set up Active Directory Authentication, first decide which Security Group should control the Active
Directory Authentication setup.
Click Setup at the upper right of the menu bar, go to Security > Security Groups and click on the
Manage Security icon for the desired Security Group.
Scroll down to the Management Features block and select Manage Active Directory Authentication.
Page 290 of 308

Check the box to allow this group permission to Active Directory Authentication setup.
Active Directory Authentication – Setup

Once permission to Active Directory Setup has been given, you will see and Active Directory Authentic-
ation Setup in System Configuration.
LDAP Active Directory Authentication Setup

In the LDAP Active Directory Authentication block, enter the connection information that you’ve
gathered.
Page 291 of 308

LDAP Connection URL (example: ldap://localhost:389)
User Base (example: CN=users,DC=mycompany,DC=com)
Lookup User Name: The Active Directory user that the login process uses to authenticate
Lookup User Password: The password for the Lookup User Name
Query Attribute: Which Active Directory Attribute do you want to use for authentication (such as
sAMAccountName, Email Address)
Testing Active Directory Authentication Setup

You can check out your Active Directory Authentication with the Test LDAP Authentication block,
which will return detailed messages about the connection and login.
Enter the Lookup Value for the selected Query Attribute and Password and click Test Login.
Test LDAP Authentication returns information about the connection and the authentication for
troubleshooting.
Active Directory Options

Active Directory Options give you additional customization:
Page 292 of 308

l Log each active directory password authentication gives you the option to post all authentication
events to an audit file. This is great for troubleshooting any Active Directory Authentication or con-
figuration issues.
l At Login, automatically create a new SoftwarePlanner user if successfully authenticated in Act-

ive Directory: Check this box if you want your Active Directory users automatically set up in Setup /
Security / Users without intervention from you. You must be using email address as the Query
Attribute.
l The next four fields are the default settings for new users created from Active Directory Authentic-
ation, which occurs when the box is checked.
l Automatically Add Users to: Select a default project for the new users
l New Users should be added to this Security Group: Select the Security group that the new users
will belong to.
l Default Time Zone for new users: select the default Time Zone for new users
l Send Notification email to: Enter an email address, and this person will be alerted when a new user
is created from Active Directory Authentication.
l When creating a new user in QAComplete, if they are using Active Directory authentication, use
this Email Body for the new user email alert: enter the text that you want in the email alert body.
l At login, if the user cannot be found in Active Directory, disable the SoftwarePlanner user
account? If you check this box, when a user with a valid email address in Setup / Security / Users is
NOT authenticated in Active Directory but tries to log in, Active Directory Authentication takes pre-
cedence and locks them out. We advise you leave this unchecked until you have tested Active Dir-
ectory Authentication and have it working the way you want – then check it if this is a security
setting that appeals to you.
Be sure to click Save Changes.
Page 293 of 308

Setting up Active Directory Users

When Active Directory Authentication is enabled, a checkbox appears on each user’s profile to switch
Active Directory Authentication on or off for that user. (You can have both: some of your team mem-
bers using Active Directory Authentication, and others using the built in authentication.)
When you check the Active Directory User? box, Active Directory Authentication will be used for this
person.
In AD Search Value, put the value that will be used by the Query Attribute property for locating this
user in Active Directory Authentication.
Page 294 of 308

On-Premises Setup Options

On-Premises installations have access to additional configuration and setup options in Setup.
System Preferences
System Preferences control certain application behaviors, such as email alert templates (See "Cus-
tomizing Email Alert Templates (On-Premises only)").
Note: Most System Preferences are system-controlled, and should only be reviewed on the advise of
the Support Team.
You may modify an Import Test example profile (See "Importing and Exporting Tests"). To change this
particular setting, click Setup at the upper right of the menu bar and go to System Configuration >
System Preferences. Use the Quick Search to find "ImportTestSteps-LineBreaks" in the Code field.
Security
In Security Groups, security settings specific to the On-Premises solution control permission to the on-
premises specific features:
l Manage Active Directory Authentication: allows access to Active Directory Authentication Setup in
System Configuration.
l Manage Reports: allows access to Report Setup, Report Maintenance, Report Groups and Report
Scheduler.
Page 295 of 308

l Manage Dashboards: allows access to Manage Dashboard Charts and Manage Dashboard Pages
under Report Setup. Requires permission to Reports.
To control permissions to these features, go to Security > Security Groups. Click the Manage Security
Rights icon next to the desired Security Group. Scroll down to the Management Features section and
select or unselect the check box to give or block permissions.
Permanently Delete Users

USE WITH CAUTION: THIS ACTION CANNOT BE UNDONE.
When you delete a user, the system performs a "soft delete". The user record is made inactive and no
longer has permission to the application. There may be times when you want to complete remove the
user record from the database, but this should be used with caution. This function is available only if
the user has never logged in to the application so there is no data for that particular user. If you per-
manently delete a user that has worked with the application, you will end up with records owned or
updated by an invalid user.
To permanently delete a user, click Setup at the top right of the menu bar and go to Security > Per-
manently Delete Users. Select the user from the drop-down list.
Verify this is the correct user and the correct action to take.
When you check the Delete This User (Are You Sure?) check box and then click Submit, this imme-
diately deletes the user and cannot be undone.
Page 296 of 308

License Manager
When you purchase additional licenses or change your licensing option, you will receive a new License
Key from SmartBear Software.
License Manager
Security permissions control access to the License Manager (See See "Additional Security Settings"). To
apply a new License Key, you must have permission to the License Manager.
When you receive a new License Key, click Setup at the upper right of the menu bar and go to Secur-
ity | Manage License.
Copy the new License Key from the email that you received, and paste it into the License Key box.
Click Verify License.
Your new license information is displayed in GREEN text.
Click Update License to apply the new License Key.
Log out, then log back in. Go to Setup to view the licensing change.
Page 297 of 308

Create Custom Fields based on SQL Queries (On-Premises

only)
On-Premises clients may create a new combo box and fill it with the information from the another
table in the SoftwarePlanner database.
For example, you may create a field on the Defects screen that returns a list of your Security Admin-
istrators. To do this, go to the Custom Fields screen for Defects and enter a field name (for example,
"Our Administrators"). Next, select the "Choice List (Based on SQL)" Field Type. Enter the SQL query to
retrieve the information about administrators from the list of users on the Persons table:
Once this is done, the new combo box will appear on the Defects screen. It will list users that have the
Security Admin check box selected:
Page 298 of 308

Create Custom Fields with Sublist (On-Premises only)

On-Premises clients can create a filtered selection by using the Custom field “Choice List (List with Sub-
list based on SQL)”.
This function allows you to give your users a shortcut, which can be used to locate the value for a field.
It can be helpful, when you have a lengthy list of items for validation. You can use this function to split
all items from the list into custom categories for easier selection.
For example, you have several Product Lines for your Applications. You have created the custom
Applications list, which is organized into Product Lines:
All values in the Application column must be unique. They are categorized by the Product Line only to
simplify selection of Application. Only the selected Application value is actually stored in the record.
To create a custom field, define it in Requirements:
Click Save when asked.
Page 299 of 308

The Select statement on the preceding screenshot refers to the “Field1” and “Field2” fields. These field
names come directly from the Lists table. They are not the labels from your field definitions.
Please use these syntax rules to properly build relationships between the fields:
l Every first field must be followed by “Code1” and “Desc1”.
l Every second field must be followed by “Code2” and “Desc2”.
l Every third field, if used, must be followed by “Code3” and “Desc3”, and so on.
The name of your list becomes the ListTypeCode value. Our example list is called “Applications”. If you
are referencing a table other than a list, use actual table and field names from that table.
Check the syntax once again and click Verify SQL.
Page 300 of 308

When you select Testing and QA in the first field, the second field lists the Applications in the Testing
and QA Product Line.
Click Submit.
Back in Requirement, you will see your Custom field for Application on the Add or Edit form.
Page 301 of 308

Open the drop-down list to see your list of Product Lines. After you select a Product Line, a second field
opens up.
Open the second drop-down list to see the list of Applications filtered by Product Line.
Make your choice and click Submit.
Another example: you have Product Line, Application and Module in another list. If you like to com-
bine this information into the Choice List with Sublist, you can actually concatenate the fields from
your List (or other table) into the new Custom Field.
Here is the sample list:
Page 302 of 308

The custom field is called “Product, App and Module”. Its definition looks like this:
Select distinct
Field1 Code1, Field1 Desc1,
Field1 + ' | ' +Field2 Code2, Field2 Desc2,
Field1 + ' | ' + Field2 + ' | ' + Field3 Code3, Field3 Desc3
From Lists
where ListTypeCode = 'FunctionalArea'
Order by Field1, Field2, Field3
You will find the results output on the Edit form:
You can add your newly created field into the listing:
Page 303 of 308

Note that this is a single custom field, not a logical relationship between multiple fields.
Page 304 of 308

Customizing Email Alert Templates (On-Premises only)

The system generates email alerts with a default built-in template for subject and body blocks. To
modify the built-in template, create new Preferences to override the built-in format.
Here is an example of a default email alert layout for the Defects entity.
To setup Email Alert Templates that can be customized, create a new set of Preferences for your
department. Once the System Preferences have been created with the initial default data, you can
alter the default email alert template.
Check whether you already have any overrides. Use the Quick Search on EmailAlerts to find any pre-
existing email alert preferences. If you cannot find any preferences for EmailAlerts, please contact our
support team for assistance.
If there are any available existing email alert preferences, you can replace or modify the Subject text in
the Value field to customize the subject for the corresponding email alert. Replace or modify the HTML
code in the Value field to customize the email alert in any of the HTML fields. The HTML value can be
modified up to 2000 characters.
Page 305 of 308

We use tokens as place holders. They will be replaced based on the data of the record being sent for
the Email Alert. For example, if the Email Alert Subject is "Defect {Id} – {Title}", then when the email
alert is sent the {Id} and {Title} will be replaced with the actual values for that defect, like in following
example:
Defect 12345 – This is a test defect
You can use these general tokens:
l {Id} – unique Id of the record. Note that this is the built-in auto incremented field.
l {Title} – Title of the record.
l {AppCode} – Your AppCode (for example, agSPEnt).
l {AppName} – Your Application Name (for example, QAComplete).
l {ProjId} – Current Project Unique Id.
l {ProjName} – Current Project Name.
l {ProjectName} – Current Project Name.
l {ProjectId} – Current Project Unique Id.
You can also use a token based on the name of any existing field. For example, for Defects, you can use
an {IssueCode} token, which will be replaced with the value of the IssueCode field for that alert. This
works for email subject and body blocks.
We also have the tokens setup that will insert specific sections that you see in the default template lay-
out:
l {TakeMeThereURL} – Embeds a Take Me There link into the alert so the recipient can click to go dir-
ectly to the record.
l {MostRecentHistory} – Embeds a recent history table in our standard table format.
l {Details} – Embeds an HTML table of details of the record using our standard format.
Page 306 of 308

Service Manager Configuration Tool

Service Manager Configuration is a tool included with On-Premises installation. This tool configures
maintenance jobs (for example, sending daily reports or clearing temporary files) that run your QACom-
plete | ALMComplete server on a scheduled basis.
IMPORTANT: Do not make any changes to your system using the Service Manager Configuration
Tool unless you are working with the SmartBear Software Customer Care team. The following
information is for reference only.
Configuring Settings Common for all Jobs

The General page of the Service Manager Configuration tool contains settings that apply to all jobs.
l Jobs running on your server can send email notifications. You can configure default email settings
that will be applied to all jobs that send notifications:
n Enter the network name or IP address of the email server, from which you want to send noti-
fications (we recommend that you set the outgoing email server to localhost).
n If needed, enter the name and the password of the user account used to connect to the email
server.
n Enter the email address, from which the notifications will be sent.
n If needed, enter the email address, to which the notifications will be sent.
When you change email settings, the tool will show you a message asking to select jobs to which
you want to apply those changes. Select the needed jobs and click Apply.
l Specify how often the service should check the jobs to run. Default value is 5 minutes.
l If needed, enter the email address to which the logs will be sent. Select the needed level of log
details.
Configuring Jobs
The Jobs page of the Service Manager Configuration tool is used to configure specific jobs.
To configure an existing job, select it in the Jobs list. To create a new job, click Add New Job and enter
the name for it.
l On the Intervals page, specify how often the job should run and a period, during which the job is act-
ive. Specify the timeout for the job.
l On the Path page, specify the application, command, routine or function the job should run.
l On the AppCodes page, enter your application code (agSPEnt) and the connection string for your
application.
Page 307 of 308

l On the Parameters page, enter the parameters for your job. If your job will send email notifications,
specify the needed email settings.
To temporary disable a job, clear the Enabled check box. To delete a job, select it in the Jobs list and
click Delete Job.
Page 308 of 308


QAC User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

QAC User Guide

Uploaded by

Copyright:

Available Formats

QAComplete Documentation

Using QAComplete General Information

With QAComplete you can:

l Re-purpose and reuse assets across your testing cycles.

l Customize the tool to your development methodology.

l Establish clear traceability across requirements, test cases, and defects.

Managing the Software Lifecycle

On-Premises System Requirements

l QAComplete has a new LOOK.

screen and easier navigation.

l Access Setup from the gear icon on the new menu.

For more details, see About Dashboards.

l For more details, see About Reports.

Strong Password Enforcement

l Security Administrators can enforce stronger password rules.

l Set a minimum password length (no less than 8).

l Set the password re-use policy.

l Set the password expiration time.

Reminder: Update your shortcuts to the new URLs:

l New Login URL: https://login.qacomplete.smartbear.com

l New SOAP URL: http://soap.qacomplete.smartbear.com/psWS.asmx

l New REST URL: https://rest.qacomplete.smartbear.com/rest-api/service

Interested in the history of features? See Version History.

Interested in information on fixes? See Fixes by Release.

Support and Resources

l Recorded Videos: Video Tours & Demos.

l Community Forums: SmartBear Community Forums.

l Articles: QAComplete Resources.

l SmartBear Software – www.smartbear.com.

l Contact Support: Contact Customer Care.

l API: Using the API.

l Data Dictionary: Using the Data Dictionary.

Getting Started with QAComplete

System Administrator Steps

To create a security group:

2. In the left navigation panel, select Security > Security Groups.

3. Click Add New.

7. Scroll down and click Submit to save your settings.

2. In the left navigation panel, select Security > Users.

3. Click Add New.

4. Enter the user's information (Name, Email, etc.)

Your new users automatically get an email with login details.

2. In the left navigation panel, select Projects (Open & Create).

3. Click Add New.

4. Enter a Project Name and click Submit.

To grant users permission to Projects:

2. In the left navigation panel, select Projects (Open & Create).

3. Click the Manage Security Rights icon next to the Project.

Create your Data

To start creating Releases:

1. Select Releases from the top menu bar.

1. In the left navigation panel, highlight the desired Release.

2. In the right, click Add New.

4. Fill out the name, status, and estimated dates.

2. Click Add New.

See Requirements Overview video.

First, create your Tests:

2. Click Add New.

3. Complete your Test description and other details and Submit.

5. Continue defining your test cases.

Next, define your Test Sets:

2. Click Add New.

6. Click Save and Exit.

7. Click Add New to continue defining Test Sets.