KLapper Admin User Guide

Introduction 

KLapper provides a user-friendly interface that guides users through the process of creating and managing assistants. Key features include: 

1. Assistant Builder: The platform allows users to create new assistants from scratch, starting with a basic template that can be customized extensively. Users can define the assistant's purpose, name, and description. 
   
2. Knowledge Builder: Users can build a comprehensive knowledge base by uploading documents, providing URLs, or linking to external data sources. The platform supports various file formats and ensures that the knowledge base is easily searchable and updatable. 
   
3. Skill Builder: The Skill Dashboard feature provides efficient skill management and integration through a user-friendly interface. This will allow users to add, edit, and manage various skill builders. Users can configure skill-specific properties, select knowledge bases, and perform essential actions such as editing, saving, deleting, and publishing components effortlessly.
   
4. Prompt Builder enables users to create and save reusable prompts for document analysis and review. These prompts ensure consistency and efficiency across workflows. All prompts are centrally stored within the Prompt Builder module for easy access and management.
   
5. Assistant Customization: KLapper offers a range of customization options, including the ability to modify the assistant's appearance, define its personality, and set specific behaviors. Users can also configure response settings to ensure the assistant interacts effectively with end-users. 
   
6. Integration Capabilities: The platform supports integration with popular services such as SharePoint, NetDocuments, and iManage. This allows assistants to access and retrieve information from these services, enhancing their utility and efficiency. 
   
7. Deployment: Once the assistant is configured, it can be deployed across various channels, including websites, messaging platforms, and mobile apps. The KLapper Admin Center provides tools for monitoring and managing the assistant's performance, ensuring it continues to meet user needs over time. 

Login

Assistant Navigation Header

Header Navigation

7. KLapper Version 
   View the current version of KLapper, including updates and enhancements, to stay informed about the latest features and improvements. 

• Assistant Builder 
  Easily create and configure your chatbot’s personality, functions, and responses with the Assistant Builder tool, tailoring it to your business needs. 

• Skill Builder 
  Develop specific skills and responses for your assistant, customizing how it interacts with users based on different scenarios and requirements. 

• Prompt Builder
  

• Ability to add Reusable and End User Prompts, and directly integrate with the Knowledge Builder to add prompts across knowledge sources and assistants
  

• Global Settings 
  Adjust platform-wide configurations, such as language preferences, time zones, and user permissions, through the Global Settings menu for streamlined operations. 

• Reports 
  Access detailed analytics and performance reports that track interactions, user engagement, and assistant efficiency to optimize and enhance the chatbot’s capabilities. 

• Account Details 
  Manage your personal and business account information, including access to0 user guides, and user access, within the Account Details section. 

• 
  

Footer 


• 
  

• User Guide 
  Access the comprehensive User Guide to understand the platform’s features, tools, and functionalities, with step-by-step instructions for optimal use. 

• Privacy Policy 
  Review the platform’s policies, including privacy, data security, and usage terms, to ensure compliance and informed decision-making. 

• Send Feedback 
  Provide feedback directly to the development team, sharing your suggestions, concerns, or issues to help improve the platform’s performance and user experience. 

• 
  

System updates

Global Settings

Users

There are 2 types of users:

Builder Users - A list of users who have built assistants and administrators can easily view and manage active users

Chat Users - The Chat Users List enables administrators and users to easily view and manage active users.

Features

Note: Once admin reaches the user limit based on the license, an error is thrown when clicking the Add button or activating a disabled user. In this case, please contact license@klapper.ai 

General

Features

Microsoft Azure Open AI Details

Anthropic AI Details

Features

Microsoft Azure App Details

Features

Azure Storage Account Details





Features


Details of the information about the storage account on Azure 


1. Account Name
   
2. Account Key

Translation Service Details

NetDocuments

How to add NetDocuments connection

Open your NetDocuments site and navigate to the admin page for your repository

1. US Region - https://api.vault.netvoyage.com/v2
   
2. EU Region - https://api.eu.netdocuments.com/v2
3. DE Region - https://api.de.netdocuments.com/v2
4. AU Region - https://api.au.netdocuments.com/v2
   
5. CAN Region - https://api.can.netdocuments.com/v2
   

1. US Region - https://vault.netvoyage.com/neWeb2
   
2. EU Region - https://eu.netdocuments.com/neWeb2
   
3. DE Region - https://de.netdocuments.com/neWeb2
   
4. AU Region - https://au.netdocuments.com/neWeb2
   
5. CAN Region - https://can.netdocuments.com/neWeb2
   

iManage

