Working with Bots

Understand how to set up bots and integrate them with your application.

Creating Bots

You can set up bots for your Embed application. Once set up, they start listening for bot events or any commands sent by the user and perform relevant actions.

Note: This feature is not available to any tenants by default. Contact our support team at support-wmio@softwareag.com to enable Bots feature for your tenant.

The Bots tab lets you view and manage the bots of your Embed Admin account. To start working with Bots, navigate to Settings > Bots.

Perform the following steps to create a new bot.

  1. Click on the Add Bot button.

    The Add New Bot window appears on screen.

  2. Provide relevant details about the bot you want to add.

    Bot Name: Provide a suitable name for the bot.

    Bot Description: Provide a short description about the bot.

    Bot Type: the type of bot you want to add.

    As soon as you select a bot type, other fields related to the selected bot are rendered in the window.

    Enter details for the additional fields that appear.

  3. Click Add to create a new bot.

This will add the bot to your webMethods.io Embed Admin account.

Updating or Deleting Bots

You can update or delete an existing bot.

To do so, navigate to Settings > Bots.

Here, you can see the list of all bots associated with your webMethods.io Embed Admin account, along with the following details:

To update or delete a bot, perform the following steps:

  1. On the Bots screen, locate the bot you want to update.

  2. Click on the associated Edit icon to update the bot details or click Delete icon to delete the bot. You can optionally publish the broadcast messages set while creating the bot to all the 1:1 bot spaces by clicking the broadcast icon.

Note:

  • You cannot edit the values for Bot Email ID, Bot Person ID, and Bot Type.

  • The Bot Token Field will not be visible in the Edit Bot window.

Adding Solutions to Bots

Once you have created a bot, you can add existing solutions of your webMethods.io Embed Admin account to a bot.

  1. Navigate to Settings > Bots You will see the list of all available bots of your account.
  2. Click the name of the bot to which you want to add a solution. You will be redirected to the Manage Solutions and Commands window.

  3. Click on Add New button on the top-right corner of the window. A new Add Solutions to Bot window will appear on screen where you can see the list of existing solutions of your Embed Admin account along with their versions.

  4. Select the checkbox given beside the solution name and click on Add.

This will add the selected solution(s) to the bot.

Managing Bot Solutions

Once you have added solutions to a bot, you can view and manage them through the Manage Solutions and Commands screen.

To do so, perform the following steps:

  1. Navigate to Settings > Bots> Bot_Name

    Here, you can view all the solutions associated with the selected bot, along with the following details:

    • Name: Name of the solution
    • Ordering: Specify the order sequence for solution
    • Added on: Date on which solution was added to bot
    • Version: Version of the solution
    • Type: Type of solution (Webhook/Default)
    • Published: Whether the solution is published on Sandbox environment or not. You can publish or unpublish the solution for the selected bot using the toggle button.
    • Production Solution: Whether the solution is published on production environment or not. If the solution is published on production environment, you will see a ‘View’ link. Click on this link to automatically navigate to this solution version on production environment. Similarly, if you are working in the Production environment, you will see a view link which will automatically navigate you to this solution version in the Sandbox environment.
    • Action: Contains action controls to manage bots.
      • Delete: Delete the solution from the selected bot. You can also add more solutions to the bot using the ‘ADD NEW’ button.

Adding Commands to Bots

Once you have created a bot, you can add existing commands of your webMethods.io Embed Admin account to it.

  1. Navigate to Settings > BOT You will see the list of all available bots of your account.
  2. Click the name of bot to which you want to add a command solution. You will be redirected to the Manage Solutions and Commands window.
  3. Click the Commands tab.

  4. Add a command to the selected bot, click on Add New button on the top-right corner of the window. A new Add Commands to Bot window will appear on screen where you can see the list of existing commands of your webMethods.io Embed Admin account along with their versions.

  5. Select the checkbox given beside the command name and click on Add. This will add the selected commands(s) to the bot.

Bot Plan and Bot User

To manage bot commands, a default bot plan and a default bot user is created for your tenant by the webMethods.io Embed support team. The details of this default plan or user cannot be edited through the UI.

Click on the default bot user email, to see all the commands associated with it.

Click the Accounts tab to see associated accounts, the Authorizations tab to see associated authorizations, and Execution Statistics tab to see the associated execution statistics. Please refer the Users section to understand these three tabs in detail.

Managing Bot Commands

Once you have created a bot, you can add existing commands of your webMethods.io Embed Admin account to it.

  1. Navigate to Settings > BOT You will see the list of all available bots of your account.
  2. Click the name of bot to which you want to add a command solution. You will be redirected to the Manage Solutions and Commandswindow.
  3. Click the Commands tab.

  4. Add a command to the selected bot, click on Add New button on the top-right corner of the window. A new Add Commands to Bot window will appear on screen where you can see the list of existing commands of your webMethods.io Embed Admin account along with their versions.

  5. Select the checkbox given beside the command name and click on Add. This will add the selected commands(s) to the bot.