Skip to content

docs(java): update fiori-drafts table for draftNew / post-active semantics #2516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agoerler merged 8 commits into from
Apr 23, 2026
+14 −11
Merged

docs(java): update fiori-drafts table for draftNew / post-active semantics #2516

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1dcabfa
docs(java): update fiori-drafts table for draftNew / post-active sema…
rjayasinghe Apr 20, 2026
47bcdc8
Merge branch 'main' into java/fiori-drafts-post-active-semantics
rjayasinghe Apr 20, 2026
ce98305
Apply suggestions from code review
smahati Apr 23, 2026
baf123f
cosmetics
smahati Apr 23, 2026
a5b9f47
Apply suggestions from code review
agoerler Apr 23, 2026
e1e4027
Update java/fiori-drafts.md
agoerler Apr 23, 2026
2218aaa
Apply suggestions from code review
agoerler Apr 23, 2026
1edb97f
Merge branch 'main' into java/fiori-drafts-post-active-semantics
agoerler Apr 23, 2026
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
25 changes: 14 additions & 11 deletions java/fiori-drafts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,19 @@ When users edit a draft-enabled entity in the frontend, the following requests a
Draft-enabled entities have an extra key `IsActiveEntity` by which you can access either the active entity or the draft (inactive entity).
:::

| HTTP / OData request | Event constant name | Default implementation |
| -------------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| POST | `DraftService.EVENT_DRAFT_NEW` | Creates a new empty draft. Internally triggers `DRAFT_CREATE`. |
| PATCH with key `IsActiveEntity=false` | `DraftService.EVENT_DRAFT_PATCH` | Updates an existing draft |
| DELETE with key `IsActiveEntity=false` | `DraftService.EVENT_DRAFT_CANCEL` | Deletes an existing draft |
| DELETE with key `IsActiveEntity=true` | `CqnService.EVENT_DELETE` | Deletes an active entity *and* the corresponding draft |
| POST with action `draftPrepare` | `DraftService.EVENT_DRAFT_PREPARE` | Empty implementation |
| POST with action `draftEdit` | `DraftService.EVENT_DRAFT_EDIT` | Creates a new draft from an active entity. Internally triggers `DRAFT_CREATE`. |
| POST with action `draftActivate` | `DraftService.EVENT_DRAFT_SAVE` | Activates a draft and updates the active entity. Triggers an `CREATE` or `UPDATE` event on the affected entity. |
| n/a | `DraftService.EVENT_DRAFT_CREATE` | Stores a new draft in the database. |
| HTTP / OData request | Event constant name | Default implementation |
| ---------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| POST with `IsActiveEntity=false` in payload | `DraftService.EVENT_DRAFT_NEW` | Creates a new empty draft. Internally triggers `DRAFT_CREATE`. |
| POST (no `IsActiveEntity`) on entity *without* `draftNew` action | `DraftService.EVENT_DRAFT_NEW` | Creates a new empty draft. Internally triggers `DRAFT_CREATE`. |
| POST (no `IsActiveEntity`) on entity *with* `draftNew` action | `CqnService.EVENT_CREATE` | Creates a new active entity. |
| POST with action `draftNew` | `DraftService.EVENT_DRAFT_NEW` | Creates a new empty draft. Internally triggers `DRAFT_CREATE`. |
| PATCH with key `IsActiveEntity=false` | `DraftService.EVENT_DRAFT_PATCH` | Updates an existing draft. |
| DELETE with key `IsActiveEntity=false` | `DraftService.EVENT_DRAFT_CANCEL` | Deletes an existing draft. |
| DELETE with key `IsActiveEntity=true` | `CqnService.EVENT_DELETE` | Deletes an active entity *and* the corresponding draft. |
| POST with `draftPrepare` action | `DraftService.EVENT_DRAFT_PREPARE` | Empty implementation. |
| POST with `draftEdit` action | `DraftService.EVENT_DRAFT_EDIT` | Creates a new draft from an active entity. Internally triggers `DRAFT_CREATE`. |
| POST with `draftActivate` action | `DraftService.EVENT_DRAFT_SAVE` | Activates a draft and updates the active entity. Triggers an `CREATE` or `UPDATE` event on the affected entity. |
| n/a | `DraftService.EVENT_DRAFT_CREATE` | Stores a new draft in the database. |

You can use these events to add custom logic to the SAP Fiori draft flow, for example to interact with drafts or to validate user data.

Expand Down Expand Up @@ -148,7 +151,7 @@ These events have the same semantics as described in section [Handling CRUD even


::: tip POST Behavior with Direct CRUD
With the 4.8.0 release, CAP Java introduced a mode where `POST` without `IsActiveEntity=true` results in the `CqnService.EVENT_CREATE` (creation of an active entity) for the given entity. This mode is only active when the CDS property `cds.draft.post-active` is set to `true` and the entity is annotated with `@Common.DraftRoot.NewAction`. The annotation value needs to be the name of an unbound action in the same service of the entity. If the entity has a key with the type `UUID`, the action needs no further parameter. Otherwise, the action needs the key values of the entity as parameters.
With the 4.9.0 release, CAP Java introduced a mode where `POST` without a value for `IsActiveEntity` in the payload results in the `CqnService.EVENT_CREATE` (creation of an active entity) for the given entity. This mode is automatically active when the entity is annotated with `@Common.DraftRoot.NewAction`, which is generated by the CDS compiler when the `cds_fiori_direct__crud` flag is set. It can also be added via explicit modeling. The annotation value needs to be the name of a bound action in the same service. If the entity has a key of type `UUID`, the action needs no further parameters. Otherwise, the action needs the key values of the entity as parameters. The behavior can be overridden via the `cds.drafts.post-active` property set to `false`.
:::

::: warning Draft locks still apply
Expand Down
Loading