Configuration

Options¶

These options are available and explained in detail below:

columns¶

default: all fields
This option defines which fields should only be taken into account during the upload.
example:

columns: ["ID", "Birthday","FirstName","LastName"],

excelFileName¶

default: Template.xlsx
This option defines the file name when a template is downloaded.
If not defined, code checks if Label for OData Type defined.

tableId¶

This plugin checks first whether exactly one table exists in an object page. If there is no table or more than one table, an error is returned.
In case of error, the ID of the table can be specified.
example:

tableId: "ui5.isu.msb.createmeterread::RunObjectPage--fe::table::_Ableseauftrag::LineItem-innerTable

odataType¶

This plugin attempts to read the OData type from the table. In case of error, the OData Type can be specified.
example:

odataType: com.sap.gateway.srvd.zui_mr_create_run.v0001.AbleseauftragType

mandatoryFields¶

The selected fields are checked to see if they are present in the Excel file. If not defined, they will not be checked.
example:

mandatoryFields: ["product_ID", "quantity"]`

fieldMatchType¶

default: labelTypeBrackets

Options:

• label
• labelTypeBrackets

In some cases, the labels of different attributes may be identical to each other.
In order to assign the correct labels and types, there is an option to make the type visible in the header.
This way a correct assignment can be made.

Default (with label) the header columns would look like this: ID, Birthday, First Name, Last Name
With labelTypeBrackets the header columns would look like this: ID[ID], Birthday[birth_day], First Name[FirstName], Last Name[LastName]

activateDraft¶

default: false

This option defines in draft scenarios whether a draft should be activated immediately or not.
The option only defines whether the attempt should be started. If a draft activation is basically not possible, it will not be executed and may lead to errors.
This is useful e.g. in a list report. If this option is set to false, all uploaded units have to be activated manually.

batchSize¶

default: 1.000

Options:

• 0 : Payload will not be divided

For large files it is necessary to split batch requests and not to send them all at once. This batchSize option enables you to control the number of records processed in each batch request, which can help avoid memory issues and improve performance.

When the number of lines in the Excel file exceeds the specified batchSize, the payload array is divided into equal parts, with each part containing the maximum number of lines specified by the batchSize. The application then processes each part separately, sending batch requests to the backend server.

The default value is 1,000, which means that when the number of lines in the Excel file exceeds 1,000, the payload array will be divided into equal parts, and each part will be sent as a separate batch request.

If you set the batchSize to 0, the payload array will not be divided, and the entire array will be sent as a single batch request.

standalone¶

default: false

This option defines whether the plugin should be used in standalone mode or not.
If this option is set to true, no table is searched and therefore no context is needed.
The mandatory parameter context and the parameter tableId is no longer necessary.

If you want to use the template download function, you have to set the parameter columns, otherwise the Download Template button will not be displayed.
The payload will be a array of objects with the keys named like the columns parameter.

Example:

this.excelUpload.attachUploadButtonPress(function (oEvent) {
        const model = this.getModel("tableData");
        model.setData(oEvent.getParameter("payload"));
}, this);

An example of an implementation to display data of an Excelupload in a freestyle app can be found here:

UploadToTable.controller.js
UploadToTable.view.xml

strict¶

default: false

When strict is set to its default value (false), the "Continue" button is displayed in the error dialog, allowing users to proceed despite encountering errors in the uploaded data.

This option defines whether the "Continue" button should be displayed in the error dialog or not. When set to true, the "Continue" button will not be displayed, and users must resolve the errors before proceeding with the next steps in the application.

decimalSeparator¶

default: ``

This option defines the decimal separator for numbers as string.
This option is only needed if in the Excel File are numbers as strings or when importing a CSV. When the datatype in the Excel File is number, the decimal separator is automatically recognized.

hidePreview¶

default: false

This option defines whether the button to preview the uploaded data in the table dialog should be hidden or not.

skipMandatoryFieldCheck¶

default: false

This options defines wether mandatory fields defined in the metadata should be checked or not.
Only the option mandatoryFields will be checked.

showBackendErrorMessages¶

default: false

This option defines whether backend error messages should be displayed or not.
In Fiori Elements scenarios, the error messages are displayed automatically. In FreeStyle scenarios, the error messages are not displayed automatically.
If this option is set to false, only the error message Error while uploading data will be displayed.

showOptions¶

default: false

This option defines whether the button to show the options dialog should be displayed or not.
Currently, the menu is more for the development process. Later, this should also be able to be used by the user.
There are also only a few selected configurations available.