Create a UI interaction

Create a UI interaction and attach it to a component event in UI Builder. UI interactions are reusable flows that combine UI, logic, and scripts into a single unit, including custom UI built with Component Builder, and can be triggered from any component event on a page.

始める前に

Role required: ui_builder_admin

このタスクについて

In this task, you create a UI interaction and define its behavior using the diagram editor. You select an interaction type, add and configure steps, define logic and branching, and specify inputs that the interaction requires at runtime.

重要:

UI interactions don’t run on their own. After creating an interaction, you must attach it to a component or page event so it can run when that event occurs.

手順

1. Navigate to All > Now Experience Framework > UI Builder.
2. From the UI Builder home page, select Create > UI interaction.

   図 : 1. Create UI interaction

   

3. In the creation modal, enter a name for the interaction.

   For example, for a UI interaction to report a knowledge gap, you may enter Report Knowledge Gap. You can change the name in the UI interaction settings later.

   図 : 2. UI interaction creation modal

   

4. Select an interaction Type.

   Generic interactions are used with no dependencies on form or list controller data. Form interactions use form-specific steps such as validating or saving a record. List interactions use list-specific steps such as refreshing or querying a list.

5. オプション: Enter a description that summarizes what the interaction does and when it runs.
   For example, Displays a confirmation modal before deleting a record.
6. Select Create.

   図 : 3. UI interaction editor

   

   The diagram editor opens with a start and end node connected by an add icon . The steps available in the toolbox depend on the interaction type that you selected.
7. Build your interaction by selecting the add icon between the start and end nodes to add steps from the toolbox.
   1. Select + to open the toolbox.

      図 : 4. UI interaction toolbox

      

   2. Browse the available steps by category, or search by name.
   3. Select a step to add it to the canvas.
   4. Configure the step properties in the configuration panel.
   5. Repeat to add additional steps in sequence.
      To run steps in parallel, select the plus icon to add a parallel branch. Branches execute in order from top to bottom. To define conditional paths, add an If/Else step. Conditions can be defined using formula building or a script. Branches are evaluated top to bottom and the first branch that evaluates to true executes.
   6. If your interaction requires data at runtime, define inputs by selecting the Inputs pill and adding the data your interaction needs.
      Supported input types are: String, True/False, Choice, Reference, and JSON.
   7. Select Save.
   8. オプション: You can remove a step from the interaction at any time by selecting the delete icon .

タスクの結果

The UI interaction is created and ready to be attached to a component or page event. Once attached, it runs its configured steps whenever the specified event occurs. See Trigger a UI interaction from a page event.

To trigger this UI interaction from a form or list button using a declarative action, see Trigger a UI interaction from a declarative action.