As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

euanmillar · 2024-04-19T11:16:01Z

Description

OpenCRVS is hardcoded to display names with family name appearing last in many places: {firstName} {middleName} {lastName}.

But in many countries surname appears first so this should be configurable in record audit and other places for example.

This ticket describes 2 changes that we need to make.

Tech tasks

National System Admin – Create user form

When logged in as a national system administrator user you can create new users in offices. The create new user form is not currently configurable and we have no plans to make it configurable. However, as we often receive requests from countries to have the surname first in this form, we have decided to satisfy that requirement by putting surname first for ALL countries.

We also want to remove the question that asks the user for a national ID number in this form as it is not required.

Change name field ordering in user creation and edit flows to [Surname] [Firstname]. Rename the labels to be "User's surname" and "User's firstname".
Remove the NID question from user creation / edit flow. Ensure possible NIDs are removed from user-mgnt.users collection. Write a migration to remove the field from existing users.

How citizen data appears in the team user list, work queues and record audit

If we create a content management key called constants.humanName with a default value {firstName} {lastName}, then the client could read this content key and dynamically choose to represent names in work queues and record audit according to it. If the content key was like this: {lastName} {middleName} {firstName} then the names could be rendered appropriately

Create new copy item constants.humanName with a default value {firstName} {lastName} and start using it in the admin view's user listing. Keep in mind that this same constant is to be used for rendering record subject names so for instance a country might want to have this as {lastName} {middleName} {firstName}
Refactor generateName in packages/client/src/utils/data-formatting.ts so that it respects the name format defined in the team user list view

Other applications

Go through the app and test for instance {lastName} {middleName} {firstName} properly applies everywhere such as work-queues and record audit.
In release notes: Add a few examples of different ways to configure this e.g. middle name doesn't exist OR

The text was updated successfully, but these errors were encountered:

euanmillar · 2024-04-22T10:15:21Z

Decision needs to be made if name configuration is decoupled from the rest of registration form configuration.

rikukissa · 2024-06-10T06:14:58Z

@euanmillar ticket updated. Can be unblocked and moved to Ready to build

rikukissa · 2024-06-17T05:17:08Z

Updated task description to include configurable name formatting elsewhere in the app as Burkina Faso needs this

euanmillar · 2024-07-22T11:12:29Z

@rikukissa if we are doing this: "Ensure possible NIDs are removed from user-mgnt.users collection" wont we need a database migration? I wonder if it is worth the effort. It might be acceptable to just leave the national id prop in the database than maintain the migration file. Just an idea

rikukissa · 2024-07-29T06:30:39Z

Good point, I'll update the task description. Long-term it's best if we aim to always have the database and data integrity in tip-top shape, so definitely worth writing a migration

we often receive requests from countries to have the surname first in this form, we have decided to satisfy that requirement by putting surname first for ALL countries. #6830

A request came for the clients to change the labels for "First name(s)" to "User's first name". Also change "Last name" to "User's surname" for clarity and less confussion. #6830

A request came for the clients to change the labels for "First name(s)" to "User's first name". Also change "Last name" to "User's surname" for clarity and less confussion. opencrvs/opencrvs-core#6830

Remove the question that asks the user for a national ID number in this form as it is not required #6830

Remove the question that asks the user for a national ID number in the User details form as it is not required opencrvs/opencrvs-core#6830

Remove the question that asks the user for a national ID number in this form as it is not required #6830

We no longer need the suffixes for the FamilyName field since we not really using it anywhere #6830

A requirement from client to remove the NID field since most of the contries are not really using it. #6830

We no longer need the suffixes for the FamilyName field since we not really using it anywhere opencrvs/opencrvs-core#6830

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

#6830

To allow countries to have custom ordering for full names #6830

To ensure that we get the format from the country-config #6830

To make the name more usable we had to extract the name formatting logic into it's own function. #6830

#6830

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

#6830

SInce we introduced the ability to allow countries to customise the order for a full name and the default being {surname} {middlename} {firstname} the tests need to conform to that opencrvs/opencrvs-core#6830

There were some screens that were not using the new customised formatName() so the refactor to formatName broke thier e2e tests, the temporary solution is to add a new function formatNameWithFirstNameFirst() which uses the old logic until the screen are updated opencrvs/opencrvs-core#6830

euanmillar added this to OpenCRVS Core Apr 19, 2024

euanmillar converted this from a draft issue Apr 19, 2024

euanmillar changed the title ~~user creation form surname should come first~~ User creation form surname should come first Apr 19, 2024

euanmillar added the Feature label Apr 19, 2024

euanmillar added this to the v1.6.0 milestone Apr 22, 2024

euanmillar added the 🚫 Blocked label Apr 22, 2024

euanmillar modified the milestones: v1.6.0, 1.7.0 Apr 29, 2024

