Managing Scripts

Scripts List

The scripts list is accessible via the Run button on the ribbon will show the scripts for the context that was last selected in the Manage Scripts dialog.

By default, the following information is displayed for each script:

• Context Type: the context to which the script is tied.
• Name: the name of the script.
• Group: the name of the script group.
• Tags: the tags added to the script.
• Created On: the date and time when the script was created.
• Created By: the user who created the script.
• Last Modified On: the date and time when the script was last modified.
• Last Modified By: the user who last modified the script.
• Help: the URL of the defined help page for the script.

In addition, the following columns are available but hidden by default:

• Id: the id of the script in the database.
• Model Id: the id of the model to which the script is linked.
• Model Name: the name of the model to which the script is linked.
• Project Id: the id of the project to which the script is linked.
• Project Name: the name of the project to which the script is linked.
• Script GUID: the globally unique id of the script.
• User Id: the id of the user to which the script is linked.

To unhide a column, right click a column title, select Column Chooser from the popup and drag the column to be shown to the desired position.

Script Properties

The Script Properties dialog is used to view and edit a script properties:

• Name: name of the script.
• Script GUID: globally unique id of the script.
• Support Link: URL of a help page for the script.
• Group: name of the script group.
• Tags: text tags added to the script.
• Description: description of the script.
• Script Code: the actual program code of the script that is to be executed. If the script code starts with the word ENCRYPTED, the script contents is visible in an encrypted format only. For more information, see Script Encryption.
• Show in Script Gallery: When selected, the script will be shown in the menu that opens by clicking the Run button in the ribbon.
• Hide Script Details: When selected, only users who have rights to modify the script can see the script code and other details. When unselected, all users who have view permissions can see the script code and other details.

Managing Scripts

• To view or edit the script properties of a script, select the script from the list and click Properties.
• To run a script, select it from the list and click Run. Alternatively, you can run a script by clicking Run on the ribbon and selecting the script to be run from the menu that opens.
• To create a new script, click New and define properties for the new script.
• To delete a script, select it in the list and click Delete. You can also delete several scripts at the same time by selecting them all.
• After making changes to the script properties, click Save to save the changes. You can also press Ctrl + S to save the changes.
• To discard changes done since the script was last saved, click Cancel Edit.

Copying Scripts to Another Context

1. Select the script(s) you want to copy from the list by left-clicking a script. To select multiple scripts, hold down either the Shift key or the Ctrl key.
2. Click Copy to Clipboard.
3. From the Context and the Selected User/Selected Project/Selected Model drop-down menus, select the context to which you want to copy the script(s).
4. Click Create from Clipboard.

Note that there cannot be duplicate Script GUID's in the same context. If there are multiple scripts with the same global ID, you will receive an error message and the script is not copied.

Script Run Log

When a script is run, a log about the script run progress is written to a Script Log. The Script Log also contains information about the previous script runs. For example, the log contains the output of the WriteLog and Print commands used in the script, as well as details about possible errors. After a script execution has finished, the Script Log can be seen when clicking the Show Details button in script run dialog.