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
6 changes: 3 additions & 3 deletions docs/advanced/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ Instead of `true`, an object configures it:
A key the endpoint does not know is refused at start, because a misspelled
`forbidden` would otherwise leave the event open.

### Opting an app in
### Opting a CAP app in

A JavaScript app opts in where it is defined, with the `agent` option of
`defineApp`, and classifies its events there:
Expand All @@ -413,7 +413,7 @@ the app on the screen and the app the session was started with, so a popup an
app calls is covered by that app's rules. An action classified `confirm` or
`forbidden` carries `"policy"` in the snapshot.

### Security model
### Security model of the CAP endpoint

- **Off by default**, and an app is reachable only when it opted in or the
configuration names it.
Expand Down Expand Up @@ -463,7 +463,7 @@ restart are lost, as a browser tab's are. Only the newest session of its line,
with its draft not expired, is restored, and only for the user whose agent
reached it.

### Connecting a client
### Connecting a client to CAP

```sh
claude mcp add --transport http bookshop http://localhost:4004/rest/root/z2ui5/mcp \
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/downporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: abap2UI5 below ABAP 7.50 - the downported branch supports NetWeaver
abap2UI5 works right away on ABAP 7.50 and later. On an earlier release, install the downported version, which supports R/3 NetWeaver 7.02 and later.

## Branch
To install on an older system, use the `702` branch:
To install on an older system, use the `702` branch - or rather its tag, `X.Y.Z-702`, which the [Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit) table names next to the tag of every other system:
| Branch | System |
|-----------| ----------------------------|
| main | S/4 Public Cloud, BTP ABAP Environment, S/4 Private Cloud, S/4 On-Premise, R/3 NetWeaver ≥7.50 |
Expand All @@ -17,7 +17,7 @@ Some sample projects and other repositories also ship a downported version. Chec

## Installation
The installation on an old release follows the normal [Quickstart](/get_started/quickstart) flow with two adjustments:
1. Pull the `702` branch with abapGit — abapGit itself is 7.02-compatible, so deployment to old ECC machines works the same way as everywhere else
1. Pull the `X.Y.Z-702` tag with abapGit (the `702` branch itself is force-pushed on every rebuild, so a tag is what to pin) — abapGit itself is 7.02-compatible, so deployment to old ECC machines works the same way as everywhere else
2. Create the HTTP handler (SICF service) with the 7.02-compatible handler syntax instead of the modern snippet

After that, call your HTTP handler from the browser and abap2UI5 is ready for use — even on your old machine.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The setup in `S/4 On-Premise` matches `S/4 Private Cloud`. Follow the [Fiori Lau
The setup matches `S/4 Private Cloud`. Depending on your release, you might also be able to add the apps to Launchpads. Follow the [Fiori Launchpad](/configuration/launchpad) guide.

## R/3 NetWeaver (<7.50)
For R/3 NetWeaver versions below 7.50, install the downported version with syntax tweaks for earlier releases. abap2UI5 runs on releases as far back as 7.02. See [Downporting](/advanced/downporting) for details.
For R/3 NetWeaver versions below 7.50, install the downported version with syntax tweaks for earlier releases. abap2UI5 runs on releases as far back as 7.02. The tag to pull is `X.Y.Z-702`, the downported build of the same release - the [Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit) table lists it next to the tag of every other system. See [Downporting](/advanced/downporting) for details.

## BTP ABAP Environment
The setup in `BTP ABAP Environment` matches `S/4 Public Cloud`. Follow the [S/4 Public Cloud](/configuration/s4_public_cloud) guide.
2 changes: 1 addition & 1 deletion docs/configuration/s4_public_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ covers both. To install abap2UI5, follow these steps:

S/4 Public Cloud supports only the ADT abapGit version. abap2UI5 contains only classes, interfaces, and tables, so you can pull it without issues.

Use the standard installation process with [abapGit for Eclipse](https://eclipse.abapgit.org/).
Use the standard installation process with [abapGit for Eclipse](https://eclipse.abapgit.org/), and pull the newest tag without a suffix, `X.Y.Z` - the [Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit) table says which tag belongs to which system.

::: warning **Two choices you cannot change later without relinking**
**Folder logic must be `PREFIX`.** It is what `.abapgit.xml` declares, and the repository's package tree is built for it.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/sizing.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ expiry the one the exit holds. The number to watch in operation is the row
count against this estimate; a count well above it means the cleanup is not
running (no app has been started for a while) or that an app writes much
larger rows than assumed - the cockpit's *Drafts & Housekeeping* tab shows
both ([Basis Runbook](/configuration/runbook#the-draft-table-z2ui5_t_01)).
both ([Basis Runbook](/configuration/runbook#the-draft-table-z2ui5-t-01)).

Two things the estimate ignores, on purpose: a stateful app writes rows only
on the paths that keep a bookmarkable draft, and the cleanup is a `DELETE`
Expand Down
12 changes: 7 additions & 5 deletions docs/configuration/transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ what does not travel and is set per system instead.
| The Admin Cockpit (optional) | package of its own, tables `Z2UI5_T_CK_*` | yes; its administrators and settings are table rows and are set per system |
| Your apps | one class per app, plus the texts, tables and other objects it uses | yes |

Pull the framework with the folder logic `PREFIX` that its `.abapgit.xml`
declares; the sub-package names are derived from the root package you pick,
and a long root name leaves the deeper ones no room (the package name is
capped at 30 characters) - [S/4 Public Cloud](/configuration/s4_public_cloud)
shows the dialog.
Pull the framework - a release tag, the one the
[Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit)
table names for the system - with the folder logic `PREFIX` that its
`.abapgit.xml` declares; the sub-package names are derived from the root
package you pick, and a long root name leaves the deeper ones no room (the
package name is capped at 30 characters) -
[S/4 Public Cloud](/configuration/s4_public_cloud) shows the dialog.

## The Order

Expand Down
4 changes: 3 additions & 1 deletion docs/configuration/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ rest.
`npx @abap2ui5/linter src --fix-dry-run` shows what it would change.
3. **Pull the tag** on the development system: in abapGit, switch the
repository to the new tag and pull. Pull a tag, not `main` - `main` may
carry an API no release has yet.
carry an API no release has yet. Which tag belongs to which system
(`X.Y.Z`, or `X.Y.Z-702` below 7.50) is the table in the
[Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit).
4. **The frontend, if a BSP is installed.** An installation that only uses
the ICF node has nothing else to pull: the frontend is embedded in the
package (`src/01/03`). An installation with the frontend as a BSP in the
Expand Down
4 changes: 2 additions & 2 deletions docs/get_started/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ Works with both ABAP Cloud and Standard ABAP:
- S/4 Private Cloud or On-Premise (ABAP for Cloud, Standard ABAP)
- R/3 NetWeaver AS ABAP 7.02 or later (Standard ABAP)

Below 7.50 you pull the `702` branch instead of `main` — same features, generated
from it automatically. See [Downporting](/advanced/downporting).
Below 7.50 you pull the `X.Y.Z-702` tag instead of `X.Y.Z` — same features, generated
from `main` automatically; the [Quickstart](/get_started/quickstart#_1-install-the-framework-via-abapgit) table says which tag belongs to which system. See [Downporting](/advanced/downporting).

### UI5 Versions
The frontend is UI5 itself, loaded at bootstrap like it is for any other UI5 app. abap2UI5 bootstraps OpenUI5 from its public CDN by default; a single exit points it at SAPUI5, at a pinned version, or at the UI5 already delivered by your own system — which is what a system without internet access uses. `1.71` is the oldest supported release, and every change is tested against UI5 2.x as well.
Expand Down
Loading