About the 3DX Script Adapter

The 3DX Script adapter allows you to pass in arguments and run a 3DX script, such as a VBScript or a Python script, that operates on, or creates, a 3DSpace object, such as a part or a simulation.

This page discusses:

See Also
Configuring the 3DX Script Adapter
In Other Guides
Automating Tasks Using Macros

You can insert a 3DX Script adapter into your simulation process and use the adapter to run a 3DX Script that operates on, or creates, a 3DSpace object with a selected app.

If your script creates a new object or modifies an existing object, your changes are not automatically saved and, by default, are lost when the script completes. In addition, you cannot perform a manual save while the script is running. However, you can do either of the following to save an object that was modified or created by your script:

  • Include save commands in your script.
  • Use the Capture object in option to capture the last object opened by the script in an object parameter. The last object opened by the script is saved in the object parameter, regardless of whether it was created or modified. The object parameter is saved when the script completes.

When Optimization Process Composer runs the 3DX Script adapter, it launches a 3DEXPERIENCE client in the background. Therefore, the 3DOrchestrate Station that runs the 3DX Script must be installed on a system that has the same prerequisites as the 3DEXPERIENCE client.

If you are running your process on a remote station, then you must run it from a browser using Process Composer (Web) or Performance Study, and close the 3DEXPERIENCE on your computer.

VBScripts

You can pass values between the simulation process and the VBScript by mapping parameters to the arguments of a function in the script. For example, you can use the script to create a Physics Simulation object and all of the features of a simulation, such the material definitions, the loads, and the FEM representation. You can control the value of simulation objects, such as loads, by passing parameters to the arguments of a function in the script.

Similarly, you could create a design of experiments that runs a simulation designed to measure the peak stress around a hole. You could control the diameter of the hole in the part in each simulation by passing in a radius parameter to a VBScript that runs a 3D Modeling app.

In most cases, you will create a VBScript by recording your actions while interacting with a dialog box in a CATIA 3D Modeling app. You should create a macro library of type PLM VBA projects in which to store your macro.

VBScript macros recorded from your interactions with a dialog box will be of type MS VBA; however, by default no arguments are passed into a recorded VBScript macro. To pass in arguments, you must edit the function definition. The following example shows a Radius argument that has been added to the function definition: 

Sub CATMain(Radius As Long)

You can define which parameters will be passed in as arguments to the function. Parameters appear in the 3DX Script editor in the same order in which they are passed into the function.

You cannot record your interactions with a physics simulation dialog box; however, you can create a VBScript macro that operates on a simulation by entering the commands into a text editor.

Python Scripts

You can run Python scripts that are associated with a physics simulation app. You cannot pass parameters into a Python script; however, you can use a combination of a Download adapter and a Text Parser adapter to modify text in a Python script during each iteration of a loop.

By default, Optimization Process Composer assumes that Python was installed when a physics simulation app was installed, and Optimization Process Composer determines the Python paths from the installation directory of the 3DEXPERIENCE client.

Alternatively, if you have not installed a physics simulation app, you can install your own version of Python. To determine the path to the Python executable and the required library, Optimization Process Composer performs the following searches in the order listed, until a condition is satisfied:

  • Search for fiper.file.root.PYTHONPATH and fiper.file.root.PYTHONEXECPATH in SMAExeStation.properties.
  • Search for the environment variables PYTHONPATH and PYTHONEXECPATH.
  • If the 3DEXPERIENCE client was installed separately from the 3DOrchestrate Station, search for fiper.station.sim.clientservices in SMAExeStation.properties. The value should be set to the installed path to the 3DEXPERIENCE client.
  • If the 3DEXPERIENCE client was installed with the 3DOrchestrate Station, search the 3DOrchestrate Station installation directory for the Python executable and the required library.

When Optimization Process Composer runs the 3DX Script adapter, it starts a 3DEXPERIENCE client in the background; however, a 3DOrchestrate Station can run only a single 3DEXPERIENCE client at the same time. Therefore, the Python script will run only if a 3DEXPERIENCE client is not already running on the same machine that is running the 3DOrchestrate Station. Likewise, if you edit the activity options of the activity containing the 3DX Script adapter and specify that the activity will run on the submitting host, you cannot run the process from Optimization Process Composer; you must run the process from a browser using Process Composer (Web) or Performance Study.