Exporting and importing workbooks

In DataLens, you can move workbooks between installations using export and import tools. For example, you can export a ready-made workbook with its settings and links from cloud DataLens to an open source installation.

Note

  • You can only export and import workbooks.
  • Some connection types are not available for export and import.

Exporting a workbook

To export a workbook:

  1. In the left-hand panel, select Collections and workbooks.

  2. Use one of the following methods to start exporting the workbook you need:

    • Next to the workbook, click → Export.
    • Open the workbook and click → Export at the top.

  3. Click Export. You can see the progress in the indicator. Note the following:

    • Workbooks are exported to a JSON file.
    • Export may take a few minutes.
    • Sensitive connection data is not saved. During import, the user will have to set up connections again, e.g., specify a token or enter a password.
    • Other DataLens versions may not support certain connection types. During import, such connections will not work.

    If you try to close the indicator window before the export is complete, you will get the cancel export warning. Select:

    • Return to continue the export.
    • Cancel export to stop it.

Once the export is complete, you may get warnings with workbook details and a list of objects requiring attention. To download the export file in JSON format, click Download.

Tip

You can edit the exported JSON file, e.g., add a password for a connection. However, DataLens does not guarantee successful import and correct operation of the workbook if you manually edit its configuration. We recommend that you carefully review all changes before import to mitigate possible issues.

If the workbook export fails, you will get an error message. Try to fix the error and re-export the workbook.

Importing a workbook

To import a workbook:

  1. In the left-hand panel, select Collections and workbooks.

  2. In the top-right corner, click Create → Create workbook.

  3. In the workbook creation window:

    1. Enter a name for the workbook.

      Note

      The workbook name must be unique within the selected collection.

    2. At the bottom, click Select file and select the JSON file with the workbook configuration.

    3. Click Create.

    You can see the import progress in the indicator. If you close the indicator window before the import is complete, it will not be interrupted. While the import is in progress, you will see the new workbook in the workbook list labeled as Importing, and selecting it will open the import progress window.

Once the import is complete, you may get warnings with details of the imported workbook and a list of objects requiring attention. To go to the new workbook, click Open workbook. You can configure additional settings if you need to, e.g., enter a password for a connection.

If the workbook import fails, you will get an error message. Try to fix the error and re-import the workbook.

Limitations

These connection types are not available for export and import.

Previous
Creating workbooks and collections
Next
Errors and warnings during export and import