Create a custom control definition

Define a custom input or response control definition that maps to a custom component.

Before you begin

A custom control definition needs a custom component. For example, a slider input control uses a custom slider component. To begin, create the customizable component that you will use for your control.

Role required: virtual_agent_admin or admin

About this task

For a given custom control, create a separate control definition for each channel in which the control will be used.

Procedure

1. Navigate to All > Conversational Interfaces > Virtual Agent > Custom Control Definitions.
2. Select New.
3. On the form, fill in the fields.

   Table 1. Custom Control form

   Field	Description
   Name	Name of the custom control to be created.
   Type	Type of custom control. Choices are as follows: Input Response
   Domain	Domain in which this control is used.

4. Select Submit.
5. Open the custom control record that you just created.
6. In the Custom Control Definitions related list, select New.
7. On the form, fill in the fields.

   Table 2. Custom Control Definition form

   Field	Descrlption
   Channel	Channels in which your control can be used. The channel is a chat client, such as a chat widget or messaging app, that is supported in Virtual Agent. If your control can be used in more than one channel, create a Custom Control Definition for each channel. If channels are defined, then the custom control can only run in the specified channels.
   Application	Scope that this control belongs to.
   UX Component Definition	List of custom components that are created for use as custom controls in Virtual Agent. Choose an optional component for your custom control.
   Domain	Domain where this control is used.

8. Select Submit.

Result

The custom control definition is available for use. You can specify it when you create the appropriate control in Virtual Agent Designer.

What to do next

Create the custom control in Virtual Agent Designer.