Administrators can connect their iManage environment to the KLapper environment by filling out the iManage section in the global settings 

How to add iManage connection (On-Premises)

Go to your iManage homepage and click your profile icon in the top-right, then select Control Center

Step 2:

Click Applications from the left column and select “Add Application”

Select Configure Manually

Configure the application with these fields specifically as shown below and fill in the remaining fields

    API Key: Client ID (From Azure API)

    API Secret: Client Secret (From Azure API)

Step 4:

Click Authentication and insert the Redirect URL from KLapper Builder

Select to Enable Refresh Token

Click fill out the rest of the fields and click Finish

Please open the Klapper Builder page and go to the global settings.

Next, enter the Input Parameters under iManage in the new settings information

How to add iManage connection (Cloud)

Go to your iManage homepage and click your profile icon in the top-right, then select Control Center

Send a request to iManage support to add a new application

    Include redirect URL from the KLapper Builder Global Settings, under iManage

Once the Application is created by support, configure the application

    Allow Refresh Tokens: Yes

    Client ID: Client ID (From Azure API)

    API Secret: Client Secret (From Azure API)

Click Authentication and insert the Redirect URL from KLapper Builder

Select to Enable Refresh Token

Proceed through other settings and press Finish

Click Finish

Please open the Klapper Builder page and go to the global settings.

Next, enter the Input Parameters under iManage in the new settings information

SharePoint

How to add SharePoint Connection (On-Premises)

1. Go to the KLapper Resource Group
   
2. Add an Azure VNet
   
1. It should be in the same region that the KLapper services were provisioned
   
3. Once the VNet is added, go to each KLapper WebApp service and repeat the following process:
   
1. Select Networking from Settings in the left panel
   
2. Select Virtual Network Configuration and click on Not configured
   
3. Click on Add virtual network integration
   
4. Then select the Subscription, Virtual Network and Subnet
   

1. In the Azure portal, go to your Virtual WAN. In the left panel, select Virtual network connections
   
2. On the Virtual network connections page, select + Add connection
   
3. On the Add connection page, configure the connection settings. For information about routing settings, see: About virtual hub routing - Azure Virtual WAN | Microsoft Learn.
   
1. Connection name: Name your connection.
2. Hubs: Select the hub you want to associate with this connection.
3. Subscription: Verify the subscription.
4. Resource group: Select the resource group that contains the virtual network to which you want to connect.
5. Virtual network: Select the virtual network you want to connect to this hub. The virtual network you select can't have an already existing virtual network gateway.
6. Propagate to none: This is set to No by default. Changing the switch to Yes makes the configuration options for Propagate to Route Tables and Propagate to labels unavailable for configuration.
7. Associate Route Table: From the dropdown, you can select a route table that you want to associate.
8. Propagate to labels: Labels are a logical group of route tables. For this setting, select from the dropdown.
9. Static routes: Configure static routes, if necessary. Configure static routes for Network Virtual Appliances (if applicable). Virtual WAN supports a single next hop IP for static route in a virtual network connection. For example, if you have a separate virtual appliance for ingress and egress traffic flows, it would be best to have the virtual appliances in separate VNets and attach the VNets to the virtual hub.
10. Bypass Next Hop IP for workloads within this VNet: This setting lets you deploy NVAs and other workloads into the same VNet without forcing all the traffic through the NVA. This setting can only be configured when you're configuring a new connection. If you want to use this setting for a connection you've already created, delete the connection, then add a new connection.
11. Propagate static route: This setting is currently being rolled out. This setting lets you propagate static routes defined in the Static routes section to route tables specified in Propagate to Route Tables. Additionally, routes will be propagated to route tables that have labels specified as Propagate to labels. These routes can be propagated inter-hub, except for the default route 0/0.
    
4. Once you've completed the settings you want to configure, click Create to create the connection.

How to add SharePoint Connection (Online)

You need to register the App in the Azure portal. If it is already registered, please check the configurations. Azure Portal URL : https://portal.azure.com

After accessing the Azure portal, navigate to “App registrations” under Azure Services.

Open the “App registration” page and click “New registration” 

Upon opening the registration page, enter the following information.

Once you click the "Register" button at the bottom of the page, it will be complete.

Step 4:

Navigate to Manage -> API permissions and add the required permissions:

1. Microsoft Graph:
   
1. Calendars.ReadWrite (Delegated)
2. Directory.Read.All (Application)
3. Group.Read.All (Application)
4. GroupMember.Read.All (Application)
5.  Sites.Read.All (Delegated)
6. User.Read (Delegated)
7. User.Read.All (Application)
2. SharePoint (Delegated):
   
