Connect App Installation Requirements

A machine on which a KYP.ai Connect App (Previously called KYP Agent) is to be installed needs to fulfill some requirements for the data gathering and communication with the server to be successful. This article highlights those requirements, to be checked before installation.

⚠️ Minimum requirements are necessary to collect any data from end user machines. We advise to fulfill recommended requirements for better data collection process.

Recommended requirements are to ensure continuity and better understanding of the processes taking place in the company.

💡 If the server installation is done on premise: server address will be delivered by your IT administrator.
If the server is done by KYP on cloud: server address will be delivered to you by one of the KYP.ai Team.

Configuration

KYP.ai software added as trusted to antivirus including used directories – list of all modules with paths can be found in KYP.ai Connect App overview.

 Additionally, requirements for configuration are:

  1. Chrome Dev Tools enabled on Desktops machines  - communication on localhost, port 9222 should not be blocked (for MS Windows version only).

  2. KYP.ai Agent installed from eligible user account.

  3. Network access to the server on port 443 (https) 

  4. Permissions for supervisor process (for MacOS version only):
    - screen recording (only when functionalities that based on screenshots are enabled like OCR or Image recognition)
    - accessibility
    - access to browsers
    Detailed descriptions of those permissions could be found in MacOS manual installation guide

Software (Windows)

  1. Microsoft C++ redistributable installed/updated (comes with KYP installation package)

  2. Operating system: Windows 10 64bit (version 1809 or higher), Windows 11 64bit
    For N versions of Windows, Media Feature Pack must be installed and it is not provided with the KYP installation package.
    For more details, please go to: Media Feature Pack for Windows 10/11 N

  3. Preferred browser is Chrome. Also, MS Edge, Firefox, Island.io can be used.

  4. In case of usage of AdBlock/Antivirus software, add KYP.ai processes to the exception. A list of process names is available here: KYP.ai Connect App overview (KYP.ai Connect App modules section).
    It is strongly recommended to add to exception whole folders with sub folders:
    - install folder, e.g. "c:\Program Files\kyp-client"
    - user space folder "C:\Users\{user}\AppData\Roaming\KypClient"
    - KypCache folder "c:\Users\Public\KypCache"

  5. Mailslot interprocess communication should be available

Software (MacOS)

  1. Operating system: 14.X (Sonoma)  or higher

  2. Preferred browser is Safar. Also, MS Edge, Chrome

  3. In case of usage of AdBlock/Antivirus software, add KYP.ai processes to the exception. A list of process names is available here: KYP.ai Connect App overview (KYP.ai Connnect App modules section).
    It is strongly recommended to add to exception whole folders with sub folders:
    - application folder "\\Application\KypAgent" and "\\Application\SysTrayAgent"
    - folder in users contains log and configuration files "\\Users\{user}\Library\Kyp" and "\\Users\{user}\Library\Logs\Kyp"

  4. Rosetta (comes with KYP installation package)

  5. Command Line Tools (if not present on the system, must be downloaded and installed after first connect app start) - one of the steps in article: MacOS manual installation guide

End-User Desktop assumed average load 

  1. RAM – max 1.2 GB DDRAM/vRAM available for KYP.ai Connect App software , most of the time around 200-400 MB

  2. CPU – up to 5%, most of the time <2%.
    Values can be higher when custom feature of image recognition is on.

  3. Disk – 2 GB HDD, preferred flash storage and 1 GB HDD storage for 1 day offline functions collection, 

  4. Network load (minimum 10 Mbit link for intranet; recommended - permanent network link – 100 Mbit).
    Detailed information can be found in Network sizing.

All above parameters depend on:

  • type of actions made by user on computer, 

  • configuration of KYP system (eg. apps and process definition, screenshot size and frequency), 

  • configuration of KYP Connect App (eg. monitoring, image recognition),

  • installed hardware.