Add display Name for roles - Githubissues

bcgov / nr-forests-access-management

Authorization solution for BC natural resource sector

Apache License 2.0

8 stars 2 forks source link

Add display Name for roles #1242

Closed gormless87 closed 2 weeks ago

gormless87 commented 6 months ago

Describe the task Add a database column to store a role display name

Acceptance Criteria

[x] Add db column (100 character limit) for role display name - nullable
[x] Populate the new column for existing roles (to be added to this ticket)
[x] Ensure child roles use parent abstract role display name as their display name
[x] Update ORM model(s) for fam_role for new column
[x] Update the return results of return-my-access-api to include role display name and role purpose
[x] Update get-user-role-assignment, ~~get-app-admin~~, get-delegate-admin to include role display name
[x] Add/update test if need

Additional context

Proper English role name to display in UI
1128 is for display
column needs to be nullable

mockup:

ianliuwk1019 commented 3 weeks ago

From database we have these roles across applications. We don't have role display names for them yet. Would these look fine (column two below):

<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns="http://www.w3.org/TR/REC-html40">

role_name | -- | -- Admin | Admin Approver | Approver CLIENT_ADMIN | Client Admin CLIENT_EDITOR | Client Editor CLIENT_VIEWER | Client Viewer FOM_REVIEWER | Reviewer FOM_SUBMITTER | Submitter Planner | Planner SPAR_MINISTRY_ORCHARD | Ministry Orchard SPAR_NONMINISTRY_ORCHARD | Non-ministry Orchard SPAR_TSC_ADMIN | TSC Admin Submitter | Submitter Viewer | Viewer

@OlgaLiber2

OlgaLiber2 commented 3 weeks ago

Here is what we have @ianliuwk1019 FAM - Design_2024-08-22_14-31-20

ianliuwk1019 commented 3 weeks ago

Here is what we have @ianliuwk1019

Great, thank you so much Olga!!

ianliuwk1019 commented 3 weeks ago

Ticket #1563 created for SILVA roles inconsistency.

ianliuwk1019 commented 2 weeks ago

The new column for display name will be fam_role.display_name, will not be fam_role.role_display_name.