Batch Importer (Bib/Acq) (UXPROD-47)

[UIDATIMP-1473] Change validation messages which were represented in code format (Poppy) Created: 12/Jul/23  Updated: 13/Oct/23  Resolved: 25/Jul/23

Status: Closed
Project: ui-data-import
Components: None
Affects versions: None
Fix versions: 7.0.0
Parent: Batch Importer (Bib/Acq)

Type: Task Priority: P2
Reporter: Oleksandr Hladchenko Assignee: Oleksandr Hladchenko
Resolution: Done Votes: 0
Labels: data-import, epam-folijet, orchid-patch-rejected
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: PNG File CurrentBehavior.png     PNG File screenshot-1.png     PNG File screenshot-2.png     PNG File screenshot-3.png    
Issue links:
Defines
defines UXPROD-3849 Spitfire: e2e tests - R1 2023 Orchid ... Closed
Gantt End to Start
has to be done after MODDICONV-327 Change profile validation messages wh... Closed
Relates
relates to FAT-7093 Review of C404371 Closed
relates to FAT-7094 Review of C404370 Closed
Sprint: Folijet Sprint 170
Story Points: 1
Development Team: Folijet
Release: Poppy (R2 2023)
CSP Approved: No
CSP Request Details: Orchid CSP requested 1 Sept 2023 on Slack.
CSP Rejection Details: CSP not approved 19 Sept 2023
Epic Link: Batch Importer (Bib/Acq)
RCA Group: Implementation coding issue

 Description   

Purpose:

Profile validation errors could be represented as either a simple message or in error code format (e.g. "jobProfile.duplication.invalid").
It is complicated on the UI side to determine whether the validation error should be shown as-is or translated into a more user-friendly message.

Now, when BE got rid of messages represented as error code format, it is necessary to change behavior on UI side.

Current behavior is shown in the screenshot CurrentBehavior.png

ORCHID Critical service patch details

  1. Describe issue impact on business - Change some profile-related BE error messages to be more understandable to users in the UI. This UI fix should have been released with CSP 5, along with the corresponding MOD issue, but was accidentally missed.
  2. What institutions are affected? (field “Affected Institutions” in Jira to be populated) - All creating new import profiles
  3. What is the workaround if exists? User interprets the BE error message
  4. What areas will be impacted by fix (i.e. what areas need to be retested) Data Import Smoke and CP automated tests; the manual tests associated with this Jira
  5. Brief explanation of technical implementation and the level of effort (in workdays) and technical risk (low/medium/high).
    • Purpose: Since BE sends error messages in plain text format (previously both plain text and code format e.g jobProfile.duplication.invalid), it is necessary to change behavior in NetworkMessage component.
    • Technical explanation:
      • If we get error message with plain text we'll show errorMessage
      • If we get error without message we'll show communicationProblemMessage
      • If we get success message we'll show successMassage
      • Removed unused translations
      • Added unit test
    • Level of effort: Work is complete and level effort was low.
    • Technical risk: Very minimal risk.
  6. Brief explanation of testing required and level of effort (in workdays). Provide test plan agreed with by QA Manager and PO. Test cases already exist and level of effort is 1 hour
  7. What is the roll back plan in case the fix does not work? Revert to previous version


 Comments   
Comment by Ann-Marie Breaux (Inactive) [ 14/Jul/23 ]

Mariia Aloshyna Oleksandr Hladchenko: Is there anything we can test manually to confirm that the code format validation messages have been changed to something more user-friendly on the UI side? It's not clear to me if there's specific error messages that we could document with TestRails

cc: Maksym Ishchenko

Comment by Oleksandr Hladchenko [ 14/Jul/23 ]

Ann-Marie Breaux We can test manually in several ways:

  • Try to create profile that already exists
  • Try to create Job profile like here
  • Try to create action profile (e.g. Create instance) with linked field mapping profile (not instance)
Comment by Maksym Ishchenko [ 21/Jul/23 ]

Hello Ann-Marie Breaux 

Ticket verified on snapshot env. Error notification message is updated. Moving ticket to In review column

Screenshots: 

cc: Oleksandr Hladchenko 

Comment by Ann-Marie Breaux (Inactive) [ 25/Jul/23 ]

Hi Oleksandr Hladchenko Thank you for sorting these out!

Reminder for Ann-Marie Breaux : the mirrored profile association toast will only show until the longer-term solution is implemented on BE

Thank you for testing and adding the TestRails, Maksym Ishchenko 

Comment by Ann-Marie Breaux (Inactive) [ 19/Sep/23 ]

Orchid CSP not approved, so we will only release as a Poppy fix

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