docs: [DHIS2-12361] Relationships widget (#3430)

dhis2 · Oct 20, 2023 · afb28dc · afb28dc
1 parent 6016b85
commit afb28dc
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 1 deletion.
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
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
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
diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget-add.png b/docs/user/resources/images/enrollment-dash-relationship-widget-add.png
diff --git a/docs/user/resources/images/enrollment-dash-relationship-widget.png b/docs/user/resources/images/enrollment-dash-relationship-widget.png
diff --git a/docs/user/using-the-capture-app.md b/docs/user/using-the-capture-app.md
@@ -986,6 +986,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. 
@@ -1226,4 +1259,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)
+![](resources/images/attribute-option-combo-tracker.png)