The connectors section allows the users to test and establish a connection through several mediums supported by KLoBot by providing valid credentials, endpoints, authentication to receive, post or manipulate data.

This connector allows the skill to establish a connection with a 3rd Party REST API. In order to use this connector, the user must have an understanding of all pre-requisites of the REST API such as the endpoint to be used, basic credentials for basic authentication, advanced credentials for OAuth 2.0 authentication and the Request Body such as the header data.

The features of the HTTPS Connector may vary upon the security type of the API.

KLoBot currently supports Basic Auth and OAuth 2.0 authentication requests.

Basic Auth

Requires the basic credentials for authentication to gain access to the REST API. This security type requires the username and the password for the REST API.

  1. Method – Specifies the HTTP request to be made to the API. KLoBot supports the GET & POST methods.
  2. Endpoint URL – Contains the API endpoint with all the parameters included. The user must enter a valid URL in this section.
  3. Endpoint URL – Contains the API endpoint with all the parameters included. The user must enter a valid URL in this section.
  4. Basic Authorization – Contains the username and password to the REST API. This section allows the user to test the REST API and get access through Basic Authentication.

OAuth 2.0

It goes through the Authorization Request via the Redirect URI asking the user to validate and permit access to get the Auth Code. Once permission has been granted and the Auth Code has been retrieved, it then initiates the Access Token request.

Allows the user to connect and gain access to a REST API by following the OAuth 2.0 process. This is a more intuitive and modern approach to authenticating a user to gain access to an API.

Once the Access Token and Refresh Token have been created, the user then gains access and receives a response from the REST API

NOTE: For more information about OAuth 2.0, proceed to this article

  1. Authorization Request URL – Contains the Authorization Request endpoint to get the Authorization Code. This is a requirement.
  2. Client ID – Contains the Client ID of the REST API. This value is given by the REST API.
  3. Client Secret – Contains the Client Secret of the REST API. This is also a value given via the REST API you’ll be using.
  4. Response Type – Can also be called the Grant Type. This section is used to indicate that the server expects an authorization code as a response. This section must always be set to code which translates to response_type=code for the authorization request.
  5. Redirect URI – The URL that developers registered to redirect users after authorization has been completed.
  6. Access Token Request URL – After getting the authorization code, the access token is required to retrieve a response for the API.
    The value for the endpoint would vary depending on the REST API. This is the Access Token Request URL for Microsoft Graph API.
  7. Grant Type – This section contains the grant type Authorization Code to indicate the exchange of the Authorization Code for an Access Token.
    In this example, Microsoft Graph API requires authorization_code as a Grant type.

Header Data – Encompasses the header data needed for the HTTP request. Some common Header Data used are Authorization or Content-Type.

  1. Delete Header Data – Deletes the header data box.
  2. Edit Header Data – Allows the user to edit and modify the header data box.
  3. Add Header – Adds a data input field in the header.
  4. Add Data – Adds a data input field in the request body.
  5. Test – Once the endpoint, credentials and request body have been validated, the user can make the request by clicking the Test button. It would then return a success or fail message.
    • Success – Indicates that the API call is a success.
    • Fail – Contains the error in the API call. When an error in the API call occurs, KLoBot can translate the error and sends out details to where the API call failed.

This connector allows the user to connect to multiple SharePoint sites by providing a valid username, password and the SharePoint Site URL. Users can get and retrieve documents or contact information from a SharePoint library. Users can also post an entry to the SharePoint list.

The SharePoint Site Settings would vary based on the Method type.

  1. Method Type – Indicates the SharePoint method to process the data. KLoBot supports the GET, POST and SEARCH methods.
    • Get Method – Fetches information found from SharePoint Columns
    • Post Method – Posts a new entry for each column to the SharePoint list
  2. SharePoint Username – Contains the username registered to the SharePoint site.
  3. SharePoint Password – Contains the password registered to the SharePoint site.
  4. Add Site – Adds a site to the process field and opens a modal to connect the user to the SharePoint Site.
  5. SharePoint Sites – A list of SharePoint lists and libraries added via the SharePoint Site Settings.
  6. Edit SharePoint List – Allows the user to edit the SharePoint Column Settings.
  7. Delete SP Name – Deletes the SharePoint list added to the SharePoint Site settings.
  8. Delete SP Name – Deletes the SharePoint list added to the SharePoint Site settings.

SharePoint Site Settings

