Vortex Studio Director User Guide

The Director enables the integrator to create, configure, launch and monitor simulators.

A simulator file contains the description of simulation applications distributed over a network of computers.

Director User Interface

The following properties are configurable in a simulator:

The Director has the following interface:

Defining a Simulator with Director

Configure a Simulator

  1. Creating a new simulator
    To create a new simulator, press the + button and Edit in the Simulator tab on the right.
  2. Selecting a network
    Select the most appropriate network, e.g., Ethernet for a LAN distributed simulator or loopback (127.0.0.1) for a local simulator.
  3. Selecting the setup file
    Select the setup document describing the nodes of your simulator. The setup document has been created using Vortex Studio.
  4. Defining the data provider path
    Optionally, you can modify the path where simulator files and other distributed simulation data will be stored.
  5. Add a custom splash image
    Optionally, you can modify the splash image.
  6. Add simulation applications
    Finally, add as many simulation applications as needed using the + button. For each application, a node of the setup document must be selected. The hostname of the computer on which the application will run can be chosen from the list of the recognized machines. Use Refresh Network to update the list if needed. For inspection purpose, the Computers tab lists all the computers found using the selected network.
  7. Save to apply your changes

Computers on the Network

The Director can discover computers present on the selected network. This can be useful to verify whether the service is running on the expected machines.

Launch and Monitor the Status of Simulation Applications

Director Launch and Force Stop

To launch a simulator, select its name in the list and press Launch Simulator.

The director can also stop the running applications using the Force Stop button: a soft close will be sent to the running applications and a hard kill will be applied if they are not responding after that.

Warning
Force Stop
Using Force Stop can be useful to guarantee that all simulation applications are shut down.
However, this should not be the standard way of closing a simulator. The proper way to shut down a simulator is to use the console interface, either the Quit button or the Windows close icon.

The launch function can also be called in the command line interface so that deployed turn key simulators used by operators will not have to go through the Director user interface to start their simulation.

When using the launch command line, the data store is automatically deduced relatively to the simulator file.

Launching a simulator from the command line or a shortcut
VortexDirector.exe --launch mydatastorepath\Simulators\mysimulatorfile.simulator

Quitting the Director

The Director window can be minimized and will continue to monitor the simulator.

In order to properly quit the Director, select File>Quit' must be used.

If the simulator is still running, you will be asked whether all applications must be force stopped.

Director Monitoring

Once the simulator has started, the usual simulation windows and user interface will appear either on the local or remote machines.

Monitoring of the remote applications can be performed using the Applications tab.

The screenshot below shows the monitoring panel opened using the Director tray icon after locally launching Vortex Studio Player.

It reports the following information that might help when troubleshooting the simulator:

When one simulation application stops unexpectedly, the Director reports it with a warning icon.

Users can locally open the log of the remote application on their workstation to investigate the cause of the issue.

Simulator Data Store Path

All simulator files created and modified by the Director are stored under the data store path.

The default path is User Document\CM Labs\Simulator on the machine starting the Director.

Each simulator has its own file. They can be manipulated with the file explorer and will be detected and monitored by the Director.

The data store path can be globally modified in the Director interface under Tools>Settings.