User Guide

Dashboard

Three activities are shown here on the top of the dashboard

Test scenarios: Stating number of Test Scenarios against project
Test case: Stating number of Test Cases against project
Defects: Stating number of Defect against project

Five graphs are being shown such as the following:

Heat Map: Show’s the health of each project by showing the number of defects open and fixed
Trend Analysis: It will show the current statuses of the defects
Defect by Severity: Refer to the severity of the defect being logged with filter
Defect by Status: Refer to status of the defect logged with filter
Test case Status: Refer to the current status of the test case with filter
Executed Test Cases: Refer to the test cases which has been executed with filter
Pie Charts: Pie Chart can be accessed by clicking on any Bar graph to analyze the number of defects considered which lead to the particular result.

Projects

The project screen contains a list of all your active and archived projects.

Creat Project

To create your project you simply click on create project button.

Not all testing projects are the same so you have the option to choose your project type and even customize the project type if required.

Choosing any project type will subsequently make any related OS, browser and devices field appear dynamically.

Fill out the following text fields to create your project

• Project Name (Project Name must be at least 5 characters long.)
• Choose Project Type from project type drop-down
• Choose the Operating system from the given Operating system drop-down
• If you select Native Mobile Applications you can select device tab will appear to enter the devices.
• “Operating System” field is now enabled
• Write down any operating system in the “Operating System” field
• Provide a brief description of your project
• If clicked on “Cancel” link, the project will not be created and user will be redirected to “Create New Project” page

Once the details are final click on create to save your project. A success message confirms that your project is saved successfully.

Edit and Delete Projects

To edit project details, add users to projects or archive your projects, you simply hover the mouse to the list and click on any of the action buttons

Team

Team Management on the project level can be done through the team page in project management.

Users on Kualitee domain can be assigned to different projects. In case, a new user needs to be added you can click on add new user to start with adding a user to the domain first.

In User, you simply provide First Name, Last Name, Email and the role that you would like to assign to this user.

Builds

The build is the process of naming and providing the details of the software build/iteration/sprint that you would be testing as part of your project. Each project can have multiple builds.

Creating a new build

Fill the following fields:

• Build ID
• Start date
• End date
• Users
• Description

Click on “Create Build” button

To edit and delete the build hover the mouse to the list.

Module

The next step after build creation is of modules.

Each build within a project can contain multiple modules. The Module Management screen will display a list of all modules within a specific build.

Creating a Module

Editing or Deleting a Module

You can edit or delete a module by hovering the mouse on the listing.

Requirement Planning

You can use requirements planning to associate your existing test scenarios and test cases with parent and sub-requirement.

Creating Requirements & Sub-Requirements

To create requirements, you simply go in project management, select requirements and click on create requirement. Your first requirement is your parent requirement and you can assign sub-requirements to by selecting the parent requirement from the drop-down. A parent requirement can have multiple sub-requirements and the user can also associate test scenarios and test cases with these sub-requirements.

Associating Test Scenarios and Test Cases

If you already have test scenarios and test cases in your project, you can associate them with your requirements or you can edit your test cases in Test management and select the requirement from the drop-down field.

Import & Export Requirements

To import your already created requirements you can simply download the CSV template and enter all the relevant information including your test scenario and test cases if you want them to be associated with your requirements. This will automatically create all the entries and populate the information.

Note: Kindly make sure that all the fields are mapped properly to avoid any issues.

Test Cases

The test case contains summary, test steps, precondition, postcondition developed for specific test scenario to verify any requirement. Mutiple test cases can be associated with test scenarios and requirements for any build and module.

Creating a test case

• Ensure that a Project has been selected from the ‘Select Project’ drop-down on top bar
• To create a new Test Case select the ‘Test Case’ tab from within the Test Management tab
• Click on “Create Test Case” button

While creating test case, Test case ID, Summary and Test type are compulsory fields. While other are optional fields.

Kualitee by default has different roles with specific set of permission. If you are a tester creating test cases, you will need to get them approved before moving them forward for execution. By default, your domain admin, test manager has the permission to approve test cases. You can ask for approval with each created test case or in bulk when importing them.

