Introduction

The System Settings allows Admin users to gain access to a database that contains all the accounts registered to the KLoBot application.

System Settings allow the Admin user to manage all the accounts in the application. They can add, edit the user and disable their account through this page.

It also allows access to the Global Settings which contains all the configuration in the application itself. The Global Settings contains all the core settings of KLoBot such as the Machine Learning settings, the Language Understanding.

NOTE: The System Settings page is only made available for ‘Admin’ users.

Users Page

Global Settings Page

Shows a complete list of users and their account information such user name, contact details, plan, Auth Code, Role and Actions for the admin.

  1. Search User – Allows the user to search for an account by user name or contact details. It then filters out the users list based on the input.
  2. User Name Column – A column that contains all the names of the users.
  3. Contact Details – A column that contains the email address and the mobile number of users.
  4. Auth Code – Contains the authorization code registered to the user for the Microsoft Authenticator App. This setting is only applicable for user with 2 factor authentication.
  5. Role – A column that contains the role of each user. It is divided into 3 categories:
    1. Admin
      • Access to the User Manage and Global Settings.
      • Edit, delete and enable/disable a user.
      • Access to all the Chat Bots made by users.
      • Access to edit and train all the skills in the skill builder page.
    2. Bot Builder
      • Has access to the chat bot they created.
      • Cannot edit or update a skill they didn’t create.
    3. Trainer
      • Access to a chat bot that the user has added the trainer to the Trainers list via the Bot Page.
      • Can edit or train skills that the specific user that added the trainer to the Trainers list only.
  6. Actions – Allows the admin to manage the user’s privileges to the application. They can edit account information, delete the user and disable the user’s account.
    1. Edit User – Allows the admin to edit the user’s account information. It redirects the user to the Edit User page.The Admin can change the user’s role and the Two Factor Authentication.
    2. Delete User – Removes the user’s account.
    3. User Active – Allows the Admin to enable or disable an account.End user will be notified with an email when the admin enables a disabled account
  7. Create New User – Allows the Admin to create a new user in the KLoBot application.
    • Two Factor Authentication – Allows the user to assign a two-factor authentication for the user being created.

Shows all the configuration and main credentials for core functionalities and features in KLoBot.

Core Settings

Allows the users to configure the core functionalities that are needed for the KLoBot application.

License Settings

Contains the License Key. A valid License Key allows all the users access to the KLoBot Application.

NOTE: License Keys are only valid for a certain time and has an expiration date.

Bot Settings

Contains all the credentials for configuring the chat bot. This section is crucial and is needed for the chat bot to process messages.

  1. Bot Welcome Message – Contains the welcome message every time the user opens the chat bot. This is customizable to the user’s preference.
  2. Bot App ID – Contains the Microsoft App Id retrieved from the Bot Service in the Azure.
  3. Bot App Password – Contains the Microsoft Secret Key retrieved from the Bot Service in the Azure.
  4. Bot API URL – Contains the URL for the Builder API project.
  5. Bot Framework URL – Contains the Bot Framework URL project.
  6. Bot UI URL – Contains the Builder UI URL project.

LUIS Settings

Contains the all the Language Understanding or LUIS configuration responsible for skill training and utterance prediction.

  1. LUIS App ID – Contains the Application ID from LUIS. This is retrieved from the cognitive services via Azure.
  2. LUIS App Version – Contains the version number or name of the LUIS application registered to the KLoBot App.
  3. LUIS Prediction URL – Contains the Prediction URL that is responsible for predicting intents and entities.
  4. LUIS Prediction Key – Contains the Secret Key responsible for predicting intents and entities.
  5. LUIS Authoring URL – Contains the Authoring URL that is responsible for intent training and creating entities.
  6. LUIS Authoring Key – Contains the Secret Key responsible for intent training and creating entities.
  7. Prediction Score – The standard prediction score that is deemed acceptable when KLoBot predicts an intent.

NOTE: Intents with prediction scores lower than the standard prediction score will not be predicted accurately by KLoBot.

Send Grid Settings

Contains all the API key and the support email to configure the Email features in KLoBot.

  1. Send Grid API Key – Contains the API key retrieved from the Send Grid API via Azure.
  2. Support Email – Contains the email address that the account will use for email features such as overall experience.

Channel Settings

Contains the credentials that allows users to deploy KLoBot to different channels.

  1. Direct Line – Contains the Direct Line ID. This ID is responsible for allowing users to deploy to a SharePoint site. This pre-populated.
  2. Teams Group ID – Contains the Group ID retrieved from the Teams Group URL. This allows the user to deploy a chat bot to a Microsoft Teams group chat.
  3. Teams Personal Bot Id – A dropdown menu that contains all the chat bots to be assigned as a “global” chat bot which is then used for deploying a personal application in the Teams app.
  4. Facebook – Contains the Page ID of a Facebook page for Messenger Deployment.
  5. Slack – Contains the Slack Client ID for Slack deployment.

iManage Settings

Contains the credentials for iManage on-premise configuration.

  1. Client ID – Contains the client ID retrieved from iManage work site.
  2. Client Secret – Contains the client secret retrieved from iManage work site.
  3. Auth URL – This URL is responsible for redirecting the user to the authentication URL to create a token and gain access to the iManage work site.

NetDocuments Settings

