Using Scripts and Software Add-Ons in Eclipse

You can launch plug-in scripts from the Tools menu in Eclipse (External Beam Planning, Plan Evaluation) and BrachyVision (Brachytherapy Planning, Brachytherapy 2D Entry). You can also store scripts as favorites in the same menu.

You can launch software add-ons via the Tools> Add-Ons menu menu in Eclipse (External Beam Planning, Plan Evaluation) and BrachyVision (Brachytherapy Planning, Brachytherapy 2D Entry).

Stand-alone executables can be launched as any Windows application.

Approval Extensions are executed automatically as part of the Plan Approval Wizard.

Launch a Plug-in Script

To launch a plug-in script:

  1. Choose Tools > Scripts. The Scripts dialog box opens.

  2. To locate the script that you want to run, select one of the following options:

    • System Scripts: The scripts that are available for all users are shown on the list.

    • Directory: [path_to_your_own_scripts]. Click Change Directory and select a folder. All files with the .cs or .esapi.dll file name extension become available on the list.

  3. In the Scripts dialog box, select the script file on the list.

  4. Click Run.

  5. If the execution of the script takes a very long time, you can click the Abort button. The execution of the script is aborted the next time the script accesses a property or method of the Eclipse Scripting API. Note that this procedure is meant only for recovering from programming errors and should not be considered a normal practice.

Launch a Software Add-On

To launch a software add-on:

  1. Choose Tools > Add-Ons. The Add-Ons dialog box opens showing the available add-ons.

  2. Click an add-on to execute the scripts for that add-on.

Launch a Stand-Alone Executable Application

You can launch a stand-alone executable like any Windows application on the workstation where Eclipse is installed. You can also debug the stand-alone executable using normal Windows debugging tools.

Add and Remove Favorite Scripts

You can add favorite scripts to the Tools menu and define keyboard shortcuts for them.

Add a Favorite Script to the Tools Menu

  1. Choose Tools > Scripts. The Scripts dialog box opens.

  2. Select the script that you want to add to the menu.

  3. Click Add...

  4. A dialog box is opened. You can define a keyboard shortcut for the favorite script.

  5. Click OK.

Remove a Favorite Script from the Tools Menu

  1. In Eclipse, select Tools > Scripts. The Scripts dialog box opens.

  2. Select a favorite script.

  3. Click Remove.

Launch a Visual Script

Visual scripts can be run from within the Visual Scripting Workbench. You can also store scripts as favorites there. See Chapter "Creating Visual Scripts", Section "Create and Test a Visual Script".

In addition, visual scripts can be run in Eclipse like any other plug-in script (see Chapter "Using Scripts and Software Add-Ons in Eclipse*",* Section "Launch a Plug-in Script"). You can also store visual scripts as favorites in the Tools menu.

The system requires that all write-enabled action packs used in a visual script must be approved for use before script execution.