Export Data

The Export Data Tool is an easy way to export data from Fuuz into different formats. The process starts by first creating an Export Configuration. An Export Configuration contains a field for a data model and filters. Currently, there are two supported export format options: JSON or CSV. When a configuration is ran, a new Export History is created which contains information from the parent Export Configuration and any information specific to that export. Each completed export will have a download link generated that will be available for 30 days before the export file will be deleted, although the Export History record will remain. Once the export process is finished, the user that initiated the process will be receive an email containing a link to the Export History Form where the download link will be shown.

Fuuz → System → Data Management → Export Data

The left most panel is a table that display all of the Export Configurations in the tenant.

The middle panel is the form where you can configure new or edit existing Export Configurations.

The right most panel will show a preview of the exported data as well as the amount of records estimated to be returned.

Export Configuration Table

The Export Configuration Table shows all of the Export Configurations. It shows the basic information that is important for queries except for the actual selected fields, as well as having 5 action buttons to interact with each configuration. The 5 different buttons are:

• Run Configuration - This will start the export process and create a new Export History record.

• Edit Configuration - This will populate the form with the configuration data so you can make changes to a configuration after creation.

• Copy Configuration - This will populate the form with the configuration data but when you save, it will create a new Export Configuration instead of updating.

• Create Preview - This will open a third panel on the right that will displays the estimated row count and a preview of the first 50 records formatted.

• Delete Configuration - This pops open a confirmation message before deleting an Export Configuration.

The Label field links to the Export History Table and the Last Run field links to the Export History Form.

Export Configuration Form

The Export Configuration Form allows you to create, edit, update, and run Export Configurations.

Whether creating, updating, or copying an existing configuration to make a new one, the process is the same. Fill in or change the necessary fields and then click either the Save or Save and Run button. If a unique Export Configuration was provided, a new record will be created. If you were editing an existing configuration from the table, it will then update that configuration. In order for the query fields and filter to properly display or populate with data, you must first select a data model to export from.

The Clear button makes it easy to reset the form if you change your mind while creating or editing and want to go back to a blank form.

Export Configuration Preview

The Export Configuration Preview panel is usually hidden but is the right most tab on the Export Data screen. It will only be shown when clicking on the copy, edit, or preview buttons.

The Estimated Row Count displays the total number of records found when executing the query with filters.

The Data Preview shows the first 50 records in the selected export format so that you can verify if all of the fields are properly included.

These preview fields are also displayed on the Export History Form.

Export History Table

The Export History Table displays all of the previously ran and currently running Export Histories.

Here, you can check out all of the Export Histories, who ran them, when they ran, and so on. To re-run an Export History, select the history and use the Retry button. This works the same way as clicking the Run button on the Export Configuration screen. A new history record will be created and start the export process again. Clicking the label of one of the histories will take you to the Export History Form of that export.

Export History Form

The Export History Form displays all of the relevant information pertaining to an Export History. The form has two different panels, the left being for the configuration of the history, and the right side dealing with the exported data and file size.

The left side contains most of the important information. Most of the fields are the same as the ones for the Export Configuration. Here, the label is slightly different in that the execution time is added to the configuration label as a way to help differentiate between Export Histories. There is also a new Export Status field which can be one of four different possibilities:

• Pending - Initial state

• Running - Currently processing

• Completed - Finished state

• Errored - Did not finish due to some error

Towards the bottom of the left side, there is a Download Link that will download the file through the browser, and a field that denotes when the download link will expire and the file will be deleted from storage.

The right panel shows some additional fields to the preview fields which updates during the export process. The Processed Row Count field is the current number of documents processed and appended to the export file. The Estimated File Size is calculated at the start of the process and gives a little warning to the user so they know what to expect when downloading the file.