Form action

Feature coming soon

Use the Form action in digital bot flows to send forms configured previously by an administrator in canned responses. This action enables your digital bot to send custom forms to your customers and capture their responses.

Administrators can create and manage forms using the canned responses feature in Genesys Cloud. For more information about creating forms, see Add a form.

Note: The Form action is currently available for Apple Messages for Business only. The action takes the failure path if you use it in any other unsupported channels.

Field Description
Name

The label you enter here becomes the name of the action in the task editor.

Library

Select the appropriate canned responses library that contains the form that you intend to use in the action. For more information about canned responses libraries, see Create and manage libraries.

Form

Select the form that the bot must send to the bot participant.

Note: If you change the library after you select the form, your form selection resets.

Form Completion Timeout

Set the maximum length of time that the bot must wait after the sending the form for the participant to complete it. If the participant does not complete the form within this duration, then the flow triggers a No Input event.

Form Pages

After you select the form, Architect automatically populates all the form elements and lists them under Form Pages. Define a variable for each form page to capture the corresponding response value and then use the variable in the flow for further actions.

The label of each form page appears in one of the following formats depending on the form page type:

  • List Picker: “Form title (form type – select type).” For example, “Select an order (List Picker – Single).”
  • Input: “Form title (form type).” For example, “Enter your name (Input).”
  • Date Picker: “Form title (form type).” For example, “Enter the order date (Date Picker).”
No Match

Enter the communication that the bot produces when the user’s input is not a valid match.

Note: The bot returns the content from Settings > User Input > No Match Detected > No Match Apology, combined with the No Match communication.

Customize No Match

Enables the No Match Reprompts field. Use this option to create a list of no match prompts that incrementally occur when the bot receives No Match input events.

No Match Reprompts

When the bot receives a No Match input, the bot returns the communication in the No Match Reprompts collection that corresponds to the current number of No Match inputs received for that action. For example, the first No Match input triggers the bot to use the first No Match reprompt in the defined collection.

The length of the No Match Reprompt collection overrides the maximum number of No Match retries that you define at Settings > User Input > No Match Detected > Maximum Number of No Match Retries for that particular action. For example, if you define two reprompts in the collection, the bot retries twice. An empty collection turns off No Match retries.

Note: The bot returns the Settings > User Input > No Match Detected > No Match Apology combined with the corresponding No Match Reprompt communication.

Default No Match

Enables the default No Match field. Use this option to define a single No Match prompt that the bot produces when it receives No Match input events.

Paths
  • Max No Inputs: Enable or disable the Max No Inputs path. When you enable this option, if the bot exceeds the maximum number of no input retries that you set for this action, then the flow follows this output path.
  • Max No Matches: Enable or disable the Max No Matches path. When you enable this option, if the bot exceeds the maximum number of no match retries that you set for this action, then the flow follows this output path.

Note: If you disable this path, then the flows that you configure for the output path are hidden, not deleted.

Define success and failure paths

Path Description
Success

This path indicates that the system successfully sent the form to the participant and the participant has filled in valid values for all the form pages.

To follow the route you want the interaction to take, drag the appropriate action below the Success path.

Failure

This path indicates that the system was unable to send the form to the participant.

To direct the route you want the interaction to take, drag the appropriate action below the Failure path.

Best practices when configuring the Form action

The following best practices help you in ensuring that the messaging channel supports the Form action:

  • Before you add the Form action, it is recommended that you identify whether the user’s device can handle forms so that you can send a different action instead of a form. The device capabilities are included within the participant data of a conversation. To confirm the device capability, you can use the expression, (FindString(Flow.deviceCapabilities,"FORM") > 0), for example, in a Decision or Switch action before the Form action. If the flow executes the action with a device that does not support FORM, then the action takes the failure path.
  • You can also use the Architect built-in variable, Session.Source, to identify the messaging channel type. For more information about this variable, see Architect built-in variables.