Skip to content

Create an Update Balance Task

This is document details steps in creating a sample banking bot. This bot is used in various use case scenarios presented in the How-Tos section of the developer documentation.

Prerequisites

  • You must have signed up with the XO Platform.
  • You must be aware of the basics of Bot building (refer to this link).
  • You must have created a simple bot (click here for an example).
  • You must have created a Banking Bot with Get Balance task (click here for example).

Bot Overview

The Bot we will be building will be performing the basic banking transactions. This Bot will do the following:

  • Get account balance based on the Account Number and Account Type entered by the user, as seen here.
  • Update accounts with the balance, on this page.
  • Transfer a specified amount from the payer account to a payee account, as given here.

Update Balance Intent

  • The Update Balance task will prompt the user to enter the account number and the account type (Savings/Current).
  • It would then prompt for the type of update – credit or debit and the amount to be updated.
  • A service call will be made to fetch the details, calculate the balance, and then another service call to update the balance.
  • The success/failure message will be displayed.
    • update balance intent

Step 1: Dialog Task

  1. Open the Banking Bot with the Get Balance task already configured, click here for more.
  2. Ensure that the Build tab is selected from the top menu.
  3. Navigate to the Conversational Skills -> Dialog Task page from the left menu.
  4. Click Create Dialog from the top right.
  5. Create Dialog screen will open.
  6. Enter the following details:
    • Intent Name – Enter the Intent name, this is the phrase that triggers the dialog. The intent name should be simple and not more than 3-4 words. For example, ‘Update Balance‘.
    • You can add a description and under More Options other dialog-related details. Let’s retain the default settings without any changes.
    • You can also include utterances to train this intent.
    • Select Try Conversation Driven Dialog Builder option.
  7. Click Proceed.
  8. Property Panel for User Intent will be displayed. We will retain the default properties.
  9. Close the User Intent Property Panel.

Step 2: Entity nodes

Entity Node is typically used to gather information from the user. Here we will be using it to capture the user input for Account Number and Account Type, Type of transaction, and Amount.

  1. Click the + below the User Intent node.
  2. Select the Entity option.
    • Select the Account Number entity already created while configuring the Get Balance task.
    • Close the AccountNumber Entity Property Panel.
  3. Click the + below the Account Number node.
  4. Select the Entity option.
    • Select the Account Type entity already created while configuring the Get Balance task.
    • Close the AccountType Entity Property Panel.
  5. Click the + below the Account Type node.
  6. Select the Entity option and follow the steps below:
    • Click the + New entity.
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity to open.
      • Enter the following details:
        • Name: TransactionType.
        • Display Name: Transaction Type .
        • Type: Select ‘List of Items (enumerated)‘ from the drop-down. We need to provide the list of values that the user can select.
      • Click the Settings icon that appears next to the field.
      • Opt for Static List.
      • Enter the following options under separate rows as the Display name – Credit and Debit. Value and Synonym columns will auto-populate, leave them as is.
        • entity display name
      • Click Save.
  7. Navigate back to Entity Property Panel and enter the following values:
    • User Prompts: Enter the following text and hit enter to save:
      Select the transaction type.
    • Display List Of Values: Mark as ‘Yes, use channel specific standard formatting for default messages and show the available list of values to end user‘. This will present the list of values in a button template for the supported channels.
      • display list of values
  8. Close the TransactionType Entity Property Panel.
  9. Click the + below the Transaction Type node.
  10. Select the Entity option and follow the steps below:
    • Click + New entity .
    • Property Panel for the Entity Node is displayed, if not click on the newly created entity node to open.
    • Enter the following details:
      • Name: Amount.
      • Display Name: Amount.
      • Type: Number.
      • User Prompts: Enter the following text and hit enter to save: Enter the amount to {{context.entities.TransactionType}}
    • Close the Amount Entity Property Panel.

Step 3: Bot Action – Service Node (Get Balance)

Service Node allows you to make a backend API call. It is included in the Bot Actions.
Here the service node is used to call an API to get the account balance for the user entered account number.

