Getting Started

In this section you will learn how to record your first script.

Recording your first test

After creating a new project you will be prompted to name it and then asked to provide a base URL.

getting-started project getting-started base url

The base URL is the URL of the application you are testing. It’s something you set once and it gets used across all of the tests in this project. You can change it later if need-be.

After completing these settings, a new browser window will open, load the base URL, and start recording.

getting-started recording

Interact with the page and each of your actions will be recorded in the IDE. To stop recording, switch to the IDE window and click the recording icon.

This test example can be downloaded here.

Configure Mugnsoft IDE to push to Mugnsoft and/or Gitlab

To be able to push the auto-generated code to Mugnsoft or to your Gitlab repository “Mugnsoft-monitors”, click on the cog icon button or use the crtl+shift+M keys.

getting-started open settings modal

Add Mugnsoft’s settings

You need to get first a Mugnsoft’s webserver token.

  1. Log in to your Mugnsoft' webserver and access the API Keys web page.
getting-started getting Mugnsoft's webserver API token step1
  1. Generate a new API key for the webserver components had the required validity for the token.
getting-started getting Mugnsoft's webserver API token step2
  1. Copy the token to clipboard
getting-started getting Mugnsoft's webserver API token step4
  1. Use the token and test the accessibility to Mugnsoft’s webserver API from Mugnsoft’s IDE
getting-started getting Mugnsoft's setting

Add Gitlab’s settings

You need to get first a Gitlab token. Ideally create a specific account to store your Mugnsoft’s script

  1. Login to your Gitlab account and go to your profile to access your token web page. Generate the token saved it in a secure place.
getting-started getting Gitlab's API token
  1. Use the token and test the accessibility to you GItlab repository from Mugnsoft’s IDE
getting-started getting Gitlab's settings


The given settings will be saved so that whenever you re-open Mugnsoft IDE these will be automatically set.

Export the auto-generated code

Once you have set the setting, you are all set to export and push the generated code to the back end (Mugnsoft’s webserver and Gitlab).

getting-started export code

Push/commit your monitor’s definition

When you are happy with your monitor’s settings and code, you can start committing them to the back-end. getting-started commit

You are left with 3 choices:

  • commit to Mugnsoft’s webserver API only
  • commit to Gitlab only
  • commit to both Mugnsoft’s webserver API and Gitlab
getting-started select your commit

Commit your monitor setting to Mugnsoft

After you’ve finished setting up the monitor’s info, you can easily push it to the Mugnsoft’s webserver API, as shown below :

getting-started commit Mugnsoft

The monitor should be found in the monitors' listing

getting-started export commit Mugnsoft result

Commit your monitor setting to Gitlab

After you’ve finished setting up the monitor’s info, you can easily push it to your Gitlab’s “Mugnsoft-monitors” repository, as shown below :

getting-started Gitlab create

A error message will be displayed if the monitor you are trying to push is already defined.

getting-started commit Gitlab exist

Alternatively you can push update to the monitor.

getting-started commit Gitlab update

The monitor’s file should be found in your Gitlab repository along with the commit message as follow.

getting-started commit Gitlab update

Delete a test

To delete a test, hover your mouse over the test and click the Delete button.

getting-started delete step1 getting-started delete step2

Save your project and work

To save everything you’ve just done in the IDE, click the save icon in the top-right corner of the IDE.

getting-started save

It will prompt you to for a location and name of where to save the project. The end result is a single file with a .side extension.



You can play tests back in the IDE by selecting the test or suite you’d like to play and clicking the play button in the menu bar above the test editor.

getting-started replay

The test(s) will play back in the browser. If a window is still open from recording, it will be used for playback. Otherwise, a new window will be opened and used.