Explain some caveats in change tracking #1798
Conversation
| 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. |
There was a problem hiding this comment.
the identifier of the target entity is not considered at all
What is the reason for this?
There was a problem hiding this comment.
That was always how I have understood the intention of syntax introduced by Nodies. FK by default (even if association target has own identifier) or own identifier if you wish.
We can no longer look at their syntax I think so this now just documents the way it works.
|
|
||
| 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. |
There was a problem hiding this comment.
What are these caveats?
There was a problem hiding this comment.
Changes in the entity's structure due to redirection + lack of localisation.
Identifiers are not expressions, so they are not rewritten by the compiler. Types can change: annotations must follow this changes. One of the first stakeholders had troubles with this (lot of renaming), that is why I mentioned it.
With our recommended way to model change tracking on top + stable types e.g. codelist this should not happen that much.
Change tracking documentation is extended to attempt to clear two things that cause confusion between stakeholders: