Date Time user input control

  • Release version: Washingtondc
  • Updated April 3, 2024
  • 6 minutes to read

    • Use the Date Time user input control in a Virtual Agent topic to enable the user to select a calendar date, time (hours and minutes), or both.

    Date Time user input control properties for LLM topic discovery

    The Date Time user input control accepts inputs from a calendar selection, or by entering plain language in the Virtual Agent chat window. If you type your answer, the Virtual Agent accepts different inputs depending on how your region handles dates. For example, if you're in the United States, the input control supports the MM-DD-YYYY format, while a user in Spain enters the date in DD-MM-YYYY format.

    Date Time property Description
    Name Name that identifies this Date Time user input control node in the topic flow.
    Detail description The one piece of information requested from the user. For example, Ask the user when they would like to schedule their departure.
    Input format Type of Date Time control to be displayed. Select one of the following formats:
    • Date: Shows only the monthly calendar for the user to select the date.
    • DateTime: Shows both a monthly calendar and time picker.
    • Time: Shows only the time picker for the user to select the time (hours and minutes).
    Advanced
    Enforce user prompt

    Toggle to open a field for a custom message shown to the user instead of the message generated by the LLM. You can create custom messages in plain language, input a script, or define conditions with the data pill picker.
    Additional instructions for LLM

    Further instructions to the LLM, such as adding data formats, restrictions, or default values for user responses. You can create additional instructions in plain language, input a script, or define conditions with the data pill picker.
    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.

    Example Date Time user input control for LLM topic discovery

    Note:
    Virtual Agent Designer controls may display and function differently in other channels.
    Input properties Date Time prompt

    Basic properties include node name, detail description, and input format. Advanced options include Enforce user prompt and Hide this node.
    Figure 1. Web UI Date Time prompt
    In the Web client, a calendar pop-up lets the user choose a date and time.

    Date Time user input control properties for NLU topic discovery

    Date Time property Description
    Name Name that identifies this Date Time user input control node in the topic flow.
    Variable Name Name of the variable that stores the user response to this prompt. The variable name is automatically created from the Name property.
    Prompt

    Prompt or question for the user. The prompt can be either a text string or a script that returns text. This value is used only when the default value is not specified. For example: What's your name?

    NLU entity

    [NLU topic discovery only]

    Option to associate an NLU entity with the node. If an NLU entity is associated with the input variable for this node, Virtual Agent can slot-fill the specified value based on the user's utterance. Select an entity from the list of entities associated with the topic intent.

    When you specify an entity for the node, the Do not ask users to confirm recognized entity toggle switch displays. When enabled, users are not prompted to confirm the extracted entity.
    Input format Type of Date Time control to be displayed. Select one of the following formats:
    • Date: Shows only the monthly calendar for the user to select the date.
    • DateTime: Shows both a monthly calendar and time picker.
    • Time: Shows only the time picker for the user to select the time (hours and minutes).
    Advanced
    Default value
    Predefine a value for user input

    Predefined value for the user response to the question or prompt. The response defined in the Default value confirmation field asks the user to confirm the default value. If the user responds with no, the value becomes null. The default value can be either a text string or a script that returns text. For example, if you're using dot-walking, the default value might be: Script Variables > Last username. Or if you're using a script, the default value might be: {{vaScripts.lastUsername}}.
    Confirmation messages
    Input completion confirmation

    Bot response shown to the user when the node interaction is complete. The message can be either a text string or a script that returns text. For example, if you're using dot-walking: Thanks, (Input Variables > Username)! Or if you're using a script, the acknowledgement might be: Thanks, {{vaInputs.username}}!

    Default value confirmation

    Message that asks the user to verify that the value in the Default value field is correct. This message is used instead of a value in the Prompt field. It can contain either a text string or a script that returns text. For example, if you're using dot-walking: Are you (Input Variables > Username)? Or if you're using a script, the confirmation message might be: Are you {{vaScripts.lastUsername}}?.
    Conversation switching
    This section is available only when NLU discovery is enabled on the instance.
    Turn on to let users change the subject

    Option to enable NLU prediction for this node. If enabled, users can enter text to answer questions, regardless of the type of input control being used. Virtual Agent uses this utterance to match another existing intent, letting the user switch topics.
    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.
    Skip reprompting if No-code condition statement or low-code script that specifies a condition for letting users skip reprompting in the conversation. When a preceding node is revisited through a topic loopback or Dialog Act, the Virtual Agent bypasses this node and automatically retain its original value.

    Example Date Time user input control for NLU topic discovery

    Note:
    Virtual Agent Designer controls may display and function differently in other channels.
    Input properties Date Time prompt
    Figure 2. Date Time user input control basic properties
    Basic properties include the node name, prompt, input format, and NLU entity.
    Figure 3. Web UI Date Time prompt
    In the Web client, a calendar pop-up lets the user choose a date and time.

    Channel support

    Table 1. Channel support for the Date Time user input control
    Channel Support Constraints
    Web UI Supported None
    Mobile UI Supported None
    Now Assist panel Supported None
    Microsoft Teams Supported None
    Slack Supported None
    Workplace Supported

    The Workplace interface does not natively support a date selection widget. Date and time selection is instead done with the buttons that are supported in these interfaces.

    The Date Time user input control prompts the user for a date, showing the current date and time. The user clicks the month, day, year, or time button to modify that value. The time and day fields prompt the user to type in a new value. The month and year fields show a set of buttons with the current and upcoming months or years. Select one of these buttons or type in a value to set the time or year.
    Facebook Messenger Supported If your administrator has set the option to request the time zone from the customer, the selected date and time reflect the customer's time zone. Otherwise, they appear in the UTC time zone. For more information about the time zone setting, see Set up Conversational Integration with Facebook Messenger.
    SMS Twilio Not supported Not applicable
    LINE Supported None
    WhatsApp Supported None
    Apple Messages for Business Supported None
    Alexa (Voice) Supported For best results, enable NLU at the node.