FAQ Squash TM

How to import requirements and associations?

 

Overview:

You can import requirements from Excel files (.xls, .xslx or .xlsm format).

This file must have a specific format, the import template can be downloaded in the application or here.

It allows you to import simultaneously requirements, requirements/test cases associations and requirements/requirements links.

 

To import a requirement file, you must:

  1. Go to the requirement worspace
  2. Click on the [Import] button of the tree drop-down menu Bouton impor exigence

  3. Click on [Import] in the drop-down menu:

  4. A window "Import Excel data" will pop up, you will be able to:

    • Download the import template
    • Choose the Excel file to import by click on "Choose file"
    • Import the file or simulate a file import

  5. After having clicked on [Import] or [Simulate] then confirmed, a window summarizing the import will pop up.
    The requirements import recap can be seen next to the “Requirement” line and the requirements/test cases association recap is next to the “Association” line. Finally, the one concerning the requirements/requirements links can be seen next to the “Links” line.
    You can download an import log with the details of the successful rows, the row in warning and the rows in failure:

  6. If you chose the “Import” option, the requirements, the requirements/test cases associations and the requirements/requirements links will appear in the tree of the requirements workspace

 

Here are some rules to follow when creating an Excel file:

  • The Excel file must have a table including columns as described hereafter in the table.
  • The data imported are materialized by a pair tag/value(s).
  • The tags are always placed on the first row (headers in the table), in whatever order.
  • The value(s) are placed in the row(s) that follow the first tag row.
  • The import is made row by row. The order does not matter.
  • The names of the fields in the first column are not case sensitive.
  • The empty rows are ignored.
  • The cells must not be merged.

 

Description of the import file 'REQUIREMENT' tab:

TAG Description

ACTION

(Mandatory)

Determines the action to realize. Must include the following values (or letters):
  • CREATE (C): when creating a requirement
  • UPDATE (U): when updating a reuqirement
PROJECT_ID Target project ID
PROJECT_NAME Target project name

REQ_PATH

(Mandatory)

Requirement path from the projetct name to the requirement name
ex: /Project name/Folder name/Requirement name
REQ_VERSION_NUM Requirement version number
REQ_VERSION_REFERENCE
Requirement version reference
REQUIREMENT_VERSION_NAME Requirement version name
REQ_VERSION_CRITICALITY Requirement version criticality code:

CRITICAL, MAJOR, MINOR, UNDEFINED

REQ_VERSION_CATEGORY Requirement version category code (default list):

CAT_FUNCTIONAL, CAT_NON_FUNCTIONAL, CAT_USE_CASE, CAT_BUSINESS, CAT_TEST_REQUIREMENT, CAT_UNDEFINED, CAT_ERGONOMIC, CAT_PERFORMANCE, CAT_TECHNICAL, CAT_USER_STORY, CAT_SECURITY

REQ_VERSION_STATUS Requirement version status code:

APPROVED, OBSOLETE, UNDER_REVIEW, WORK_IN_PROGRESS

REQ_VERSION_DESCRIPTION Requirement version description
REQ_VERSION_#_TC Number of test cases linked to the requirement version
REQ_VERSION_#_ATTACHEMENT Number of attachments linked to the requirement version
REQ_VERSION_CREATED_ON Requirement version creation date
REQ_VERSION_CREATED_BY Creator login
REQ_VERSION_LAST_MODIFIED_ON Requirement version last modification date
REQ_VERSION_LAST_MODIFIED_BY Last author of modification login
REQ_VERSION_MILESTONE Milestone(s) bound to the requirement version
REQ_VERSION_CUF_<cuf code> Custom field(s) code(s) bound to the requirement version

 

Description of the import file 'LINK_REQ_TC' tab:

TAG Description
REQ_PATH Requirement path from the project name to the requirement name
ex: /Project name/Folder name/Requirement name
REQ_VERSION_NUM Requirement version number to link.
TC_PATH Test case path from the project name to the requirement name
ex: /Project name/Folder name/Requirement name

 

Description of the import file 'LINK_REQ_REQ' tab:

TAG Description
ACTION Determines the action to realize. It must include the following values (or letters):
  • CREATE (C)/UPDATE (U): when creating or updating a link between requirement versions
  • DELETE (D): when deleting a link between requirement versions
If the ACTION cell is empty, CREATE/UPDATE action will be use by default. Management rule are detailed below.
REQ_PATH Requirement path from the project name to the requirement name
REQ_VERSION_NUM Requirement version number.
RELATED_REQ_PATH Linked requirement path from the project name to the requirement name
RELATED_REQ_VERSION_NUM Linked requirement version number
RELATED_REQ_ROLE Linked requirement role code

 

If you need more information on importing a requirement, you can check the dedicated page on the Wiki.

How to configure bugtrackers on Squash TM?

Squash TM is natively linked to Mantis but also supports, via plugins, JIRA (soap and rest), Bugzilla, Trac, Redmine and RTC.

To configure a bugtracker, follow these steps:

  1. Add a bugtracker

    Prerequisite: The plugin is installed

    1. In the Administration home page, click on the [Bugtracker] button.
    2. Click on [Add a bugtracker], a pop-up displays:



    3. Fill the requested fields in:
      • Name
      • Kind: Drop down menu with bugtrackers (depending on the installed plugins)
      • Url: url of the bugtracker. ex: http://localhost/mantis
      • Displays in iframe: if the checkbox is ticked, the bugtracker will be displayed in the workspace (on the right area of the screen) when clicking on the Bugtracker workspace button of the navigation bar. If the checkbox is unticked, it will open in a new window.
        Some bugtrackers do not support this function.
    4. Click on [Add]. The bugtracker workspace table is updated.


  2. Link a bugtracker to a Squash TM project

      1. In the administration home page, click on the [Projects] button.
      2. Add a project or click on the name of a project.
      3. In the Bugtracker section, fill the following fields:
        • ‘Bugtracker’ field: select the bugtracker added in the first step
        • ‘Project name’ field: the exact project name in the bugtracker

    A Squash TM project can be linked to several bugtracker projects.
    Several Squash TM projects can be linked to the same bugtracker project

How to change Squash TM default port?

Squash TM uses 8080 port as default port. This port can be modified, the procedure depends on the operating system.

Look for HTTP_PORT and replace 8080.

Windows :

In bin/startup.bat : set HTTP_PORT=8080

Linux :

In bin/startup.sh : HTTP_PORT=8080

Debian/Ubuntu :

In ect/init.d/squash-tm : HTTP_PORT=8080

RedHat :

In ect/sysconfig/squash-tm : HTTP_PORT=8080

 

Please notice that the system will not check if the port is available (except if you are using the Debian launching script), you should then make sure with the administrator that it is the case.

How to configure attachments (size and extension)?

Attachments can be configured in the app. To do so, as an administrator, go to Administration then System parameters.

In the Attachments block:

  1. In the white list for file upload, complete extensions to allow, separated by commas. By default, the following extensions are indicated: txt, doc, xls, ppt, docx, xlsx, pptx, odt, ods, odp, pdf.
  2. In the upload limit size in bytes, enter the maximum size allowed (by default 4 000 000)
  3. In the upload limit size of import file in bytes, enter the maximum size allowed (by default 2 000 000)

If you are using a MySQL database, don't forget to check max_allowed_packet=X property (where X is the max authorized size of attachments by Squash. By default, the application is set to 2Mo,ie X=2M) in tge MySQL configuration file (my.cnf ou my.ini).

How to import test cases and associations?

 

Overview:

You can import test cases from Excel (.xls, .xslx or .xlsm) or .zip format files.

These files must have a specific format, the import template can be downloaded in the application.

With an import file in Excel format you can import simultaneously test cases, test steps, parameters, datasets and the test cases/requirements associations.

The zip format import file allows you to import test cases and test steps.

 

This article will only focus on the import in Excel format. If you need information on the import in .zip format, you can check the dedicated page on our Wiki.

 

To import a test case file:

  1. Go to the test cases workspace
  2. Click on the [Import] button of the tree menu Bouton impor TC

  3. Click on “Import” in the drop-down menu:

  4. A window “Import Excel data” will pop up, you will be able to:

    • Choose the import format (Excel or zip), in this example it is Excel
    • Download the import templates for every format
    • Choose the file to import by clicking on [Choose file]
    • Import the file or simulate a file import

  5. After having clicked on [Import] or [Simulate] then confirmed, a window summarizing the import will pop up. The requirements import recap can be seen next to the “Requirement” line and the requirements/test cases association recap is next to the “Association” line.
    Finally, the one concerning the requirements/requirements links can be seen next to the “Links” line:

  6. If you chose the “Import” option, the requirements, the requirements/test cases associations and the requirements/requirements links will appear in the tree of the requirements workspace.

 

