Exporting Reports in JSON/SQL Formats

Owned by Mahisha Chandrakumar CTOO (Unlicensed)
Last updated: Apr 13, 2022 by Lakshminarayanan1 S CTOO (Unlicensed)
3 min read

Canvas enables you to export the configured reports in JSON and SQL formats. You can use this feature to promote reports configuration from one environment to another, e.g. development to testing servers. Once you export the reports configuration in JSON format from source environment (e.g. development), you can then inject using the Import feature in Sigma Studio on the target environment (e.g. testing). If you have exported in SQL format from the source environment, you must execute the exported SQLs on the DB in the target environment.

It is essential that the appropriate connection, data source and data source aggregators used for the exported (downloaded) reports, should also be exported in the JSON format, so that the entire sets of configurations applied for the report could be used as individual JSON structures. Even for exporting the reports in the SQL format, t is essential that the appropriate connection, data source and data source aggregators used for the exported (downloaded) reports, should also be exported in the SQL format, so that the entire sets of configurations applied for the report could be used as individual SQL statements.

Perform the following to export the report configuration:

Steps to export report metadata in JSON format:

  1. Click Information Report menu from the left navigation in Sigma Studio.
    A list of configured reports appears on the right-side of the page.

  2. Right-click an existing report and click Generate JSON.

  3. Click OK to the success message.


The JSON file containing the report metadata is exported with the component ID as filename as highlighted in the following screenshot.

Steps to export report metadata in SQL format:

  1. Click Information Report menu from the left navigation in Sigma Studio.
    A list of configured reports appears on the right-side of the page.

  2. Right-click an existing report in Sigma Studio and click Generate SQL.

  3. Click OK to the success message.


The SQL file containing the report metadata is exported with the component ID as filename as highlighted in the following screenshot.

Copyright © Intellect Design Arena Limited.

All rights reserved. These materials are confidential and proprietary to Intellect Design Arena Limited and no part of these materials should be reproduced, published in any form by any means, electronic or mechanical including photocopy or any information storage or retrieval system nor should the materials be disclosed to third parties without the express written authorization of Intellect Design Arena Limited.