Import and Export of Test Case

Additionally, you can also import your already created test cases, you can either upload your own copy and map the fields according to Kualitee fields using the in-app mapping wizard or you can download the template and use that to upload your list of test cases.

You can export your data in three different formats CSV, Excel and Word. Click on any of the icons will get your file ready for export and promp you when its ready for download.

Bulk Edit

You can use the bulk edit option to change associations between data e.g build, module, requirements and test scenarios associated with your test cases can be changed using the bulk edit option for selected or otherwise all of the items in the listing.

Note: Associations once changed cannot be reverted back to earlier state.

Bulk Action

The action button allows you to save your test cases as templates for future use or save them as a copy. Additionally, you can also approve and reject test cases as well.

Delete and Bulk Delete

To delete an item(s) from the list you have to hove to that specific test cases and the option to delete, edit will appear at the end of the row. You can also bulk delete by selecting mutiple test cases and click on the bulk button.

Test Scenarios

Test scenarios are tied with builds and requirements. Test cases can be grouped according to scenarios to provide further coverage for testing.  The listing shows associations that each test scenario has with build, module and requirements. Test Scenarios can also be created independent of the mentioned associated.

Creating a test scenario

To start with creating your test case, follow the steps below

Import and Export of Test Scenarios

Additionally, you can also import your already created test scenario and test cases, you can either upload your own copy and map the fields according to Kualitee fields using the in-app mapping wizard or you can download the template and use that to upload the your list of test scenarios.

You can export your data in three different formats CSV, Excel and Word. Click on any of the icons will get your file ready for export and promp you when its ready for download.

Bulk Edit

You can use the bulk edit option to change associations between data e.g build, module or requirements associated with your test scenarios can be changed using the bulk edit option for selected or otherwise all of the items in the listing.

Note: Associations once changed cannot be reverted back to earlier state.

Delete and Bulk Delete

To delete an item(s) from the list you have to hove to that specific test scenario and the option to delete, edit will appear at the end of the row. You can also bulk delete by selecting mutiple test scenarios and click on the bulk button.

Cycle

The test cycle contains test cases or entire test suites that spans multiple builds. These cycles can be your functional cycle, UI cycles etc. They can also be your regression cycles. Cycles are created to move your test cases for executions.

Creating Cycle

• To create a cycle, you ensure that a project has been selected
• You go in cycle under test lab
• Click on create cycle

While creating cycles you choose the respective build which is being tested. The testing dates would be within the same period you have set for the build.

You can now also assign cycles to your teams so they can commence testing.

Deleting a cycle

You can also delete the cycle by hovering your mouse on the specific cycle.

Manage Test Cycle

User can drag and drop Test Scenarios and Test cases from the project repository to the cycle repository

You can move the same test case from your project repository to multiple cycles in the cycle repository. Each test case execution transaction history is maintained exclusively with regard to the cycle it was integrated.

Note: only those test cases will be available in the Project Repository, which are approved by the Test Manager.

Test Case Execution

In test case execution screen, you can execute both your manual and automated test cases. In the listing section you will see test cases associated with build and cycles with which you have created the association. You can directly execute the test cases from the listing

To view the test case detail you can simply click on the test case and pop-up view will open.

Executing Test Case

To execute the test case simple click on execute. To manually execute, simply select the status from the drop down and click on execute. This will update the status of the test case and save the transaction.

When you have marked a test case as failed, the system will ask if you would like to associate a defect with it. Clicking on add defect will ask two options

• Create defect
• Attach existing defect

Clicking on create defect will take you to the defect management to create a defect from scratch. Clicking on Attach existing defect, will open a pop to choose the defect from your already created list of defects

Defect Management

Defect management gives you a detailed picture of the type of defects. You can capture a bug by reporting different aspects of abnormalities in our information rich format. You can further manage your defects by approving, assigning to developers, rejecting and logging comments for future references. Bugs can be tracked in multiple ways, simplifying the process manifold through different viewing formats. You can monitor the bug history any time with multiple information pointers.

