Skip to content

Manage Test Automation Servers

Add, Modify and Delete a Test Automation Server

Squash TM can connect to two different test automation servers: Squash Orchestrator to automate tests with Squash Orchestrator and Jenkins to automate tests with Squash TF.

To add and configure a test automation server, go to the Administration, then click on "Servers > Test Automation Servers".

Manage test automation servers

When you create a server, you must enter the server's name, type, and URL (should be as short as possible).

Add a test automation server


Deleting a test automation server associated with at least one project or execution deletes the links to the result and execution reports, as well as the automation script associations with the test cases. However, you can still access automated test cases executions. Warning: this action cannot be undone.

Configure a Squash Orchestrator test automation server

Configure the connection to Squash Orchestrator

For Squash TM to communicate with Squash Orchestrator, the following URLs must be configured:

  • Receptionist URL: it is the URL entered when adding the server in Squash TM. It is used to launch automated tests with Squash Orchestrator
  • Observer URL: it is used to retreive Squash Orchestrator information. If this URL is not configured in Squash TM, it is valued by the receptionist URL
  • Event bus URL: event bus allows the passage of subscription and publication information to various services of Squash Orchestrator.

There are two approaches to define these URLs in Squash Orchestrator:

  • Squash Orchestrator is installed behind a reverse proxy: receptionist URL, observer URL and event bus URL are identical and communicate with Squash TM via the same port.
    • Receptionist URL:
    • Observer URL:
    • Event bus URL:
  • Squash Orchestrator is not installed behind a reverse proxy: receptionist URL, observer URL and event bus URL are different. Default exposed ports are 7774 for the receptionist, 7775 for the observer and 38368 for the event bus. The base URL can also differ.
    • Receptionist URL:
    • Observer URL:
    • Event bus URL:

Learn more

To learn more about Squash Orchestrator installation and configuration, visit Squash Orchestrator

For the server to work, you also must enter an authentication token generated from Squash Orchestrator.


With Squash Orchestrator, there must be a token for the automated test to execute correctly from Squash TM. Even if the automation server does not require you to authenticate yourself, you must still enter any value for the token in Squash TM. The token can be configured at project level.

Consultation page of a Squash Orchestrator type of test automation server Test automation server consultation page

Define a default execution environment

Squash Orchestrator enables you to describe execution environments through ssh or an agent.
Each execution environment is described, among other items, by tags that indicate what capabilities it provides: OS, browser or else.

Learn more

For more information on environment tags use cases, visit Squash Orchestrator documentation

In Squash TM, for 'Squash Orchestrator' test automation servers, the Environments block enables you to view the available environments with their tags and to define default environment tags.

Available environments are displayed in the Available environments table. It contains the environments' list with their tags.
This information is returned in real time by Squash Orchestrator. Displayed environments depend on the token configured in the Authentication policy and its permissions on each environment.

The Default environment tags field enables you to define default values among the tags of all the available environments.
Whenever a value is selected, the Available environments table is automatically filtered, so the administrator can see if the combination of selected tags matches or not at least one available environment.

When running automated tests, these tags are offered by default to the user (he can modify them) to target an execution environment that matches the selected values.

Learn more

Token and default environment tags can also be defined on the projects linked to the Squash Orchestrator test automation server. In this case, the project's values are offered by default when running automated tests. To learn more, visit the page Associate a Squash Orchestrator test automation server to a project

Associate environment variables and define their default value

With environment variables, it is possible to indicate for example the credentials, the environment type (prod/preprod), the Git branch or the browser used to launch the tests. Unlike the environment tags that are returned by Squash Orchestrator, environment variables must be created in Squash.

Learn more

For more information on environment variables use cases, visit the Squash Orchestrator documentation

The Environment variables block allows you to associate environment variables previously created in Administration > Entities > Environment variables, and to define their default value.

To associate an environment variable with the test automation server, click on Add and select the variable(s) to associate.

Associate environment variable

Once the environment associated, it is possible to define a default value. This value can be redefined at the project level. Depending on the environment variable type, different characters are authorized. When running automated tests, this value is offered by default to the user, but they can modify it.

Server environment variable

To dissociate one or multiple environment variable from a test automation server, click on Dissociate.

Set up an additional configuration for the automated execution server


Additional configuration management is available with the Squash Ultimate licence and the Squash TM Premium plugin.

The additional configuration allows data to be sent directly from Squash to the orchestrator when a workflow is created (hooks, environment variables, resources, etc.).

To do this, a dedicated space is available for declaring a YAML or JSON script with colouring and syntax checking.

Click in the field to edit a script. Several buttons then appear above the script, allowing you to:

  • Confirm the changes made. You can also save them using the keyboard shortcut [CTRL]+[ALT]+[S].
  • Cancel changes made since the last save and return to read-only mode
  • Check the script syntax

Additional configuration script

The Help button displays a help panel for writing additional configuration scripts, showing examples of hooks, metadata, resources and variables.

Help with writing scripts

Learn more

To learn more about additional workflow configuration, consult the Squash Orchestrator documentation.

Configure a Squash TF test automation server

When you add a Jenkins automation server, the checkbox "Select manually the server when the execution of the automated tests starts (this implies this server is a master server)" enables you to choose the execution server at the start of the tests when using master servers with secondary servers.

For the server to work, you also must enter credentials: Jenkins login and password.

Consultation page of a Jenkins type of test automation server Test automation server consultation page