Using the Script Editor

Before using scripting, consider whether using actions (Actions) would be more efficient.

Information on the Application Studio Scripting Object Model can be found in the Scripting Object Model Reference. Click the Help icon in the Script Editor’s toolbar to open it.

These tasks can be done with actions instead of scripting:

  • Conditional jumps between and within reports. Conditions can now be specified within an action. Previously, scripts were required to evaluate conditions.
  • Actions triggered by a changed selection in a ListView object (for example, a combo box).
  • Initializing a report. The OnReportLoaded action replaces the OnScriptStart event.

These tasks, for example, still require scripting:

  • Hot keys - using the Spreadsheet_KeyDown event to react to key strokes within a report and execute a script.
  • Changing OLAP Server models - using the Scripting API (Application.GetAleaAPI method) to add or remove dimension elements etc.
  • Conditional hiding of part of a report - for example, showing or hiding a navigation panel.
  • Any design mode scripts . Actions are only executed in View Mode.

See Design Mode scripts.

To open the Script Editor, select View > Scripting or press <Shift+F6>. This option is disabled if you do not have permission to create or edit scripts.

The script area has four panes:
Pane Description
Scripts Choose the script type.
Input area Enter the script code.
Objects Displays the available objects of the opened report.
Classes Displays the available classes for the script.
Note: You cannot create scripts if you are connected to more than one database.