Configure a Set Field block

Set Field block

The Set Field is a building block that contains the configurable data from the caller (a field and a value) that can be transferred to other miniApps or building blocks and channel the conversation. The value of the Set Field building block can substitute the value of a previously used miniApp or building block. For example, the user can configure the Set Field building block by creating a field or choosing the available one from the list, and providing a value that contains the information from the caller. This allows to use the data from the Set Field building block instead of configuring and using complex miniApps or Flows.

To add and configure a Set Field building block, follow the steps:

1. Choose the Set Field building block from the Dialog Control panel, drag and drop it onto canvas and connect with another building block, for example, the ExtraInfoAnnouncement miniApp.

2. Click the Settings icon in the right upper corner of the Set Field building block to configure it.

3. Click + Add Input Field button first.

4. Type a field name to create a new one, or select one from the dropdown menu of the available ones; these are the fields previously used in the conversation.

5. Enter a value that can be received from the caller, and click Save when finished.

If the Value field is empty (undefined), the previous miniApp or any other building block will be played again. For example, if Intent is selected as a field, and cardNumber is selected as a value in the Set Field building block, cardNumber will be used instead of the value from the ExtraInfoAnnouncement miniApp.

It is possible to add a counter-type field for the Set Field block (covers the function of the Intelli miniApp). For example, the counter value can be passed as an input to other building blocks, so it can track how many times an error has occurred during the course of a dialog and take special actions once a specific threshold has been exceeded.

To add a counter, select the plus equals sign from the dropdown so it increments a value of the Value field. In this case, the Value field can contain any positive or negative number.

Entity Suggestion

The Set Field building block provides a possibility to suggest an entity with the obtained information at a later step of the dialog. It allows the system to use the value that has already been obtained in a dialog and to preconfigure it in as output of the upcoming miniApp. For example, the following scenario illustrates the usage of entity suggestion:

Currently entity suggestion can be used as a miniApps output in the following miniApp types: Alpha, Alphanumeric, Numeric, Date, Amount or Text.

To configure the entity suggestion, follow the steps below:

1. Configure miniApps (for example, the WebService and Amount types) to enable entity suggestion, and place them onto the canvas in order to create a conversation.

2. Select the Set Field block to drag and drop it onto the canvas. Connect with the miniApps to run a dialog.

3. Configure miniApps as follows:

a. WebService miniApp: create the value for Orchestrator Field 1 of the Output Fields. For example, MonthlyAmount.

b. Amount miniApp: create the value for Orchestrator Field 1 of the Output Fields. For example, PaymentAmount.

4. Click the Options menu of the Set Field and select the ?= operator.

5. Select the PaymentAmount field (as in the Amount miniApp) and attach it with the MonthlyAmount value (as in the WebService miniApp) so that the system suggests value of the MonthlyAmount as entity for the PaymentAmount.

6. The final part of the conversation that contains entity suggestion in a dialog looks as follows:

JS API Isolation mode

To improve the security of the JS API, you can run user scripts in safer, isolated environments. You can select if the JS API will run as usual or select the Isolated Mode.

• Legacy Mode: Retaining standard behavior, wherein scripts are executed within a single node environment.

• Isolated Mode: Implementing script execution within isolated environments.

To enable Isolated Mode, you can use a Set Field as shown below:

1. Add a Set Field in your Application with the Field js-isolated-mode = true.

   

2. On the following miniApp connected to the Set Field add js-isolated-mode as Input Field 1 and click Save. The output is what you would like to get from this miniApp as usual.

   

   The connected miniApp in the flow will execute JS in Isolated Mode. To test the outcome of Isolated Mode, please follow the steps described in JavaScript Functions in miniApps page.