$object.changeLog([maxEntries[, includeSubtree[, startRev[, stopRev[, author[, includeTechnical[, excludedModules]]]]]]])changeLog()
Returns the list of changes (tl.changelog:ChangeSet) affecting the given business object.
When includeSubtree is set (the default), changes to objects that were in the composition subtree of the given object at the time of the change are also included. When set to false, only changes to the object itself are returned.
When object is omitted or null, the global application change log is returned (no subtree filter). In that case, maxEntries should typically be used to keep the result size manageable.
The optional startRev and stopRev parameters narrow the analyzed revision range. Each may be passed as either a revision object or as a numeric commit number. By default the entire history (from revision 1 up to the latest revision) is analyzed.
The optional author parameter restricts the result to changes committed by the given account.
The optional includeTechnical flag controls whether change sets that represent a purely technical change (one that does not reflect in the model) are also reported.
The optional excludedModules parameter is a collection of modules whose changes must not be regarded. Each element may be either a TLModule reference or a module name as a string.
| Name | Type | Description | Mandatory | Default |
|---|---|---|---|---|
| object | Business object | The business object whose change history shall be returned. Passing null or omitting the argument returns the global application change log. |
no | null |
| maxEntries | Integer | Limits the number of returned entries, newest first. A value less than or equal to 0 means unlimited. | no | 0 |
| includeSubtree | Boolean | Whether the entire composition subtree is considered (true) or only the object itself (false). |
no | true |
| startRev | Revision or Integer | First revision to analyze. Either a revision object or a commit number. | no | 1 (initial revision) |
| stopRev | Revision or Integer | Last revision to analyze. Either a revision object or a commit number. | no | latest revision |
| author | tl.accounts:Person or business object with account reference |
Restricts the result to changes committed by the given account. | no | null (no author filter) |
| includeTechnical | Boolean | Whether change sets that represent a purely technical change (with no effect on the model) are also reported. | no | false |
| excludedModules | Collection of TLModule or string |
Modules whose changes must not be regarded. Each element may be either a TLModule reference or a module name as a string. |
no | empty |
Type: List of tl.changelog:ChangeSet
The list of changes in ascending revision order.
$project.changeLog()
Returns every change to the project and to every contained sub-object.
$project.changeLog(10, false)
Returns the ten most recent changes made directly to the project object (without sub-objects).
changeLog(null, 50)
Returns the 50 most recent changes of the entire application, with no subtree restriction.
changeLog(author: $account, includeTechnical: true)
Returns all changes (including purely technical ones) committed by the given account.
$project.changeLog(0, true, 1000, 2000)
Returns all changes to the project (including its subtree) committed between revisions 1000 and 2000.
changeLog(excludedModules: [`tl.accounts`, "tl.legacy"])
Returns the global change log without any changes from the modules tl.accounts and tl.legacy.