Managing Scripts

Manage Scripts

Scripts are tied to specific contexts, and the Manage Scripts dialog lists all the scripts accessible to the user according to the context selections defined by the Context, Selected User, Selected Project, and Selected Model drop-down menus. The list of scripts 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 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:

1. Right click a column title and select Column Chooser from the popup.
2. Drag the column to be shown to the desired position.

You can get the same information related to scripts as listed above if you run a script with the --#GetAnalysis command in the Script Manager dialog using Script Report (24) as the analysis type. For more information, see Data Extraction, Transformation, and Loading.

Viewing or Editing Script Properties

To view or edit the script properties of a script, select the script from the list and click Properties

Running a Script

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.

Creating a New Script

To create a new script, click New and define the Script Properties.

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 duplicated global ID's (= the identifier in the Script GUID field) 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.

Deleting Scripts

To delete script(s), select them from the list and click Delete.

Script Properties

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

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

Saving or Discarding Changes

• 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.

Running a Script

Click Run to run the script. Alternatively, you select it from the list on the Script Manager dialog and click Run, or you can click Run on the ribbon and select the script to be run from the menu that opens.