Details on Add/Edit Script Parameter


This dialog is used to define script parameters for IronPython scripts in action controls and JavaScript parameters when you Edit HTML of a text area. Note that JavaScript parameters can only be of the type String.

  1. Click on the Toggle Edit Mode button, text_toggle_edit_mode_button.png, in the Text Area title bar.

    Comment: You can also right-click in the text area and select Edit from the pop-up menu.

  2. In the Text Area toolbar, click on the Insert Action Control button.

  3. Click on Script in the left-hand panel.

  4. Click New...or select an existing script and click Edit....

    Response: The New Script or Edit Script dialog is displayed.

  5. Click Add....

text_add_script_parameter_d.png

Option

Description

Name

Type the name of the parameter as it is defined in the script.

Description

An optional description of what this parameter is used for.

Type

[Only applicable for IronPyton script parameters. When working with JavaScript, only String parameters are allowed.]

Select the type of parameter. The type can be a simple data type such as a text string, an integer, etc., or it can be a visualization, page or data table in the current analysis.

Debug value

The debug value settings vary with the type of input parameter. When a visualization is selected, you specify a visualization from your current analysis to use as debug value. When a page is selected, you specify a page as debug value. When a data table is selected, you specify a data table.

For the options available when selecting any of the standard data types, see below.

   Value

Use this option to specify a value of the selected type to use when debugging the script.

   Property

Use this option to specify a property of the selected type to use when debugging the script.

   Select Property...

Opens the Select Property dialog where you can select a property to tie to the script parameter.

   Expression

Use this option to calculate the debug value for the parameter via an expression.

   Edit Expression...

Opens the Edit Expression dialog where you can specify an expression using columns, properties and functions.

See also:

Details on New/Edit Script