Document toolboxDocument toolbox

Administration related properties

The properties listed here allow you to set the administrative properties for the Kyvos Web portal.

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

monitor

refreshInterval: Controls auto refresh time(milliseconds) on monitor tab info 

maxRows: Controls the number of records to be fetched in the audit log on Activity Monitor.

pastDaysCount: Used in the filter in the completed process. Default value for completion time in days.

pastHoursCount: Used in the filter in the completed process. Default value for completion time in hours.

futureDaysCount: Day limit for showing future scheduled jobs.

"refreshInterval" : 60000,

"maxRows" : 300,

" " : 3,

"pastHoursCount": 12,

"futureDaysCount" : 7

Custom user defined

file

allowSqlBasedFile: Controls if SQL based file is to be supported or not at the register file step

enableHiveSQLInterface: Controls if Hive SQL interface is to be shown which is used for Kyvos 365 for adding the ability to add tables in HCatalog by providing SQL.

"allowSqlBasedFile":false,

" ": false

true/false

dataSets

allowDatasets: Controls view of datasets and its instances in the app

"allowDatasets" : true

true/false

semantic model 

allowSMExportForPBI: Enables or disables exporting the semantic layer view of the Kyvos semantic model for Power BI, which can be used when connecting using the Spark SQL connector.

"allowSMExportForPBI" : true

true/false

localRepository properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

allowed

Controls if entity data is to be stored in indexDB/browser local storage or not

true

true/false

cacheWidgetData





true/false

quota

Maximum size of data which will be stored in local storage/indexDb for respective entities

"CUBES":5000,

"WORKSHEETS":5000,

"WIDGET_DATA":20000,

"TRANSACTION_LOG 5000,

"CUBES_WC2":5000,

"WORKSHEETS_WC2":5000,

"TRANSACTION_LOG_WC2":5000

Custom user defined

i18n properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

default

File name for default language file

en_US

 Language file name

enabled

If language change is enabled on the login page

true

true/false

languages

Contains an array of available languages along with its key for the file name, name of the language and default message

[{"key": "en_US", "name": "English - US","msg":"Welcome"}]

Language information like key/file name, language name and message

recentList properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

limit

Controls the number of recent list items to be shown on the home page (used but not working)

50

Numeric value for recent list count



entityList properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

limit

Controls number of folders/entities to be fetched for datasets, semantic model, relationship designer, and workbook listing.

500

Numeric value for entity list to be fetched

entityProperties properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

descLimit

description text character limit for entities

200

Numeric value for character limit for description

autoValidate

Controls if entities are to be validated/tested at the load of the entity

true

true/false

escapeData properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

enabled

Not used

false 

true/false

licenseExpiry properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

licenseExpiry

Controls the number of days prior to which a warning message will be shown to the user for license expiry

15

Numeric value for the number of days

copyToClipBoard properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

enabled

Controls, if copy to clipboard in the Kyvos application, is to be enabled or not

true

true/false

wc2Route properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

"setup":true,

"monitor":true,

"relationships":true,

"files": true,

"cubes": true,

"angular7HomePage":true,

"summary": true,

"viewer": true

Controls navigation to angularJS or migrated angular app; if true, URLs for the mentioned entities will be navigated to the migrated angular app.

 

NOTE: Redirection to angularJS is no longer supported now.

"setup":true,

"monitor":true,

          "relationships":true,

          "files": true,

          "cubes": true,

          "angular7HomePage":true,

          "summary": true,

          "viewer": true

true/false

homePage properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

viewType

Controls view the type of recent list, values can be LIST and TILE

NOTE: If viewType is defined in user preferences then that will take precedence over portal properties

LIST

LIST/TILE

help properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

baseURL

Base URL, which is used to redirect users to particular documentation from the Kyvos app

 

Base URL in string

appendVersion

Controls if the version needs to be appended in the URL of the documentation. 

true

true/false

supportInfo properties

Property

Description

Current Value

Possible values

Property

Description

Current Value

Possible values

email

email for support of the Kyvos application

support@kyvoinsights.com

Email ID to contact Kyvos support

Zendesk integration properties

Property name: feedbackHelpCenterUrl in zendeskConfig object

"zendeskConfig": {
"formId": "",
"fieldIds": {
"visibility": "",
"type": "",
"environment": "",
},
"feedbackHelpCenterUrl": "",
}
Description: This property is part of zendeskConfig object. Valid value will be the URL of Zendesk's help center, where users can track tickets after logging in.  Users will be able to track all their tickets through this Zendesk help center (separate web portal) that has been configured by the Kyvos support team.

Default value: ““

Application: Using the URL, users can track their issues and feedback.

Comes into effect: This is a hot deployed property. Administrators can change it, refresh the application URL in the browser, and users will start seeing the updated behavior on the portal as per the configured value.

Impact Area: Feedback system.

Environment: Applicable in all environments

Copyright Kyvos, Inc. All rights reserved.