Skip to content

Explain some caveats in change tracking #1798

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

vmikhailenko
Copy link
Contributor

Change tracking documentation is extended to attempt to clear two things that cause confusion between stakeholders:

  • the element-defined identifier should not be used for compositions as it does very little sense for them.
  • the stakeholders need to ensure that change-tracked entities are updated using deep updates from the root of the document (entity with compositions). Notably, the changes are not linked to their expected parents and this causes confusion.

@vmikhailenko vmikhailenko requested a review from beckermarc April 29, 2025 11:24
Elements from the `@changelog` annotation value must always be prefixed by the association name. The same caveats as for the identifiers for the entities apply here.

If you annotate a composition with an identifier, the change log will contain an entry with the identifier's value. Additionally, it will include change log entries for all annotated elements of the composition's target entity.
Elements from the `@changelog` annotation value must always be prefixed by the association name and the identifier of the target entity is not considered at all.
Copy link
Contributor

Choose a reason for hiding this comment

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

the identifier of the target entity is not considered at all

What is the reason for this?


If you annotate a composition with an identifier, the change log will contain an entry with the identifier's value. Additionally, it will include change log entries for all annotated elements of the composition's target entity.
Elements from the `@changelog` annotation value must always be prefixed by the association name and the identifier of the target entity is not considered at all.
The same caveats as for the identifiers for the entities apply here.
Copy link
Contributor

Choose a reason for hiding this comment

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

What are these caveats?

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.

2 participants