Page Comparison

HTTP

HTTP

Kyvos pages can open in the host application as Inline Frame (iframe) element.

HTTP

HTTPS

Kyvos pages can open in the host application as an iframe.

HTTPS

HTTPS

Kyvos pages can open in the host application as an iframe.

HTTPS

HTTP

Kyvos pages can open in a new browser window, but not in an iframe.

As this may be a security threat to the secure host application, the browser does not support opening as iframe.

Request parameter

Value

Description

Page

Usecase Name

Name of the Kyvos functionality/use case to open. Allowed values are:

• workbooks: Allows users to access Kyvos workbooks from the host application.

• semantic models: Allows users to access Kyvos semantic models from the host application.

• relationship: Allows users to access Kyvos relationship designer from the host application.

• datasets: Allows users to access Kyvos datasets from the host application.

• files: Allows users to access Kyvos file registration from the host application.

• monitor: Allows users to access Kyvos Activity Monitor from the host application.

• users: Allows users to access Kyvos user configuration from the host application.

• groups: Allows users to access Kyvos groups configuration from the host application.

• connections: Allows users to access Kyvos connection configuration from the host application.

• license: Allows users to access the Kyvos license screen from the host application.

• export semantic models: Allows users to access the Kyvos user configuration from the host application.

• import: Allows users to access Kyvos import functionality from the host application.

• export: Allows users to access Kyvos export functionality from the host application.

name

Entity Name

Name of the entity to open from the host application. For example, the name of the semantic model, dataset, or dashboard, etc.

id

Entity ID

The ID of the entity to open from the host application.

NOTE: Use this parameter if the name is not available.

folderName

Name of the folder

If the entity to be opened is placed in a folder, then provide the folder name in this parameter. If the entity is not contained within any folder, then ignore this parameter.

folderId

Folder ID

The ID of the entity containing the folder to open from the host application.

NOTE: Use this parameter if the name is not available.

workbookName

Name of the workbook

Name of the dashboard or worksheet to open from the host application.

workbookId

Workbook ID

The ID of the workbook to open from the host application.

NOTE: Use this parameter if the name is not available.

<EXT_AUTH_HEADER_ID>

Authentication token parameter

Value of this parameter is the token(sessionId) received from the successful Kyvos login REST API response. Name of this parameter is defined in kyvosclient.properties. (For more details, please refer user authentication section below in the same document.)

mode                    

Mode Name

This parameter is optional.  Set this value to the name of the mode(defined in integration.config.json), so that when workbook use case is loaded with the URL, all configuration related to that mode will be applied on the viewer workspace. For example, mode=”VIEW”

overrideConfig

Config to override Integration.config.json

This parameter is optional. A comma-separated list of properties to override the property in integration.config. For example, header.show:false,usecases.listing:false,header.homeIcon:false.

actionCode

Action Code

This is an optional parameter. The possible values are:

• add: Use this to add a worksheet in a workbook.

• addWorkbook: Use this to add a workbook inside a folder or root.

• Show: Use this to open a worksheet or dashboard.
  The default value is Show.

integrationId

Integration identifier

This parameter is optional, possible value is any unique string, that will be used to identify a particular kyvos application in embedded mode.  This identifier will be used to map runtime communication between a particular iframe (Kyvos application) and host application, when multiple iframes are there.