Here are some rules to follow when creating an Excel file:

  • The Excel file must have a table including columns as described hereafter in the table.
  • The data imported are materialized by a pair tag/value(s).
  • The tags are always placed on the first row (headers in the table), in whatever order.
  • The value(s) are placed in the row(s) that follow the first tag row.
  • The import is made row by row. The order does not matter.
  • The names of the fields in the first column are not case sensitive.
  • The empty rows are ignored.
  • The cells must not be merged.

 

Description of the import file 'LINK_REQ_TC' tab:

TAG Description

ACTION

(Mandatory)

Determines the action to realize. It must include the following values (or letters):

  • CREATE (C): when creating a test case
  • UPDATE (U): when updating a test case

TC_PATH

(Mandatory)

Test case path, from the project name to the requirement name
ex: /Project name/Folder name/Requirement name
TC_NUM Test case order in its folder
TC_REFERENCE
Test case reference
TC_NAME Test case name
TC_MILESTONE Name of the milestone(s) bound to the test case
TC_WEIGHT_AUTO Complete with 1 if weigh calculation is automatic
Complete with 0 if weigh calculation is manual
TC_WEIGHT Test case importance code:
VERY_HIGH, HIGH, MEDIUM, LOW
TC_NATURE Test case nature code:
ATDD, BUSINESS_TESTING, NON_FUNCTIONAL_TESTING, PERFORMANCE_TESTING, SECURITY_TESTING, UNDEFINED, USER_TETSTING
TC_TYPE Test case type code:
COMPLIANCE_TESTING, CORRECTION_TESTING, END_TO_END_TESTING, EVOLUTION_TESTING, PARTNER_TESTING, REGRESSION_TESTING, UNDEFINED
TC_STATUS Test case status code:
APPROVED, OBSOLETE, TO_BE_UPDATED, UNDER_REVIEW, WORK_IN_PROGRESS
TC_DESCRIPTION Test case description
TC_PRE_REQUISITE Test case prerequisite
TC_CREATED_ON Test case creation date
TC_CREATED_BY Creator login
TC_LAST_MODIFIED_ON Test case last modification date
TC_LAST_MODIFIED_BY Login of the user who last modified the test case
TC_CUF_<cuf code> Code of the custom fields bound to the test case

 

Description of the ‘SETPS’ tab of the import file:

Balise Description

ACTION


(Mandatory)

Determines the action to realize. It must include the following values (or letters):

  • CREATE (C): when creating a test step
  • UPDATE (U): when updating a test step

TC_OWNER_PATH

(Mandatory)

Path towards the test case owner of the test step
TC_STEP_NUM Order of steps (by numbers)
TC_STEP_IS_CALL_STEP Complete with 0 if step is a step action
Complete with 1 if step is a call step
TC_STEP_CALL_DATASET INHERIT: if the chosen option is not to choose datasets, in that case, the calling test case will inherit the parameters of the called test case
<name>: gives the chosen dataset
TC_STEP_ACTION Step action or path towards the called test case if it is a call step
TC_STEP_EXPECTED_RESULT Expected result for the step
TC_STEP_CUF Code of the custom fields bound to the test step

 

Description of the ‘PARAMETERS’ tab of the import file:

Balise Description

ACTION
(Mandatory)

Determines the action to realize. It must include the following values (or letters):

  • CREATE (C): when creating a parameter
  • UPDATE (U): when updating a parameter

TC_OWNER_PATH

(Mandatory)

Path towards the test case owner of the dataset
TC_PARAM_NAME
Parameter name
TC_PARAM_DESCRIPTION Parameter description

 

Description of the ‘DATASETS’ tab of the import file:

Balise Description

ACTION
(Mandatory)

Determines the action to realize. It must include the following values (or letters):

  • CREATE (C): when creating a dataset
  • UPDATE (U): when updating a dataset

TC_OWNER_PATH

(Mandatory)

Path towards the test case owner of the dataset

TC_DATASET_NAME

(Mandatory)

Dataset name
TC_PARAM_OWNER_PATH
Path towards the test case owner of the parameter.
This column is necessary in the case of parameters coming from test cases called bu the test case owner of the dataset.

TC_DATASET_PARAM_NAME

(Mandatory)

Parameter name for which the value will be filled
TC_DATASET_PARAM_VALUE
Corresponding value for the specified pair {dataset | parameter


Description of the ‘LINK_REQ_TC’ tab of the import file:

Balise Description

REQ_PATH

(Mandatory)

Requirement path from the project name to the requirement name

REQ_VERSION_NUM

(Mandatory)

Number of the requirement version to link

TC_PATH

(Mandatory)

Test case path from the Project name to the test case name

 

Subcategories

Fonctionnalités
Article Count:
1