Spreadsheet Download

This feature downloads data from the backend and converts it to a Spreadsheet file.
In the future, the feature will allow users to upload data in order to update the data in the backend.
The main difference between this feature and the integrated Spreadsheet Download is that it can download data from multiple entities at once.

For example, if you have Orders and OrderItems, you can download both entities at once and the data will be structured in the Spreadsheet file in a way that allows for easy data updates and re-uploading.
It is also possible to recursively download data from multiple entities indefinitely.

• Orders
  • OrderItems
    • Info
  • ShippingInfos

This means that you can download all Orders, including the OrderItems, ShippingInfos, and the Info of the OrderItems.

Configuration¶

Sample Usage¶

The configuration is done in the pro section of the component data.

componentData: {
    context: this,
    activateDraft: true,
    pro: {
        spreadsheetExportConfig: {
            deepLevel: 2,
            deepExport: true,
            addKeysToExport: true,
            filename: 'MyExport'
        }
    }
}

addKeysToExport¶

default: false

This option adds hidden keys to the export, such as GUIDs that are usually hidden in the UI. These keys are necessary for updating data from the file in the future.

filename¶

default: Entity Name of Root Entity

This option defines the filename for the export XLSX file.

deepExport¶

default: false

This option determines whether sibling entities should be exported as well.

deepLevel¶

default: 1

This option defines how deep sibling entities should be exported.

showOptions¶

default: true

This option determines whether the options dialog should be shown to the user.

API¶

triggerSpreadsheetDownload¶

This method triggers the Spreadsheet Download without the need to open the spreadsheet upload dialog.
The input parameter for triggerSpreadsheetDownload is the same as the configuration for the spreadsheetExportConfig in the pro section of the component data.
You can overwrite the configuration from the component data by passing the configuration to the triggerSpreadsheetDownload method.

download: async function () {
    this.spreadsheetUpload = await this.editFlow
        .getView()
        .getController()
        .getAppComponent()
        .createComponent({
            usage: "spreadsheetImporter",
            async: true,
            componentData: {
                context: this,
                activateDraft: true,
                pro: {
                    spreadsheetExportConfig: {
                        deepLevel: 1,
                        deepExport: true,
                        addKeysToExport: true
                    }
                }
            }
        });
    this.spreadsheetUpload.triggerSpreadsheetDownload({
        deepExport: true,
        addKeysToExport: true
    });
}