Working with Bot Commands

In Kore Bot Builder, you can add and manage commands to launch an action task directly from a message window in a space room. For example, while exchanging messages in the Kore application about a customer problem, you can launch a task in Asana to comment on a particular Asana task without leaving the message window.

About Bot Commands

In the Kore app, if the Asana Bot is added to a space room, by typing @asana followed by a space, you can see a list of Asana action tasks that can be initiated from the message window as shown in the following illustration.

 alt=

The user can either select or type, for example, comment_on_task in the Bot command shown below.

To execute the Bot command, the user presses ENTER to display the Asana action task, in this case, the Comment On Task as shown in the following image.

"

The Bot command is executed when the user defines the mandatory fields, and then clicks the Submit button. The results of the Asana action task are displayed directly in the message window as shown in the following image.

"

Configuring a Bot Command for a Task

Defining a Bot command is a two-step process:

  • Enable and define the Bot Command section on the Bot - Defines the @ command settings for the Bot, for example, Asana, JIRA, and Twitter. When the user enters the Bot command, for example, @asana, the definition for the Asana Bot is displayed.
  • Add the Bot Command to the Task - Defines one or more action tasks to display to the user when the Bot command is entered, for example, @asana, displays a list of available Bot commands for the Asana Bot. Bot commands can only be configured for published action tasks. 

Defining the Bot Command - Bot Level

When you create or modify a Bot, you can select to enable Bot commands in the Bot Command section. When selected, the parameters to define the Bot command are displayed as shown in the following illustration.

"

  • Command Name - The name used for the Bot using the @Bot command in the user interface.
  • Help - The help text displayed for this Bot command when the /help command is used.
  • Example Command - An example command displayed below the description of the Bot command in the user interface.
  • Description - The description to display for the Bot.

The following illustrations show where the parameters are displayed in the Kore app for users.

"

"

Defining the Bot Command - Task Level

After you enable Bot commands at the Bot level, you are ready to configure which actions tasks are displayed as Bot commands. Bot commands for tasks can only be added after an action task is published.

To add a Bot command, in Bot Builder, in the Actions Tasks section, click the Settings icon for the task to add a Bot command to, and then click Add Command as shown in the following illustration.

"

When Add Command is clicked, the Add Command dialog is displayed with parameters to define the Bot command for the task as shown in the following illustration.

"

Define the following parameters for the task.

  • Sub Command Name - The name used for the task in the user interface.
  • Help - The help text displayed for this Bot command when the /help command is used.
  • Example Command - An example command displayed below the description of the Bot command in the user interface.
  • Description - The description to display for the Bot.

Click Save.

The following illustrations show where the parameters are displayed in the Kore app for users.

"

Next Steps

After you enable the Bot command for the Bot, and define one or more action task Bot commands, the Bot commands are immediately available for any user with the Bot added to a room in their space.

 

Comments