A new documentation is available for Squash TM 2.0 and later versions, check it here

3.03 - Consulting/Modifying a project

3.3.1 Consultation page of a project

You can reach the consultation page of a project by clicking on the project name in the projects table. The consultation page then displays following information:

[Rename project] allows you to modify the project name.
[Remove] allows you to remove the project if it does not contain any items anymore (requirements, test cases, campaigns, iterations, test suites).
The page as well displays three tabs detailed below, the "Main panel" tab, the "Custom fields" tab and the "Wizards" tab.
The "Main panel" tab displays five units, dedicated to the custom fields administration of the different items of Squash TM : requirements, test cases, campaigns, iterations and test suites.

3.3.2 Main panel tab

This tab is organized in seven foldaway units:

The "Project Information" unit in which it is possible to modify the label (simple text field) and the description (rich text editor field). Moreover, if the project is linked to a project template, it allows to view said template.
The "Bugtracker" unit in which it is possible to relate a bugtracker to the project. Only displays if a bugtracker is configured.
The "Permissions" unit in which it is possible to add and modify clearances of users or teams on the project.
The "Execution Options" unit in which it is possible to activate (or deactivate) the possibility to edit a testcase while they are being run.
The "Status options" unit in which it is possible to define which optional status are allowed.
The "Test automation management" unit in which you can activate an automation workflow (distant or native), define a technology and the language to implement for Database Testcases, link an automated execution server, jobs or link a source code management server.
The "Attachments" unit in which it is possible to add attachments to the project. These attachments are only reachable from this administration workspace (for example, clearances administration document, procedure to connect with the bugtracker, procedure to connect TM/TA...).

3.3.2.1 Configuring the bugtracker

The link with bugtracker configuration is done via the Bugtracker unit, following this procedure:

Prerequisite: Having configured a bugtracker in Squash (as seen here).

1. The Bugtracker unit displays a drop down menu with these choices:

No bugtracker: This choice means that no bugtracker is related to the project.
The name of the bugtracker set in the application.

2. Define in the field "Project name", the name of the project in the bugtracker, with the same case and spelling as in the bugtracker. Please pay attention to the fact that you must enter the name of the project, and not its ID. You can create entries to several projects by clicking next to your first project and add the names of the other projects.

3. It is possible to create several project names in the field "Project name in the bugtracker". The project names initially configured in the bugtracker and added to this field displays under the form of tags that you can delete by pressing the [X] button.

4. In order to add a project name, you need only to click in the field, fill-in a name and press [Enter] on your keyboard.

3.3.2.2 Permissions of users or teams on the project management

It is possible to add or modify permissions of users or teams from the Permissions unit, following this procedure:

Prerequisite: Having created users or teams in the User administration space.

1. In the Permissions unit, click on [Add].

2. A pop-up window in which you have to fill in the login details of the user or the team to add opens up. A drop down menu allows you to choose the profile and the related clearance to the user or the team on this project.

3. Click on [Add], the user or the team is displayed in the Permissions unit table.

FOCUS

The simple text field proposes to complete automatically the field with a drop down menu containing all the users and teams which logins start as the first keyboarded letters.

The column Profile of the Permissions unit table contains a drop down menu displaying the available profile for the user or the team. You can modify the profile of the user or the team from this place. This modification will be available only on the project in which it has been made.

To remove a permission, follow this procedure:

1. In the Permissions unit, click on [Remove] ([-]) at the end of each line of the Permissions unit table.

2. A pop-up window asking to confirm the action opens up.

3. Click on [Confirm]. The Permissions unit table is refreshed.

This chapter deals with the users' rights by profiles.

3.3.2.3 Configuring the optional status

In this unit, it is possible to define whether optional statuses (Untestable or Arbitrated) are authorized or prohibited.

It is possible to change the additional test status of an ongoing project. For instance, let's take the case of a test case, with at least one execution set to either one of the additionnal status. If said, additional status is prohibited by the administrator, a pop-up message appears saying:"some steps of this project are currently set to XXX, they must be redefined. To which status would you like to assign them? ", with a drop-down menu of the 5 basic statuses, but also other allowed additional statuses.

Once the new status has been set, the administrator can either [Confirm] to validate its changes, or [Cancel] in which case, the previous status remains unchanged.

Confirmation entails the following actions:

The deleted status is removed from possible statuses during execution
The steps statuses are updated
The test case statuses of executions, of which the steps were updated, are modified.
The iteration and campaign statistics are updated

