Skip to content

docs: document BDM data retention feature — BPA-439#3299

Open
tmarie-bonitasoft wants to merge 2 commits into2026.1from
docs/BPA-439-bdm-data-retention
Open

docs: document BDM data retention feature — BPA-439#3299
tmarie-bonitasoft wants to merge 2 commits into2026.1from
docs/BPA-439-bdm-data-retention

Conversation

@tmarie-bonitasoft
Copy link
Copy Markdown

@tmarie-bonitasoft tmarie-bonitasoft commented Apr 13, 2026

Summary

Documents the new BDM data retention feature shipped in 2026.1:

  • New BDM data retention page in the Runtime module covering:
    • overview of retention rules (reference date, retention period)
    • tracking mechanism (data_retention_bdm_tracking table)
    • composition vs aggregation tracking behavior
    • scheduled cleanup via the new bonita.runtime.retention.schedule.cron property
    • audit trail via the BUSINESS_DATA_CLEANED_UP queriable log event
  • Tracking behavior notes added to the BDM composition/aggregation section
  • GDPR design guide updated with a link to the new feature
  • 2026.1 release note entry
  • Runtime navigation updated

Closes BPA-439.

Follow-up

A companion PR (BPA-441) adds a procedure for backfilling the tracking table for legacy BDM data. It is based on this branch and should be merged after.

Test plan

  • Built locally with Antora (`build-preview.bash --branch 2026.1 --component bonita --single-branch-per-repo true --local-sources true --fetch-sources false --ignore-errors true`) and reviewed in the browser
  • Verify xrefs resolve in the final build

- Add new page 'BDM data retention' in the Runtime module with:
  - Overview of retention rules and their scope
  - Tracking mechanism (data_retention_bdm_tracking table)
  - Composition vs aggregation tracking behavior
  - Scheduled cleanup (bonita.runtime.retention.schedule.cron)
  - Queriable log audit trail (BUSINESS_DATA_CLEANED_UP)
- Update the BDM composition section with data retention behavior notes
- Update the GDPR design guide with a BDM data retention section
- Add release note entry for 2026.1
- Update Runtime navigation
@github-actions
Copy link
Copy Markdown
Contributor

📝 Contribution Summary

To merge this Pull Request, you need to check your updates with the following URL.

🔗 Updated pages

Note

The following pages were updated, please ensure that the display is correct:

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@bonita-ci
Copy link
Copy Markdown
Contributor

bonita-ci commented Apr 13, 2026

🎊 PR Preview e49c087 has been successfully built and deployed to https://bonitasoft-bonita-doc-deploy-pr-3299.surge.sh

🕐 Build time: 0.01s

🤖 By surge-preview

Copy link
Copy Markdown
Contributor

@abirembaut abirembaut left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments (editions are to confirm with Product)
other than that it looks good to me

Comment on lines +105 to +110
If you do not want these entries stored in the database, disable the event in `bonita-tenant-sp-custom.properties`:

[source,properties]
----
bonita.tenant.queriable.log.BUSINESS_DATA_CLEANED_UP.INTERNAL=false
----
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure we want to document this

- Use 'Performance, Enterprise and Scale editions only' (not 'Subscription')
- Add edition note in release notes entry
- Remove feature name and version from main page note
- Add '(Subscription editions)' to BDM composition tracking heading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants