Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ jobs:
name: mkdocs build --strict
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: '3.x'
- run: pip install -r requirements.txt
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
with:
python-version: '3.x'
- run: pip install -r requirements.txt
Expand Down
51 changes: 13 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,21 @@
# Spreadsheet Importer — Documentation
# Spreadsheet Importer documentation

Combined documentation for the **Spreadsheet Importer** family:
This repository publishes the [Spreadsheet Importer documentation](https://docs.spreadsheet-importer.com/).

- the **[UI5 Spreadsheet Importer](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter)** —
the frontend UI5 custom control, and
- the **server-side ABAP RAP Spreadsheet Importer** — the backend component.
- The [UI5 guide](https://docs.spreadsheet-importer.com/ui5/pages/GettingStarted/) covers version 2.5.0 of the [UI5 Spreadsheet Importer](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter), including installation, configuration and the OData V2 and V4 examples. The Community Edition uses the Apache License 2.0.
- The [ABAP guide](https://docs.spreadsheet-importer.com/abap/) covers the separate server-side RAP importer.

Built with [MkDocs](https://www.mkdocs.org/) + [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
the same stack as the existing UI5 docs at [docs.spreadsheet-importer.com](https://docs.spreadsheet-importer.com/).
## Build locally

## Structure
From the root of this repository, use Python 3.11 or later.

```sh
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements.txt
mkdocs serve
```
docs/
├── index.md # combined landing — the two-part ecosystem + "which one do I need?"
├── ui5/ # UI5 frontend component
│ └── index.md # overview + map to the live UI5 docs (full integration in progress)
└── abap/ # ABAP backend importer
├── index.md # overview, requirements, install, quick start
├── integration-guide.md
├── public-api-contract.md
└── usage-cookbook.md
```

## Status

- **ABAP backend docs** — added (overview, integration guide, public API contract, usage cookbook),
sanitized for a public site (no links into private/maintainer sources).
- **UI5 frontend docs** — a placeholder + map to the live site for now; full incorporation
(snapshot vs. multi-repo build) is a follow-up.
- **Deploy** — not wired yet. CI runs `mkdocs build --strict` on every push/PR; publishing to a domain
is a follow-up once the domain (vs. the live UI5 docs domain) is decided.

## Local development

```bash
pip install -r requirements.txt
mkdocs serve # http://localhost:8000

# or, matching the UI5 repo's Docker workflow:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
Open <http://127.0.0.1:8000/> to preview changes. Edit UI5 pages in `docs/ui5/pages/`, ABAP pages in `docs/abap/` and navigation in `mkdocs.yml`.

`mkdocs build --strict` must pass (CI enforces it) — it fails on broken internal links and pages
missing from the nav.
Run `mkdocs build --strict` to reproduce the pull request check. Merging to `main` builds the site and publishes it through GitHub Pages.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,13 @@ A quick integration tutorial for this component is available on YouTube [here](h
!!! tip "Also available: a server-side ABAP importer"
Need to import in the **backend** — large files, or straight into a RAP business object? The
**[ABAP Spreadsheet Importer](abap/index.md)** parses xlsx/CSV in your S/4HANA / BTP ABAP system and
creates the rows through your own RAP BO via EML. Find it under **Integration → ABAP** in the navigation.
creates the rows through your own RAP BO via EML. Find it under **ABAP (Backend Importer)** in the navigation.

## Feature Overview

- Supports upload from List Report/Object Page in Fiori Elements with or without draft
- Usable across all Fiori scenarios (Fiori Elements, Freestyle, OpenUI5, V2/V4)
- [Export related records](ui5/pages/spreadsheetdownload.md) and [update existing rows](ui5/pages/Update.md) with OData V2 or V4
- Includes several frontend checks
- Capability to download a pre-generated Spreadsheet template
- Extension Points for uploading to App or sending to the backend
Expand Down
34 changes: 18 additions & 16 deletions docs/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,36 @@
> UI5 component to import spreadsheet data into Fiori/UI5 apps, supporting bulk Excel uploads and optional CAP backend processing.

**Notes**
- Works with Fiori Elements and freestyle UI5 apps; backend-agnostic; see repo for license.
- Works with Fiori Elements and freestyle UI5 apps; backend-agnostic. UI5 Spreadsheet Importer 2.5.0 uses Apache 2.0, including for production.
- For large workbooks, prefer server-side processing with the CAP CDS Plugin.
- Keep `manifest.json` version namespaces aligned with the deployed component.
- Issues & updates: https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter/issues

## Quick Start
- [Getting Started](https://docs.spreadsheet-importer.com/pages/GettingStarted/): Install via npm/CDN, set `resourceRoots` and `componentUsages`.
- [Configuration](https://docs.spreadsheet-importer.com/pages/Configuration/): Reference of options with examples and defaults.
- [API Reference](https://docs.spreadsheet-importer.com/pages/APIReference/): Component methods, events, and constructor options.
- [Getting Started](https://docs.spreadsheet-importer.com/ui5/pages/GettingStarted/): Install via npm/CDN, set `resourceRoots` and `componentUsages`.
- [Configuration](https://docs.spreadsheet-importer.com/ui5/pages/Configuration/): Reference of options with examples and defaults.
- [API Reference](https://docs.spreadsheet-importer.com/ui5/pages/APIReference/): Component methods, events, and constructor options.

## Core Features
- [Button Control](https://docs.spreadsheet-importer.com/pages/Button/): Add the importer button and preload configuration.
- [Events](https://docs.spreadsheet-importer.com/pages/Events/): Extension points for validation and data manipulation.
- [Wizard](https://docs.spreadsheet-importer.com/pages/Wizard/): Guided step-by-step import process (v2.2.0+).
- [Button Control](https://docs.spreadsheet-importer.com/ui5/pages/Button/): Add the importer button and preload configuration.
- [Events](https://docs.spreadsheet-importer.com/ui5/pages/Events/): Extension points for validation and data manipulation.
- [Wizard](https://docs.spreadsheet-importer.com/ui5/pages/Wizard/): Guided step-by-step import process (v2.2.0+).

## Deployment & Operations
- [Central Deployment](https://docs.spreadsheet-importer.com/pages/CentralDeployment/): Recommended central deployment to ABAP/BTP systems.
- [Update Operations](https://docs.spreadsheet-importer.com/pages/Update/): Update existing entities instead of creating new ones.
- [Supported Versions](https://docs.spreadsheet-importer.com/pages/SupportVersions/): Compatible UI5 versions and tested scenarios.
- [Central Deployment](https://docs.spreadsheet-importer.com/ui5/pages/CentralDeployment/): Recommended central deployment to ABAP/BTP systems.
- [Update Operations](https://docs.spreadsheet-importer.com/ui5/pages/Update/): Update existing entities instead of creating new ones.
- [Supported Versions](https://docs.spreadsheet-importer.com/ui5/pages/SupportVersions/): Compatible UI5 versions and tested scenarios.

## Backend & Advanced
- [CAP CDS Plugin](https://docs.spreadsheet-importer.com/pages/CdsPlugin/): Upload directly to CAP backend for scalability.
- [Troubleshooting](https://docs.spreadsheet-importer.com/pages/Troubleshooting/): Common errors, diagnostics, debug flags.
- [ABAP RAP importer](https://docs.spreadsheet-importer.com/abap/): Separate server-side component for ABAP systems.
- [OData V2 export and update](https://docs.spreadsheet-importer.com/ui5/pages/Development/ODataV2-ExportAndUpdate/): Implementation and draft handling in 2.5.0.
- [CAP CDS Plugin](https://docs.spreadsheet-importer.com/ui5/pages/CdsPlugin/): Upload directly to CAP backend for scalability.
- [Troubleshooting](https://docs.spreadsheet-importer.com/ui5/pages/Troubleshooting/): Common errors, diagnostics, debug flags.
- [GitHub Repository](https://github.com/spreadsheetimporter/ui5-cc-spreadsheetimporter): Source, releases, issues.

## Optional
- [Checks & Validation](https://docs.spreadsheet-importer.com/pages/Checks/): Built-in data validation and error types.
- [Table Selector](https://docs.spreadsheet-importer.com/pages/TableSelector/): Multi-table selection dialog for complex views.
- [Spreadsheet Download](https://docs.spreadsheet-importer.com/pages/spreadsheetdownload/): Export backend data to spreadsheets.
- [Development Guide](https://docs.spreadsheet-importer.com/pages/Development/GettingStarted/): Local dev setup and sample apps.
- [Checks & Validation](https://docs.spreadsheet-importer.com/ui5/pages/Checks/): Built-in data validation and error types.
- [Table Selector](https://docs.spreadsheet-importer.com/ui5/pages/TableSelector/): Multi-table selection dialog for complex views.
- [Spreadsheet Download](https://docs.spreadsheet-importer.com/ui5/pages/spreadsheetdownload/): Export backend data to spreadsheets.
- [Development Guide](https://docs.spreadsheet-importer.com/ui5/pages/Development/GettingStarted/): Local dev setup and sample apps.
- [Package on jsDelivr](https://www.jsdelivr.com/package/npm/ui5-cc-spreadsheetimporter): Public package and latest version.
Loading