TSI Action

TSIAction general information

A TSI Action is logic that is executed when a user clicks an action button in the action menu of a TSI. Instead of reacting on a save of a BusinessObject (BO) like a Business Rule, the logic is started explicitly by the user.
Typical use cases are actions on demand, such as creating related records, do some calculations or opening an external URL for the selected record.

Behavior of a TSIAction

The following statements are true:

  • The flow is started by the user from the action menu, on the BO that is selected in the TSI.
  • Changes are not saved automatically. An explicit save function must be added on every BO that is changed, including the selected BO.
  • When jumping to another BO, for example a Property, that Property must also be saved explicitly.
  • Notification functions like Show warning, Show error and Show confirmation can be used to give feedback to the user.

TSI-Action functions

Besides all regular functions the following TSI-Action specific functions are available:

  • Redirect to URL: opens a URL after the action has been executed.
  • Refresh Grid: refreshes the grid so changes made by the action become visible to the user.

See the in-app manual for the parameters of each function.

Configuration

The TSI-Action solution type is only available from basic level 1.

  • Create a new configuration in the free module. Provide a Code and a Name / Description and save. See Planon configuration.
  • Open the editor via the link button next to the URL and add &level=3 to the URL.
  • On the Start of flow node set the Solution type to TSI-Action and select the BusinessObject on which the action is executed.
  • Build the logic and add the save functions.
  • Save the configuration.

Registering:

  • Go to the TSI in which the action button must become available.
  • Add a new TSI action to the action menu.
  • Select the Logic Flow Builder TSI action class from the Class Name reference.
  • Provide the configuration code just created.
  • Provide a caption for the action button as per business needs.
  • Save the changes.

Licensing

Each TSI-Action registration with a unique configuration counts as 1 license. The license usage is visible on the License usage tab of the in-app manual.