For the complete documentation index, see llms.txt. This page is also available as Markdown.

Simulator

Availability of functionality depends on the license and may not be available in all deployments.

Thanks to the application simulator, we can open a form with parameters defined by us:

  • selected environment,

  • user identifier,

  • specific input parameters,

  • selected channel: App (RWD), Native, IB inline, IB popup, or in a new browser tab.

In the App and Native channels, it is also possible to specify a specific device for simulation. Additionally, for Native, API calls for the given application are displayed.

Launching the application simulator

To launch the application simulator, select the option from the Eximee Designer navigation bar Simulator.

Setting input parameters

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

  1. Button showing/hiding the input parameters form.

  2. Environment - the environment on which the tested application is located.

  3. Request - the name of the tested application; if the value is empty, the simulator will display a list of available applications (for App, Native, New Tab channels) or a default, predefined application (for IB inline and IB popup channels).

  4. User identifier - allows entering the user identifier for which the session key will be fetched and added to the URL when the simulator is displayed. If the field is empty, the key will not be fetched.

  5. Parameters paths (query parameters) - a field allowing you to define parameters that will be appended to the path (e.g. source=ib).

  6. The button App - launches the simulator in the desktop channel (app).

  7. The button Native - launches the simulator in the native application channel.

  8. The button IB inline - launches the simulator in the IB inline channel.

  9. The button IB popup - launches the simulator in the IB popup channel.

  10. The button New Tab - opens the application in the selected environment in a new browser tab.

  11. Channel* - the layout in which the application is to be launched (an option dependent on configuration).

Figure 1. Simulator properties
Figure 2. Simulator properties with channel selection

Selecting the simulated device

After selecting the application launch channel, a button will appear in the lower-left corner of the screen allowing you to choose the simulated device (12). Changing the device adjusts the application's dimensions to those of the selected device. By default, Desktop Mode is simulated for the App, IB Inline, and IB Popup channels, while for the Native channel, iPhone X is simulated by default.

API call preview

After selecting a launch channel other than desktop, a panel will be displayed in the lower-right corner API calls. It displays the API methods called by the simulated application. The component can be collapsed by clicking the title bar. The button with the trash icon in the title bar allows clearing the component contents.

Figure 3. Application screen after selecting the "Native" channel

Configuration

To configure the simulator, prepare a JSON file that will contain a description of the available environments, layouts, and channels in which application simulation will be possible.

In the Eximee Designer settings, there should be a path to the configuration file as the value of the parameter form-starter.configurationPath, e.g.:

Example configuration file:

Configuration file

where:

  • showChannels - an attribute specifying whether the simulator should display a dropdown list with the option to select a layout

  • channels - list of available layouts

    • name - layout name

    • defaultChannel - whether the layout should be selected by default

    • formModes - channels in which a given layout is available

      • name - channel name supported in Eximee Designer

      • label - displayed channel name

      • icon - icon representing the given channel

  • environments - environments on which application simulation can be launched

    • displayName - display name

    • url - environment address.

Last updated

Was this helpful?