Creating Defect

Ensure that a project has been selected and then move to defect management by clicking on the left side pane.

Defect Id’s are auto-generated. You have the following fields to provide details on the defect in defect management

• Build
• Module
• Defect Description
• Defect Type
• OS
• Severity
• Status
• Steps to Reproduce
• Actual Result
• Expected Result
• Comments
• Assign to
• Priority
• Attach Video
• Attach multiple images
• If you have integrated with JIRA, also select the JIRA user

Clicking on the save button will create the defect.

Import and Export of Defect

Additionally, you can also import your already created defects, you can either upload your own copy and map the fields according to Kualitee fields using the in-app mapping wizard or you can download the template and use that to upload your list of defects.

You can export your data in three different formats CSV, Excel and Word. Click on any of the icons will get your file ready for export and promp you when its ready for download.

Bulk Edit

You can use the bulk edit option to change associations between data e.g build, module, requirements  associated with your defect can be changed using the bulk edit option for selected or otherwise all of the items in the listing.

Note: Associations once changed cannot be reverted back to earlier state.

Delete and Bulk Delete

To delete an item(s) from the list you have to hove to that specific test cases and the option to delete, edit will appear at the end of the row. You can also bulk delete by selecting mutiple test cases and click on the bulk button.

Task – Calender View

In tasks you will see tasks and timelines for your project. You can view the details of each task by bringing the cursor on it. The details include:

• Project Name

• Start and End date

• Module

• Assigned to
• Assigned By

Meanwhile colors are custom selection by users to differentiate between projects.

You can create, edit and assign new tasks to your team members by clicking on any of the dates you wish to start your project from.

Once you have successfully created and assigned the task a notification will appear on the ‘Notification bell’. Your task will also be represented on the calendar under the color you have chosen from start to end date. You can check the brief details of the task by bring you cursor on the color.

Tasks – Board View

No matter what methodology you use Scrum, Kanban, or your own unique approach; Boards are built to support you, so you can work your way.

Columns:

Define your own columns for each process, and use them to quickly see the status of each task — and what still needs to be done before you can reach your goals.

Drag & Drop

You can drag and drop tasks and columns to reorganize your work or move it through stages. Project members can rearrange tasks as needed, and followers will get updates when tasks move columns so all members stay on the same page.

Task Details

The task created by you is also shown in ‘Task Detail’ where you are able to log and track time against those tasks. Task Detail page shows your current tasks.

Time Log

You can log time and select whether you would like these hours to be logged as your billable hours.

Test Reports

Under test reports you can develop custom test reports with key information such as:

• Build
• Module
• Test Case Status
• Cycle
• Date

Extended search allows you to filter through to the exact Test Report you are searching for and then take exports of the custom report that you have generated.

Export Test Case report to Excel, CSV and Word. Also you can make an extended search on the basis of defined parameters.

Bug Reports

The bug tracking report is one of the most important elements of a bug tracking system. The report is what tells every detail about a bug and how it was handled or is being handled. It is very important that each report is detailed. Bug tracking reports need to include certain pieces of key information. The following explains what’s in each and every report issued

• Build
• Module
• Status
• OS
• Browser
• Assign to
• Severity
• Cycle
• Date

Export Defect report to Excel, CSV and Word. Also you can make an extended search on the basis of defined parameters.

Test Execution Reports

Under test execution reports you can develop custom reports with key information such as:

• Build
• Cycle
• Tested By
• Selected Executed Status

Extended search allows you to filter to the exact results you are searching for.

Export the report in a format of your choice Excel, CSV and Word. Also, you can make an extended search on the basis of defined parameters.

GitLab

Kualitee has integrated itself with GitLab issues. This exclusive two-way integration allows you to sync your issues between Kualitee and Gitlab. Each GitLab project can be linked with a Kualitee project to sync all reported issues in both projects. Since its a two-way integration all updates made on the issue will automatically get synched that includes a change in status, additional comments and association changed through Kualitee.

Creating GitLab Integration

To integrate with GitLab, you click on ‘create integration’ in settings and choose GitLab from the product. Provide your email, password, and domain URL to successfully create domain level integration.

Once the integration is created, the next step is to map projects.

Under the GitLab Projects, you will see the list of projects you have in GitLab. While in the Kualitee project you will see the list of projects you have on Kualitee.

The basic mapping is a hard-coded field to field mapping between Kualitee and GitLab. Below is a table that shows the mapping for each field.

Users in GitLab can also follow the template below to provide additional information for the fields available in Kualitee.

Selenium

To get started with integrating your Kualitee domain with Selenium start by

1. Downloading Kualitee Selenium Plugin from https://github.com/virtualforce/KualiteeSelenium Unzip the downloaded Kualitee Selenium Plugin (named: “KualiteeSelenium-master”) in servers’ default web root

(e.g. /var/www/html on a ubuntu machine and for windows xampp/htdocs/)

Note: make sure you have xampp up and running on selenium server

2. Try out the URL first on browser / e.g http://172.27.5.19/KualiteeSelenium/index.php
3. Enter your kualitee domain on browser e.g: testguru.kualitee.com
4. Select a project from the drop down
5. Then go to settings where you’ll add the path of the plugin you just installed in integrations tab i.e http://172.27.5.19/KualiteeSelenium/index.php

To integrate selenium with your Kualitee domain, simply go into settings and select integration and click on ‘Add New Integration’ Tab. From the drop down select Selenium and provide the required credentials to integrate selenium with your domain.

Once your credentials are accepted and domain integrated, the user will be re-directed to a checklist. This checklist will confirm whether all aspects of the integration are integrated successfully and will troubleshoot in case of an issue.

Project level integration is not required for selenium. To get started with uploading scripts for your test cases, simply select automation from the execution type drop down and then upload script option will appear below.

Your script will be visible in the context field in which we add a code snippet that will hook back to us the response of your automation scripts. you can add as many assertions as you want in that context field

Roles

Kualitee allows you to create roles with certain set of privileges that are provided to keep users under specific job roles. You select and apply privileges to a role and transfer them to a User.

The user then can use the role to perform the task that has been delegated to him under the parameters of his role.

Create Role

Permissions:

Only admin has the option to edit and change permissions of users. You can edit the role name, description and permissions

• Role: Allows you to define the designation for the user being added
• Description: You can add description to the provided role
• Removable: Whether the created role or designation can be deleted.
• Permission: Includes what information the user can view while on Kualitee and actions that he/she can perform.  Permissions include
  • Reports: Whether it can be viewed or not
  • Project Management: Whether it can be viewed or not
  • Dashboard: Whether it can be viewed or not
  • Test Management: Whether it can be viewed or not
  • Bug Management: Whether it can be viewed or not
  • Test Lab: Whether it can be viewed or not

Users

“Users” is a very important feature of Kualitee. Here, Admin can add a list of Users and build his team on the domain. These users can later be assigned to different projects from the project management tab.

• Click on “Settings” tab shown on the dashboard.
• Click on “Users” button.

Create New User

To start adding your team on to Kualitee, simply click on create new user and provide brief details and at the end assign them a role. The roles are domain based that means the user’s level of access will remain the same on every project.

Inactive Users

Users who have been sent the invitation link but have not yet activated their account are listed in the inactive users page.

SDK

Email Notifications

Under the tab of ‘Email Notifications’ you select what email should be send to which role

Scenarios are:

• Test Cases
• Test Case Execution
• Defect Management

Email notifications are user based. So, we can customize the notifications for each user according to each module.

JIRA

Kualitee has integrated itself with one of the most popular tools JIRA. This particular features allows you to stay connected with the development team while doing your planning in Kualitee and sending checked and tested feature information back to your development team. The integration allows both tools to send and receive real time updates as they happen.

For example, if updates are made to certain features and requirements in Kualitee with “Sync Integration tool” those changes are automatically made in JIRA and vice versa. However, certain items and detail components are mapped so that if the product or development team split the progress into several different statuses the other team can monitor and remain updated with the progress.

