Running a Behavior Experience with Batch

You can use a batch to perform a behavior experience. This is useful to automate this operation, or to perform it on a remote computer. You can also execute a function and a script file related to the scenario.

Batches in general are described in 3DEXPERIENCE Native Apps: Native Apps Common Services: Tools: Batches. For more information, see Batches.

Tip: You can export the simulation results as Engineering Documents containing CSV files. For more information, see Generating File from Results by Simulation Setup.

This task shows you how to run a behavior experience with batch, including executing a related function and script file:

Before you begin: Create a behavior experience.
Tip: If you want to also execute functions and script files related to the simulation, you can do the following to have an example to work with:
  1. In the Dymola Behavior Modeling app, create the library MyLib according to the first subsection in Dymola Behavior Modeling User´s Guide: Performing a Virtual Execution: Scripting: Running Script Files and Functions with Batch.
  2. From the model MyModel in this library, create a behavior experience.
    Note: If you name the behavior experience simulation MySimulation, it fits the search criteria example in the task.

From a Session

You can start the behavior experience batch from any app during a session.

  1. From the Tools section of the action bar, click Utility .

    The Batch Monitor is a separate application, this means you might have to supply a password and select options when starting it.

    The Batch Monitor appears to let you select the convenient batch.
  2. Double-click CATSymBatchExecuter.
    The CATSymBatchExecuter dialog box appears to let you select a behavior experience.
  3. Click 3DEXPERIENCE Platform Object Search to select a behavior experience.
    The 3DEXPERIENCE Platform Object Search dialog box appears.
  4. In the Object Selection tab of the dialog, do the following to perform a simple search for a Behavior Experience by the title:
    1. In the Object box, select, from the list, Simulation (abstract).
    2. In the Extension box, keep (No Extension).
    3. In the Easy tab, use the Title box to search the title of the simulation, by entering a text string.

      Tips:
      • You can use the star * as wildcard, typing, for example *My* to search for all simulations containing "My" in the title.
      • You can display a list of previous text strings entered.
      • You can select if you want to use case sensitive search by selecting or clearing Case sensitive.

    4. Keep the default selection Add Results.
    5. Click Apply to perform the search.

      Important: You must click Apply to perform the search, you cannot directly click OK.

      The CATSymBatchExecuter dialog box displays your selection.
    6. Click OK to close the search dialog.
    7. Delete all search results except the result you want to work with.
  5. If you want to select a script file and a function to be executed together with the scenario, do the following:
    1. Click the Selected Operation tab.
    2. Enter the name of the Modelica script files and the Modelica function that you want to execute together with the scenario.

      Important:
      • The function must be present in the model from which the scenario was created.
      • It is highly recommended that the script file should be stored as a resource in the library that the above model belongs to, to ensure that the batch works also on a remote computer.

      For more information about creating functions, script files, and how to specify the names of them, see Dymola Behavior Modeling User´s Guide: Performing a Virtual Execution: Scripting: Running Script Files and Functions with Batch.

  6. Optional: Click Save to create an .xml file from the behavior experience batch.

    Important: You need such an .xml file to perform the batch from a prompt command.

  7. Click Run to start the behavior experience batch.
    The CATBatchStarter.exe is launched.

You can check the result in an .htm report.

From a Prompt Command

You can start the behavior experience batch without entering any app.

For more detailed information, see Running a Batch from the Command Line.

Before you begin:

Save your behavior experience in an .xml file.

  1. Open a prompt command.
  2. Type one of the following command lines:
    • CATUTIL -Name CATBatchStarter xml_file
    • catstart -run "CATBatchStarter" -input xml_file -host remote_machine
    • CATBatchStarter -input xml_file
    The CATBatchStarter.exe is launched.

You can check the result in the .htm report.

On a Remote Computer

You can start the behavior experience batch on a remote computer. For general information, see

For more detailed information, see Running Batches in Remote Mode.

  1. Open a prompt command.
  2. Launch a daemon service by entering the following command line:
    • catstart -run "CATBatSrvMonitorExe BB"
  3. Launch the behavior experience batch by entering one of the following command lines:
    • CATUTIL -Name CATBatchStarter xml_file
    • catstart -run "CATBatchStarter" -input xml_file -host remote_machine
    • CATBatchStarter -input xml_file
    The CATBatchStarter.exe is launched on the remote computer.

You can check the result in the .htm report.

Check the Result in a .htm file

A .htm report with the default name SimulationReport_.htm is generated to let you check your behavior experience result.

  1. Enter the dedicated folder. By default, this folder is: C:\temp

    Note: This path, and the name of the report, can be customized when launching the batch from the Behavior Experience Batch dialog box, in the Report tab.

  2. Open the SimulationReport_.htm file.
    The batch process is described.
  3. In the report, click the minor green OK to access a .htm report with the behavior experience results.

Working with the Process Composer

You can, in the Process Composer app, use the System Experiment Batch utility to execute a selected System Behavior Simulation, including executing related functions and script files.

For more information, see Process Composer User´s Guide: Using Adapters: Function Adapters: 3DEXPERIENCE Utility Adapter: Configuring the 3DEXPERIENCE Utility Adapter: Configuring the Execution of a 3DEXPERIENCE Utility: Executing Modelica Functions and Scripts and CATIA System Behavior Simulations.