On this page

Cameo Collaborator for Teamwork Cloud has a user interface that allows you to simulate a project directly in the Cameo Collaborator document published from that project.


Preparing projects for simulation in Cameo Collaborator for Teamwork Cloud

To simulate a project in Cameo Collaborator for Teamwork Cloud, prepare it as described below.


To prepare a project for simulation in Cameo Collaborator for Teamwork Cloud

  1. In a modeling tool, open the project that you want to simulate.

  2. Create a Simulation Configuration and specify its properties if you haven't already done so.

    In Cameo Collaborator for Teamwork Cloud, you can only simulate the projects that have a Simulation Configuration.

  3. Make sure you specify the Execution Target property of the Simulation Configuration.

  4. If you want the simulation results to be saved and displayed in a Cameo Collaborator document after every simulation, specify the Result Location property of the Simulation Configuration.

    The value of the Result Location property should be the Instance Specification in which you want to save simulation results.


     

  5. Commit project changes to the server or save and add the project to Teamwork Cloud (if the project is local).
  6. Publish the project to Cameo Collaborator for Teamwork Cloud.


Now you can open the Cameo Collaborator document and simulate the model on the web.


Simulating projects in Cameo Collaborator for Teamwork Cloud

Once you publish your project to Cameo Collaborator for Teamwork Cloud, you can simulate it in a Cameo Collaborator document, as described below.


To simulate a project in Cameo Collaborator for Teamwork Cloud

  1. Open the Cameo Collaborator document published from the project you want to simulate.

  2. Click  on the bottom right corner of the screen.

  3. Navigate to the element you want to execute (the execution target of a Simulation Configuration) and select it.
  4. When the Select configuration and run pane opens on the right side of the screen, select the Simulation Configuration you want to run.

  5. Click  on the top right corner of the pane.



    Requirement or Constraint verification in an Instance Table

    In the example above, the execution target is an Instance Specification in an Instance table. As you can see, the Instance Table cells are highlighted in green or red according to Requirement or Constraint verification results. To see the tooltip with Requirement or Constraint text, hover the mouse pointer over a highlighted cell.

  6. Wait for the notifications informing you about the simulation's place in the queue and its status. You can use these notifications to do one of the following:

    • When the simulation is complete, click Refresh to refresh the page and see the simulation results.
    • When the simulation is complete, click Navigate to go to the document section where the simulation was initiated and see the simulation results.
    • When the simulation with UI is started, click Open to open the UI window.


After simulating a project in Cameo Collaborator for Teamwork Cloud, a new project version is created with the following commit message: Simulation WebApp: '<Simulation Config Name>' execution results. If the simulation runs longer than 1 min, the right-side panel is closed, and you can work with the document as usual while the simulation continues to run in the background. When the simulation is completed, you get a notification with the link to the document location where the simulated instance was selected.


Displaying charts with the simulation results

Server-side simulation supports Timeline and Time Series Charts, which are updated in real-time during simulation. When displayed in a Cameo Collaborator document, Timeline and Time Series Charts are automatically updated with the latest simulation results every time you simulate the model.


To display a Timeline or Time Series Chart in a Cameo Collaborator document

  1. In a modeling tool, open the project that you want to simulate.
  2. Open the Specification window of the Simulation Configuration you want to run.
  3. Set the value of the Result Location property to the Instance Specification in which you want to save simulation results.
  4. Set the value of the UI property to the Timeline or Time Series Chart you want to display in a Cameo Collaborator document.
  5. Open the Specification window of the Timeline or Time Series Chart you specified as the value of the UI property in the previous step.
  6. Set the value of the Record Plot Data As property to HTML.
  7. Commit project changes to the server or save and add the project to Teamwork Cloud (if the project is local).
  8. Publish the project to Cameo Collaborator for Teamwork Cloud.
  9. Simulate the project in Cameo Collaborator for Teamwork Cloud.


Once the simulation is finished, a Timeline or Time Series Chart will be displayed in the HTML format as the Documentation property of the Instance Specification set as the location result (see step 3).


A Timeline Chart displayed in a Cameo Collaborator document.