We will be using a dummy API setup for this tutorial. We will be using a mock API created specifically for this purpose with the following fields – FirstName, LastName, Address, City, Country, ZipCode, AccountNumber, AccountType, Balance.

  1. Click the + below the Amount Entity node.
  2. Select Bot Action, click to open properties, name it ToGetBalance, and close the properties window.
  3. To add a service node, click the + icon next to the ToGetBalance bot action to expand it.
  4. Click the + within the bot action layout.
  5. Select Service – Service node is used to make a backend API call to get account balance information.
  6. Select the existing GetAccountBalance service node, created in the Get Balance task.

Step 4(a): Bot Action – Script Node

Script Node allows you to incorporate programming logic into the bot and is part of Bot Action.
Here the script node is used to credit/debit the user entered amount to/from the account.

  1. Click the + below the GetAccountBalance node within the Bot Action layout.
  2. Select Script – Script node is used to calculate the balance to be updated.
  3. Click the + New Script.
  4. Property Panel for the Script Node is displayed, if not click on the newly created script node to open.
  5. Enter the following details:
    • Name: BalanceCalculation.
    • Display Name: Balance Calculation.
    • Under the Script Definition section click the Define Script link.
  1. In the Add Script window enter the following script. This script first checks the account type to match the user entry and then extracts the balance for that record.
var balance, i;
<pre class="prettyprint">for (i=0; i < context.GetAccountBalance.response.body.length; i++ )
{ if (context.GetAccountBalance.response.body[i].AccountType == context.entities.AccountType)
   { balance = parseFloat(context.GetAccountBalance.response.body[i].Balance);
   }
}
  1. Click Save.
  2. Close the Script Property Panel.
    3. script property panel

Step 4(b): Bot Action – Service Node (Update Balance)

Here the service node is used to call an API to update the account balance for the user entered account number.
We will be using a dummy API setup for this tutorial.

  1. Click the + icon below the BalanceCalculation script node.
  2. Select Service – Service node is used to make a backend API call to update account balance information.
  3. Click the + New service.
  4. Property Panel for the Service Node is displayed, if not click on the newly added service node to open.
  5. Enter the following details:
    • Name: UpdateBalance.
    • Display Name: Update Balance.
    • Service Type: Custom Service.
    • Type: Webservice.
    • Sub Type: REST.
    • Click DEFINE REQUEST.
      • In the Define Request Page, enter the following details:
        • Request type – PUT.
        • Request URL: https://5c3c633d29429300143fe4d2.mockapi.io/AccountDetails/{{context.entities.AccountNumber}}. This API does not require any Auth Parameters.
      • In the Body tab, select the type as application/json.
      • Select the Test Request tab.
      • Enter an account number and balance in the Sample Context Values section.
      • Click the Test button.
      • Wait for the test to be completed and you get a Status: 200.
      • Click Save as Sample Response.
      • Click Save.
  6. On the Service node Property window, click the Connections tab.
    • Under the Connection Rules section, ensure that the Default connection is set to End of Bot Action.
  7. Close the Service Property Panel.
  8. Click the – icon next to the Bot Action node to collapse the bot action node.

Step 5: Message Node

A Message Node is used to display a message from the Bot to the user.
Here we will be using the Message node to show the success message.

  1. Click the + below the ToUpdateBalance Bot Action.
  2. Select Message and click the + New message . Property Panel for the Message Node is displayed.
  3. Enter the following details:
    • Name: UpdateMessage.
    • Display Name: Update Message.
    • Bot Responses: Enter Your account balance has been updated and hit enter to save.
  4. On the Bot Response Property Panel, open the connections tab by clicking the ‘Connections‘ icon. Then, follow the steps below:
    • Change the Default connection from ‘Not Connected‘ to ‘End of Dialog‘.
    • Click Save.
  5. Close the Property Panel.

Test

To test the Dialog task, you can use the ‘Talk to bot’ at the bottom right corner.
Enter the following utterance (intent name) – “Update Balance.”

Follow the Bot instructions and enter the values for the fields below::

  • Account Number – For example, 29565731.
  • Account Type – Savings or Current.
  • Transaction Type – Credit or Debit.
  • Enter the Amount – For example, 1000.
    • update balance intent

Next Steps

Your Banking Bot is almost complete, you have successfully added Get Balance and Update Balance dialog tasks to the Bot. The next step would be to include the Transfer Funds task. Click here to continue.