Managing Configuration files

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

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

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.
   
   

   Open

   

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

   Open

   

4. 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:

Uploading Synonym file for Elastic Search

To configure Elastic Search Service, you must first 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.

   Open

   

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.

Open

Managing Compute Server for YARN Deployments

From Kyvos 2025.7 onwards, you can now launch dedicated compute servers within YARN containers, enhancing compatibility with YARN-based on-premises deployments. This enhancement enables users to run dedicated compute servers specifically for semantic model processing, ensuring improved resource isolation, scalability, and performance.

To set up a dedicated compute server for Yarn deployments, do the following:

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

2. On the Manage Configuration Files page, click the Kyvos folder to expand, and then click Query Engine > /kyvos/queryengine/bin/ > start-yarn-cs.sh

3. Download the start-yarn-cs.sh script, and the following parameters (other parameters in this file are automated) can be modified with their default values. To modify these defaults, update the values of the following parameters:

   1. Change Application Master Name,

      1. APPLICATION_NAME: Ensure that the application name (Dedicated compute) is unique across Kyvos clusters running on the same Hadoop cluster.

      2. APP_MASTER_LOG_PATH

   2. Update containers default values in which Kyvos Compute Server will be launched as Java application,

      1. export CS_CONTAINER_VCORES=8

      2. export CS_CONTAINER_MEMORY=16384

      3. export CS_COUNT=1

   3. Update Kyvos Compute Server configurations,

      1. CS_HEAP_MEMORY="4096M"

      2. CS_OFF_HEAP_MEMORY="2048M"

      3. CS_ANALYTICAL_STORE_BUILD_MEMORY="6GB"

      4. CS_ANALYTICAL_STORE_MAX_TASK_COUNT=2

      5. AUTO_CONFIGURE_PROCESSING_TASK_COUNT="AUTO"

4. Upload the start-yarn-cs.sh script.

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

6. Restart the BI Server, then trigger a sanity semantic model job. By default, Kyvos will launch 1 Compute Server with the following specifications:

   • 16 GB Memory

   • 4 GB Heap

   • 2 GB Off-heap

   • 6 GB Analytical Store Build Memory

   • 2 Tasks

Modifying CSV Metadata Template

When exporting a worksheet to CSV and PDF formats, you can include metadata in the report. A separate text file, following the csvMetadataTemplate.txt template, is also exported and can be modified as needed.

To modify the CSV metadata template, perform the following steps.

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

2. On the Manage Configuration Files page, click the Kyvos folder to expand, and then click BI Server > /kyvos/olapengine/conf/dataExport/en_US/ > csvMetadataTemplate.txt

3. Download the template file. In the file, you can view the following:

   Open

   

4. Make the changes in the template file as needed and save it.

5. Upload the template file.

6. Click Save. The template file will be updated with your changes.

Open