After you describe the Bot alert task on the General tab, and if required, define authentication requirements on the API Request tab, you are ready to start configuring the API request that asks for data from your Bot website, system, or web application for the task. This topic describes how to configure the request object for an alert task with the Connection Mode set to SOAP.
To define a task web service request object with Connection Mode set to REST, see API Request Tab – Alert Task Request – REST.
Configuring the API Request (SOAP)
For a task with the Connection Type specified as Webservice and the Connection Mode set to SOAP, you need to set up the following:
- Authentication – If required for your alert task, you need to define the authentication to access the API, for example, using basic authorization, OAuth, or API Key. For more information, see API Request Tab – Authentication Settings for an Alert Task.
- WSDL URL – Define the URL that contains your WSDL data. When the URL is retrieved, you can choose from a list of Available Operations based on the WSDL, and then customize the user input fields. For more information, see Defining the WSDL URL.
- Access Using a connector – Specify if your Bots Platform is installed on-premises and you want to user the Kore.ai Connector agent. For more information, see Access Using a Connector.
- Response Sample – Define key/value pairs that you expect to receive in the alert task payload. The key/value pairs that you provide are available as drop-down choices for handling the data to display to the end-user. For more information, see Adding a Response Sample for an Alert Task.
Defining the WSDL URL
- On the API Request tab, expand the WSDL URL section
- To begin the request task configuration for a SOAP request, enter the URL for your SOAP WSDL in the WSDL URL field.
- Click Get WSDL Description. A list of available operators defined in the WSDL opens.
- Click Select for the SOAP request that you want to use for your task. Kore.ai will automatically populate one or more Alert Task Fields if necessary for user input.
Customizing SOAP Alert Task Fields
You can customize the default input fields provided by Kore.ai after you select one or more of the Available Operations from your WSDL. To customize the default Alert Task Fields, click Edit for the Alert Task Field that you want to customize. The Set up Alert Task Field dialog is displayed as shown in the following illustration.
To define end-user fields for a task, specify the values for the parameters in the Set up Alert Task Field dialog as described in the following table.
|Field Title||The title of the task input field displayed in the end-user interface, for example, Country.|
|Help Hint||The help text displayed below the task setting title to describe the task, for example, Enter the Country Name you want the Weather for..|
|Field Key||A read-only key that represents the end-user input value that you want to collect, for example, country.|
Specifies the type of task input field displayed in the end-user interface to collect user input for the request object to assign to the Key value. The default setting is Textbox, but can be customized to any one of the following:
Select one of these user input types:
|Placeholder||The text displayed below the input textbox to help the user define the field. This field is only displayed for some Field Types.|
|Visibility||Specify if the task input field should be visible or hidden from the end-user.
The Visibility field can also be set to Custom field where data is captured from the user but not used as a query parameter or payload field. For example, with a JIRA bot, posting a comment on a ticket using an @mention tag as shown below:
"@Mike, please look into this issue"
The JIRA API to Post a comment requires one query field and one payload field as:
With the Visibility field set to Custom, you can capture the user information for the user mentioned as
The default Visibility field setting is Visible.
|Mandatory||Select if the end-user must define this setting to save the task settings configuration.|
|Untranspose the Key||
Select to disable key transposition by Kore.ai. By default, Kore.ai transposes a key/value pair, for example,
Access Using a Connector
To get started with defining access using a connector for a task, follow these steps:
- On the API Request tab, expand the Access using a connector section.
- In the Access Using A Connector field, select Yes to enable access for Kore.ai Bots using the Kore.ai Connector agent. This option is only visible if a Kore.ai Connector agent is configured and enabled in your enterprise on-premises network. For more information, see Using the Kore.ai Connector.
Adding Response Sample for an Alert Task
In the Response Sample section, you can enter or paste examples of the key-value pairs that you expect to receive in the task payload. When you define the response sample, the keys specified in the Response Sample section are available as drop-down choices for handling the output data.
Adding the Sample Response
- On the API Request tab, Expand the Sample Response section.
- Enter your Response Sample that contains the key-value pairs from your JSON response payload. Do one of the following:
After you finish defining your API request, click Continue to display the Configure the Alert Task Response dialog. For more information, see Defining the Bot Response for an Alert Task.