Secure custom input properties sheet

  • Release version: Xanadu
  • Updated October 30, 2024
  • 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

    This guide assists ServiceNow customers in implementing secure inputs like passwords within custom input controls in Virtual Agent. Adhering to scoped application requirements in Workflow Studio is essential for using secure inputs.

    Show full answer Show less

    Key Features

    • Custom Control Definition: Select how the control is rendered for the specific channel.
    • Generate Control Data Function: Script function for providing data required to render the control.
    • Transcript Function: Script function for messages recorded in the transcript about rendered controls.
    • Non-supported Channel Response: Default message displayed when the control runs on an unsupported channel.
    • Invoke Workflow Studio Asset: Action or subflow for secure inputs to be passed into Workflow Studio.
    • Input and Output Mapping: Define variables for input and output based on the selected action or subflow; secure fields are automatically marked as mandatory.
    • Advanced Permissions: Choose permissions for the action, either as the initiating user or as a system user.
    • Conditional Visibility: Options to conditionally show or allow users to skip nodes based on custom conditions.

    Key Outcomes

    By utilizing this secure custom input properties sheet, ServiceNow customers can effectively handle sensitive information like passwords in Virtual Agent interactions while ensuring compliance with security requirements. The structured approach to input and output mapping enables seamless integration with Workflow Studio, enhancing the functionality of custom control implementations.

    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.