KLapper Deployment Guide

v2.0

Introduction

This document details the deployment process for our KLapper virtual assistant builder.

Prerequisites

The deployment process is on Azure Cloud, we need the following prerequisites:

Azure Requirements

These requirements will get provisioned by the PowerShell script

KLapper Connecting to On Premise Systems

To fully leverage the capabilities of KLapper, we should be ready with the connectivity requirements to below platforms

1. SQL Server – This can be residing in on premise network
   
2. SharePoint – This can be on premise SharePoint instance or online
   
3. iManage – This can be on premise instance or cloud
   
4. NetDocuments
   

Connecting to On-Premises SQL Server/SharePoint/iManage

KLapper is deployed in Azure App Services. To connect an app service deployed in Azure to on-premises systems like SQL/SharePoint/iManage you can follow one of the approaches outlined below

Hybrid Connection

Azure Virtual Network Integration

Requirements

Azure ExpressRoute

3. Private connection between Azure datacenter and on-premises infrastructure
   
4. Doesn't go over the public internet
   
5. Higher bandwidth and lower latency than typical VPN connections

Requirements

Site-to-Site VPN

Requirements

Azure SQL Managed Instance with Azure Arc

Requirements

Installation

PowerShell Setup

1. Install PowerShell 7.4.7 from - https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5
   
2. Open Windows PowerShell as an Administrator
   
3. Verify the proper Windows PowerShell version is installed using this script (7.4.7)
   
1. $PSVersionTable.PSVersion
   
4. Run the script below
   
1. Set-ExecutionPolicy Unrestricted -Force
   
5. Run the script below and check the Azure PowerShell module version is 13.4.0
   
1. Get-InstalledModule -Name Az -AllVersions | Select-Object Name, Version
   
1. If the incorrect version is installed, use this to uninstall that version before downloading 13.4.0:
   
1. Uninstall-Module -Name Az -Version {Version Number}
   
6. To install the specific version use below command
   
1. Install-Module Az -RequiredVersion 13.4.0 -Scope CurrentUser -Repository PSGallery
   
7. Run the script below
   
1. Get-AzContext
   
8. Run the script below
   
1. Connect-AzAccount

Installation Process

1. Download the installation zip file shared.
2. Extract zip file to the folder in a Windows 10, 11 or 2019 server with PowerShell configured
3. Make sure the user performing installation has Provisioning privileges in Azure.
4. Open Inputs.ps1 and fill in the details. No underscores or capital letters should be used for any variables, after the Resource Group Name.
   

Variable Name	Description
$licenseKey	Please use the license key provided to you by the support team
$adminFirstName	First name of the Administrator who manages KLapper
$adminLastName	Last name of the Administrator who manages KLapper
$adminEmail	Email address of the Administrator who manages KLapper
$tenantId	Azure tenant id
$subscriptionId	Azure subscription id
$location	Azure location (Ex: eastus, eastus2 etc)
$resourceGroupName	Azure resource group under which KLapper services to be provisioned
$cosmosMongoDBName	This will be used to provision Azure Cosmos MongoDB account name
$cosmosMongoDatabase	This will be used to provision a new Database inside the Cosmos MongoDB account
$cosmosNoSqlDBName	This will be used to provision a new Azure Cosmos NoSql account name
$cosmosNoSqlDatabase	This will be used to provision a new Database inside of the Cosmos NoSql account
$appServiceWindowsPlanName	Windows app service plan name
$appServiceLinuxPlanName	Linux app service plan name
$fmApiAppServiceName	KLapper file manager app service name
$frameworkAppServiceName	KLapper framework app service name
$docConversionAppServiceName	KLapper document conversion service name
$openAIServiceName	Azure Open AI service name
$entraAppName	Azure Entra app name
$builderUrl	Azure Entra app name
$containerName	In case if you are planning to add a custom domain for the KLapper builder app service. Please fill in or it will be the builder app service name Ex: https://appService.azurewebsites.net
$translatorName	Translation service name

1. Navigate to the extracted folder in PowerShell
2. Run Provisioning.ps1

Post installation

Enable NoSQL Features in CosmosDB

1. Open Azure Portal
   
2. Open the newly created resource group
   
3. Open the Cosmos NoSQL DB
   
4. From left pane - Expand "Settings" - Select Features
   
5. Enable below features
   
1. Full-Text & Hybrid Search for NoSQL API (preview)
   
2. Vector Search for NoSQL API
   

Grant Permission to Entra App

Grant “Contribute” access to Entra App on the resource group, so KLapper can dynamically provision Azure Bot Services as part of assistant creation process

Add SQL Permissions (Optional)

1. Create a contained database user for the Service Principal
   
1. CREATE USER [AppRegistrationName] FROM EXTERNAL PROVIDER;
   
2. Assign the desires roles to the Service Principal
   
1. ALTER ROLE db_datareader ADD MEMBER [AppRegistrationName];
2. ALTER ROLE db_datawriter ADD MEMBER [AppRegistrationName];
3. ALTER ROLE db_owner ADD MEMBER [AppRegistrationName];

Configuring Builder Settings

Troubleshooting

Azure Open AI Deployment Failed

In this case we must manually deploy gpt-4o model

Updating KLapper

1. Go to global settings
   
2.  Click update and proceed
   

How to add a custom domain for KLapper

1. Head to the Azure portal, and navigate to the resource group that was created for KLapper
   
2. Open the KLapper Builder App Service
3. From the left column, select Custom domains