Skip to content
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

docs: [DHIS2-18732] changelog docs #3958

Merged
merged 4 commits into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/user/resources/images/changelog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions docs/user/using-the-capture-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -1345,3 +1345,49 @@ The attribute option combo selector will be displayed when you are adding or cha
Example from new Tracker event:

![](resources/images/attribute-option-combo-tracker.png)


## Changelog

The **Changelog** feature provides a historical record of changes made to data for both events and Tracked Entities. Every time data is added, modified, or deleted, a record is stored in the changelog.

![](resources/images/changelog.png)

### Changelog functionality

**Sorting**: Clicking the sorting icon next to a column header toggles between default, ascending, and descending order. By default, records are sorted by date (newest first). Sorting by user or data item is also available, but you can only apply one sorting option at a time.

**Filtering**: You can filter by a specific data item. You can only apply one filter at a time.

> **Note:**
> All data items are displayed in the filter dropdown, regardless of whether they have a changelog record.

**Pagination**: Displays 10 records per page by default, with options to adjust the number of records shown, up to 100 per page.

---

### Event changelog

The **Event Changelog** tracks changes to data items within an event. These data items include event properties (e.g., report date, scheduled date, and geometry) and data elements.

#### How to open the event changelog
1. **Navigate** to the "View event" page of an event in the Capture app.
2. Click **View Changelog** to open the changelog.
![](resources/images/open-event-changelog.png)

---

### Tracked entity changelog

The **tracked entity changelog** tracks changes to attributes of a tracked entity within an enrollment.

#### How to open the tracked entity changelog
1. **Go to the Maintenance app** and **enable** the **Tracked Entity Instance Audit Log**.
![](resources/images/enable-tracked-entity-instance-audit-log.png)

2. **Open** the enrollment dashboard in the Capture app.

3. Click **View Changelog** in the **Tracked Entity Profile** widget to open the changelog.
![](resources/images/open-tracked-entity-changelog.png)


Loading