jpye-finch removed the 🚫 Blocked label Jun 13, 2024

rikukissa changed the title ~~User creation form surname should come first~~ Configurable human name formatting Jun 17, 2024

rikukissa moved this from Backlog to Ready to build in OpenCRVS Core Jul 3, 2024

Siyasanga self-assigned this Sep 18, 2024

Siyasanga moved this from Ready to build to In Development in OpenCRVS Core Sep 18, 2024

Siyasanga added a commit that referenced this issue Oct 1, 2024

Ask surname first in the User details form

9d4f064

we often receive requests from countries to have the surname first in this form, we have decided to satisfy that requirement by putting surname first for ALL countries. #6830

Siyasanga mentioned this issue Oct 1, 2024

feat: Update the order of system user add/edit form fields and labels and remove NID field #7697

Merged

Siyasanga mentioned this issue Oct 1, 2024

feat: Update system user form fields translations opencrvs/opencrvs-countryconfig#289

Merged

Siyasanga added a commit that referenced this issue Oct 3, 2024

Remove NID field from the user details form

38704ec

Remove the question that asks the user for a national ID number in this form as it is not required #6830

Siyasanga added a commit to opencrvs/opencrvs-countryconfig that referenced this issue Oct 3, 2024

Remove NID field from the user details form

4795f6e

Remove the question that asks the user for a national ID number in the User details form as it is not required opencrvs/opencrvs-core#6830

Siyasanga added a commit that referenced this issue Oct 4, 2024

Remove NID field from the user details form

a124bb6

Remove the question that asks the user for a national ID number in this form as it is not required #6830

Siyasanga pushed a commit that referenced this issue Oct 8, 2024

Remove lang suffix for FamilyName field

08556a2

We no longer need the suffixes for the FamilyName field since we not really using it anywhere #6830

Siyasanga pushed a commit that referenced this issue Oct 8, 2024

Add migration to remove NID field from user

1d83f88

A requirement from client to remove the NID field since most of the contries are not really using it. #6830

Siyasanga pushed a commit to opencrvs/opencrvs-countryconfig that referenced this issue Oct 8, 2024

Remove lang suffix for FamilyName field

788bb9e

We no longer need the suffixes for the FamilyName field since we not really using it anywhere opencrvs/opencrvs-core#6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Use getLocalisedName on the UserAudit comp

29401cb

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

refactor: use getLocalisedName() @ InProgress.tsx

4f517dc

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Refactor the work queues to use getLocalisedName()

0e02343

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Record changes in the CHANGELOG for this PR

b66f929

#6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Add humanName to constants.ts

0e7cc51

To allow countries to have custom ordering for full names #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Use constants.humanName on the UserList.tsx comp

4f1820d

To ensure that we get the format from the country-config #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Create a utility function getLocalisedname()

3465e6a

To make the name more usable we had to extract the name formatting logic into it's own function. #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Use getLocalisedName on the UserList component

a563c5a

#6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Use getLocalisedName on the UserAudit comp

347999c

Replace older logic to get the name which was based on an assumption that we support names in multiple languages #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

refactor: use getLocalisedName() @ InProgress.tsx

cec5d6a

We've found cleaner way to make the rendered name customizable for each country through client copy from country-config #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Refactor the work queues to use getLocalisedName()

b2de8b9

We need to update all the places where a citizen's name is being referenced to show it in the format that the country chooses #6830

Siyasanga added a commit that referenced this issue Nov 14, 2024

Record changes in the CHANGELOG for this PR

948771b

#6830

prinzab removed this from the v1.7.0 milestone Nov 14, 2024

Siyasanga linked a pull request Nov 15, 2024 that will close this issue

feat: Add constants.humanName to allow countries to have custom full name format #7957

Open

Siyasanga linked a pull request Nov 15, 2024 that will close this issue

refactor: fix failing e2e test for all places referencing a full name opencrvs/opencrvs-farajaland#1164

Open

euanmillar added this to the v1.7.0 milestone Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

euanmillar commented Apr 19, 2024 •

edited

Loading

euanmillar commented Apr 22, 2024

rikukissa commented Jun 10, 2024 •

edited

Loading

rikukissa commented Jun 17, 2024

euanmillar commented Jul 22, 2024

rikukissa commented Jul 29, 2024

As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

As a user from another country I want to see names in a format that we use so that they reflect my cultural norms #6830

Comments

euanmillar commented Apr 19, 2024 • edited Loading

Description

Tech tasks

euanmillar commented Apr 22, 2024

rikukissa commented Jun 10, 2024 • edited Loading

rikukissa commented Jun 17, 2024

euanmillar commented Jul 22, 2024

rikukissa commented Jul 29, 2024

euanmillar commented Apr 19, 2024 •

edited

Loading

rikukissa commented Jun 10, 2024 •

edited

Loading