/
Managing Configuration files
Document toolboxDocument toolbox

Managing Configuration files

Owned by Sarabjeet Kaur
Last updated: Mar 28, 2025
3 min read

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)

Note

You can see the last operation details, including progress status and start time, by clicking the i icon. To view more comprehensive details, simply click the View Details link, which will take you to the Operations page, where you can view the operation information in detail. 

You can upload configuration files from Kyvos Manager to sync the current state of the cluster.

  1. On the navigation pane, click Utilities > Manage Configuration Files.

  2. On the Manage Configuration Files page, navigate to the file that you want to update and click the corresponding Upload button.

Important

We recommend creating a backup of all the files that you are updating, as Kyvos may not preserve these files during the upgrade.

  1. Click the Choose File button to locate the configuration file from your computer network and click the Upload button.

Important

You must ensure the correctness of file content before upload, as Kyvos Manager will not validate the contents.

  1. Click the Save button from the top-right of the screen.

Integrating Kyvos with host applications for Conversational Analytics

  • To integrate Kyvos with host applications, configure the User Interface (UI) elements for chat sessions:

    1. On the Manage Configuration page, download the ‘integration.config.json’ file.

    2. Open the downloaded file and add the necessary configurations, which include: ‘clearChat’, ‘showMetadata’, ‘showSelectedSemanticModel’, and ‘allowSemanticModelChange’.

    3. Set the value of these configurations to true if you want them to be displayed. By setting these configurations to true, the corresponding features will be displayed in the integration mode.

    4. Once you have made the changes, upload the file back on the Manage Configuration page.

  • In the Kyvos integration mode with host applications, to add a new chat session as a worksheet from a URL, the host application must send the following URL to Kyvos:

<KyvosPath>/kyvosIntegration.jsp?page=workbooks&workbookName=<%Workbookname%>&folderName=<%Folder%>&cubeName=<%CubeName%>&cubeFolderName=<%CubeFolder%>&cubeId=<%CubeId%>&sheetType=QNASHEET&actionCode=ADD

Uploading Synonym file for Elastic Search

To configure Elastic Search Service, you must download the synonym.xls file. Ensure that you must not change the name of the synonym file while saving the file.

Using the Synonym file

  1. Download the file. In the file, add the actual value and its synonym you want to use for elastic search.

    image-20250328-115759.png

  2. Save the file without changing its name.

  3. Upload the file.

Uploading the Synonym file

  1. On the Manage Configuration page, expand Kyvos >Commons>kyvos/commons/config/kyvossearch.

  2. Upload the updated synonym file.

  3. Click Save.

image-20250325-140127.png

Related content

Copyright Kyvos, Inc. All rights reserved.