Testim Documentation

Welcome to the Testim documentation. You'll find comprehensive guides to help you get started quickly, example code snippets, and tips for being more productive. You will also find details about advanced features that allow you to customize Testim to fit your environment or special testing conditions. Don't worry, we'll support you if you get stuck. Let's jump right in!

Guides    Changelog

How to Record a Test

Step 1 - Creating a new test

Create a new test by clicking on the Create Test button. If you don’t currently have a test opened on the Testim Visual Editor screen, then this button is shown in the middle of the screen.

Alternatively, you can click on the Create New button on the Test List screen or the New Test button (which is shown in the header bar on all screens).

A new test opens in the Visual Editor. This is where you record the test, add validations and edit the test steps.

Step 2 - Setting the Base URL

The Base URL specifies the initial site that opens when you begin recording the test, see Base URL.

📘

You can record tests that include steps that open additional windows and perform actions in those windows, see Recording in multiple windows.

There are two ways to set the Base URL:

  • Setting the Base URL manually - If no default Base URL has been configured, then you need to manually enter the Base URL for each new test. If a default Base URL has been configured, then the default URL is used unless you manually edit the URL.
  • Setting a default Base URL - You can set a default Base URL for a Project. This URL is automatically applied to all new tests that you create within the Project.

Setting the Base URL manually

If you haven’t yet set a default URL, then you need to enter the Base URL manually for each test.
To set the Base URL manually:

  1. After creating a new test, in the Visual Editor click on the red Record button in the toolbar.

The Start A New Test window opens.

  1. In the Your app URL field, enter the Base URL for this test.
  2. If you would like to set this Base URL as the default Base URL for this project, select the Remember my decision checkbox.

If you have set a default Base URL for your Project and you would like to use a different Base URL for a specific test, you can manually edit the Base URL.
To change the Base URL for the current test only:

  1. After creating a new test, in the Visual Editor, hover over the Base URL step and click on the button.

The Properties window opens alongside the main window.

📘

Alternatively, you can select the step and then click on the button in the header bar.

  1. Click on the Base URL field and enter a new Base URL._
  2. Click Save.
    Your changes are saved for this test.

Setting/Editing a default Base URL in the Project Settings

You can set a default Base URL for the project on the Project Settings screen. When you create a new test in that project, the first step automatically includes the default Base URL, enabling you to immediately begin recording the test.

To set/edit the Base URL:

  1. In the main navigation, click .
    The Project Settings screen is displayed.
  1. Click on the URL field.
    The Test Default URL window opens.
  1. In the Your app URL field, enter the default Base URL or edit the current URL.
  2. Click OK.
    The default Base URL is saved. It is applied automatically whenever you create a new test.

Once you have set a default Base URL, when you click on Create New, the first step is automatically configured to use the default Base URL.

Step 3 – Setting the Test Configuration

The Test Configuration determines the system specifications used to run the test. If you intend to run the test locally then the configuration should match your local environment. If you intend to run the test on the Testim Grid, then Testim simulates whichever environment is specified.

📘

When the test is run in the CLI, you can override the default configuration by specifying a new Test Configuration in the run command, see Command line interface.

🚧

If you run a test locally on a system that doesn’t correspond with the Test Configuration, then the Test will run with the available configuration and a warning message will be shown.

Test Configuration Parameters

The following table describes the Test Configuration parameters.

Parameter

Description

Name

The name of the configuration.

Browser

The browser on which the test runs. Supported browsers are: Chrome, Firefox, Safari, Edge and Internet Explorer 11.

OS

The OS on which the test runs. Supported OSs are Linux, Windows 10, Windows 8, Windows 8.1, Windows 7, Windows XP, macOS Sierra, macOS High Sierra, macOS Mojave, OS X El Capitan, OS X Yosemite, OS X Mavericks, OS X Mountain Lion, OS X, Snow Leopard.

Resolution

The screen resolution used for the test.

Advanced

Step Timeout (milliseconds)

The time lapse which causes Testim to register a fail for a test step.

Step Delay (milliseconds)

The delay between implementing test steps.

Setup step timeout (milliseconds)

The delay before implementing the initial (Base URL) step of the test.

Adjusting the Test Configuration

When you create a new test, the default Test Configuration is automatically applied. The default configuration is shown at the top of the Visual Editor screen.