1. AllSites.Read (Delegated)
2. Sites.FullControl.All (Application)
3. Sites.ReadWrite.All (Application)
4. Sites.Search.All (Delegated)
5. TermStore.Read.All (Application)
6. User.Read.All (Application)

Refer to the snapshot below for guidance.

After adding permissions, click the "Grant admin consent" link.

After adding permissions, create the secret key under Manage -> Certificates & secrets.

A “New client secret” needs to be generated. Please fill the below options.

Description - Need to enter the description secret key

Expires – Choose the option of secret key expires

After generating the secret key, make sure to record the value in a notepad or another secure location. 

Please also note down the client ID and tenant ID, which can be found in the overview section.

After the setup is finished, you need to open the SharePoint admin portal. In the URL below, replace your SharePoint tenant name.

https://${tenant name}-admin.sharepoint.com/_layouts/15/appinv.aspx

Enter your Azure app registration client ID into the "App Id" field and click "Lookup". The Title and redirect URL will be populated automatically. To complete the App permissions XML, use the following and need to fill the App domain.

<AppPermissionRequests AllowAppOnlyPolicy="true"> 

</AppPermissionRequests>

After completing the form, click the “Create” button. This will take you to the “trust page,” where you should click the “Trust It” button.

Next, enter the Input Parameters under SharePoint in the new settings information.

1. Tenant Name: Tenant’s Name
   
2. Tenant URL:  Tenant site URL
   
3. Tenant ID: Tenant id, you copied from azure App registrations
   
4. Client ID: Client id, you copied from azure App registrations
   
5. Client Secret: Client secret, you copied from azure App registrations

After clicking "Test Connection" and verifying it, press the "Add Tenant" button.

1. Generate a self-signed certificate using the PowerShell command below:
   

1. “Enter Certificate Password” should be replaced with a password.
   
2. Write down this password for future reference as Certificate Password.
   
3. After executing the command, find the .cer and .pfx files from the respective path for future usage.
   

1. Login to the Azure portal and select App Registrations.
   
   
2. Select New registration from the App registrations page.
   
   
3. Fill the following highlighted field values and click Register in the Register an application page.
   
   
4. Go to the Application Overview page after completed the application registered.
   
5. Write down the Tenant ID and Entra App ID from this page.
   
1. Directory (tenant) ID as Tenant ID
   
2. Application (Client) ID as Entra App ID
   
   

1. Click the Authentication menu from the left-side menu.
   
2. Click Add a Platform.
   
   
3. Click Web and then Configure Web.
   
4. Enter [Klapper Builder URL]/assets/spauth/index.html in the Redirect URIs input.
   
5. Click Configure to save the configuration.
   
   
6. Verify that the Redirect URI was properly added from the Authentication pane.
   
   

1. Click the Certificates & Secrets menu from the left side.
   
   
   

1. Click Certificates tab to navigate the Certificates list 
   
2. Click Upload certificate.
   
3. Add the certificate that was previously created (the .cer file) and enter a description.
   
4. Click Add button to complete the upload.
   
   
5. After completing the certificate upload write down the Thumbprint as Certificate Thumbprint.
   
   

1. Click the Client Secrets tab 
   
2. Click New client secret
   
3. Enter the description and choose an expiry date for the client secret in the popup.
   
4. Click Add button.
   
   
5. After creating the secret write down the secret value as Application Secret and Secret ID.
   
   

1. Click API Permissions menu from the left menu, 
   
2. Click Add a permission and add the following permissions
   
1. Microsoft Graph
   
1. User.Read (Delegated)
   
2. Sites.Read.All (Delegated)
   
3. Calendars.ReadWrite (Delegated)
   
4. Directory.Read.All (Application)
   
5. Group.Read.All (Application)
   
6. GroupMember.Read.All (Application)
   
7. User.Read.All (Application)
   
2. SharePoint
   
1. AllSites.Read (Delegated)
   
2. Sites.Search.All (Delegated)
   
3. Sites.FullControl.All (Application)
   
4. Sites.ReadWrite.All (Application)
   
5. TermStore.Read.All (Application)
   
6. User.Read.All (Application)
   
3. Click Grant admin consent for {tenantName} 
   
   

1. The KLapper Builder End User use the Delegated permission.
   
2. The Klapper Learning use the Application permission.
   

Adding the SharePoint Connection on Global Settings

1.  Add a new SharePoint connection
   
2. Fill in every required field with the values from previous steps
   

SMTP Server Details

1. SMTP Server Host Name: Host name for the used SMTP server
   
