Use this sheet to specify secure inputs, such as a password, in a custom input control in Virtual Agent.

Important: To implement secure (password2) inputs in your Virtual Agent custom control, you must adhere to the scoped application requirements in Flow Designer. For details, see Flow Designer scoped application requirements for secure inputs.

Secure custom input properties sheet

Secure custom input property Description
Custom Control Definition List of custom control definitions for the controls.

Select the definition that defines how the control is rendered for the channel in which it runs.
Generate Control Data Function Script function that provides the data used to render the custom control.

For example, if you're asking for one or more passwords, you would define the values for each password.
Transcript Function Script function that provides the message recorded in the transcript.

For example, a message for an input control could confirm that the control is rendered with specific data values.
Non-supported channel response message Default fallback message that is displayed when a user is running the control on an unsupported channel.

Invoke Flow Designer object

The Flow Designer action or subflow that secure inputs from the custom control can be passed into.

For more information about Flow Designer actions and subflows, see Actions and Subflows.
Spoke

Name of the scoped application that contains Flow Designer content that is dedicated to a particular application or record type.

For a list of default spokes, see Spokes.
Action / Subflow

The Flow Designer action or subflow to be performed in the instance. The Input mapping and Output mapping areas change depending on your selection.

For details about the action or subflow, click the link beneath your selection to view it in Flow Designer.
Input mapping Specifies the variables to be used as input to the selected action. The check boxes for secure fields (password2 type) are selected automatically, which makes them mandatory. If you select the check box for a String field, it will be mandatory, but not secure. Only fields that use the password2 data type are secure.
For each selected field, provide the corresponding input response variable name that is specified in the action or subflow. For example, a Flow Designer action contains an oldPassword input and a newPassword input. The input response object looks like this: 
{ 
   “old_password”: “1234”,
   “new_password”: “5678”  
}

In this example, enter old_password for the oldPassword property, and then enter new_password for the newPassword property.
Output mapping Specifies the variables to be output by the selected action. The contents of this area change according to the action you selected.
Advanced (optional)
Permissions
Run as
Permissions to use for the action. Select one of the following options:
  • User who initiates session: When selected, the action runs using the same permissions that the current user has.
  • System User: When selected, the action runs using system privileges, some of which may be unavailable to the current user.
Hide or skip this node
Conditionally show this node if

No-code condition statement or low-code script that specifies a condition for presenting this node in the conversation. The condition must evaluate to true.
Allow user to skip this node if

No-code condition statement or low-code script that specifies a condition for letting users skip this node in the conversation. The condition must evaluate to true. You can set this field using either the condition builder or a script. When this field is active, the node presents the user with a Skip option in the Virtual Agent conversation. Alternatively, in an LLM topic, you can reply with an utterance such as I want to skip this question. Virtual Agent chat window with Skip button following a query from the Virtual Agent.