The following Python script allows exporting dashboard data to CSV files.
The script will export each widget to a separate CSV file.
The script uses the data from the Sisense mongodb to build the widgets' JAQL queries and the Sisense REST API to execute the queries.
Download
Export script zip package - Requires Python 3.6 installation on the server with additional packages as listed below.
Export script zip exe- Does not require Python installation on the server.
Release Notes_UPDATED_3_18_2019
NOTE: The required Python packages can be installed using the requirements.txt file attached, by running the following command:
pip install -r requirements.txt
Settings
The script uses a settings.yaml file. You should configure the following settings:
|
Admin email address. If you're using the api token to authenticate leave this value blank. |
|
| password |
Admin password. If you're using the api token to authenticate leave this value blank. |
| api_token |
The API token can be use instead of the password. To retrieve you API token use the POST /authentication/login REST API command. See here form more info. |
|
Note: The admin email and password are used for retrieving the API token. The token is required for running API command. See the REST API documentation for more information. |
|
| file_logLevel |
Log level for the log file. Available options: DEBUG INFO WARNING ERROR CRITICAL |
| console_logLevel |
Log level for the console. Available options: DEBUG INFO WARNING ERROR CRITICAL |
| mongoPort |
Mongodb port. Default: 27018 |
| mongoWriteUserPass |
Password for the mongodb WriteUser. If you haven't set one up see here for instructions. |
| protocol |
Protocol for accessing Sisense http or https. Default: http |
| port |
Sisense port. Default 8081 |
| host |
Sisense host. Default: localhost |
| csvFilePath |
CSV files output directory |
| csvFileNameConvention |
Naming convention for the generated CSV files. Options are: WIDGET_NAME (e.g. Total csv) WIDGET_AND_DASHBOARD_NAME (e.g. Total Revenue_Sales Dashboard.csv) WIDGET_AND_DASHBOARD_ID (e.g. 5783b9eb25ddaf78420000a6_56f1aa1dbc4b62043a000028.csv) |
Running the Script
Running the .py script
From a command line window, as administrator, run the following command:
C:\>python <path to script>\exportDashboardToCSV.py <dashboardIDs to export separated by spaces>
The script will create an output directory 'csv' in the scripts directory.
Each widget in the dashboard will be exported to a separate CSV file named as: dashboardID_widgetID.csv
Running the executable
From a command line window, as administrator, run the following command:
C:\>python <path to script>\exportDashboardToCSV.exe <dashboardIDs to export separated by spaces>
The script will create an output directory 'csv' in the scripts directory.
Each widget in the dashboard will be exported to a separate CSV file named as: dashboardID_widgetID.csv