Creating JIRA Integration

To create the JIRA integration, you click on create integration and choose JIRA from the product. Provide your JIRA admin email and API token with domain URL to successfully create domain level integration.

Once the integration is created, next step is to map projects.

Under the JIRA project, you will see the list of projects you have in JIRA. While, in the Kualitee project you will see the list of projects you have on Kualitee.

Basic Mapping

Basic Mapping with JIRA is hard-coded field to field mapping as mentioned in the table below.

Following is the mapping of defect status in Kualitee with bug status in JIRA.

Mapping of priorities is:

• JIRA “Environment” which includes information regarding Browsers/Devices will appear under “Step to Reproduce” in Kualitee.
• Once, Sync integration function is active all the changes e.g. new defects created, updated and deleted will be reflected on either sides.
• Only issues which are classified as bug in JIRA will appear in Kualitee. Issues modified as story, task or epic in JIRA will not appear in Kualitee.
• Changing project name, project type or Re-Indexing the project will affect the integration.

Custom Mapping

Custom Mapping allows you to customize your synchronization with JIRA. You will need to create similar kualitee fields inside JIRA and drop down values so field to field mapping can take place upon sync.

Before you start mapping, make sure that you have completed the following steps:

• Created Custom Fields in JIRA for each field you are trying to map.
• Confirm the Field Type as mentioned in the table below
• Any Custom Value that you have created in Kualitee, is created in JIRA

*Note:

1- Till Mapping is not configured basic JIRA Integration will be working
2- This configuration will not affect previous issues. It will only work with Issues created from this point onwards.
3- Build & Module created in JIRA will be created in Kualitee but will not have association with test scenarios and cases etc. To do that you will need to manually edit scenarios and cases or create build and module in Kualitee to maintain the association.
4- Any custom value created in JIRA will automatically be created once synced with Kualitee but any Custom value added in Kualitee will not be available inside JIRA. It will need to be created.
5- In case of Integration fail, make sure that field type and value you are mapping is available in JIRA.

Custom Fields

In case, you require adding more information to your defect reports, test scenario or test case, you can add them through the custom field feature in settings.

Take advantage of the wide array of fields like e.g. Text Box, Text Area, Multiple Selection, and date fields etc.

Create, Edit or Delete:

You can create custom fields by clicking on ‘Create New’ Select your Project and then select the module in which you would like to add the fields.

In “Select Project” select the project in whose module you would like the custom fields to appear.

Select Module the particular module you would like the custom fields to appear. You can create custom fields in your Defects, Test Scenarios and Test Cases.

Name your fields, add description and choose the type of fields you would like to add. You have the option select

• Text Box
• Text Area
• Multiple Selection
• Single Selection
• Date

Once you have inserted all the required information, click on “Create Field” to let it take effect.

Dropdown Values

The dropdown feature allows you to insert custom values you require in different fields. Currently, you can add values in different fields in Project Management, Bug Management, Test Scenario and Test Case.

Create, Edit or Delete:

To create custom dropdown option you go in settings and select customizations and then choose dropdown.
Here you’ll see the option ‘Create New’, click on it and you’ll be presented with the following page.

GitLab

Kualitee has integrated itself with GitLab issues. This exclusive two-way integration allows you to sync your issues between Kualitee and Gitlab. Each GitLab project can be linked with a Kualitee project to sync all reported issues in both projects. Since its a two-way integration all updates made on the issue will automatically get synched that includes a change in status, additional comments and association changed through Kualitee.

Creating GitLab Integration

To integrate with GitLab, you click on ‘create integration’ in settings and choose GitLab from the product. Provide your email, password, and domain URL to successfully create domain level integration.

Once the integration is created, the next step is to map projects.

Under the GitLab Projects, you will see the list of projects you have in GitLab. While in the Kualitee project you will see the list of projects you have on Kualitee.

The basic mapping is a hard-coded field to field mapping between Kualitee and GitLab. Below is a table that shows the mapping for each field.

