diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget-add-choose.png b/docs/user/resources/images/enrollment-dash-relationship-widget-add-choose.png new file mode 100644 index 0000000000..59c052056b Binary files /dev/null and b/docs/user/resources/images/enrollment-dash-relationship-widget-add-choose.png differ diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget-add-existing.png b/docs/user/resources/images/enrollment-dash-relationship-widget-add-existing.png new file mode 100644 index 0000000000..467adef42c Binary files /dev/null and b/docs/user/resources/images/enrollment-dash-relationship-widget-add-existing.png differ diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget-add-new.png b/docs/user/resources/images/enrollment-dash-relationship-widget-add-new.png new file mode 100644 index 0000000000..6e64a2f58d Binary files /dev/null and b/docs/user/resources/images/enrollment-dash-relationship-widget-add-new.png differ diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget-add.png b/docs/user/resources/images/enrollment-dash-relationship-widget-add.png new file mode 100644 index 0000000000..78c0e82f83 Binary files /dev/null and b/docs/user/resources/images/enrollment-dash-relationship-widget-add.png differ diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget.png b/docs/user/resources/images/enrollment-dash-relationship-widget.png new file mode 100644 index 0000000000..baf3c48666 Binary files /dev/null and b/docs/user/resources/images/enrollment-dash-relationship-widget.png differ diff --git a/docs/user/using-the-capture-app.md b/docs/user/using-the-capture-app.md index 1de82958d9..1d7e908b41 100644 --- a/docs/user/using-the-capture-app.md +++ b/docs/user/using-the-capture-app.md @@ -982,6 +982,39 @@ The enrollment comment widget displays comments and allows addition of comments, By clicking in the text field, you will be able to enter new text and see action buttons **Save comment** and **Cancel**. Note that Enrollment comments are attributed to a user and cannot be deleted. +### Relationship widget + +The Relationships widget on the enrollment dashboard is used for viewing the record’s linked relationships to other records. +The number next to the title signifies the total number of relationships + +![](resources/images/enrollment-dash-relationship-widget.png) + +For tracked entity instance relationships, the key attributes shown in the widget are the attributes that have been selected to be displayed on 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 a program. + +Click the **Add new** button to add a new relationship. Adding a new relationship opens a dialog where you can select the applicable relationship type. + +![](resources/images/enrollment-dash-relationship-widget-add.png) + +Choose between linking to an existing tracked entity instance or creating a new one. + +![](resources/images/enrollment-dash-relationship-widget-add-choose.png) + +#### Existing tracked entity instance + +Use the search form to find any existing record to link to. + +![](resources/images/enrollment-dash-relationship-widget-add-existing.png) + +#### New tracked entity instance + +Use the form to create a new record and link. + +![](resources/images/enrollment-dash-relationship-widget-add-new.png) + ### Tracked entity instance profile widget On the enrollment dashboard, you can view the tracked entity instance profile widget. Inside the profile widget you can view the key attributes values. @@ -1222,4 +1255,4 @@ 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) \ No newline at end of file +![](resources/images/attribute-option-combo-tracker.png)