On this page

If you work with Teamwork Cloud projects, you can simulate them on the server without using a modeling tool. You can execute your models using REST API, or the Cameo Collaborator for Teamwork Cloud user interface (if there are Cameo Collaborator documents published from those models). You can also run your models using the Resources application and Python client (pyST.py).

The following demo shows the server-side simulation in action:

System requirements

The following Web Application Platform system requirements apply to an environment that runs a single server-side simulation. If you set up an environment where you can run concurrent server-side simulations, the system requirements applicable for a single simulation must be adjusted accordingly.

Web Application Platform system requirements for the environment with server-side simulation:

  • Simple non-iterative simulations:
    • 1-core CPU
    • 1GB of RAM
    • Sample projects:
      <install_root>\samples\simulation\SpacecraftMassRollup.mdzip
      <install_root>\samples\simulation\CoffeeMachine.mdzip
  • Simple iterative simulations:
    • 2-core CPU
    • 1GB of RAM
    • Sample projects:
      <install_root>\samples\simulation\TradeStudyExamples.mdzip
      <install_root>\samples\simulation\      HingeMonteCarloAnalysis.mdzip
  • Complex, time-consuming simulations:


Installation information

The server-side simulation service is one of many Web Application Platform services provided as a separate application. After successfully installing the server-side simulation service, the Simulation application is displayed on the welcome page of the Web Application Platform. Opening the application will redirect you to the Server-side Simulation Swagger page.

Web Application Platform welcome screen

The server-side simulation service is installed automatically alongside Web Application Platform while using Teamwork Cloud or Magic Collaboration Studio installer. If you install Web Application Platform on a separate machine and use the Advanced Install option, select the server-side simulation service during installation. To learn more, refer to Web Application Platform Installation on a separate machine. 


To install the Server-side simulation

  1. Install Web Application Platform.
  2. Open the <wap_install_root>\apache-tomcat\shared\conf\webappplatform.properties file and set the sim.license.checkout property to true.
  3. If the Web Application Platform is installed on a separate machine, set the portfolio.name property to Magic Collaboration Studio in the webappplatform.properties file.
  4. Restart Web Application Platform.

Licensing information

The server-side simulation functionality only works with a floating Magic Model Analyst license managed by the DSLS or FlexNet license server.


Preparing projects for server-side simulation

To simulate a project on the server, it must meet the following criteria:

  • A project has to be added to Teamwork Cloud.
  • For simulation results to be saved, you need to specify the Result Location property of a Simulation Configuration.

To control the auto-starting and auto-terminating properties of server-side simulation, specify the autoStart and autoTerminate properties of SimulationConfig accordingly. To learn more, refer to SimulationConfig stereotype. 

Required permissions

To perform server-side simulation, you need to have the following Teamwork Cloud permissions:

  • Read Resources - allows you to simulate resources.
  • Edit Resources - allows you to commit the simulation results to a resource.

  • Manage Simulations - allows you to manage all simulations, including the ability to get and review simulation results and terminate simulations executed by other users.

To manage all simulations, in addition to the Manage Simulations permission, you need to have the Read Resources permission for the related resources.


Server-side simulation limitations

There are several limitations related to server-side simulation:

  • Math engine integrations (Matlab, Mathematica, etc.) are not available.
  • FMU/FMU co-simulation with Windows binaries is not available.
  • UseCase Execution is not available.
  • DSL stereotypes are not applied to created Slot and InstanceSpecification elements.
  • Finding elements by Name (e.g Signals, Operations with ALH, mapping with ExcelHelper) is not available.

Related pages