Details on Action Settings


This dialog is used for adding or editing actions to be performed when clicking a dynamic item in a graphical table or a text area, or clicking a tile in a KPI chart. The actions can open TIBCO Spotfire tools that work on the range of filtered or marked data, apply bookmarks, or navigate to a certain page or visualization in the analysis, the same things that are available for Action Controls. Multiple actions can be performed in just one click. It is also possible to add your own custom actions using the IronPython scripting functionality, or to refresh data function calculations.

  1. Right-click the dynamic item column for which to add or edit an action in a graphical table visualization.

  2. Select Properties from the pop-up menu.

  3. If the Settings dialog for your selected dynamic item is not opened directly, go to the Axes page in the Graphical Table Properties dialog, select the column you want to modify and click Settings.

  4. Go to the Actions page and click Settings.

  1. In the text area title bar, click the Edit Text Area button, text_toggle_edit_mode_button.png.

    Comment: You can also right-click the text area and select Edit Text Area from the pop-up menu.
    Response: The Edit Text Area dialog is opened.

  2. Right-click the gray edit box representing the desired dynamic item in the text area.

  3. Select Edit Control from the pop-up menu.

  4. Go to the Actions page and click Settings.

  1. Right-click the KPI tile for which you want to add or edit an action.

  2. Select KPI Settings in the opened menu.

  3. Go to the Actions page in the KPI Settings dialog.

  4. Select the Perform action on click check box.

  5. Click Settings.

Actions

Select this option to insert an action which includes displaying or hiding panels, applying bookmarks, switching pages, or performing various operations on marked rows.

vis_action_settings_d.png

Option

Description

Description

A text that can be shown in the tooltip when hovering with the mouse pointer over the item connected to the action.

By typing a good description you can help other users of the analysis understand what will happen when clicking on the item.

Available actions

Lists all actions that can be included in a multiple action link, grouped by type. Click on the plus sign to expand a group. Click on an action (a function, a bookmark or a page) to select it.

Comments about bookmarks:

For bookmark components, the active visualization always takes precedence over the active page.

The filter settings of the active filtering scheme are changed, including the setting determining how related data tables are affected by each other's filtering.

The markings component of a bookmark takes the analysis back to the state all markings had when the bookmark part was captured. If a marking has been removed, that marking is simply ignored.

Comments about marked rows:

The marking applied when adding any of the Marked Rows functions is the one used by the active data table. The active data table is the one used by the visualization that was active before clicking on the text area. If the marking for the active visualization is set to (None), nothing will happen when clicking on the link.

Add

Adds the selected action to the Selected actions list.

Remove

Removes the selected action from the Selected actions list.

Selected actions (applied in top-bottom order)

Lists the added actions in the order that they will be performed.

Settings

Opens the Settings dialog for the action selected in the Selected actions list (when applicable).

Move Up

Moves the selected action up in the list.

Move Down

Moves the selected action down in the list.

Script

Select this option to insert an action that executes a script when clicked. For script examples, see IronPython Example Scripts or  Action Script Examples

Note: For security reasons, there are some restrictions for using scripts. For more information, see Usage of Scripts.

vis_action_settings_script_d.png

Option

Description

Description

A text that can be shown in the tooltip when hovering with the mouse pointer over the item connected to the action.

By typing a good description you can help other users of the analysis understand what will happen when clicking on the item.

Available scripts

Lists all currently defined scripts.

Note: The Remark field can contain information about whether a script is trusted or not. Scripts that you have created yourself are trusted, and so are scripts saved as trusted to the library by a member in the Script Author group.

If you receive an analysis file containing a script directly from another person, the script will be listed as "Not trusted". This does not necessarily mean that the script contains any unsafe material, but you should determine whether you trust the script or not by inspecting it in the Edit Script dialog. By clicking OK in the Edit Script dialog, the script will be trusted. If you know all scripts are safe, you can click Trust All.

However, due to security reasons, scripts cannot be used in a Spotfire Business Author cloud environment. In a Spotfire Business Author on premise environment, scripts can be executed if they are saved as trusted by a member in the Script Author group.   

New

Opens the New Script dialog where you can define a new script.

Import

Opens a dialog where you can select an analysis file from which to import all available scripts.

Note: Spotfire compares the scripts you are trying to import with already existing scripts. A script whose script body is identical to an existing script will not be imported even if it has a different name.

Edit

Opens the Edit Script dialog where you can edit the selected script or its parameters.

Trust All

If you are sure all scripts are safe, click the Trust All button to trust them simultaneously.

Delete

Deletes the selected script.

Necessary input for the selected script

Lists all parameters that have been defined for the selected script. Click on a parameter to modify the input. Different parameter types have different input settings.

   Value

Click this radio button if you want to type a value to use as input for the selected parameter.

   Property

Click this radio button to associate the selected parameter with a property.

   Select Property

Opens the Select Property dialog where you can specify which property to get the input to the script from.

   Expression

Click this radio button to calculate the value for the selected parameter via an expression.

   Select visualization

Select the visualization in the current analysis that you want to associate with the selected script parameter.

   Select page

Select the page in the current analysis that you want to associate with the selected script parameter.

   Select data table

Select the data table in the current analysis that you want to associate with the selected script parameter.

Data Function

Select this option to insert an action that refreshes a previously executed data function when clicked.

vis_action_settings_data_function_d.png

Option

Description

Description

A text that can be shown in the tooltip when hovering with the mouse pointer over the item connected to the action.

By typing a good description you can help other users of the analysis understand what will happen when clicking on the item.

Available data functions

Lists all data functions that have been executed within the current analysis and that do not use the Refresh function automatically feature.

See also:

Sparkline Settings - Actions

Calculated Value Settings - Actions

Icon Settings - Actions