Document toolboxDocument toolbox

Exporting data to a cab file

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

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


When you export data, you create a cab file that is downloaded to your local machine. You can choose to include metadata to use for comparing clusters during the import process. That metadata is only used for comparison purposes, it is not deployed. If the semantic model contains aggregates, the aggregate data is included.

You can export the following types of data:

  • Users

  • Groups

  • Roles

  • Datasets

  • Relationships

  • Semantic Model

  • Workbooks

  • Templates

  • Source entities

  • Dependent entities

Included by default

  • Schedule

  • Advanced properties

  • Security settings

To export data, perform the following steps. 

  1. From the Toolbox, choose Utilities > Export Objects.
    The Export Objects window opens in a new tab.

  2. Select each entity you want to export and choose the specific data you want.

    1. Do one of the following:

      1. Type in the Search box to quickly find items.

      2. Click the checkbox next to a folder.

      3. Select All in any of the columns where you want to select all items shown.

    2. Do this for each type of entity you want to include in this cab file.

  3. Confirm that the summary indicates the correct data has been selected, and choose one of the following:

    • To export all entities, click Export All.

    • To export selected entities, click Export Selected. 

    • To export related entities, right-click the selected semantic model and click the Properties link to select all related entities. Then click Export Selected.

  4. Enter the Name, Author, Version, and Description.

    1. Depending on the data type selected you may see additional options such as:

      1. Deployment options: Choose Overwrite or Delete to specify whether you want to overwrite or delete existing data at the time you import this data.

        • If you choose the Overwrite option, any existing entities are overwritten.

        • If you choose the Delete option, any existing entities are deleted. 

      2. Include: Select the items you want to include, such as the build schedule, advanced properties used with the data, data security settings, cache population rules, source entities (such as the datasets used to create a dataset for example), or dependent entities (such as semantic models based on a dataset relationship).
        You will see the number of sources and dependent entities selected next to the checkbox.

  5. For comparison only: Select to export the table metadata of the selected file. Note that the metadata is not deployed to the target cluster but is used to compare clusters during the import process.

  6. Click Export & Download. The Export dialog box displays the status of exported objects.

The .cab file is downloaded to your local system.

Copyright Kyvos, Inc. All rights reserved.