Adding a New External Action to an Analysis


Note: To add or use external actions, you need TIBCO Cloud™ Integration license (TCI). For more information, see Enabling External Actions with TIBCO Cloud™ Integration.

Actions that include sending data to external systems make use of integration and connection services in TCI. Services can be created for specific action needs. From Spotfire, the services are then accessed using TIBCO Cloud Mesh, a global repository of these kinds of services.

A service contains various parameters to configure. When adding an action that calls a service, these defined parameters will be provided automatically in a configuration flyout in Spotfire, where you map them to your data. For example, you can define what kind of data in the visualization to send to the external system.

A configured action is then activated using some type of trigger in the visualization, like a floating button, as shown below, or a right-click menu item.

When adding a new action, you add it to a visualization of your choice, and you can specify one or more triggers in that visualization. When you have added an action, it becomes available for selection in all visualizations in the analysis. That is, an action can be added to more than one visualization in an analysis, using the same type of trigger or a different one. You can also add more than one action to a single visualization.

To add a new external action:

  1. On the authoring bar, click Actions to open the flyout.

  2. Click More actions and select Add action from external service.

  3. In the TIBCO Cloud Login dialog, log in to TIBCO Cloud, and follow the steps.

  4. In the Select a service from TIBCO Cloud Mesh dialog, locate and select the service to use for the action.

  5. Response: The Configure action flyout is opened, listing the parameters that are defined for the service.

  6. Optionally, click the pen to rename the action, and type a description.

  7. Comment: A description of the action is recommended to inform people who run it about the purpose of the action.

  8. Click to select an icon that will represent the action.

  9. Expand the parameters, and configure the action, that is, map inputs to the contents of your analysis. For more details on the available options for the parameters, see Options for Action Parameters.

  10. Comment: It is the configurator of the action who determines what data the action will send. The configurator might select a data table, or one or more columns, to send data from, add a document property (perhaps a property that people can change using controls in a text area), or even type a value directly. By specifying the type Prompt for input when running action, the person who runs the action will be asked to provide the input. Optionally, a description can be added to a parameter using prompt as input type. A question mark icon will then be shown next to that parameter in the prompt, and the description will be available in the tooltip.

  11. Click Next.

  12. Response: The Review action configuration flyout is opened. The flyout shows the configuration and affected data that potentially will be sent externally.

  13. Make sure the configuration is correct, and click Done.

  14. Response: You are now the signer of the action. The action is added to the Actions flyout, and will also be available for selection when adding action triggers in visualizations. See Adding an Action Trigger to a Visualization to learn more.

See also:

What are Actions?

Running an External Action

Manage Trust