2. SMTP Port: Port used for the SMTP server
   
3. Username: Username for the SMTP server
   
4. Password: Password for the SMTP server
   
5. From Email: What email you want the transcript to be sent from

KLapper Update History

This is where the admin can see the version history and date updated on by the Admin user

Features

Updating KLapper

Click update and initiate (By default, this update will run during afterhours)

To start the WebJob process manually, go to builder UI app service, click on WebJobs and press Run

Assistant Builder

The Assistant Builder enables the admin user to create, customize and train assistants that they can then deploy to various environments

Steps to Create a New Assistant

Add a Title 

Description

Create Assistant

Add Skills 

List of skills that KLapper ships with:

Who Is

    Will give details about people from the provided SQL

Create Meeting

    Will create a meeting using KLapper’s API

Timesheet

    Will add entries to a Harvest timesheet

Create Service Now

    Creates a new support ticket for the user’s issue

Get Service Now Incident

    Gets information on service tickets

Alerts

    Details all alerts for the signed in user

Matter

    Provides details about a matter that the user sends a query about

Preview Assistant

Click the ‘Preview Assistant’ which launches the Assistant bot 

Chat box

Chat message

Assistant Settings

Manage Users/Groups Assignments

Assistant Bubble 

(These all change the appearance of the assistant bubbles)

6. Assistant Bubble Border Color
   

7. Assistant Bubble Background Color
   

1.     The background color of the text boxes in the assistant
   

8.    Assistant Bubble Text Color
   

User Bubble

Assistant Icon

1. Outline 

Microsoft Azure Settings

Skill Builder 

To create and add new skills so that the admin can add these skills to the various assistants and then deploy those assistants to the different channels to help attorneys and legal staff with their day to day work and documentation.

Skill Creation

To create a skill in KLapper builder, choose the “Skill Builder” in the top menu item and click on the button “+ Add New Skill”.

 

Enter Skill Name and click on “Create” button.

 

Input Prompts

In the Input Prompts page, the user can provide necessary information with entities required for the skill to execute.

 

Different sections of the Input Prompts form,

Add prompt

      Click on “+ Add prompt” button to add a new prompt. This will add a new prompt form element in the form for the user to input data.

Additional System message

The user can enter additional system instruction in this input field for the skill to process.

A few sample Additional System message

1. Format all date values as year-month-day (yyyy-MM-dd)
   
2. Convert short or abbreviated US locations into full names. For example:
   
1. "NY" becomes "New York"
   
2. "Edison, NJ" becomes "Edison, New Jersey"
   Assume the location is in the United States unless clearly stated otherwise.
3. empid should always be "currentUserEmailId". We must use this prompt to pass the current user email for an entity.
   
4. If the time zone is missing, use the current time zone listed below.
   Convert all time zones into standard Windows format. For example:
1. "ET" becomes "Eastern Standard Time"
   
2. "CT" becomes "Central Standard Time"
   
3. "IST" becomes "India Standard Time"
   Format the start time as: day-month-year hour:minute:second (dd-MM-yyyy HH:mm:ss)
   If the user doesn’t mention the time, do not make one up. Just leave it blank and ask them for it.

Required Entities

This section will show the list of entities that are provided from every prompt. We can select the check box to make the entity as required.

 

In this example subject, start and attendees are required entities. If these entities are not available in the user input prompt the framework will process the prompt and ask for the user to input the details for these entities if it is not able to get it from the prompt.

In this example time zone is an optional entity. Even if this entity is not available in the input prompt the framework start executing the prompt without asking user to input the details for the time zone.

Prompt Section

1. Input
   
1. The user can input the prompt to train the assistant to identify the intent of the skill
   
2. isReusable
   
1. This option can be checked to make the prompt as a reusable prompt
   
3. isEndUser
   
1. This option can be checked to make the prompt available for the end user
   
4. Add Entity
   
1. Define the entities from the prompt for the framework to identify
   
5. Entities
   
1. These are the key value pairs as the value must be pick from the prompt for the framework to identify.
   

Test Prompt

To test a prompt as how the assistant will respond by processing the prompt. Click on “Test Prompt” button will open a popup to input a prompt and submit it to the assistant for processing.

 

Click on the button “Next” will open the flow builder page where the user can design the flow of the skill that will execute by the assistant.

Flow Builder

Flow builder is a tool used to create a flow for the skill to execute. Using flow builders, the skill can connect with connectors to get the response, can handle conditional based process, can do response looping to perform some activities, etc.,

In the Flow builder there are different types of nodes used to design the flow process.

Nodes

Start

      This node defines the start of the flow process.

 

