Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Custom input properties sheet

Use this sheet to define a custom input control in Virtual Agent.

Custom input properties sheet

Custom input propertyDescription
Custom Control DefinitionList of custom control definitions for the controls.Select the definition that defines how the control is rendered for the channel in which it runs. If you need to add a custom control definition, click the Custom control definitions link.
Generate Control Data FunctionScript function that provides the data used to render the custom control. For example, if you're creating a slider input control, you would define the values for the slider. These values include the slider minimum and maximum values, slide default values, icon used in the slider, and so on.
Transcript FunctionScript 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.
Response Handler FunctionScript function that defines how the input response is handled on the conversation server.
Response Transcript FunctionScript function that provides the message for the input control response that is recorded in the conversation transcript.
Non-supported channel response messageDefault fallback message that is displayed when a user is running the control on an unsupported channel.
Advanced \(optional\)
Hide or skip this node
Conditionally show this node ifNo-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 ifNo-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.