RunScript

Created: September 29, 2017 | Updated: February 12, 2019 | Applies to versions: 18.0, 18.1, 19.0, 19.1, 20.0, 20.1 and 20.2

Parent page: ScriptingSystem Commands

The following pre-packaged resource, derived from this base command, is available:

Run Script

Applied Parameters: None

Summary

This command is used to run a script within Altium Designer.

Access

This command is accessed by choosing the File » Run Script command from the main menus.

Use

After launching the command, the Select Item To Run dialog will open. The dialog will present all script projects (*.PrjScr) and associated source documents that are either:

Open as active projects in the Projects panel.
Made available as global scripting projects from the Scripting System - Global Projects page of the Preferences dialog. Such script projects are installed on a permanent basis so their functionality becomes available at all times for all Altium Designer sessions.

These are not a necessity, however. You can browse for and add a script that you want to run directly to the Select Item To Run dialog. This can be a file-based script project or a revision of a Script Item in a managed content server to which you are currently signed-in (a revision of a Script Item stores a script project).

Select the script to be run then click OK.

Tips

If there are errors present in the script, after clicking OK in the Select Item To Run dialog an error dialog will open alerting you to the fact an error is present. The dialog will give information about the error and the source script document will be opened and the offending line of script highlighted. The error dialog will only flag the first scripting error encountered. There may be more existing, which will be found by subsequent attempts to run the script.