SharePoint window that contains the configuration to connect to the SharePoint Site.

  1. SharePoint Endpoint URL – SharePoint Site URL that the user connects to.
  2. Get List – Gets and fetches all the SharePoint Lists from the SharePoint site. After user clicks the button, it populates the SP List dropdown.
  3. SharePoint Lists – A dropdown menu containing all the SharePoint Lists in the SharePoint Site or SharePoint Library.
  4. Add SharePoint List – Adds a SharePoint List to the site settings. It redirects the user to the SharePoint Columns Page.
  5. SharePoint Lists – Contains all the SharePoint lists added in the SharePoint.
  6. Edit SharePoint List – Allows the user to edit the SharePoint Column Settings.
  7. Delete SP Name – Deletes the SharePoint list added to the SharePoint Site settings.

SharePoint Column Settings

Contains all the Columns in the SharePoint Site. This page is where the user can assign search fields and return fields to perform a search in the SharePoint columns or post data to each column.

Get Method

Users must assign an entity to a Search Field, then returns the information found through the Return Fields.

  1. Column Name – Contains all the columns in the SharePoint site.
  2. Search Fields – A checkbox that allows users to assign a column as a search field. Search Fields are the columns assigned to perform a search. Users can select multiple search fields.
  3. Operators – Contains expressions and operators for numerical type columns.
  4. Entities – Contains all the entities trained in the utterances. Users must select and assign an entity to a column if the column is a search field.
  5. Return Fields – A checkbox that allows users to assign columns as return fields. Return Fields section contains all the data that will be returned after the SharePoint Search. Users can assign multiple return fields.
  6. Save Changes – Saves all the modifications made in the column settings page.
  7. Cancel Changes – Cancels and discards all the changes made in the column settings page.

Post Method

Users can post a new entry to the SharePoint list via selecting columns. It is similar to the Get method only there’s no Search or Return Fields. Users can only assign a field to post a new entry.

  1. Column Name – Contains a list of all the SharePoint column names.
  2. Fields – Allows the user to select a column name to create a post.
  3. Entities – Allows the user to assign an entity to the column name to create a post.

This connector allows KLoBot to connect to a NetDocuments vault. The user must provide valid credentials to the NetDocuments vault in order to establish a connection.

KLoBot performs document management through the NetDocuments connector.

Users can perform several tasks such as retrieving recent and favorite documents, document searches, check-in and check-out documents, renaming document names and deleting documents.

  1. NetDocuments Endpoint URL – The NetDocuments API URL that handles all the NetDocuments processes.
  2. Client ID – Contains the client id in the NetDocuments vault. User must enter a value for client ID otherwise the connection won’t work.
  3. Client Secret – Contains the client secret key from the NetDocuments vault. User must enter a value for the client secret, otherwise the connection won’t work.
  4. Process Name – A dropdown menu that specifies which process or NetDocuments task to perform.
  5. Test – Makes the request to the API call. If the user’s access token has expired, the skill builder will create an authenticate button that will ask user to enter NetDocuments credentials.

10 Main Skills

Connect to NetDocuments

Connects and authenticates the user to the NetDocuments Vault.

Disconnect from NetDocuments

Disconnects the user from the NetDocuments Vault.

Recent Documents

Retrieves and returns all the recent documents created in the NetDocuments Vault.

Favorite Documents

Retrieves and returns all the favorite documents created in the NetDocuments Vault.

Find Document by Name

  • Initiates a document search by name. The skill expects a document name to perform the search. The user must click Add to add a data with the document name in the request body.
  • Data Request Body – Contains the prompt data entity and the document name to search.

Find Document by Workspace

  • Initiates a document search using the matter id or client id. The skill expects a client name or matter name to perform the search. The user must click Add to add a data with the document name in the request body.
  • Data Request Body – Contains the prompt data entity, client name or matter name to search.

Rename

  • Allows the user to rename a document given the document name and document ID. To test the rename API, this skill expects the user to provide document name, new document name and the document ID.
  • Data Request Body – Contains the document name, new document name and the document ID. The document ID is a 12-digit unique identifier for each document.

Delete

  • Allows the user to delete a document given the document name and document ID. To test the delete API, this skill expects the user to provide document name and the document ID in the request body.
  • Data Request Body – Contains the document name and the document ID to delete.

Check-in

  • Allows the user to check-in a document given the document name and document ID. To test the check-in API, this skill expects the user to provide a document name and the document ID in the request body.
  • Data Request Body – Contains the document name and the document ID to check-in.

