[UIU-2684] Custom-fields does not allow you to edit the refId (Both UI and API) Created: 31/May/22  Updated: 17/Oct/22  Resolved: 06/Oct/22

Status: Closed
Project: ui-users
Components: None
Affects versions: None
Fix versions: None

Type: Bug Priority: P3
Reporter: Theodor Tolstoy (One-Group.se) Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: back-end, epam-spitfire, support
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File image-2022-05-31-11-15-09-961.png     PNG File image-2022-05-31-11-17-02-705.png     PNG File image-2022-05-31-11-21-46-232.png     PNG File image-2022-05-31-11-22-26-284.png    
Issue links:
Defines
defines UXPROD-3677 NFR : Enhancements/Bugfixes/Tech Debt... Closed
Relates
relates to UXPROD-3837 Add RefId value to the display of a c... Draft
Sprint:
Development Team: Spitfire
Potential Workaround: Make sure to spell and name custom fields properly from the start.
OR
Remove the misspelled custom field and create a new one.
Affected Institution:
!!!ALL!!!
RCA Group: Not a bug

 Description   

Overview: When trying to update a custom field's refId, this is ignored by both PUT API endpoints
Steps to Reproduce:

  1. Log into https://folio-snapshot.dev.folio.org/
  2. Go to settings->users->custom fields
  3. Create a custom field, purposely misspelled
  4. Try to correct your spelling in the UI. Save.

Expected Results:

  • You get a clear warning that this edit may affect users already in the system and are asked if you want to proceed.
  • After the update is made, the refId aligns with the name of the custom field as if it was newly created (casing, stripping weird characters, etc)
  • You now have a clear understanding of what the refId is for this custom field, and by so, you can set up ongoing patron loads with this new custom field.

Actual Results:

None of the above happens. The refId stays the same.

 

  1. To verify, make an HTTP GET to /custom-fields or check the Developer Tools in the browser to see what edits were made:

Additional Information:
This behavior is likely by design since the refID is the value stored in the records themselves as property names.

However, in the context of setting up FOLIO and doing initial migrations, it would be good if you could force updates to refIDs, either by API or UI. 

I guess the assumption was made that after the initial migration, adding users is a manual task, and the name of the actual refId does not matter.  However, libraries rely on automated loads for these users, and having the wrong refIds for custom fields will lead to errors and confusion. 

 

 

 



 Comments   
Comment by Ann-Marie Breaux (Inactive) [ 01/Jun/22 ]

Hi Khalilah Gambrell There was no dev team assigned to this bug - looks like it belongs to Spitfire. Please adjust if not correct. Thank you!

Comment by Pavlo Smahin [ 22/Aug/22 ]

It's expected behavior and the cause of the implementation details: refId should be unchangeable. All we can do is allow refId changes only when there are no values in users for the custom field.

cc: Khalilah Gambrell 

Comment by Theodor Tolstoy (One-Group.se) [ 22/Aug/22 ]

I agree, but could another way around it be to have the RefID shown in the UI? We do this for codes in other parts of settings. 

Comment by Khalilah Gambrell [ 22/Aug/22 ]

So Theodor Tolstoy (One-Group.se)  - if we display the RefID in the UI Then that will address this issue? 

Comment by Ann-Marie Breaux (Inactive) [ 23/Aug/22 ]

Similar to the HRIDs in all of the various Inventory records - they display in the UI, but are not editable

Comment by Erin Nettifee [ 23/Aug/22 ]

The custom field ref IDs are not HRIDs, Ann-Marie Breaux - they're ids to the setting, the field itself.

Theodor Tolstoy (One-Group.se) you can get the refIds from the underlying JSON of the setting. Is that not sufficient for what you're trying to do?

I don't see a particular issue with adding the refID to Settings > Users > Custom Fields, but they should not display on the Users app UI - that will only lead to confusion.

Comment by Charlotte Whitt [ 19/Sep/22 ]

Support SIG: Khalilah Gambrell do you have an update on this ticket. This is an issue affecting ALL libraries.

Comment by Theodor Tolstoy (One-Group.se) [ 06/Oct/22 ]

Sorry for not geeting back to this until now. I think showing the refID in the settings would be the perfect solution, just as you describe Erin Nettifee  

Comment by Erin Nettifee [ 06/Oct/22 ]

So what I'm going to do is close this and open up another Jira for that work than Theodor Tolstoy (One-Group.se)

Comment by Erin Nettifee [ 06/Oct/22 ]

We will open up another feature to add the RefId display as a solution to this.

Generated at Thu Feb 08 22:22:32 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.