> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/documentation/documentation-en/zarzadzanie-aplikacja-biznesowa/testowanie-i-debugowanie-aplikacji/symulator.md).

# Simulator

{% hint style="info" %}
Feature availability depends on the license and may not be available in all deployments.
{% endhint %}

The application simulator lets us open a form with parameters we define:

* the selected environment,
* the user ID,
* specific input parameters,
* the selected channel: App (RWD), Native, IB inline, IB popup, or a new browser tab.

In the App and Native channels, you can also select a specific device to simulate. Additionally, for Native, API calls made by the application are displayed.

## Launching the application simulator <a href="#symulatorwnioskow-uruchomieniesymulatorawnioskow" id="symulatorwnioskow-uruchomieniesymulatorawnioskow"></a>

To launch the application simulator, select **Simulator**.

### Setting input parameters <a href="#symulatorwnioskow-ustawienieparametrowwejsciowych" id="symulatorwnioskow-ustawienieparametrowwejsciowych"></a>

The form at the top of the module lets you launch an application with the selected parameters.

1. Button for showing or hiding the input parameters form.
2. **Environment** - the environment where the application being tested is hosted.
3. **Application** - the name of the application being tested. If this field is empty, the simulator displays a list of available applications (for the App, Native, and New Tab channels) or a default, predefined application (for the IB inline and IB popup channels).
4. **User ID** - lets you enter the user ID for which a session key will be retrieved and added to the URL when the simulator is displayed. If the field is empty, the key will not be retrieved.
5. **Parameters** path (query parameters) - a field for defining parameters to append to the path (e.g., source=ib).
6. Button **App** - launches the simulator in the desktop (app) channel.
7. Button **Native** - launches the simulator in the native application channel.
8. Button **IB inline** - launches the simulator in the IB inline channel.
9. Button **IB popup** - launches the simulator in the IB popup channel.
10. Button **New Tab** - opens the application in the selected environment in a new browser tab.
11. **Channel**\* - the appearance in which the application will be launched (this option depends on the configuration).

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fl7dy90qH1sqGkVNLcUjG%2Fimage.png?alt=media&amp;token=00a0be3e-1fa1-4bf5-9f4f-b3846adfd4a1" alt=""><figcaption><p><em><strong>Figure 1.</strong> Simulator properties</em></p></figcaption></figure>

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FvBl5jimHrG5mQfAcxlmS%2Fimage.png?alt=media&amp;token=3b6b1f7d-50b1-4e99-84ad-d2a471d2763e" alt=""><figcaption><p><em><strong>Figure 2.</strong> Simulator properties with channel selection</em></p></figcaption></figure>

### Selecting the simulated device <a href="#symulatorwnioskow-wyborsymulowanegourzadzenia" id="symulatorwnioskow-wyborsymulowanegourzadzenia"></a>

After selecting the channel for launching the application, a button for selecting the simulated device (12) appears in the bottom-left corner of the screen. Changing the device adjusts the application's dimensions to match those of the selected device. By default, Desktop mode is simulated for the App, IB Inline, and IB Popup channels, while iPhone X is simulated by default for the Native channel.

### API call preview <a href="#symulatorwnioskow-podgladwywolanapi" id="symulatorwnioskow-podgladwywolanapi"></a>

When you select a launch channel other than desktop, a panel appears in the bottom-right corner **API calls**. It displays the API methods called by the simulated application. You can collapse the component by clicking its title bar. The trash-can button in the title bar clears the component's contents.

<figure><img src="https://2112972046-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2FSUR9q8A6JFcv6R7JI37v%2Fimage.png?alt=media&amp;token=6390e135-dc90-4243-ba6e-1b512a086af7" alt=""><figcaption><p><em><strong>Figure 3.</strong> Application screen with the "Native" channel selected</em></p></figcaption></figure>

### Configuration <a href="#symulatorwnioskow-konfiguracja" id="symulatorwnioskow-konfiguracja"></a>

To configure the simulator, prepare a JSON file describing the available environments, themes, and channels in which applications can be simulated.

In Eximee Designer settings, specify the path to the configuration file as the value of the parameter **form-starter.configurationPath**, for example:

```
form-starter.configurationPath=/etc/eximee/form-starter.json
```

Example configuration file:

<details>

<summary>Configuration file</summary>

```
{
  "showChannels": false,
  "channels": [
    {
      "name": "app",
      "formModes": [
        {
          "name": "app",
          "label": "App",
          "icon": "desktop_windows"
        },
        {
          "name": "mobile",
          "label": "Native",
          "icon": "phone_iphone"
        },
        {
          "name": "inline",
          "label": "IB inline",
          "icon": "featured_play_list_outlined"
        },
        {
          "name": "popup",
          "label": "IB popup",
          "icon": "flip_to_front"
        },
        {
          "name": "newTab",
          "label": "New tab",
          "icon": "open_in_new"
        }
      ],
      "defaultChannel": true
    },
    {
      "name": "form",
      "formModes": [
        {
          "name": "app",
          "label": "App",
          "icon": "desktop_windows"
        }
      ]
    }
  ],
  "environments": [
    {
      "displayName": "Dev bank",
      "url": "https://pl.dev.bank.eximee.dev.consdata.org"
    },
    {
      "displayName": "Dev bank CZ",
      "url": "https://cz.dev.bank.eximee.dev.consdata.org"
    },
    {
      "displayName": "Mandarynka",
      "url": "https://pl.mandarynka.eximee.dev.consdata.org"
    },
    {
      "displayName": "Mandarynka RREV",
      "url": "https://pl-rrev.mandarynka.eximee.dev.consdata.org"
    },
    {
      "displayName": "Mandarynka CZ",
      "url": "https://cz.mandarynka.eximee.dev.consdata.org"
    },
    {
      "displayName": "Mandarynka SK",
      "url": "https://sk.mandarynka.eximee.dev.consdata.org"
    }
  ]
}
```

</details>

where:

* **showChannels** - an attribute that specifies whether the simulator should display a dropdown list for selecting a theme
* **channels** - list of available themes
  * **name** - theme name
  * **defaultChannel** - whether the theme should be selected by default
  * **formModes** - channels in which a given form is available
    * **name** - channel name supported in Eximee Designer
    * **label** - displayed channel name
    * **icon** - icon representing the channel
* **environments** - environments in which the application simulation can be run
  * **displayName** - display name
  * **url** - environment address.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.eximee.com/documentation/documentation-en/zarzadzanie-aplikacja-biznesowa/testowanie-i-debugowanie-aplikacji/symulator.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
