Squash Workspaces

Squash Homepage

Once you have logged in, the app's homepage appears. You can then navigate between the different spaces.

To see the homepage's Message, click on the [Message] button. The message can be customized by an Administrator.

If you have saved the dashboard as a Favorite for your homepage from the Reporting workspace, the dashboard appears by clicking on the [Dashboard] button.

You can also access the homepage by clicking on the Squash logo on top of the sidebar.

Introduction of the Squash Workspaces

Sidebar

The fixed sidebar on the left of the screen allows you to access any Squash workspace at any time.

When the sidebar is hidden, only the workspace icons appear, thus leaving more screen real-estate for you to view their content.

Requirement, Test Case, and Execution Workspaces

These workspaces are at the core of software qualification. They allow you to:

• create, organize, trace, and create versions of your requirements;
• create, manage, modularize, and use variables on your test cases;
• manage, plan, and run your test campaigns and validate sprint requirements.

Warning

The screenshots in the documentation may still refer to the old Execution workspace name (previously called Campaign).

Reporting Workspace

This workspace is dedicated to test monitoring. It is mainly intended for testing project managers.

Automation Workspace

This workspace is dedicated to automation management within Squash.

Action Workspace

A workspace dedicated to the sharing of BDD test case actions (requires Squash Ultimate license 💎).

Info

The Administration menu is only accessible to Administrator or Project Leader users.

My Account

You can access the My Account page by clicking on the icon with the user's initials at the foot of the sidebar.

Two links appear when you hover on this icon: My Account and Logout.

My Account

The My Account page contains user information. This information is organized under the following boxes:

Information

This box contains the current user's following details: their name, address, and their group (Admin or User). From this page, you can modify your e-mail address and/or your local password.

Clearance

This table allows you to visualize the user's projects and their permissions.

Bugtrackers Configuration Mode

This block allows you to manage the connection to the bugtrackers linked to the projects you are cleared to work on. When an administrator selects the option The users authenticate themselves during the configuration of a bugtracker and when the bugtracker is part of a project the user is cleared to work on, then the user can choose either a manual or an automatic connection.

When Manual connection to the bugtracker is selected, the user must systematically connect to the bugtracker to declare or go through an issue by clicking on the [Login] button. When Automatic connection to the bugtracker is selected, the connection to the bugtracker starts automatically.

The box Login details contains the list of the bucktrackers linked to the user's projects. When the user saves their login information, they are automatically connected to the bugtracker in the app's different workspaces. You need to click on the [Save] button to confirm the entry.

Focus

Depending on the bugtracker type, credentials may vary. For more information, please visit the page Bugtrackers authentication protocol.

Personal API tokens

Each user can create personal tokens to make API calls. Click on .

All fields are mandatory:

• name (maximum 255 characters);
• permissions:
  • read to allow GET operations only;
  • read and write to authorize all operations (GET, POST, DELETE, PATCH);
• expiry date: default one year after creation date, cannot exceed one year.

The generated token is only displayed once. Click on to display it or on to copy it without displaying it.

The token can be deleted by clicking on the icon in the list of tokens.

Logout

When you click on the sub-menu Logout, you are disconnected from the app.

Projects Filter

Located in the sidebar, the menu Projects Filter allows you to select the projects you want to display in the app's different workspaces. Its way of operating is reminiscent of that of a library.

In this menu, the All projects options shows all the projects whereas the Multi-projects option opens a new window where you can select projects. To select a project to include in the filter, check the box before its name then click on [Apply]. To make the project selection process easier, you can use the dynamic search field to look for the projects Name and Tag.

Focus

The projects filter is applied by default on the Search pages.

Bugtrackers

In the Bugtrackers menu, which is located on the sidebar, you can see the list of all the bugtrackers associated to the projects the current user is cleared to work on.

When you click on its name, the bugtracker opens in a new tab or in an i-frame. Only the Jira and RTC bugtrackers can open in an i-frame.

Help

The Help menu located in the sidebar gives you access to three sub-menus:

About Squash

This pop-up indicates the Squash version in use, and links to the LGPL license and to the credit of the icons used in the app.

Documentation

This link redirects you to Squash's online documentation.

API Documentation

It contains sub-menus that redirect to Squash APIs documentation:

• REST API;
• Admin REST API;
• Xsquash4Jira REST API;
• Action words library REST API.

Info

This menu and its sub-menus are only displayed if the corresponding are installed. For more information about Squash APIs, visit the page Squash APIs.

Report an issue

This link redirects you the public Bugtracker of Squash tool which allows you to report the issues you have encountered while using the app. It is up to you to create an account to use this tool.