Secure custom input properties sheet

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Secure Custom Input Properties Sheet

    The Secure Custom Input Properties Sheet allows you to define secure inputs, such as passwords, for use in Virtual Agent custom controls. It is essential to follow the scoped application requirements in Workflow Studio to implement these secure inputs effectively.

    Show full answer Show less

    Key Features

    • Custom Control Definition: Select the control definition that determines how the control is rendered in the relevant channel.
    • Generate Control Data Function: Script function that provides data for rendering the custom control, such as password values.
    • Transcript Function: Script function that logs a message for the transcript confirming the control data.
    • Non-supported Channel Response: Default message displayed when the control is used on unsupported channels.
    • Invoke Workflow Studio Asset: Specify the Workflow Studio action or subflow for passing secure inputs from the custom control.
    • Input and Output Mapping: Define input variables for the selected action, with secure fields (password2 type) marked as mandatory. Output mapping varies based on the selected action.
    • Permissions: Choose between running as the user who initiates the session or as a system user with higher privileges.
    • Conditional Logic: Set conditions for showing or allowing users to skip the node in the conversation through no-code or low-code scripts.

    Key Outcomes

    By utilizing the Secure Custom Input Properties Sheet, you can create secure inputs for your Virtual Agent, enhance data protection, and ensure proper handling of sensitive information during user interactions. This enables a seamless and secure experience for end-users while complying with security protocols.

    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 Workflow Studio. For details, see Workflow Studio 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 Workflow Studio asset

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

    For more information about Workflow Studio actions and subflows, see Actions and Subflows.
    Spoke

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

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

    The Workflow Studio 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 Workflow Studio.
    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 Workflow Studio 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.