Element "participating-org" requires @ref or sub-element "narrative" to be populated

[emmajclegg]

The IATI Publisher data entry form for activity element participating-org currently allows users to save data with both @/ref and narrative unpopulated:

This would be very easy to do and will cause errors in published data as, according to the Standard, "the participating organisation must have an identifier or a narrative"

1. Can we add data validation to the data entry form to force the user to populate one of these fields before saving.
2. Can we rename "narrative" to "name" in the interface (similar to what we did for reporting-org in Clearer labelling and/or auto-population of reporting-org/@narrative #1406) to make it clearer to the user what this field is.
3. Can we (ideally) move the narrative sub-element to the top of the form as it is logical to the user to complete this first.

TODO

• Can we add data validation to the data entry form to force the user to populate one of these fields before saving.
• Can we rename "narrative" to "name" in the interface (similar to what we did for reporting-org in Clearer labelling and/or auto-population of reporting-org/@narrative #1406) to make it clearer to the user what this field is.
• Can we (ideally) move the narrative sub-element to the top of the form as it is logical to the user to complete this first.

[PG-Momik]

@emmajclegg Question on this.
For imports, should we not let users import activity if both participating org reference and narrative (name) is not provided?

cc: @Sanam-07

[emmajclegg]

For imports, should we not let users import activity if both participating org reference and narrative (name) is not provided?

(I'm updating my previous response on this)

@PG-Momik - as discussed earlier today, this participating-org rule is a (non-critical) IATI validator error, so it may already be in your import data checks? It should be treated the same as other non-critical validation errors so could be given as feedback after a data import, but not block the activity import entirely.

[Sanam-07]

( @Sanam-07 's initial comment has been overridden, validation for narrative was flagged as error. )

@emmajclegg This has been deployed to staging.

Summary of Changes:

• To save the form, users must fill in either a reference (ref) or at least one name.
• During imports, an error message of the 'error' level will be displayed if the conditions are not met.

Other Important Updates:

The logic for calculating completeness has been updated. Previously, a participating organization was considered complete if only the organization role was filled. Now, a participating org is considered complete only if both of the following conditions are met:

• The organization role is filled.
• Either a reference or at least one name is provided.

Additionally, a required (*) indicator will appear next to the reference and name fields.

---

Let us know if the change in logic for completeness is not needed.

cc: @Sanam-07 @BibhaT

[emmajclegg]

Thanks @Sanam-07

The data entry form check looks good and the change you've made to the logic for calculating completeness makes sense.

Additionally, a required (*) indicator will appear next to the reference and name fields.

Some organisations will not have a reference for users to enter, so please can we remove the required (*) against this field. All organisations should have a narrative (i.e. name), so it is reasonable for this to be marked as a required field to help the user complete the data entry form.

During imports, an error message of the 'error' level will be displayed if the conditions are not met.

To check normal behaviour, are error messages displayed for all import file types (xml, csv and xlsx), or just xlsx?

I see an error message for missing participating-org name and reference when I've tested an xlsx file import, but not for an equivalent csv import (e.g. Test csv import - organisation _Emma's test publisher - Sep 2024.csv)

[PG-Momik]

@emmajclegg

To check normal behavior, are error messages displayed for all import file types (xml, csv and xlsx), or just xlsx?

No, the error message should be displayed for all import types. I've redeployed the changes + the new changes with required(*) removed from reference. Please let me know if the issue persists.

[emmajclegg]

Thanks @PG-Momik - the csv import issue has been resolved.

A last minor comment - I've noticed that only the reference field is highlighted with a red border when the error messages display. I think name should also be highlighted red, given the errors relate to both fields:

Once that's updated, I'm happy for this issue's changes to be deployed.

[Sanam-07]

@emmajclegg

I have looked at the bug you highlighted in other environment as well ,it exists there as well. The source of this bug is the changes made during issue #1598. I have raised the new issue #1610 and informed @PG-Momik .

CC: @PG-Momik @BibhaT

[emmajclegg]

@PG-Momik - I can still see this bug on staging: #1610, so assume that's being picked up separately?

I'm happy for the participating-org changes to be deployed in the meantime.