Topic Block utility

  • Release version: Xanadu
  • Updated November 5, 2024
  • 3 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 Topic Block utility

    The Topic Block utility in Virtual Agent conversations enables you to invoke specific functions or subflows by embedding reusable topic blocks within a calling topic. This approach streamlines complex conversations by modularizing tasks and allows conditional execution of these blocks based on dynamic criteria.

    Show full answer Show less

    Key Features

    • Dynamic Topic Block option: When enabled, it allows programmatic selection of which topic block to run, based on conditions or scripts, rather than a fixed choice. This supports flexible handling of varied conversation paths.
    • Input and Output Mapping: Inputs and outputs for the selected topic block can be configured to pass necessary variables into and receive results from the block, either automatically for static blocks or manually when dynamic mode is active.
    • Node Naming: The node name is auto-assigned when selecting a static topic block, or manually specified when using dynamic topic blocks, helping you identify the node purpose within the conversation flow.
    • Conditional Node Presentation: Use no-code conditions or low-code scripts to control whether the topic block node appears in the conversation, ensuring relevance and efficiency.

    Practical Application

    By leveraging dynamic Topic Blocks, you can consolidate similar conversation flows into a single reusable block that adapts based on input conditions. For example, you might manage password operations with one dynamic block that decides whether to perform a standard password reset or a two-factor authentication reset, simplifying maintenance and enhancing flexibility.

    The dynamic expression script returns the appropriate topic block name based on input variables, enabling the Virtual Agent to route conversations effectively. This reduces redundancy and tailors responses to specific user inputs, such as selecting troubleshooting topics for different car makes.

    What You Can Expect

    • Modular and reusable conversation components that improve maintainability and scalability.
    • Enhanced ability to handle diverse and conditional conversation paths dynamically.
    • Fine-grained control over inputs, outputs, and node visibility to optimize user experience.

    Use a Topic Block in a Virtual Agent conversation to perform a specific function or subflow that runs certain steps in a calling topic.

    Topic Block utility properties

    For more information, see Add a reusable topic block to a calling topic or topic block.

    Property Description
    Use dynamic Topic Block Set this toggle to activate dynamic Topic Block options.
    Topic block A list of published topic blocks. Select a topic block to add to the calling topic.

    With Use dynamic Topic Block active, use the condition builder to input a condition or script instead.
    Node name Name of the topic block node. The name is automatically assigned based on the topic block that you select. For example, if you choose the Acme Contextual Search topic block, the Name is Acme Contextual Search.

    With Use dynamic Topic Block active, input a name of your choice.
    Input mapping

    The variables to be used as input to the selected topic block. For example, the following image has example variables:

    In this example, input mapping variables include catalog item ID, execute contextual search, confirm catalog item, and show end state card.

    The contents of this area change according to the topic block you selected. Options may include string input, referenced records, scripts, and so forth.

    With Use dynamic Topic Block active, you add all input mappings manually instead by selecting the Manage inputs to define icon Manage inputs to define icon.. Inputs are handled similarly to the Input Parameters dialog box in the Start segment of a reusable topic block.
    Output mapping

    The variables to be output by the selected topic block. For example, the following image has example variables that are enabled:

    In this example, output mapping variables include record ID, record table, and user option variables.

    The contents of this area change according to the topic block you selected.

    With Use dynamic Topic Block active, you add all input mappings manually instead by selecting the Manage outputs to define icon Manage outputs to define icon.. Inputs are handled similarly to the Input Parameters dialog box in the Start segment of a reusable topic block.
    Advanced
    Hide this node
    Conditionally use this node if

    A 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.

    Example Topic Block utilities

    Topic Block utility properties include the reference to an available topic block, input mapping variables to the topic block, and the output variables that the topic block will pass.Topic Block utility properties with the Use dynamic Topic Block toggle switch turned on.

    Using dynamic Topic Blocks

    Toggling the dynamic setting on the Topic Block enables you to programmatically choose which topic block or blocks to invoke, based on any number of conditions. You can pass in a dynamic set of inputs without an explicit, one-to-one match for a Topic Block definition.

    For example, assume you have two Topic Blocks. One sets your password by taking your username and returning a success or fail message. The other resets your password, but requires that you send two-factor authentication (2FA) token with the request before returning a success or fail message and a temporary password.

    You can create two separate Topic Block invocations to handle the password-reset procedure, or you can create one Topic Block with the dynamic setting active and defined as follows:

    • Add a script that checks if the reset type is includesTwoFactor = true. If the statement evaluates to true, then you return TwoFactorReset, otherwise you return NormalPasswordReset.
    • Define two input mappings: password and twoFactorToken, both set equal to an object passed in which contains their values.
    • Define two output mappings: successful and tempPass, the latter of which is only set if it exists in the return value for the Topic Block.
    • Define two output nodes to output success or failure, and an output to confirm to you whether the tempPass value is true.

    Example dynamic Topic Block expression

    (function execute() {
    /* Return the name of the topic block to run. For example:
        switch (vaVars.car_make) {
            case 'Ford':
                return 'Ford troubleshooting';
            case 'Toyota':
                return 'Toyota troubleshooting';
            default:
                return 'General car troubleshooting';
        }
    */
})()

    The script in the dynamic Topic Block expression returns a value based on your input. In this example, if you input Ford or Toyota, the Virtual Agent will call for the appropriate troubleshooting topic. If you input any other value, the Virtual Agent returns a general troubleshooting topic instead.