Initial

      This is the initial node of the flow process, which handles the input prompt from the user.

Condition

      This node is used to do condition check on the provided params and take a decisional based flow.

 

The properties of conditional node are:

 

Check Params

      By Selecting “Check Params” the user can select the Link Node – Initial node input params or Connector node response params to perform condition check. Over the conditions object the following conditional checks can be performed. 

 

Delete

      Selecting this will delete the entire condition nodes and the nodes inside the conditions.

Message

      By selecting “Message” the condition will become “Yes” or “No” option selector and will show a “Yes” or “No” options in the chat window for the user to select.

 

 

If the user selects “Yes” the nodes below the “Condition” branch will get execute and if the user selects “No” the nodes below “On Condition Failed” will get execute.

Show Options Card

      Selecting this property will show an adaptive card in the User Chat as an option to select.

 

For this, the selected Link Node should be a “Connector” Node. Provide the input as Array element from the response of the selected “Connector”. The “has” condition will check over the selected property from the Array element matches to the conditional value added. If the Array element has the conditional value, then the Options Adaptive card will be shown in the user chat window else the “On Condition Failed” branch will get execute.

 

Example case: The API endpoint of TimeSheet requires project id to execute. But the user can provide project id or project name in the prompt. So, if the user enters project name in the prompt then we have to convert the project name to id before processing the API endpoint and for that reason this “Show Options” conditional node will help to show the user the list of projects in the chat as for the user to pick it from the list.

In general, if the condition gets pass, then the nodes below “Condition” node will get execute, else the node below “On Condition Failed” branch get execute.

  

The “On Condition Failed” node has 3 properties,

Continue

      Selecting this will continue the execution

Delete

      Selecting this will delete the entire condition nodes and the nodes inside the conditions.

Message

      Selecting this will show the added message in the chat window.

 

Connector

      This node is used to connect with API/SQL/Fabric connector and pick the response by executing the connector. 

 

The connector expects input to perform the task. To provide the input to the connector the connector node must pick data from the Link Node. The user can select the Link Node – Initial node input params or Connector node to provide input data. In the “Map Params” section the param from the “Link Node” must be assigned to a Key/Variable. This Key/Variable will be used in the connector configuration.

We can see the Connector Configuration in detail in the below “Connectors” section.

Do Until

      This node is used to Loop Over an array element from the response of the Link Node.  

  

 

For the Node elements (Connector and Condition) inside the Do-Until loop will pick the data from the selected Loop Over Array based on the loop index. 

Get Input

      This node will make the chat wait for the user input. After the user inputs text information, then the flow continues to execute. The input can be passed to a Connector node by mapping “User Input” property.

 

Search Knowledge Base

      In the flow, this node will pick the initial prompt and do a Knowledge Base search.

 

Show Message

      In the flow, this node will show the message in the chat progression. This will be useful to show engaging messages in the chat.

 

End

In the flow, reaching this node will end the flow process.

 

Connectors

The connector node has an option to configure the connector. Click on the “Configure Connector” button in the connector node will open the connector configuration popup. 

The Connector has 2 sections – configuration and output.

The output section shows following items: 

1. Filtered JSON (filtered data from the connector output)
   
2. Output Prompt (Enter additional prompt information for the LLM to process)
   
3. Generate Prompt (click on this button will create auto generated output prompt)
   
4. Output Format (select the output format – Text or Adaptive Card) for the assistant to display in the chat.
   

By selecting “Adaptive Card” option can add “Adaptive card data”. 

Sample data:

{

                     "type":"AdaptiveCard",

                     "$schema":"http://adaptivecards.io/schemas/adaptive-card.json",

                     "version":"1.0",

                     "body":[

                        {

                           "type":"TextBlock",

                           "text":"%$.name%",

                           "weight":"Normal",

                           "size":"Normal"

                        },

                        {

                           "type":"TextBlock",

                           "text":"Temp %$.main.temp%°K",

                           "weight":"bolder",

                           "size":"Large"

                        },

                        {

                           "type":"Image",

                           "url":"http://openweathermap.org/img/w/%$.weather[0].icon%.png",

                           "size":"small",

                           "style":"Normal"

                        },

                        {

                           "type":"TextBlock",

                           "text":"%$.weather[0].description%",

                           "weight":"Normal",

                           "size":"Normal"

                        }

                     ]

                  }

Click on “Test Output” prompt will show the test output the Assistant will response.

 

In the Connector Configuration section, select the Type of Connector and do the configuration

 

Universal Web Connector

This connector configuration includes the following form elements