Contains the credentials for NetDocuments related integration.

  1. Client ID – Contains the client ID from the NetDocuments account.
  2. Client Secret – Contains the client secret from the NetDocuments account.
  3. Auth URL – Contains the URL for the authentication process. This allows the user to enter their credentials and create an access token to connect to the NetDocuments account.
  4. NetDocuments Base URL – Contains the base URL where all the documents are stored.
  5. UK Client ID – Client ID for an account set to United Kingdom location.
  6. UK Client Secret – Client Secret Key for an account set to United Kingdom location.
  7. DE Client ID – Client ID for an account set to Denmark location.
  8. DE Client Secret – Client Secret Key for an account set to Denmark location.

Knowledge Builder Settings

Contains the credentials for Knowledge Builder module responsible for creating knowledge bases and FAQ skills.

  1. Subscription Key – Contains the subscription key for the Knowledge Builder module retrieved from the cognitive services.
  2. Subscription Host – Contains the URL for the subscription host retrieved from the cognitive services.
  3. Subscription Service – Contains the subscription service endpoint containing the version number.

Twilio Settings

Contains the credentials for configuring KLoBot to Twilio.

  1. Twilio Phone Number – Contains the Twilio Phone number registered to the application. This can be retrieved from the Twilio Active Numbers page.
  2. Twilio Sid – Contains the Account Sid retrieved from the Twilio Account Dashboard.
  3. Twilio Auth Token – Contains the Auth Token retrieved from the Twilio Account Dashboard.
  4. Twilio Validation URL – Contains the URL for Twilio Validation retrieved from the TwiML Apps page.

Graph API Settings

Contains the credentials for configuring the Personal Assistant skill that uses the Graph API.

  1. Tenant Domain – Contains the domain name from the Azure Active Directory retrieved from the Azure side.
  2. Client ID – Contains the Microsoft Client ID retrieved from Azure.
  3. Client Secret – Contains the Microsoft Client Secret retrieved from Azure.

Login Settings

Contains configuration and the standard time that a user is logged in to KLoBot. This section controls the login experience of a user.

  1. Auth Code Issuer – Contains the domain name from the azure active directory.
  2. User Logout Days – Contains the maximum days that the user can be logged out.
  3. Password Expire Days – Contains the maximum days until the password expires.
  4. Token Expire Days – Contains the number of days until the token expires.
  5. Token Expire in Minutes – Maximum number of minutes until the token expires. After token expires, it logs out the user.
  6. Account Lock in Minutes – Maximum number of minutes that locks the user.

Update Settings

Allows the user to upload the publishing profiles for each project to update features or changes made within the KLoBot application.

This allows the user to conveniently update changes made by developers in the KLoBot application by clicking Upgrade KLoBot button.

  1. KLoBot Builder Publishing Username – Contains the username for the Builder UI project. This is prepopulated via the publishing profile attachment.
  2. KLoBot Builder Publishing Password – Contains the password for the Builder UI project. This is prepopulated via the publishing profile attachment.
  3. KLoBot API Publishing Username – Contains the username for the Builder API project. This is prepopulated via the publishing profile attachment.
  4. KLoBot API Publishing Password – Contains the password for the Builder API project. This is prepopulated via the publishing profile attachment.
  5. KLoBot Framework Publishing Username – Contains the username for the Bot Framework project. This is prepopulated via the publishing profile attachment.
  6. KLoBot Framework Publishing Password – Contains the password for the Bot Framework project. This is prepopulated via the publishing profile attachment.

Users Page

How to create a user?

  1. To create a user, the user must have an admin account. Go to the Systems Settings page and click Create New.
  2. The Admin will be redirected to the Create New User page. Enter all the required values.
  3. Select the role for the user. The role has three categories namely Admin, Bot Builder and Trainer.
  4. The Admin can enable the Two Factor Authentication for improved account security.
    NOTE: For accounts that enabled this feature, user must download an extension in the browser called Microsoft Authenticator which can be downloaded in the Chrome Web Store
  5. Ensure that all the required fields are entered then click save changes. The user will receive an email depending on if they enabled the Two Factor Authentication.
    NOTE: There are instructions to configure the Auth Code provided in the email.
  6. Click the link provided in the email to set-up the password. Enter the new 6-character password then confirm the password. Click save changes.You have successfully created an account!

Global Settings

How to customize the welcome message?

  1. Log-in to your KLoBot account and ensure that your account has Admin privileges. Proceed to the Global Settings page from the Systems Settings module.
  2. Under Core Settings, navigate to the Bot Settings and under Bot Welcome Message section, enter the welcome message of your preference.
  3. Click Save Changes then test the welcome message by going to Bot Builder page. Open a chat bot and check to see if the welcome message is correct.

How to change the prediction score?

  1. Log-in to your KLoBot account and ensure that your account has Admin privileges. Proceed to the Global Settings page from the Systems Settings module.
  2. Under Core Settings, navigate to the LUIS Settings and under Prediction Score section, enter the two-digit score.This prediction score will now be the standard score that KLoBot deems to be acceptable in predicting intents.
  3. Click Save Changes then test prediction score via the Live Testing page.

How to set a global chat bot for Microsoft Teams Personal App?

  1. Log-in to your KLoBot account and ensure that your account has Admin privileges. Proceed to the Global Settings page from the Systems Settings module.
  2. Under Channel Settings, select a chat bot in the Teams Personal Bot ID section.
  3. Click Save Changes then test the chat bot by deploying a chat bot in the teams app.Upload a custom app and then click Add. Do not add the chat bot to a team.The chat bot you deployed is now pointing to the global chat bot.