Check-out

  • Allows the user to check-out a document given the document name and document ID.
  • Data Request Body – Contains the document name and the document ID to check-in.

This connector allows KLoBot to connect to a SQL server. The user MUST provide a valid SQL connection string to connect to the collections and stored procedures.

Users can retrieve filtered information from a SQL collection via Stored Procedures in the SQL Server.

  1. Connection Method – Contains the method to connect to the SQL. KLoBot supports ‘Procedure’ connection method which allows users to retrieve ‘Stored Procedures’ from the SQL server.
  2. Connection String – Contains the connection string retrieved from the SQL Management Studio. The test button allows the user to validate the connection string and retrieves all the stored procedures.
  3. Stored Procedure – A dropdown menu that contains a list of all the stored procedures retrieved from the SQL server. A stored procedure is a pre-built function created by a user via SQL Management Studio.
  4. Parameters – Built-in parameters from the Stored Procedure. These values are fixed and can’t be changed. A user must provide a value to these parameters since the Stored Procedure is expecting a parameter.
    1. Parameter Name – Name of the parameter from the stored procedure.
    2. Entity Name – The entity assigned to the parameter. The user can also select from a list of entities by clicking the button.
    3. Value – The value the user enters to the parameter. This is the value that KLoBot makes a search to the SQL server.

KLoBot has the ability to connect to iManage responsible for a variety of document management tasks.

Users can retrieve recent and favorite documents, search and find documents from iManage libraries and rename documents.

KLoBot can connect to an iManage on-premise Work and iManage Cloud software

On-Premise

iManage On-Premise connects to the iManage Work 10 which requires the client ID and the client secret to gain access.

  1. Host – Indicates the location of the host. In this case, it’s on-premise.
  2. Host name – Contains the iManage host name.
  3. Client ID – Contains the client ID retrieved from the iManage work.
  4. Client Secret – Contains the client secret retrieved from the iManage work.

On-line (Cloud)

iManage On-Premise connects to the iManage Cloud services and does not require credentials.

  1. iManage Process – A dropdown menu that contains a list of all the process names in iManage.
  2. Test – Creates the API call and test the connection to iManage connector. The test functionality is only available for Connect, Disconnect, Recent, Favorite sub-skills.
  3. Select Library – Allows the user to open the Library Settings to add a library to perform a search.

NOTE: This feature is only available for Find Document skill.

Library Settings

A modal that contains iManage Libraries to find and search for a document through the columns. This is similar to the SharePoint Site Settings Modal.

  1. Select Library – Dropdown menu containing all the Libraries that the user can add to make a search.
  2. Add Library – Adds the library to perform a search. This button redirects the user to the Columns page.

Columns Page

Contains all the columns, operators, entities and the search and return fields that the user can assign to find documents and retrieve information.

  1. Column Name – Contains a list of all the columns in the iManage library.
  2. Search Fields – An allocation of checkboxes that allows the user to select a column name to make a search.
  3. Operators – Dropdown menu that contains operators. The dropdown menu is enabled for numerical type column names.
  4. Entities – A dropdown menu that contains all the entities used in the Train section. This is a requirement if a search field is assigned.
  5. Return Fields – An allocation of checkboxes that allows the user to select a column name to be returned to the user. This is the data that gets retrieved after KLoBot creates a search.

6 Sub Skills

Connect

Authenticates and connects the user to iManage. This gives the user access to the iManage connector.

Disconnect

Disconnects the user from iManage. Removes the use’s access to the iManage connector.

Recent

Retrieves and returns all the recent documents added in iManage.

Favorite

Retrieves and returns all the favorite documents added in iManage.

Find documents

Allows the user to search and find for documents based on the name. This returns all the documents based on document name.

NOTE: The user must select a library to search a document.

Rename name

Allows the user to rename a document.

NOTE: The user must select a library to search a document.

KLoBot has the ability to create a skill that sends an email to a specified email address

This connector is useful for skills that are meant for IT Support, business queries, customer service and application

  1. Email Title – The subject of the email that gets sent to the email address
  2. Email Recipients – The receiver of the email. Users can enter multiple email addresses by adding the ; at the end of each address
  3. Email Body – The body and the look of the email that gets sent to the Email Recipient. Users can format this email by right clicking words and map with respective entities created from the prompts.
  4. Skill Binding – A dropdown menu that allows the user to bind a skill after KLoBot finishes processing the email. This allows the skill to continuously flow after the user sends an email to the recipient.
    NOTE: The user can only bind to a sub-skill created within the parent skill.