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-13299] related stages epic docs #3936

Open
wants to merge 4 commits into
base: DHIS2-18018
Choose a base branch
from
Open
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
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 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,42 @@ 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)

# Related stages and linked events for Tracker programs
You can connect any two program stages via a relationship. To enable this feature, you can set up two program stages in the same program and link them with a stage-to-stage relationship.

simonadomnisoru marked this conversation as resolved.
Show resolved Hide resolved
## Adding a new tracker event
When opening the new event form, a widget called *Actions - ${Relationship type name}* will appear at the bottom of the page. From this widget, users can:
1. Schedule a new visit in another Organisational unit.
2. Enter data directly.
3. Link to an already existing event.

When clicking Complete or Save without completing, the Capture app will create the requested event, schedule the response event and make sure that there is a link between them in the correct context.
![](resources/images/related-stages-new-event.png)

## Editing a tracker event
### When there isn't a linked event
If the event is eligible for related stages but isn’t linked yet, a widget called *Linked event* will appear at the bottom of the page. From this widget, users can:
1. Schedule a new visit in another Organisational unit.
2. Enter data directly.
3. Link to an already existing event.

The label of the action button will change based on the user's selections. When clicking the action button, the Capture app will create the requested event, schedule the response event and make sure that there is a link between them in the correct context.
![](resources/images/related-stages-edit-event.png)

### When there is a linked event
If the event is already linked, a Linked Event widget will appear at the top of the page. This widget allows users to view details of the linked event.
![](resources/images/related-stages-linked-event-view.png)

Additionally, by clicking the Menu in the top-right corner, users can:
1. Unlink the linked event.
2. Unlink and delete the linked event.
![](resources/images/related-stages-linked-event-actions-menu.png)

## Enrolling a tracked entity
Enable the "First stage appears on registration page" flag in the Maintenance for the Tracker program. When opening the form to enroll a new tracked entity, a widget called *Actions - ${Relationship type name}* will appear at the bottom of the page. From this widget, users can:
1. Schedule a new visit in another Organisational unit.
2. Enter data directly.

When clicking Save, the Capture app will enroll the requested tracked entity, schedule the related event and make sure that there is a link between them in the correct context.
![](resources/images/related-stages-enroll-trackedEntity.png)
Loading