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.

Sign up for GitHub

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-12362] relationships documentations #2806

Closed
wants to merge 2 commits into from
Closed

docs: [DHIS2-12362] relationships documentations #2806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21bee60
chore: [DHIS2-12362] add documentations
jasminenguyennn May 19, 2022
9d0927c
docs: [DHIS2-12372] add docs for view linked records
jasminenguyennn Jul 20, 2022
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/tei_relationships_widget.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/user/using-the-capture-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,6 +1001,17 @@ Colored legend circles are only shown for indicator values that have them set up
On the enrollment dashboard, the warning widget displays warnings related to the current dashboard. The widget shows warnings that are not associated with any specific data item.
If there aren't any warnings to show for the current dashboard then the widget is hidden.

### Relationships widget of tracked entity instance
The Relationships widget on enrollment dashboard is used for viewing the record’s linked relationships to other records of the tracked entity instance.
The number next to the title signifies the total number of relationships

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

For tracked entity instance relationships, the key attributes shown in the widget are the attributes that have been selected to be displayed in the widget (from the list of attributes that have been configured for that Tracked entity type and Program) in the relationship type page in Maintenance.

If no attributes are selected, it will just show a row per record with tracked entity type name and relationship creation date.

When clicking a tracked entity instance you should be taken to the Enrollment Dashboard. If the relationship type includes a program, you should be taken to the latest enrollment for that program. If no program is specified, you should still be sent to the enrollment dashboard, but without the program.

## Enrollment event view and edit page

Expand Down Expand Up @@ -1104,7 +1115,12 @@ After clicking **Schedule** button, user will be navigated back to enrollment ov

![](resources/images/enrollment-add-event-schedule-page.png)

### Relationships widget of event
For event relationships, event date and the key data elements shown in the widget are the data elements that have been selected to be displayed in the Relationships widget (from the list of data elements configured for that program) in the relationship type page in Maintenance.

If no data elements are selected, it will just show a row per record with program stage name and relationship creation date.

When clicking an event: If the event has an associated tracked entity instance, you will be navigated to the view enrollment event page. If no associated tracked entity instance, you will be navigated to the view single event page.
## Program stage event list

You can reach the program stage event list by clicking **Go to full {stage event name}** button in the overview page.
Expand Down