Configure Xsquash in Jira

Xsquash and Xsquash Cloud enhance the integration between SquashTM and Jira Data Center, and Cloud. They retrieve the test cases and executions associated with requirements synchronized with Xsquash4Jira in SquashTM, to display them directly in Jira requests.

Configure Xsquash on Jira Data Center

Xsquash is an additional component for Jira Data Center available on the Atlassian Marketplace.

Install Xsquash

To install Xsquash on Jira Data Center:

1. Log into Jira as an administrator;
2. Go to the Jira administration and choose the option Manage apps. The Jira Atlassian Marketplace appears;
3. Search for "Xsquash" on the Marketplace;
4. Click on the [Install] button to download and install the plugin.

To install a previous version of the Xsquash plugin on Jira:

1. Visit the Xsquash page Version history on the Marketplace;
2. Download the version you want on your computer;
3. Log into the Jira instance as an administrator;
4. Manually import the plugin by using the "Import app" feature on the "Manage apps" page.

Declare a Server in Xsquash

You can configure the Xsquash plugin from the Jira administration, in the "Manage apps" part. In the menu on the left of your screen, search for "Xsquash", then click on "Configuration". Xsquash enables you to configure multiple Xsquash4Jira servers from different SquashTM instances:

To add a new server, click on the [Add] button and fill in the form with the following information:

• Server name;
• SquashTM's base URL (stop at /squash);
• Name of the jira.xsquash server declared in SquashTM corresponding to the Jira instance (case-sensitive);

• Depending on the authentication mode, login and password, or API token with read permission of a SquashTM account. This account will be used for all the API requests the plugin will send to SquashTM.

  Warning

  Basic authentication will no longer be available by mid-2027, learn more here.

  Learn more

  For more information about generating API tokens in SquashTM, see Personal API tokens section.

  We recommend that you use a SquashTM administrator account for this configuration because this one has access to all the projects on the instance. However, you can still use a guest profile with only reading permissions for projects containing acceptance data (test cases and executions) to be synchronized in Jira.

Configure Xsquash for a Project

You must configure the Xsquash plugin independently for each Jira project.

To configure Xsquash for a project, go to [Project parameters], search for "Xsquash" in the vertical menu, then click on [Configure]. Activate Xsquash via the radio button, then select the server you want in the list.

By default, the synchronization tabs of the SquashTM acceptance data are named SquashTM test cases and SquashTM executions. The configuration pop-up enables you to rename these tabs that appear in the Jira requests of the project. Once the configuration is done, click on [Save].

Configure Xsquash Cloud on Jira Cloud

Xsquash Cloud (Forge) is an application available on the Atlassian Marketplace

Migrate data from Xsquash Cloud (Connect) to Xsquash Cloud (Forge)

This feature allows a Jira administrator to import the configuration of the previous application (servers and associated project settings) directly into the new application. To do this, the configuration file must be obtained from our teams upon request. Once this file is imported, servers are automatically created and activated on the relevant Jira Cloud projects.

To import existing servers and activate them on Jira projects, follow these steps:

1. Install the application from the Atlassian Marketplace;
2. Contact SquashTM support, explicitly stating the request to migrate from Xsquash Cloud (Connect) to Xsquash Cloud (Forge);
3. Support will provide one or more migration file(s) in JSON format;
4. Import this/these JSON file(s) into the application to restore the server configuration and automatically activate it on the relevant projects. If several JSON files were provided, the one containing the server configuration must be imported first.

Install Xsquash Cloud

Declare a Server in Xsquash Cloud

To configure Xsquash Cloud, click on [Parameters] > Marketplace apps. In the menu on the left of your screen, search for "Xsquash", then click on [Configuration]. Xsquash enables you to configure multiple Xsquash4Jira servers from different SquashTM instances:

Click the [Add SquashTM server] button to add a new SquashTM server and fill in the form with the following information:

• Server name;
• SquashTM's base URL (stop at /squash);
• Name of the jira.xsquash server declared in SquashTM corresponding to the Jira instance (case-sensitive);

• an API token from SquashTM with read access. This account will be used for all API requests sent to SquashTM by the plugin.

  Warning

  Basic authentication will no longer be available by mid-2027, learn more here.

  Learn more

  For more information about generating API tokens in SquashTM, see Personal API tokens section.

It is recommended to apply the principle of least privilege: use a read-only API token corresponding to a technical account with only the "Guest" profile on the SquashTM projects that need to be accessible from Jira.

Configure Xsquash Cloud for a Project

You have to configure the Xsquash Cloud app independently for each project.

To configure Xsquash Cloud for a project, go to Project parameters, then click on Configure Xsquash in the vertical menu. Enable Xsquash using the radio button, then select the desired server from the list.

By default, the synchronization tabs of the SquashTM acceptance data are named SquashTM test cases and SquashTM executions. The configuration pop-up enables you to rename these tabs that appear in the Jira requests of the project. Once the configuration is done, click on [Save].

Preview of a Jira Request

In Jira Data Center and Jira Cloud, the tabs added by Xsquash appear in the Activity block of the configured project's requests.
See the Follow testing activity in Jira page for more information.