Set up Simulator agents

The Simulator agent hosts simulations that you can run in your local environment on any machine. These simulations send messages, receive requests, or respond like real services.

Use the Simulator agent to create, edit, and organize your simulations, or connect your agent to Tosca to do this in the cloud.

Before you start

  • Simulator agents are copyable files, so you don’t have to install anything specific for it.

  • The machines on which you run your Simulator agents must meet the minimum system requirements.

Set up your Simulator agent

You can set up your Simulator agent through the setup wizard during the download process. If you are a Tricentis Tosca administrator, you can also set it up through the appsettings.yml file.

You only need to do this once. When you restart a registered Simulator agent, it automatically connects to Tricentis Tosca in the cloud.

Choose this option if you haven't yet downloaded a Simulator agent. The wizard starts automatically during the download process:

  1. Go to Resources in the menu bar at the top and open Downloads.

    Download the Simulator agent. Click to enlarge.

  1. Download the Simulator agent for your operating system. This starts a setup dialog during the download process.

  2. Copy the tenant and workspace connection details from the dialog to the clipboard and close the dialog.

  3. Double-click the executable file that you've downloaded.

  4. In the next dialog, you have the following options:

    • Select Connect Simulator agent if you want to organize your simulations with Tricentis Tosca in the cloud.

    • To use the local Simulator agent interface, select the link. The Simulator agent opens and you can start exploring right away. You don't need to do the next step.

    Simulator agent welcome screen. Click to enlarge.

  5. Paste the tenant and workspace details you copied to the clipboard, and follow the on-screen instructions.

    Your Simulator agent is now active and listed on the Simulator agents page.

As an administrator, you can connect your Simulator agent to Tricentis Tosca in the cloud using the Simulator agent details dialog and the appsettings.yml file:

  1. Go to API simulation > Simulator agent and select Get agent details.

  2. In the default installation folder %LOCALAPPDATA%\Tricentis\Simulation, open the appsettings.yml file.

  3. In the Simulator agent details dialog, copy the values Tenant, Workspace, and Client secret, then paste them into the respective entries in the appsettings.yml file.

  4. Close the Simulator agent details dialog.

  5. Save and close the appsettings.yml file.

    Your Simulator agent is now active and listed on the Simulator agents page.

Simulator agent files and directories

The default installation folder for Simulator agents is %LOCALAPPDATA%\Tricentis\Simulation. It includes the following folders and files:

Folder or file

Description

Log

Storage for your Simulator agent log files.

Workspace

Store your simulation files in this folder. Create folders to organize them. When you start the Simulator agent, it loads all simulation files that are in this folder.

Note: you can only reference files in the same workspace folder in a simulation file.

appsettings.yml

This is the Simulator agent configuration file. You can use this file to integrate the Simulator agent to Tricentis Tosca in the cloud.

Start the Simulator agent

To start the Simulator agent, double-click the Tricentis.Simulator.Agent.exe file that you've downloaded.

When the Simulator agent is set up, the console window opens and shows all logs. It's now connected to Tricentis Tosca in the cloud. The Simulator agents page also opens in a new tab.

If the Simulator agent isn't connected to Tricentis Tosca in the cloud, its user interface opens.

What's next

Deploy simulations to your Simulator agent.

Take a look at the Simulator agents overview page.

If you don't have a simulation yet, create one.