Exporting semantic model metadata

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 export semantic model metadata for use with other applications. Use these options to export a semantic model that you want to use for analysis within Tableau and Power BI.

When you export the semantic model data for Tableau, you need to indicate which Tableau version it will be used with. You don't need to provide connection details, as the metadata and connection information are included.

For Tableau, verify the server IP address, port, and username to use for the connection to the original semantic model source or update it if needed. The username must have rights to the semantic model data.

Choose one of the following formats:

Tableau Data Source (Spark SQL)
Tableau Data Source (Kyvos ODBC). The Tableau version should be 2019.4 or later.
Power BI Data Source

Note

From Kyvos 2024.2 onwards, exporting semantic model metadata in a TDS or PBIT file will include the Kyvos measure format. This format will be applied when the file is imported into Tableau or Power BI, respectively.

The steps to export the semantic model metadata for Tableau Spark SQL and Kyvos ODBC are the same, as explained below.

Exporting semantic model metadata for Tableau

To export semantic model metadata, perform the following steps.

From the Toolbox, click Utilities > Export Semantic Model Metadata.
The Export Semantic Model Metadata window opens in a new tab.
Select the semantic models you want to export data from by doing one of the following:
1. Type in the Search box to quickly find items.
2. Select the checkbox next to the folder or file name.
3. Click Select All in any of the columns to select all items shown.
Click Download All or Download Selected.
The Download Selected Semantic Model Metadata dialog is displayed.

Alternatively, click the Action menu appears on the right side of the semantic model page next to the Properties pane. Click Export Semantic Model Metadata. The Download Selected Semantic Model Metadata dialog is displayed.
Choose the format and specify the Tableau version.
Update the Server IP and port details if needed, or use the ones listed.
Select Save Username in file to save the username with the data.
If you select this option, use the default choice or enter a username.
Click Download.

Note

If the semantic model consists of calculated measures, the calculated measure column is exported as a part of the file with the distinct count as its aggregate function.

As a separate process, you will need to upload the resulting file to the destination where you intend to use it.

Exporting semantic model metadata for Power BI

To export semantic model metadata for Power BI, perform the following steps.

Connect to Power BI using Spark SQL. See the Connecting to Power BI using Spark SQL for more details.
Export Power BI template. To do this, go to File > Export > Power BI template.
From the Toolbox, click Utilities > Export Semantic Model Metadata.
The Export Semantic Model Metadata window opens in a new tab.
Select the semantic models you want to export data from by doing one of the following:
1. Type in the Search box to quickly find items.
2. Select the checkbox next to the folder or file name.
3. Click Select All in any of the columns to select all items shown.
Click Download Selected.
The Download Selected Semantic Model Metadata dialog is displayed.
Alternatively, click the Action menu appears on the right side of the page adjacent to the Properties pane. Click Export Semantic Model Metadata. The Download Selected Semantic Model Metadata dialog is displayed.

Note

By selecting this checkbox, Kyvos will create Power BI custom calculations that sends the totals and subtotals queries to Kyvos. This is required to accurately show values for advanced measures like calculated measures, semi-additive measures, and advanced hierarchies with custom rollups.

Select the format as Power BI Data Source (Spark SQL).
Select the Power BI template from your local computer that you downloaded after connecting to Power BI using Spark SQL.
Click Convert and Download. The Semantic model is converted to a folder structure.
Open the downloaded the PBIT file in Power BI where the semantic model has been converted into a folder structure. Now, you can view the identical folder structure in Power BI as the one found in the Kyvos Web Portal.

Important

To obtain an accurate semantic model structure, the user should upload the Power BI template file to the same semantic model that they have exported using Spark SQL connector initially.

Default Summary functions for TDS and PBIT files

The following are the default summary functions for TDS and PBIT files when exporting semantic model metadata from Kyvos.

	Tableau TDS File		Power BI PBIT File
Summary Function	Without Advanced hierarchy	With Advanced Hierarchy	Without creating Power BI calculations for advanced Kyvos resources	With creating Power BI calculations for advanced Kyvos resources
Sum	Sum	Percentile	Sum	Custom calculation
Average	Average	Percentile	Average	Custom calculation
Count	Count	Distinct Count	Count	Distinct Count
Distinct count	Distinct Count	Distinct Count	Distinct Count	Distinct Count
Min	Min	Min	Min	Min
Max	Max	Max	Max	Max
Semi-additive	Percentile	Percentile	Distinct Count	Custom calculation
MDX Calculated Measure	Percentile	Percentile	Distinct Count	Custom calculation