Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Co-authored-by: sjvans <30337871+sjvans@users.noreply.github.com>
  • Loading branch information
mnkiefer and sjvans authored Oct 16, 2023
1 parent 87740fb commit 4093c74
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ By adding the annotation `@changelog`, we have already change-tracked everything
However, as we can see in our file above, additional identifiers or labels may be necessary to obtain better *human-readable* change records. These are described below.
#### Human-readable IDs and Values
The columns *Object ID* and *Parent Object ID* are already human-readable by default, unless the `@changelog` definition cannot be uniquely mapped such as types `enum` or `Association`. In our example, we have added `[ customer.name, createdAt ]` for incidents and `[ customer.name ]` for conversations entities to obtain columns consisting of the customer's name and timestamp or the author's name and timestamp respectively. This is similar for elements, where we have added `[ customer.name ]` to element `customer` to obtain human-readable *Old Value* and *New Value* records.
#### Human-readable Fields and Types
Expand Down

0 comments on commit 4093c74

Please sign in to comment.