Image Alt

User Guide: Connectors

In the skill builder page, KLoBot has the ability to connect to a 3rd party REST API and integrate this connection to a skill. By providing the correct credentials and API endpoint, the user can create a skill that connects KLoBot to a SharePoint Site, NetDocuments API or HTTPS Connector.

This connector allows the skill to establish a connection with a 3rd Party REST API. In order to use this connector, the user must know the endpoint, the credentials and the necessary information for the REST API.

This Connector supports two request methods, GET and POST. For Security type, supports None, Basic Auth and OAuth 2.0. If the REST API, has no Security Type, leave as None.

In the following, connecting to Service Now API with Basic Auth for the IT Support Skill.

If the REST API requires additional Headers or Data, add them using the respective add button.

After the required information is entered. Test to see if the connection is successful.

This connector allows the skill to connect to NetDocuments. In order to use this connector, the user must have a NetDocuments account .

There are many processes in the NetDocuments Connect. To see how they are used, Go to NetDocuments Skill in the How To section.

In the following, connecting to NetDocuments API for the Workspace process.

You are required to have the correct KLoBot Microservice Endpoint, the Client ID, and Client Secret.

In the following, adding the data for workspace process for NetDocuments Skill.

After the required information is entered. Test to see if the connection is successful.

This connector allows the skill to connect to a SharePoint site. In order to user this connector, the user MUST have a valid SharePoint site and Must have Valid SharePoint site.

The SharePoint Connector supports two Methods, Search and Get Method.

In the following, connection to search in a SharePoint Site.

To add a SharePoint site, click Add Site(s). It will open a new window where you can add your SharePoint Site URL.

To connect to a SharePoint site, enter a valid SharePoint Site URL and click Get List(s). Get List button retrieves all the lists from your SharePoint site.

Click the dropdown button to open your SharePoint Lists.

From the dropdown menu, select a SharePoint list and click the “+” button.

You will be redirected to a menu where you can select the search fields of your SharePoint Skill. This menu is broken down to 4 components.

Column Name

Refers to the name of the Column in your SharePoint site. Please refer to the image below to see a sample of a Column name in SharePoint.

Question and Answer are examples of Column Names in a sample SharePoint Site.

Search Fields

This serves as the search criteria for SharePoint. To select a search field, select a column name from the list and check the box next to it to use the column name as a search field.

In this example, we will be using Person as a search field. We will be searching under Person column.

Operators

The operators are responsible for creating the condition of the search field. The operators are defaulted to == as a standard.

In this example, we will be using Person as a search field. We will be searching under Person column.

Entities

Entities are responsible for extracting the data from an utterance. This is the same entity created in the skill building process.

In this example, we set the entity to general.name:matter.

Return Fields

These properties are responsible for creating the Bot Response to the user. This is what is being returned or shown to the user in the chat.

To set a return field from the column list, select a column name and check the return field boxes.

In this example, we set Person, Extension, Email and Office as return fields.

In the chat, the user will get information regarding the return fields that we just checked.

After entering all the relevant information required, click Save.

NOTE: SharePoint Connector supports connecting to different Lists, Libraries and Sites.

SharePoint connection to a different list

To connect to another SharePoint list, select a list from the dropdown menu then click add.

Repeat the same process as we did from adding the search fields and click save.

In this example, we connected two SharePoint Lists Whom to contact and Directory.

SharePoint connection to multiple sites

To connect to another SharePoint Site, go back to the skill page and click Add Site(s).

Enter another valid SharePoint URL and click Get List(s).

Select another SharePoint List and click +.

Repeat the same process as we did from adding the search fields and click save.

In this example, we were able to connect to 3 SharePoint sites.

To edit a SharePoint Site, click the button as shown below and it will open the SharePoint window to update changes.

To delete a SharePoint Site, click the button as shown below and it will delete the entry.

Default Filter

In some cases, SharePoint Lists have documents that vary based on audience or personnel. Some documents are filtered based on employee role such as Staff or Lawyer. KLoBot has configured a default filter where users can set this filter to show documents based on that filter.

In this policies list example, documents vary based on Audience.

In the skill builder, the user can select Filter as a prompt.

  1. Add a prompt in the skill
  2. Select Filter as data type
  3. Bind the Card Variables based on the SharePoint column. In this example we used Audience
  4. Enter the default value. In this case, we set it to Staff so all the documents searched will only display for Staff
Remove Duplicates

In some cases, SharePoint libraries and lists contain duplicate results that can be confusing for the user. In this case, KLoBot can eliminate these duplicate results based on the Return Fields. To remove the Duplicate results:

Navigate to the Process section and add your SharePoint site. Apply all the search fields and the return fields desired

You will see a checkbox with the label Remove duplicates. Once checked, a list of return fields would show.

User can check a number of SharePoint columns with duplicate results. This would prevent KLoBot to show duplicate results based on the return fields selected. In this example, this filter would not show duplicate results with identical Area

In the SharePoint list, we have 2 identical values for Area called Client Development.

In this case, KLoBot would only return one document from owner Miriam Graham.

The SQL Connector allows the user to connect KLoBot to the SQL Server.

Requirements

In the Local Area Network (LAN), ensure that the SQL Server has public access. Once confirmed that the LAN has public access, use the username and password of SQL database to get access anywhere.

To connect to the SQL Connector, under Type of the process select Microsoft SQL Server.

Next step is set the Connection Method to Procedure

In this step, ensure that you have a valid connection string from SQL Server. The connection string looks something like this
Server=tcp:test.database.windows.net,1433;Initial Catalog=Test2019;Persist Security Info=False;User ID=testuser;Password=testpassword

Enter the connection string and click Test to test connection.

Once connection is successful, you will get a list of Stored Procedures or built-in functions from your SQL server.

Open the Stored Procedure dropdown menu and select a stored procedure.

This will automatically generate Parameters that will need user input or data.

In this example, we selected Get Matters by Attorney stored procedure and is asking for a name of the attorney.

To select an entity to bind the data, click the button it will open a window with a list of entities to bind as show below.

To save the parameter, click the save icon.

To edit the parameter, click the edit icon.

Click the test button and you should receive a success message when connection is a success.

NOTE: Stored Procedures can have multiple parameters or arguments and they cannot be deleted and are required.