The Data Export function enables users to download CoolPlanetOS data sources for a selected date range and rollup interval. The downloaded file is in a CSV file format.
Tot create a new Data Export navigate to the Data Export section of the UI. This is found under "Admin" in the high-level menu items.
This will open the Data Export List Screen. This screen displays a list of previously created Export Configurations and outlines the number of times a Data Export file has been previously exported.
To create a new Data Export click on the "New Data Export" button located in the top right-hand corner of this screen. This will launch the "Create a Data Export" screen.
Once the Data Export is given a name the Data Export Configuration can be created. It is initially created with default file outputs.
The Configurable output fields are as follows:
Timestamp Format
This is the format the user wants the timestamp to display in the output file.
Default -> yyyy/MM/dd HH:mm:ss
Delimiter
This is the delimiter used in the outputted CSV file.
Default -> ","
Decimal Separator
The separator that is used for decimals in the outputted file.
Default -> 1.0
Null Value
The value to use if a timestamp has no data.
Default -> Blank (No Null Value replacement)
Boolean Values
The values to use for True or False.
Default -> "true or false"
Once the Data Export has been correctly configured, Datasources need to be selected to include in the outputted file. This is done from the "DataSources Used" tab below the configuration options.
Click "Add DataSources" to then select Datasources to add to the export. These can be found using the "Find DataSource" modal and standard filters or Datasource name search bar.
Once they have been selected from the modal they will then be displayed in the UI. The order of these can be changed by dragging the rows positions. Once all Datasources are selected the user clicks on "Save Changes" to keep these datasources and save the configuration.
Once the Export is saved the user can then run the File export. This is done from the "Export Run History" tab using the "Run a New Export button" in the top right of the UI.
This will then launch the modal to select the date range (Last Month, Last Week, etc) and the rollup interval of the data (hourly, daily, etc). Click "Export" to then export the file to your local machine/folders.
The export function is then ran and depending on the length of the date range selected by the user, it will take longer to successful download. Once the file is successfully downloaded the status of the export will show a green tick as shown below.
The file will show a status of a clock when it is being downloaded and will then show the green tick if it successful or a red cross if it fails to download.
The Data Export with the configuration set and the Datasource selected can then be exported for any period of time and rollup interval.