3.3.2.4 Configuring automation

3.3.2.4.1 Choosing the technology and implementation language of Database Testcases

For each project, you may configure your implementation technology for Database Testcases as well as Database Scripts. The project leader may choose between Cucumber and Robot framework for the implementation technology. If the Cucumber technology is selected, it is possible to choose between 4 languages for the script : English, French, Spanish and German. The Robot framework technology, English is the only available language.

3.3.2.4.2 Configure the storage life of automated suites

The storage life of automated suites is set in days from the Automation block. After a cleaning of automated suites by an administrator, all automated suites "younger" than the previously set duration are kept while all the others will be deleted. If no duration has been defined, the storage life of automated suites will be infinite. By default, no value is filled in.

3.3.2.4.3 Activate/Deactivate the automation workflow

Activating the automation workflow for a project is done via the droplist in the Automation block in the field "Automation workflow". By default, the option 'None' is selected. The option 'Squash' triggers the activation of the native workflow while the "distant server" option (when available) triggers the activation of a distant workflow.

Its activation leads to the appearance of an "Automation" block in the Informations tab of testcases. In the native workflow's case, tests to automate can be followed from the Automation space by both testers and automaters.

The activation of an automation workflow also leads to the appearance of a source code management server in the block "Automation" of a Project.

3.3.2.4.4 Activate/Deactivate the automation workflow

Associating an automated execution server to a project can be done from the "Automation" block.

Prerequisite: you must have previously configured a link TM-TF.

1. Go to Administration, then to Projects

2. Click on the label of the project you want to associate with the execution server

3. In the Automation block :

a. Execution server : select the server created in the space 'automated execution server' -> a block 'Jobs' appear below

b. Jobs : Click on the button [+] -> a pop-up displays

c. Pop-up 'Add a job' : Select one or several jobs, tick the case 'May execute Gherkin' if the job is configured to execute gherkin scripts or databases. Finally, click on [Confirm] -> The selected jobs display in the table.

FOCUS

A box "can run gherkin" is present

When this box is ticked :

- If the automated workflow is activated, the association of automated scripts to automated test cases (Gherkin or database) can be done in an automated way. Be careful however : in this case, it is recommended to only have ONE job able to execute the scripts in the Jobs table.

FOCUS

It is possible to modify a job (pen icon) to customize it

In the field 'Possible execution servers (separated by semicolon)', it is possible to choose slave servers to be used to execute the job. Fill in the field with the name of servers separated with semicolons (ex : SlaveServ1; SlaveServ2).

FOCUS

an administrator has access to all jobs associated to the automation server.
A project manager must identify with a jenkins account in order to be able to select jobs. For this, if the project manager click on [+], an authentication pop-up displays where you can enter your Jenkins credentials. Only the jobs associated to the Jenkins account are accessible to Squash TM.

The project is linked to a SquashTF server. For this project, it is possible to associate test automation scripts to TM testcases and then execute them from the Campaign Workspace and read the execution results.

FOCUS

For the projects linked to Squash TF server, in the description block of the execution screen associated to a testcase, the field "Script Auto" displays under the field "Status"

3.3.2.4.5 Associating a source code management server

As seen here, you can configure the link TM/TA in this unit.

When the automation workflow is activated, a part in the block entitled “Source code management server” is displayed.

Prerequisite: It is necessary to add a source code management server and a repository in the Source code management server block.

1. Go to Administration, then to Projects

2. Click on the label of the project you want to associate with the execution server

3. In the Test automation management block

a. Automation workflow: click on the switch button to put it in “Active” mode

b. Source code management server:

i. Server: select the server previously created in the “Source code management server” part

ii. Repository: select a repository previously associated with the server.

FOCUS

From version 1.20, it is possible to use the TM tree structure in the repository when test cases are transmitted so that they are organized in the same way in both sides.

To activate this function, click on the switch button of the line entitled “Use TM tree structure in the repository” to put it in “Active” mode (default setting).

3.3.2.5 Adding attachment(s) in a project

It is possible to add attachments in the projects consultation page via the Attachments unit:

1. In the Attachments unit, click on [Upload attachment]. A pop-up window called « Upload new attachments » opens.

2. Click on [Choose file] and select the attachment(s) you want to add to the project.

3. Click on [Upload], the attachments unit is refreshed, and an icon which represents the attachment is displayed.

