Adding action buttons that run a script

You can add a button to run an IBM® Cognos® TM1® TurboIntegrator script that was created by the Import wizard or by the Cognos TM1 administrator.

You can view this video to learn how to use context sensitive action buttons.

Video that demonstrates how to use context sensitive action buttons.

Before you begin

Before you can add an action button that runs a script, the Cognos TM1 administrator must enable cube import using IBM Cognos TM1 Performance Modeler. For more information, see the TM1 Performance Modeler documentation on IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter/).

About this task

Use a script that was created by the Import wizard to reimport data with the click of a button. If you use a script that the administrator added to the Cognos TM1 server, you must be authorized to connect to the server.

Action buttons that run a TurboIntegrator (TI) process can be synchronized so that one or more parameters for the TI process can be obtained from the workspace.

Note:
  • Parameter names are passed as string values, even if the value of a parameter is not a string.
  • A context-sensitive parameter acts like any object in the synchronization model except, when more than one item is selected, multiple values are not included as parameters.
  • You must supply the invariant name of the parameter only. Even if a caption is displayed in the workspace, the invariant name must be used to specify the dimension. The invariant name of the selected element is passed to the TI process as a parameter.

Procedure

  1. Click Insert, and then click Action Button.

    If you know where you want to place the action button on the canvas, right-click the location and click Insert Widget, and then click Action Button.

  2. Select a script to run.
  3. Set the parameters by completing each field.
  4. Optional: To set the action button to use a context-sensitive value as a parameter, use the following syntax: @Dimension.([<dimension_name>]) in the default field of parameters that you want to use the context of another synchronized widget for.
    Context-sensitive action button parameter syntax.
    For example, to pass the element of the NewCube.Measures dimension that is in context, enter @Dimension.(NewCube.Measures) as the parameter. When the TI process runs, the parameter is dynamically replaced by the name of the currently selected member of the NewCube.Measures dimension. To use another value, select a different member of the Dimension and click the button again.
  5. To change the label or image for the action button, click the Style tab.
  6. Click OK.
  7. To edit the action button, click the Widget actions icon Widget actions icon and click Edit Properties.
  8. To set the synchronization scope for your action button, see Synchronizing widgets.