Managing Configuration files

This documentation is for Kyvos 2026.2.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.2.x. To view documentation for other Kyvos versions, click here.

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

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

This section explains how to manage and upload configuration files in Kyvos Manager to synchronize configuration changes across the Kyvos cluster, allowing administrators to update system configuration files, templates, and integration settings used by different Kyvos components.

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.

On the navigation pane, click Utilities > Manage Configuration Files.
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.

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.

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 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

Download the file. In the file, add the actual value and its synonym you want to use for elastic search.
Save the file without changing its name.
Upload the file.

Uploading the Synonym file

On the Manage Configuration page, expand Kyvos >Commons>kyvos/commons/config/kyvossearch.
Upload the updated synonym file.
Click Save.

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:

On the navigation pane, click Utilities > Manage Configuration Files.
On the Manage Configuration Files page, click the Kyvos folder to expand, and then click Query Engine > /kyvos/queryengine/bin/ > start-yarn-cs.sh
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"
Upload the start-yarn-cs.sh script.
Click the Save button from the top-right of the screen.
Restart the Analytical 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

Note

The sum of CS_HEAP_MEMORY, CS_OFF_HEAP_MEMORY, and CS_ANALYTICAL_STORE_BUILD_MEMORY should be less than or equal to CS_CONTAINER_MEMORY - 4GB.
Before switching compute type from shared Query Engine compute to Dedicated Compute, stop all Analytical Servers and Query Engines (QE-based Appmaster).

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.

On the navigation pane, click Utilities > Manage Configuration Files.
On the Manage Configuration Files page, click the Kyvos folder to expand, and then click Analytical Server > /kyvos/olapengine/conf/dataExport/en_US/ > csvMetadataTemplate.txt
Download the template file. In the file, you can view the following:
Make the changes in the template file as needed and save it.

Note

If you remove a field from the template and later need it, you must add the field and upload the template again.

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

Configuring SQL Expressions-based Row-Level Security

Go to Kyvos Manager > Manage Configuration Files > kyvos/olapengine/conf/RLSconf
Specify the configuration details in the RLSConfiguration.json file.
Sample RLSConfiguration file
{ "commonAttributes": { "syncFrequency": "1", "connectionFileName": "Big-Query-Connection.xml" }, "semanticModels": [ { "semanticModelId": "17702985232058127070077138174032", "userIdentifierColumnInRuleTable": "User_Name", "fetchRulesQuery": "select * from dev-enterprises-273509.ds.identity_bitmap_rules", "rlsRuleQuery": "((is_amaas_enabled = sm.is_amaas_enabled) AND (division_code_bitmap & sm.amaas_division_bitmap) > 0 AND (job_function_level1_bitmap & sm.amaas_job_function_bitmap) > 0 AND ((organization_level2_bitmap_1 & sm.amaas_hub_bitmap1) > 0 OR (organization_level2_bitmap_2 & sm.amaas_hub_bitmap2) > 0 OR (organization_level2_bitmap_3 & sm.amaas_hub_bitmap3) > 0 OR (organization_level2_bitmap_4 & sm.amaas_hub_bitmap4) > 0 OR (organization_level2_bitmap_5 & sm.amaas_hub_bitmap5) > 0) AND ((signature_code_bitmap_1 & sm.amaas_signature_bitmap1) > 0 OR (signature_code_bitmap_2 & sm.amaas_signature_bitmap2) > 0))", "columnMappings": { "sm.is_amaas_enabled": "Is amaas enabled", "sm.amaas_division_bitmap": "amaas division bitmap", "sm.amaas_job_function_bitmap": "amaas job function bitmap", "sm.amaas_hub_bitmap1": "amaas hub bitmap1", "sm.amaas_hub_bitmap2": "amaas hub bitmap2", "sm.amaas_hub_bitmap3": "amaas hub bitmap3", "sm.amaas_hub_bitmap4": "amaas hub bitmap4", "sm.amaas_hub_bitmap5": "amaas hub bitmap5", "sm.amaas_signature_bitmap1": "amaas signature bitmap1", "sm.amaas_signature_bitmap2": "amaas signature bitmap2" } } ] }
Specify the following configuration parameters details as:

Parameter	Description

Parameter	Description
Common Attributes	Defines global settings applied across all semantic model configurations.
SyncFrequency	Defines the refresh interval (minutes) for synchronizing security rules. The system reruns fetchRulesQuery at this interval to update user permissions. Lower values enable near real-time updates but increase database load.
ConnectionFileName	Specifies the connection configuration file name as defined in Kyvos. It must exactly match the name used during connection setup in Kyvos. This file establishes connectivity to the external data source containing RLS rules.
semanticModelId	Unique identifier of the target semantic model used to associate security rules with the correct semantic model.
userIdentifierColumnInRuleTable	Identifies the column in the RLS rules table with user identifiers. Supports formats such as email addresses, usernames, and employee IDs. Matches authenticated users to their security rules.
fetchRulesQuery	SQL query that retrieves user-specific RLS rules from the external rules table. It executes over the connection specified in connectionFileName and returns all columns required for bitmap filtering operations. The query re-executes periodically based on the syncFrequency setting
RlsRuleQuery	Defines the row-level security filter logic applied to user queries using bitwise AND (&) and OR operations to evaluate access permissions. It references columns from both fetchRulesQuery results and semantic model columns. It applies automatically to every query users execute on the semantic model
columnMappings	JSON object mapping query aliases to semantic model column names. Left side: alias used in rlsRuleQuery, typically prefixed with "sm." Right side: actual column name as defined in the semantic model Enables flexible query construction independent of column naming.