Users in GitLab can also follow the template below to provide additional information for the fields available in Kualitee.

Selenium

To get started with integrating your Kualitee domain with Selenium start by

1. Downloading Kualitee Selenium Plugin from https://github.com/virtualforce/KualiteeSelenium Unzip the downloaded Kualitee Selenium Plugin (named: “KualiteeSelenium-master”) in servers’ default web root

(e.g. /var/www/html on a ubuntu machine and for windows xampp/htdocs/)

Note: make sure you have xampp up and running on selenium server

2. Try out the URL first on browser / e.g http://172.27.5.19/KualiteeSelenium/index.php
3. Enter your kualitee domain on browser e.g: testguru.kualitee.com
4. Select a project from the drop down
5. Then go to settings where you’ll add the path of the plugin you just installed in integrations tab i.e http://172.27.5.19/KualiteeSelenium/index.php

To integrate selenium with your Kualitee domain, simply go into settings and select integration and click on ‘Add New Integration’ Tab. From the drop down select Selenium and provide the required credentials to integrate selenium with your domain.

Once your credentials are accepted and domain integrated, the user will be re-directed to a checklist. This checklist will confirm whether all aspects of the integration are integrated successfully and will troubleshoot in case of an issue.

Project level integration is not required for selenium. To get started with uploading scripts for your test cases, simply select automation from the execution type drop down and then upload script option will appear below.

Your script will be visible in the context field in which we add a code snippet that will hook back to us the response of your automation scripts. you can add as many assertions as you want in that context field

JIRA

Kualitee has integrated itself with one of the most popular tools JIRA. This particular features allows you to stay connected with the development team while doing your planning in Kualitee and sending checked and tested feature information back to your development team. The integration allows both tools to send and receive real time updates as they happen.

For example, if updates are made to certain features and requirements in Kualitee with “Sync Integration tool” those changes are automatically made in JIRA and vice versa. However, certain items and detail components are mapped so that if the product or development team split the progress into several different statuses the other team can monitor and remain updated with the progress.

Creating JIRA Integration

To create the JIRA integration, you click on create integration and choose JIRA from the product. Provide your JIRA admin email and API token with domain URL to successfully create domain level integration.

Once the integration is created, next step is to map projects.

Under the JIRA project, you will see the list of projects you have in JIRA. While, in the Kualitee project you will see the list of projects you have on Kualitee.

Basic Mapping

Basic Mapping with JIRA is hard-coded field to field mapping as mentioned in the table below.

Following is the mapping of defect status in Kualitee with bug status in JIRA.

Mapping of priorities is:

• JIRA “Environment” which includes information regarding Browsers/Devices will appear under “Step to Reproduce” in Kualitee.
• Once, Sync integration function is active all the changes e.g. new defects created, updated and deleted will be reflected on either sides.
• Only issues which are classified as bug in JIRA will appear in Kualitee. Issues modified as story, task or epic in JIRA will not appear in Kualitee.
• Changing project name, project type or Re-Indexing the project will affect the integration.

Custom Mapping

Custom Mapping allows you to customize your synchronization with JIRA. You will need to create similar kualitee fields inside JIRA and drop down values so field to field mapping can take place upon sync.

Before you start mapping, make sure that you have completed the following steps:

• Created Custom Fields in JIRA for each field you are trying to map.
• Confirm the Field Type as mentioned in the table below
• Any Custom Value that you have created in Kualitee, is created in JIRA

*Note:

1- Till Mapping is not configured basic JIRA Integration will be working
2- This configuration will not affect previous issues. It will only work with Issues created from this point onwards.
3- Build & Module created in JIRA will be created in Kualitee but will not have association with test scenarios and cases etc. To do that you will need to manually edit scenarios and cases or create build and module in Kualitee to maintain the association.
4- Any custom value created in JIRA will automatically be created once synced with Kualitee but any Custom value added in Kualitee will not be available inside JIRA. It will need to be created.
5- In case of Integration fail, make sure that field type and value you are mapping is available in JIRA.