You can change the Test Configuration using one of the following methods:

  • Edit – Edit the current Test Configuration. The new configuration applies only to the current test (it does not affect the Configuration profile).
  • Choose Other – apply a different Test Configuration from the list of available configurations.
  • Custom (create new) – Create a new custom configuration and apply it to the current test.

Edit the Test Configuration

To edit the Test Configuration for the current test only:

  1. After creating a new test, in the Visual Editor, hover over the Base URL step and click on the button.

The Properties window opens alongside the main window.

📘

Alternatively, you can select the step and then click on the button in the header bar.

  1. Scroll down to the Configuration section and click on the Edit button.
    The Edit Configuration pane opens.
  1. Edit the configuration parameters as desired.
    The new configuration is applied to the current test.

Choose a different Test Configuration

To apply a different Test Configuration to this test:

  1. After creating a new test, in the Visual Editor, hover over the Base URL step and click on the button.

The Properties window opens alongside the main window.

📘

Alternatively, you can select the step and then click on the button in the header bar.

  1. Scroll down to the Configuration section and Click on Choose Other.
    The Choose New Configuration pane opens, showing a list of available configurations.
  1. Click on the desired configuration.
    The new configuration is applied to the current test.

Create a custom Test Configuration

The following procedure explains how to create a custom configuration on the Visual Editor screen. Alternatively, you can create a new custom configuration on the Runs > Configuration List screen and then apply it to your tests.
To create a new custom Test Configuration:

  1. After creating a new test, in the Visual Editor, click on the Default configuration at the top of the editor screen.

The Change Default Config window opens.

  1. Click on the Default Configuration field.
    A dropdown list of configuration options is shown.
  1. Click Custom (create new).
    The Test Configuration Parameters are shown.
  1. Fill in the configuration parameters as desired.
  2. Click Change.
    The new Test Configuration is saved in the system and it is applied to the current test.

Step 4 - Recording the test

When you begin recording a test, a new browser opens to the Base URL. This is the Application Under Test (AUT) window, actions that you take in this window are recorded by Testim and configured as steps in your test.
The following actions are identified as separate test steps:

  • Click
  • Double click
  • Right click
  • Scroll
  • Set (enter text)
  • Scroll on page
  • Scroll to element
  • Drag
  • Resize window

To record a new test:

  1. After creating a new test, on the Visual Editor screen, click on the red record button in the header bar.

The AUT browser opens to the Base URL.

  1. In the AUT browser, take the actions that you would like to include in the test. Each action is identified by Testim and shown as a step in the Visual Editor.

Pausing/Restarting a recording

You can pause and restart the recording. Only actions taken in the AUT browser while you are in recording mode are included in the test. Actions taken while recording is paused are not included.

👍

While the recording is paused you can set up your test scenario and then resume recording.

To pause/restart recording:

  1. On the Visual Editor screen, while you are recording a test, the pause button is shown in the header bar. Click on the Pause button to pause the recording.
  1. While recording is paused, the red record button is shown in the header bar. Click on the record button to resume recording.
  1. Go back to the recording browser, either by maximizing the window or by clicking on the Go to app button in the header bar, and continue recording the test.

📘

Using the above method continues recording the steps sequentially from where you left off. You can also insert additional recorded tests in between existing steps. This is done by clicking on the button at the point where you would like to make the insertion and then clicking Record action here from the dropdown list.

Step 5 - Saving a Test

Whenever you create a new test or make changes to an existing test, you need to save the test.

❗️

If you close the browser without first saving the test, your work will be lost.

Saving a new test

To save a new test:

  1. Once you have created a test, click Save.
    The Save Test window opens.
  1. In the Name field, enter a unique name for the test.
  2. In the Description field, enter a brief description of the purpose of the Test (optional).
  3. Click OK.
    The test is saved.

Saving an edited test

When you edit an existing test, e.g. record additional steps, adjust properties, add validations etc. you need to save the changes.

❗️

When you save the edited version it overwrites the previous saved version.

To save changes to a test:

  1. After making changes to the test, click Save.
    The Change Message window opens.
  1. In the Message field, enter a description of the changes made in this version (optional).
  2. Click OK.
    The latest version of the test is saved.

Updated about a month ago


What's Next

Next, you can learn how to edit your tests in Testim.

Editing your tests

How to Record a Test


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.