Skip to content

Commit 849a197

Browse files
chg ! documentation
1 parent edee7b1 commit 849a197

File tree

5 files changed

+38
-5
lines changed

5 files changed

+38
-5
lines changed

docs/src/.pages

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ nav:
77
- flows
88
- Interfaces: interfaces.md
99
- Data cleaning and updates: data_cleaning_updates.md
10-
- Import Data: import_data
10+
- Data Import: import_data
11+
- Data Validation : validation.md
12+
- Push Data to HOPE Core: push_data.md

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ management process.
1313
### Implemented Features
1414

1515
- [Import data](import_data/index.md) from [Kobo](import_data/kobo.md) / [Aurora](import_data/aurora.md) / [XLS](import_data/xls.md) (RDI format)
16-
- Data validation
16+
- [Data validation](#validation.md)
1717
- [Data cleaning and updates](data_cleaning_updates.md)
18-
- Push data to HOPE
18+
- [Push data to HOPE](#push_data.md)
1919
- Export/Amend/Import process

docs/src/push_data.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
### Prerequisites
2+
3+
Before pushing data to the HOPE core system, you must [validate](#validation.md) households along with their members.
4+
5+
---
6+
7+
### Processing
8+
9+
##### Navigate to Households
10+
In the [Collector Interface](interfaces.md#collector-interface), navigate to the menu
11+
```
12+
Households
13+
```
14+
!!! warning
15+
Only beneficiaries not marked as removed are displayed in this interface.
16+
17+
##### Select and Initiate Push
18+
19+
Select the relevant households, choose the **Push to HOPE core** action, and click **[Go]**. This opens a form where you can set the batch options.
20+
21+
22+
##### Configure Batch Options
23+
In the form, you can adjust:
24+
25+
- **Batch Name** – A label for the RDI-to-HOPE batch. This parameter is optional; if omitted, the default value is *"RDI to HOPE " + the current datetime*.
26+
27+
##### Start the Process
28+
Click **[Push]** to start the process. You will be redirected to the **Jobs** page to monitor the job's progress and details.
29+
30+
##### Post-Push Status
31+
After a successful push, all households and their members that were sent will be marked as **removed**. To review removed beneficiaries, use the [Admin Interface](interfaces.md#admin-interface).

docs/src/validation.md

Whitespace-only changes.

src/country_workspace/contrib/hope/push.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ def check_households_validity(self) -> None:
4040
"""
4141
for hh in self.queryset:
4242
if not hh.is_valid():
43-
self.total["errors"].append(f"HH #{hh.pk} invalid or unvalidated.")
43+
self.total["errors"].append(f"HH #{hh.pk} invalid.")
4444
for ind in hh.members.all():
4545
if not ind.is_valid():
46-
self.total["errors"].append(f"Individual #{ind.pk} invalid or unvalidated.")
46+
self.total["errors"].append(f"Ind #{ind.pk} invalid.")
4747

4848
def rdi_create(self) -> None:
4949
"""Create a new RDI record in the external system.

0 commit comments

Comments
 (0)