API endpoint

       This form element is used to define the endpoint url and the endpoint type.

Auth

      This form element is used to define the Auth type.

 To configure “OAuth 2” fill the OAuth2 configuration details, Auth URL, redirect_uri, response_type, client_id, grant_type and generate the Access Code.

 

After generating the “Access Code” generate the “Access Token” by providing the additional information of client_secret.

Header, Query, Body 

      The next step is to configure the API request with headers and query params if needed.

  

Here in the query param mapping there a possibility to add the Key/Variable that holds the data in the Connector mapping in the connector node.

Sample Request

The sample request text field is not editable, and it is framed based on the configuration details. Verify it and then press “GET” or “POST” button to execute. The response data will get populated below as a tree structure.

 

Only the selected properties will be considered from the response and will be treated as the output of the connector.

After seeing the response, the connector configuration is successfully completed and can be saved.

To edit the connector configuration, it is needed to see the final step up to sample response. Otherwise, the “Update” button will be disabled.

SQL Connector

      This connector configuration includes the following form elements

 

The SQL Connector settings include Azure SQL and SQL Server. 

Fill out the necessary details for the type of connection.

On successful connection, select the stored procedure to execute on this SQL connector

 

After selecting the stored procedure, then we must map the input params for the stored procedure.

In the “Map Input Fields” form element, choose the params that are added from the Key/Variable that holds the data in the Connector mapping in the connector node.

   

Response Data

      After completing the configuration, click on the button “Get Result” to execute the stored procedure with the mapped params and get the response. The response data will get populated below as a tree structure.

 

Only the selected properties will be considered from the response and will be treated as the output of the connector.

After seeing the response, the connector configuration is successfully completed and can be saved.

To edit the connector configuration, it is needed to see the final step up to Response Data. Otherwise, the “Update” button will be disabled.

Authentications

SQL Server Authentication (SQL Server)

Skill Connector Configurations

1. SQL Server User Account needs to have permission to the Stored Procedure and tables/views used by stored procedure.
   
2. Server/Host may differ depending on Server location:
   SQL server name
3. Database Name
   SQL database name
4. UserName
   Sql account username
5. Password
   Sql account password.
6. Additional Settings
   

Additional Settings Configured Based on the SQL Server

For example, if you encounter a certificate error such as "certificate not issued", please add the following command in the Additional Settings box:

      TrustServerCertificate=True;

You can also add multiple settings if needed. For example:

      TrustServerCertificate=True;Encrypt=False;

SQL Server with Key Vault Authentication (SQL Server)

SQL Server with Key Vault authentication means we retrieve the username and password from Azure Key Vault.

Skill Connector Configurations:

1. SQL Server User Account needs to have permission to the Stored Procedure and tables/views used by stored procedure.
   
2. Server/Host may differ depending on Server location:
   SQL server name
3. Database Name
   SQL database name
4. Key Vault Name
   In azure key vault place need to maintain the username and password.
1. Go to the Azure Portal and search the “Key vaults”.
   
2. Select the “Key vaults” and create the new Key vault.
   
3. Once created after expanding the object an create the client secret for username and password.
   Username – sqlUsername
   Password  - sqlPassword
4. Once secret create after click the “Access control (IAM)” and assign the Role for Klapper Entra APP
   
5. Additional Settings
   

Additional Settings Configured Based on the SQL Server

For example, if you encounter a certificate error such as "certificate not issued", please add the following command in the Additional Settings box:

      TrustServerCertificate=True;

You can also add multiple settings if needed. For example:

      TrustServerCertificate=True;Encrypt=False;

Microsoft Entra Service Principal (Azure SQL)

Pre Configurations

1. Configuration of Service Principal
   
1. Open Azure portal
   
2. Open “App Registrations”
   
3. Create new app or select any existing klapper app
   
4. From left menu, select “API Permissions”
   
5. The following permissions should be requested, click “Grant admin consent
   
1. Select Azure SQL Database
   
1. app_impersonation
   
6. Need to copy the client id and client secret for corresponding APP
   
2. Add Sql Permissions
   Log into the SQL using an AD account and execute the follow script
1. Create a contained database user for the Service Principal
   CREATE USER [AppRegistrationName] FROM EXTERNAL PROVIDER;
2. Assign the desired roles to the Service Principal
   ALTER ROLE db_datareader ADD MEMBER [AppRegistrationName];
   ALTER ROLE db_datawriter ADD MEMBER [AppRegistrationName];
   ALTER ROLE db_owner ADD MEMBER [AppRegistrationName];

Skill Connector Configurations:

1. Server/Host may differ depending on Server location: 
   SQL server name
2. Database Name
   SQL database name
3. Client Id – App Client Id
   
4. Client Secret Id – App Secret Id
   
5. Additional Settings
   

Additional Settings Configured Based on the SQL Server

For example, if you encounter a certificate error such as "certificate not issued", please add the following command in the Additional Settings box:

      TrustServerCertificate=True;

You can also add multiple settings if needed. For example:

      TrustServerCertificate=True;Encrypt=False;

Managed Identity Principal (Azure SQL)

Pre Configurations:

1. Enable Managed Identity for the App Service
   
1. Go to your Azure App Service in the Azure Portal.
   
2. Navigate to Identity → System Assigned.
   
3. Set Status to On and Save.
   
4. This creates a managed identity in Entra ID (formerly AAD) for your App Service.
   
2. Add Sql Permissions
   Connect to your Azure SQL database using an Azure AD admin account and execute the follow script
1. Create a contained database user for the Service Principal
   CREATE USER [your-app-name] FROM EXTERNAL PROVIDER;
2. Assign the desired roles to the Service Principal
   ALTER ROLE db_datareader ADD MEMBER [your-app-name];
   ALTER ROLE db_datawriter ADD MEMBER [your-app-name];
   ALTER ROLE db_owner ADD MEMBER [your-app-name];

Skill Connector Configurations

1. Server/Host may differ depending on Server location: 
   SQL server name
2. Database Name
   SQL database name
3. Additional Settings
   

Additional Settings Configured Based on the SQL Server

For example, if you encounter a certificate error such as "certificate not issued", please add the following command in the Additional Settings box:

      TrustServerCertificate=True;

You can also add multiple settings if needed. For example:

      TrustServerCertificate=True;Encrypt=False;

Fabric Connector

The Fabric Connector configuration will be done in a similar way, and the only difference is to connect to the Fabric Server Endpoint. The rest of the configuration will be the same as SQL Connector.

 

Authentications

1. Active Directory Service Principal:
   
1. Microsoft Fabric Server Name and Database Name
   Microsoft Fabric uses OneLake and data items like Lakehouses, Warehouses, and Datasets. If you’re looking for server and database details for connecting via tools like SQL Server Management Studio (SSMS) or Azure Data Studio:
   For a Fabric Warehouse or Lakehouse (via SQL):
1. Go to: https://app.fabric.microsoft.com
   
2. Open your Workspace and then the Warehouse or Lakehouse.
   
3. Select the SQL Endpoint or Open in SQL Editor.
   
4. You will see a connection string like:
   Server= 5mzlzjsvyjquzh3tpo3v5cbldy-35gzzp35p77utg32rh4dunghy4.datawarehouse.fabric.microsoft.com;Database=YourWarehouseName;
1. Server name: 5mzlzjsvyjquzh3tpo3v5cbldy-35gzzp35p77utg32rh4dunghy4.datawarehouse.fabric.microsoft.com
   
2. Database name: Whatever warehouse or Lakehouse you selected (Legal101_Fabric_DB)
   
2. Register Azure App and Assign Permissions
   If you already have the Fabric Client ID and Client Secret, reuse them; otherwise, create a new one in Azure.
   Register an App in Azure AD
   (Azure Portal > Azure Active Directory > App registrations)
   After registration, note:
1. Client ID
   
2. Client Secret
   
3. Tenant ID
   
3. In Microsoft Fabric:
   
1. Go to the workspace containing the Warehouse
   
2. Click Workspace Access
   
3. Add the App Registration as a Viewer or Contributor
   

Skill Connector Configurations

1. Server Name: 
   Fabric server name
2. Database Name
   Fabric database name
3. Client Id – Azure App Client Id
   
4. Client Secret Id – Azure App Secret Id
   
5. Additional Settings
   

Additional Settings Configured Based on the Fabric Server

For example, if you encounter a certificate error such as "certificate not issued", please add the following command in the Additional Settings box:

      TrustServerCertificate=True;

You can also add multiple settings if needed. For example:

      TrustServerCertificate=True;Encrypt=False;

Export Skill

Click on the “Export” button will export the skill settings/configurations as “.skill” file.

Import a Skill

    Click Import Skill and select a .klapperskill file, then click Import.

Knowledge Builder

To help the assistants to learn matters and documents across workspaces by

1. Dragging and dropping
2. Selecting a file, folder from My Computer (max file size: 400MB)
3. Adding a Web URL or File URL
4. Connecting to SharePoint, NetDocuments, iManage connectors
   

Action Buttons

For any context that is not sourced from My Computer, these action options will be available:

1. Refresh: Clicking this will bring up the option to refresh this learned content's data from its source immediately or schedule refreshes in intervals
   

Prompts / Q&A

1. Prompt: Custom prompts can be added to help KLapper learn with specific instructions and create a subset answer and keep it ready so that when the prompt is used it will quickly come up with the answer
1. Click on the Prompt tab
   
2. Add a prompt or start typing and select a prompt from the reusable selection of prompts and add it to the prompt selection for the document
   
3. Click Save to save the prompt

1. Q&A: This allows builders to refine the assistant's responses by adding specific Questions & Answers for specific Knowledge Base content.
   
1. Question: Enter the anticipated user questions that need to be refined.
   
2. Answer: Provide the desired response to each question.
   
3. Link/File Name: Include the link to the SharePoint List or the name of the selected file.
   

These questions and answers will be used by the assistant to fine tune responses. This can be used to overwrite incorrect responses from the assistant or provide a specific response to the specified question.

Delete

1. Remove the selected content from the Knowledge Base.
   

ACL Users

1. View which users can/cannot access the content of this document through the assistant
   
1. For My Computer, Web URL and File URL content, you can manually give/revoke access to specific users/AD groups
   
2. Refresh all groups refreshes the permissions for all members in any groups that are selected

Default Knowledge Base

Connectors to learn documents

Note: Avoid selecting a NetDocuments or iManage Cabinet or Workspace as a knowledge builder for security reasons.  These repositories often contain sensitive information, and caution should be exercised. 

Prompt Builder

Purpose

Prompt builders help the user build prompts that can be used for document analysis and review and these prompts can be saved in a centralized repository in the prompt builder module.

 

1. Add New Prompt Button
   
1. When clicked a new empty prompt is created in edit mode.
   
2. More information in the next section.
   
2. Prompt Display Table
   
1. This table displays a list of existing prompts with the following columns:
   
1. Prompt Text: The message text that is sent to the bot. Must be unique.
   
2. Prompt Description: A short description shown in the chat UI prompts popup.
   
3. Category: Used to filter prompts within this table and in the chat UI.
   
4. Reusable Prompt: Indicates if the prompt is available for reuse in the Knowledge Builder.
   
5. End User Prompt: Indicates if the prompt is visible to users in the chat UI.
   
2. All text and checkbox columns are sortable by clicking on the column headers.
   
1. By default, the table is sorted in ascending order by Prompt Text.
   
3. Usage:
   
1. Users: Opens a modal showing users who have favorited this prompt.
   
2. KB: Opens a modal showing which assistants and documents are using this prompt in the Knowledge Builder.
   
4. Edit/Delete Actions
   
1. Edit: Enables inline editing for the selected prompt. See below for details on the edit view.
   
2. Delete: Deletes the selected prompt after user confirmation. A confirmation modal will appear, followed by a success or error message.
   
5. Category Filter Dropdown
   
1. Provides a list of all categories found in existing prompts.
   
1. Selecting a category filters the table to show only matching prompts.
   

Adding a new prompt

1.  Add a New Prompt Button
   
1. Adds a new prompt at the top of the view, allowing the user to begin entering prompt details.
   
2. Prompt edit menu
   
1. Enables editing or entering values for all prompt fields.
   
1. Category Suggestions: When typing at least three characters into the category field, a dropdown appears with matching existing categories to choose from.
   
3. Save/Cancel Actions
   
1. Save: Submits a new prompt or applies updates to an existing one. Displays a success or error message upon completion.
   
2. Cancel: Discards a new prompt or resets any unsaved changes made during editing.
   

Reusable Prompt

An instruction that you can feed with the document to KLapper.

When you click on the custom prompt (refer to Knowledge Builder section) and as the user types words the related reusable prompts will show up and the user can select the reusable prompt instead of having to write it

End User Prompt

An end user prompt that you can feed to end users of KLapper for documentation review and analysis.

Deploy To

Admin can click on “Deploy to” option and download a package that package can be deployed to multiple applications to ease an Attorney’s Day to day work.

Microsoft Teams

SharePoint

SharePoint Online

SharePoint Online Search EXTN

Website

Reports

Summary report of Users and Assistants 

User

Features

3. List of Assistants that have been created, conversations, messages, comments, likes, dislikes, tokens, and flags. 
4. Channels used by Admin
5. Assistants List View 

Assistant

https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them

User Account

This is where the User can manage his account details from and access the User Guide and give Feedback.

Word Add-in

Create Document

When using the KLapper Word Add-in with a blank document, you can generate content for a document