From b74284e51861d8fd94b5ee1a72de6ebf871b1045 Mon Sep 17 00:00:00 2001 From: marianfoo <13335743+marianfoo@users.noreply.github.com> Date: Fri, 20 Nov 2026 13:45:11 +0100 Subject: [PATCH] docs: update UI5 integration guide for Apache-licensed 2.5.0 --- docs/index.md | 4 +-- docs/ui5/pages/Button.md | 10 +++--- .../ui5/pages/CHANGELOGSPREADSHEETIMPORTER.md | 19 +++++++++++ docs/ui5/pages/CentralDeployment.md | 12 +++---- docs/ui5/pages/GettingStarted.md | 32 ++++++++++--------- docs/ui5/pages/Troubleshooting.md | 8 ++--- docs/ui5/pages/Typescript.md | 8 ++--- 7 files changed, 57 insertions(+), 36 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4294b27..4c1d862 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,8 +12,8 @@ For information about the currently supported OData and UI5 Versions, click [her A quick integration tutorial for this component is available on YouTube [here](https://www.youtube.com/watch?v=dODt9ZWmi4A). -!!! danger "Commercial License Required" - This component is licensed under the SpreadsheetImporter Commercial License since version 2.0.0. For details, see [LICENSE.md](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/blob/main/LICENSE.md). The version 1.x is licensed under the Apache License 2.0 and remains free of charge but no major updates will be provided. +!!! info "UI5 component license" + UI5 Spreadsheet Importer 2.5.0 is available under the Apache License 2.0, including for production use. Versions 1.x also use Apache 2.0. Published versions 2.0.0 through 2.4.0 use their respective commercial licenses. See the [license history](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/blob/main/LICENSE.md). !!! tip "Also available: a server-side ABAP importer" diff --git a/docs/ui5/pages/Button.md b/docs/ui5/pages/Button.md index 95ff84a..30ac8cf 100644 --- a/docs/ui5/pages/Button.md +++ b/docs/ui5/pages/Button.md @@ -25,13 +25,13 @@ npm install ui5-cc-spreadsheetimporter !!! warning "Resource Roots Path" - The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. + The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. ```json "resourceRoots": { - "cc.spreadsheetimporter.v2_4_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" + "cc.spreadsheetimporter.v2_5_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" } ``` @@ -51,7 +51,7 @@ This is optional and preloads the component on startup of the application. "sap.ui.table": {} }, "components": { - "cc.spreadsheetimporter.v2_4_0": {} + "cc.spreadsheetimporter.v2_5_0": {} } } ``` @@ -63,7 +63,7 @@ This is optional and preloads the component on startup of the application. ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } } ``` @@ -137,7 +137,7 @@ A sample configuration can be found in the manifest.json of the [OData V4 Fiori "customSectionReuse": { "title": "Spreadsheet Upload", "embeddedComponent": { - "name": "cc.spreadsheetimporter.v2_4_0", + "name": "cc.spreadsheetimporter.v2_5_0", "settings": { "tableId": "ui.v4.ordersv4fe::OrdersObjectPage--fe::table::Items::LineItem-innerTable" } diff --git a/docs/ui5/pages/CHANGELOGSPREADSHEETIMPORTER.md b/docs/ui5/pages/CHANGELOGSPREADSHEETIMPORTER.md index 5bc2a33..24533ca 100644 --- a/docs/ui5/pages/CHANGELOGSPREADSHEETIMPORTER.md +++ b/docs/ui5/pages/CHANGELOGSPREADSHEETIMPORTER.md @@ -1,3 +1,22 @@ +## [2.5.0](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/compare/ui5-cc-spreadsheetimporter-v2.4.0...ui5-cc-spreadsheetimporter-v2.5.0) (2026-11-20) + + +### License + +UI5 Spreadsheet Importer 2.5.0 is available under the Apache License 2.0, including for production use. The package includes the license and third-party notices. The UI5 namespace is `cc.spreadsheetimporter.v2_5_0`. + +### Features + +* export with v2 ([#780](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/780)) ([4962c0f](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/commit/4962c0fca6f86fccbddd483b6bd9d9c720a0621f)) + + +### Bug Fixes + +* isolate V2 importer writes in a dedicated request group ([#231](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/231)) ([#811](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/811)) ([c59cc03](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/commit/c59cc038ebc11f522473da8095905d76a071cb45)) +* match labelTypeBrackets columns case-insensitively ([#802](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/802)) ([2e15c2f](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/commit/2e15c2ff877f06e18bb9134227cd6dad5298562d)) +* reset only importer-created entities, preserve user's pending changes ([#808](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/808)) ([b73de07](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/commit/b73de070aaca2e478ad405eea498ed250b90ed57)) +* review follow-ups for OData V2 export & update ([#812](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues/812)) ([9a30aec](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/commit/9a30aec3b7ba07bf957b3c2bf61d3fe18acd2cd2)) + ## [2.3.0](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/compare/ui5-cc-spreadsheetimporter-v2.2.0...ui5-cc-spreadsheetimporter-v2.3.0) (2025-07-04) ### Features diff --git a/docs/ui5/pages/CentralDeployment.md b/docs/ui5/pages/CentralDeployment.md index 98e5e8d..ea63a94 100644 --- a/docs/ui5/pages/CentralDeployment.md +++ b/docs/ui5/pages/CentralDeployment.md @@ -164,7 +164,7 @@ server: customMiddleware: - name: ui5-middleware-servestatic afterMiddleware: compression - mountPath: /resources/cc/spreadsheetimporter/v2_4_0/ + mountPath: /resources/cc/spreadsheetimporter/v2_5_0/ configuration: rootPath: 'node_modules/ui5-cc-spreadsheetimporter/dist' ``` @@ -178,7 +178,7 @@ To consume the centrally deployed component while developing locally in VS Code Access the App Index to find the URL of the component: ``` -/sap/bc/ui2/app_index/ui5_app_info?id=cc.spreadsheetimporter.v2_4_0 +/sap/bc/ui2/app_index/ui5_app_info?id=cc.spreadsheetimporter.v2_5_0 ``` 2\. **Configure Proxy Middleware** @@ -197,9 +197,9 @@ server: - path: /sap url: destination: - - path: /resources/cc/spreadsheetimporter/v2_4_0 + - path: /resources/cc/spreadsheetimporter/v2_5_0 destination: - pathPrefix: /sap/bc/ui5_ui5/sap//thirdparty/customcontrol/spreadsheetimporter/v2_4_0/ + pathPrefix: /sap/bc/ui5_ui5/sap//thirdparty/customcontrol/spreadsheetimporter/v2_5_0/ url: ``` @@ -210,9 +210,9 @@ server: customMiddleware: - name: ui5-middleware-simpleproxy afterMiddleware: compression - mountPath: /resources/cc/spreadsheetimporter/v2_4_0/ + mountPath: /resources/cc/spreadsheetimporter/v2_5_0/ configuration: - baseUri: '/sap/bc/ui5_ui5/sap//thirdparty/customcontrol/spreadsheetimporter/v2_4_0/' + baseUri: '/sap/bc/ui5_ui5/sap//thirdparty/customcontrol/spreadsheetimporter/v2_5_0/' username: password: query: diff --git a/docs/ui5/pages/GettingStarted.md b/docs/ui5/pages/GettingStarted.md index ace8285..81b93e4 100644 --- a/docs/ui5/pages/GettingStarted.md +++ b/docs/ui5/pages/GettingStarted.md @@ -1,8 +1,10 @@ -!!! danger "Commercial License Required" - This component is licensed under the SpreadsheetImporter Commercial License since version 2.0.0. For details, see [LICENSE.md](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/blob/main/LICENSE.md). The version 1.x is licensed under the Apache License 2.0 and remains free of charge but no major updates will be provided. +!!! info "UI5 component license" + UI5 Spreadsheet Importer 2.5.0 is available under the Apache License 2.0, including for production use. Versions 1.x also use Apache 2.0. Published versions 2.0.0 through 2.4.0 use their respective commercial licenses. See the [license history](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/blob/main/LICENSE.md). +To upgrade an existing app to 2.5.0, install the version below, update its component usage and resource root to `cc.spreadsheetimporter.v2_5_0`, then rebuild and deploy the app. For central deployments, deploy the 2.5.0 component before switching the app. + ## Deployment Strategy We recommend different deployment approaches depending on your platform: @@ -60,7 +62,7 @@ There are two ways to include the component in your application: 1\. **Install the component from npm:** ```sh -npm install ui5-cc-spreadsheetimporter +npm install --save-exact ui5-cc-spreadsheetimporter@2.5.0 ``` 2\. **Add `resourceRoots` to the `sap.ui5` section of your `manifest.json`:** @@ -72,7 +74,7 @@ npm install ui5-cc-spreadsheetimporter ```json "resourceRoots": { - "cc.spreadsheetimporter.v2_4_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" + "cc.spreadsheetimporter.v2_5_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" } ``` @@ -97,7 +99,7 @@ For BTP applications (or apps using the index.html bootstrap), you can use jsDel data-sap-ui-theme="sap_horizon" data-sap-ui-resourceroots='{ "your.app.namespace": "./", - "cc.spreadsheetimporter.v2_4_0": "https://cdn.jsdelivr.net/npm/ui5-cc-spreadsheetimporter@1.7.3/dist" + "cc.spreadsheetimporter.v2_5_0": "https://cdn.jsdelivr.net/npm/ui5-cc-spreadsheetimporter@2.5.0/dist" }' data-sap-ui-oninit="module:sap/ui/core/ComponentSupport" data-sap-ui-async="true" @@ -107,7 +109,7 @@ For BTP applications (or apps using the index.html bootstrap), you can use jsDel !!! info "Version Specification" - Always specify the exact version in the CDN URL (e.g., `@1.7.3`) to ensure consistent behavior of your application. + Always specify the exact version in the CDN URL (e.g., `@2.5.0`) to ensure consistent behavior of your application. For more information on using jsDelivr CDN, see the [jsDelivr documentation](https://www.jsdelivr.com/documentation#id-npm). @@ -124,7 +126,7 @@ For more information on using jsDelivr CDN, see the [jsDelivr documentation](htt ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } } ``` @@ -140,7 +142,7 @@ If you encounter the error `component does not exist` when deploying to an SAP s ```json "sap.app": { - "embeds": ["thirdparty/customcontrol/spreadsheetimporter/v2_4_0"] + "embeds": ["thirdparty/customcontrol/spreadsheetimporter/v2_5_0"] } ``` @@ -158,7 +160,7 @@ If you encounter the error `component does not exist` when deploying to an SAP s ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } } ``` @@ -337,7 +339,7 @@ Running outside Fiori Launchpad? Register the component path in `index.html`. src="resources/sap-ui-core.js" data-sap-ui-resourceroots='{ "your.app.namespace": "./", - "cc.spreadsheetimporter.v2_4_0": "/sap/bc/ui5_ui5/sap/Z_XUP/thirdparty/customcontrol/spreadsheetimporter/v2_4_0" + "cc.spreadsheetimporter.v2_5_0": "/sap/bc/ui5_ui5/sap/Z_XUP/thirdparty/customcontrol/spreadsheetimporter/v2_5_0" }' > ``` @@ -347,14 +349,14 @@ Running outside Fiori Launchpad? Register the component path in `index.html`. ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } } ``` #### Error: Library/Component Used in Application Does Not Exist -When deploying the app to your ABAP system, you might encounter an error like `SAPUI5 library/component cc.spreadsheetimporter.v2_4_0 used in application Z*** does not exist`. The application is deployed, but the service returns an error. +When deploying the app to your ABAP system, you might encounter an error like `SAPUI5 library/component cc.spreadsheetimporter.v2_5_0 used in application Z*** does not exist`. The application is deployed, but the service returns an error. To avoid this error, add the following to your `manifest.json` file: @@ -365,7 +367,7 @@ To avoid this error, add the following to your `manifest.json` file: ```json "sap.app": { - "embeds": ["thirdparty/customcontrol/spreadsheetimporter/v2_4_0"] + "embeds": ["thirdparty/customcontrol/spreadsheetimporter/v2_5_0"] } ``` @@ -487,7 +489,7 @@ The metadata name is defined in the [`ui5.yaml`](https://github.com/spreadsheeti When using decentralized deployment, deployment may fail with the following error: -`"Service name 'spreadsheetimporter_v2_4_0' and public setting 'true' in embedded manifest.json have to be equal to service name 'xxxxxxx' and public setting 'true' of root manifest.json"` +`"Service name 'spreadsheetimporter_v2_5_0' and public setting 'true' in embedded manifest.json have to be equal to service name 'xxxxxxx' and public setting 'true' of root manifest.json"` SAP currently does not provide a fix for this. @@ -512,7 +514,7 @@ builder: afterTask: replaceVersion ``` -This task will update the Spreadsheet Importer manifest with the app's service name at this path: `dist/thirdparty/customcontrol/spreadsheetimporter/v2_4_0/manifest.json`. +This task will update the Spreadsheet Importer manifest with the app's service name at this path: `dist/thirdparty/customcontrol/spreadsheetimporter/v2_5_0/manifest.json`. ##### Workaround 2 diff --git a/docs/ui5/pages/Troubleshooting.md b/docs/ui5/pages/Troubleshooting.md index 07e8443..5d5e12f 100644 --- a/docs/ui5/pages/Troubleshooting.md +++ b/docs/ui5/pages/Troubleshooting.md @@ -43,7 +43,7 @@ Alternatively, you can try selecting all the messages and copying them to a text If you receive an error similar to the following: ``` -ui5loader-dbg.js:1042 Uncaught (in promise) ModuleError: failed to load 'cc/spreadsheetimporter/v2_4_0/Component.js' from resources/cc/spreadsheetimporter/v2_4_0/Component.js: script load error +ui5loader-dbg.js:1042 Uncaught (in promise) ModuleError: failed to load 'cc/spreadsheetimporter/v2_5_0/Component.js' from resources/cc/spreadsheetimporter/v2_5_0/Component.js: script load error ``` Since the component is designed to always use a specific version, you must ensure that the correct version is used after an update. @@ -63,16 +63,16 @@ See the configurations for this version below: !!! warning "Resource Roots Path" - The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. + The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } }, "resourceRoots": { - "cc.spreadsheetimporter.v2_4_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" + "cc.spreadsheetimporter.v2_5_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" } ``` diff --git a/docs/ui5/pages/Typescript.md b/docs/ui5/pages/Typescript.md index d020c6e..5549600 100644 --- a/docs/ui5/pages/Typescript.md +++ b/docs/ui5/pages/Typescript.md @@ -21,17 +21,17 @@ Add the component usage and the resource roots to the manifest.json as described !!! warning "Resource Roots Path" - The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. + The `resourceRoots` path "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" changed from version 0.34.0 to lowercase. Please make sure to use the correct path. ```json "componentUsages": { "spreadsheetImporter": { - "name": "cc.spreadsheetimporter.v2_4_0" + "name": "cc.spreadsheetimporter.v2_5_0" } }, "resourceRoots": { - "cc.spreadsheetimporter.v2_4_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_4_0" + "cc.spreadsheetimporter.v2_5_0": "./thirdparty/customcontrol/spreadsheetimporter/v2_5_0" }, ``` @@ -44,7 +44,7 @@ import Component, { Component$ChangeBeforeCreateEvent, Component$CheckBeforeReadEvent, Component$UploadButtonPressEvent -} from 'cc/spreadsheetimporter/v2_4_0/Component'; +} from 'cc/spreadsheetimporter/v2_5_0/Component'; import BaseController from 'sap/fe/core/BaseController'; import ExtensionAPI from 'sap/fe/core/ExtensionAPI';