-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
58 changed files
with
2,323 additions
and
193 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| "packages/ui5-cc-spreadsheetimporter": "1.5.2" | ||
| "packages/ui5-cc-spreadsheetimporter": "1.6.0" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
|
|
||
| Only V4 is supported for now. | ||
|
|
||
| ## OData V4 | ||
|
|
||
| The problem with Draft is that when updating lot of objects, the update will fail if one of the objects is not found because of the draft status. | ||
| Draft status will determined with `IsActiveEntity` property. | ||
| To make it as seamless as possible, the process will try to find every object with `IsActiveEntity=true`. This does not find objects that dont have a active entity (draft but not yet created). | ||
| The finding of the object result in a get request to the OData service for each row. | ||
| After that the process knows the state of the object and can update it. | ||
| So if on the object `HasDraftEntity` is true or `IsActiveEntity` is false, the process will create a new context with `IsActiveEntity=false` and use the draft entity automatically to update the object. | ||
|
|
||
|
|
||
| ## Technical Details | ||
|
|
||
| To get the all the objects that are imported from the spreadsheet, the process will create a new empty list binding with a filter of all the keys from the spreadsheet. | ||
| Technically is has to query for `IsActiveEntity=true` and `IsActiveEntity=false` and combine the results. | ||
| This will result in two get requests to the OData service for each row combined in two batch request for each batch. | ||
| If a row is not found it is just not included in the List Binding. | ||
| So the process will not fail if a row is not found and can match which objects are not found from the List Binding. | ||
| If a object was not found the user can then decide to continue with the found objects or to cancel the process. | ||
| Each context will then be used to update the object with `setProperty`. | ||
|
|
||
| ### Different States in Export | ||
|
|
||
| For the export the process determines the state of the object by checking the `IsActiveEntity` and `HasDraftEntity` properties. | ||
|
|
||
|
|
||
| #### List Report | ||
|
|
||
| - `IsActiveEntity=true` and `HasDraftEntity=false` -> `IsActiveEntity` column is set to true | ||
| - `IsActiveEntity=true` and `HasDraftEntity=true` -> `IsActiveEntity` column is set to false | ||
|
|
||
| #### Object Page | ||
|
|
||
| - `IsActiveEntity=true` and `HasDraftEntity=false` -> `IsActiveEntity` column is set to true | ||
| - `IsActiveEntity=true` and `HasDraftEntity=true` -> `IsActiveEntity` column is set to false | ||
|
|
||
| ### Different States in Upload | ||
|
|
||
| #### List Report | ||
|
|
||
| - `IsActiveEntity=true` and `HasDraftEntity=false` -> update the object (expecting `IsActiveEntity=true` in the spreadsheet import) | ||
| - `IsActiveEntity=true` and `HasDraftEntity=true` -> create a new context with `IsActiveEntity=false` and use the draft entity automatically to update the object (expecting `IsActiveEntity=false` in the spreadsheet import) | ||
|
|
||
| #### Table in Object Page | ||
|
|
||
| ##### Not in Edit Mode | ||
|
|
||
| - `IsActiveEntity=true` and `HasDraftEntity=false` and `HasActiveEntity=false` -> update the object (expecting `IsActiveEntity=true` in the spreadsheet import) | ||
|
|
||
| ##### In Edit Mode | ||
|
|
||
| - `IsActiveEntity=false` and `HasDraftEntity=false` and `HasActiveEntity=true` -> update the object (expecting `IsActiveEntity=false` in the spreadsheet import) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| !!! warning | ||
| This feature is currently experimental and may not work as expected. | ||
| Also only available for OData V4. | ||
| Please provide feedback: https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| It is recommended, especially for Entities with GUID, to first download the data with the Spreadsheet Importer and include the keys. | ||
|
|
||
| 1. Download the data with the Spreadsheet Importer and include the keys. | ||
| 2. Edit the spreadsheet | ||
| 3. Upload the data with the Spreadsheet Importer. | ||
|
|
||
| ## Getting started | ||
|
|
||
| The minimal configuration to update entities instead of creating is: | ||
|
|
||
| ```js | ||
| this.spreadsheetUploadUpdate = await this.editFlow.getView().getController().getAppComponent() | ||
| .createComponent({ | ||
| usage: "spreadsheetImporter", | ||
| async: true, | ||
| componentData: { | ||
| context: this, | ||
| tableId: "ui.v4.ordersv4fe::OrdersObjectPage--fe::table::Items::LineItem-innerTable", | ||
| action: "UPDATE", | ||
| deepDownloadConfig: { | ||
| addKeysToExport: true, | ||
| showOptions: false, | ||
| filename: "Items" | ||
| }, | ||
| showDownloadButton: true | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| This configuration will show the download button and download all the available data for the referenced table. | ||
| When you press the download button, the data will be downloaded including the keys necessary for the update. | ||
|
|
||
| You can then change the data in the spreadsheet and upload the data again. | ||
| By default, only the changed properties are updated (partial update). You can change this by setting the `fullUpdate` property to `true` (see [Configuration](#configuration) below). | ||
|
|
||
| ## How it works | ||
|
|
||
| When you upload the file to the App, it will do the usual checks if the columns are in the data model and the data is valid (see [Checks](./Checks.md)). | ||
| When the user presses the upload button, it will fetch all the data in the batch. To make sure all the data is fetched, it will fetch the data for active and draft separately. So for every batch a ListBinding is created and two requests are made with filters for the keys and for `IsActiveEntity = true` and `IsActiveEntity = false`. This is needed because of the separation of active and draft (see [why requests fail in CAP with OData draft enabled](https://cap.cloud.sap/docs/get-started/troubleshooting#why-do-some-requests-fail-if-i-set-odata-draft-enabled-on-my-entity)). | ||
|
|
||
| This data is used to determine if the object is in draft or active mode, if the object exists at all, and for partial updates whether a field is changed. | ||
|
|
||
| For every change, an `ODataContextBinding` is created and the data is updated. | ||
|
|
||
| ## Things to consider / Drawbacks | ||
|
|
||
| ### IsActiveEntity handling | ||
|
|
||
| The column `IsActiveEntity` states the current state of the object (Draft or Active). In the spreadsheet file, the current state must match the state of the object. | ||
|
|
||
| • If the state is wrong, a warning is shown and the user can still continue. If the user continues, the object will be updated in the current state that the object is actually in. | ||
| For example, if in the spreadsheet file the `IsActiveEntity` column is set to `true` but the object is in draft mode, a warning will be shown, and if the user continues, the draft object will be updated with the data from the spreadsheet. | ||
|
|
||
| ### Download only Active Entities | ||
|
|
||
| If you download the data with the Spreadsheet Importer, only the active entities are downloaded. If you then update the data, the object will be updated in the current state that the object is in. | ||
| So if the object is in draft mode, the data from the active state will still be used to update the draft object. | ||
|
|
||
| ### Performance and batch size | ||
|
|
||
| Because the update needs extra requests (fetch of active and draft objects, plus partial updates), the update is slower than a create operation. For mass updates, this can take some time. | ||
| Because of the performance considerations, the batch size for update is limited to 100 per batch. | ||
|
|
||
| ### Filter Limitations | ||
|
|
||
| When exporting the data, currently all the data is exported. Any filters in a List Report are not respected at the moment. | ||
|
|
||
| ## Configuration | ||
|
|
||
| Below is a brief overview of the main configuration options relevant to updating. For the complete list, see the [Configuration documentation](./Configuration.md). | ||
|
|
||
| | Option | Description | Default | | ||
| | --------------- | ------------------------------------------------------------------------------ | ------- | | ||
| | `fullUpdate` | Update all properties of the object (true). If false, only changed properties are updated. | false | | ||
| | `columns` | Columns to update. | all | | ||
|
|
||
| ### fullUpdate | ||
|
|
||
| If `fullUpdate` is set to `true`, the component updates all properties of the object. | ||
| If `fullUpdate` is set to `false` (default), only the properties that have changed are updated (partial update). | ||
|
|
||
| ### columns | ||
|
|
||
| The `columns` property is an array of strings. The strings are the names of the columns that should be updated. | ||
| Columns that are not in the array will not be updated at all. This is useful if you only want to update a subset of properties. | ||
|
|
||
| When using `fullUpdate = true`, the system will still honor `columns`—only those columns listed will be sent in the update request. For unlisted columns, no updates will be sent. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.