The format and the weight of the attachment is customizable. If you wish to know how to do this, click on the following links, here and here.

3.3.3 Custom fields tab

The Custom fields tab displays six units, from where it is possible to add custom fields to the following items:

Requirements
Test Cases
Test Steps
Campaigns
Iterations
Test Suites

3.3.3.1 Adding custom fields to a project

To add custom field(s), follow this procedure:

Prerequisite: Having created at least one custom field in the Custom fields administration space (as seen here).

1. In the project consultation page, click on the [Custom fields] tab.

2. Click on [Add a custom field] in the window of the item for which you want to create a custom field.

3. A pop-up window appears that lists all the available custom fields. Choose the wished custom field, then click on [Ok].

4. The unit is refreshed with the name of the previously added custom field.

3.3.3.2 Adding custom fields: Specific Case

When you add a custom field to Test Steps, you have to check the box "display in test steps table" if you want the custom field to be displayed in the test steps table.

FOCUS

Once related to a project, a custom field can be removed by clicking on the delete icon at the end of the dedicated unit table line. This remove only the association and not the custom field itself.

3.3.4 Custom lists (From version 1.12)

The consultation page displays following information:

A retractable block containing three drop-down list :

- A drop-down list 'Requirement Workspace - Category'
- A drop-down list 'Test case Workspace - Nature'
- A drop-down list 'Test case Workspace - Type'

3.3.4.1 Binding lists to a project

It is possible to bind lists to a project using the 'Lists binded to project' tab, by following these steps:

1. Click on the drop-down in front of the list you want to associate
2. Select the desired list
3. Click on the button [Confirm]
4. A pop-up message appears, click on the button [Confirm]

FOCUS

The list will be permanently modified. The default value of the new selected list will be associated with the project objects.

Once the new list confirmed, the default value of the list is displayed in the corresponding field in the consultation page of the object.

3.3.5 Milestones (From version 1.12)

The consultation page displays following information:

[+] allows you to add a milestone to the project.
[-] allows you to remove milestones from the project.
[Create] allows you to create a milestone from the project page.
[Clone] allows you to clone a milestone from the project page.

3.3.5.1 Binding milestones to a project

It is possible to add milestones to the project via the 'Milestones' tab by following these steps:

1. Click on [+]
2. In the pop-up window, you can pick the milestones you want to bind to the project, then check the box in front of the milestones you want to bind
3. Click on [Confirm]. The pop-up window shuts itself, and the selected milestones appear in the table.

FOCUS

To bind milestones to the project, it is necessary that the milestones were createdbeforehand. Milestones should be to the status 'Planned', 'In progress' or 'Completed'.

3.3.5.2 Disassociating milestones to a project

It is possible to disassociate milestones to the project from the 'Milestones' tab by following these steps:

1. Click on [-] in front of milestones you want to disassociate, or select the milestones you want to disassociate, and click on [-] in the button bar.
2. A pop-up window opens, click on [Confirm], the pop-up shuts itself, and the selected milestones disappear from the table.

FOCUS

The milestones are disassociated only from the project where you are. Milestones should be to the status 'Planned', 'In progress' or 'Completed'.

3.3.5.3 Creating a milestone from a project

It is possible to create a milestone and bind it to the project via the 'Milestones' tab by following these steps:

1. Click on [Create].
2. A pop-up window opens and you must fill in the fields : Name, Status, Due Date and Comment.
3. Click on [Create]. The pop-up shuts itself and the created milestone appears in the table.

It is also possible to create a milestone, bind it to the project and its objects via the 'Milestones' tab by following these steps:

1. Click on [Create].
2. A pop-up window opens and you must fill in the fields : Name, Status, Due Date and Comment.
3. Click on [Create and bind]. The pop-up shuts itself, and the created milestone appears in the table.

3.3.5.4 Cloning a milestone from a project

It is possible to clone a milestone and bind it to the project via the 'Milestones' tab by following these steps:

1. Select the milestone you want to clone and click on [Clone a Milestone].
2. A pop-up window opens and you must fill in the fields : Name, Status, Due Date and Comment. You can also select the duplication options about the requirements, test cases and campaigns.
3. Click on [Add]. The pop-up window shuts itself, and the milestone appears in the table.

FOCUS

In the case duplication of options on the requirements, test cases or / and campaigns have been checked, the duplicated milestone is automatically associated with the objects(Requirements, test cases, campaign) of the original milestone according to what has beenchecked.

Page updated

Report abuse