bcgov / entity

ServiceBC Registry Team working on Legal Entities
Apache License 2.0
23 stars 57 forks source link

UI - Step 3 Organization Owner Look Up #12837

Closed mstanton1 closed 1 year ago

mstanton1 commented 1 year ago

GIVEN I am Registries Staff entering an organization as a home owner in a Manufactured Home Initial Registration WHEN I am in Step 3 - Enter the home owner THEN I can look up an organization AND click on a organization from the list retrieved AND Partnership or Proprietorship registrations show as light grey / disabled AND the organization name and address populates in the appropriate fields

ACTIVE Businesses to Include that are selectable

ACTIVE Business in Include and Display as disabled with info icon:

Visual Design Comps for this --> https://projects.invisionapp.com/share/6U12ZPBREB2F#/screens?browse

jinghualicgi commented 1 year ago

Hey team! Please add your planning poker estimate with ZenHub @cameron-freshworks @dimak1 @doug-lovett @garyfan1 @ChasBoucher

mstanton1 commented 1 year ago

Hey team! Please add your planning poker estimate with ZenHub @chdivyareddy @thorwolpert

dimak1 commented 1 year ago

Moving back to Sprint Backlog to work on another task instead.

dimak1 commented 1 year ago

@mstanton1 @forgeuxGH5 Melissa, Scott, do you know if this lookup is for modernized or all businesses?

Context: Right now we are using API to get all business names based on user input. This API does not return the addresses. We would have to make another call to pull address info, and based on business type (modernized vs all) we'll need to use different APIs.

mstanton1 commented 1 year ago

@dimak1 this should look against

Sole proprietorships, partnerships and limited partnerships should be retrieved as well but disabled in grey as they may not be selected as a home owner. I'd recently checked with @thorwolpert because I was nervous that only cooperatives had moved over and we might need to do look-ups in more than one place. He'd noted the search has all businesses - but I hadn't verified address as I was looking into the status (verifying active) at that time.

@JohnamLane @thorwolpert are we able to pull an entity address through the search API?

forgeuxGH5 commented 1 year ago

Business Registry did this for SP/GP and I thought they included the address - I can double check that

dimak1 commented 1 year ago

@mstanton1 We have integrated search API via #12856 and it does return all those 'legal' types you mentioned (sample results below). So we are good there. Getting address info once user selected an Organization is the next step, and we need to figure out which API to use for that. I'm in talks with Kial and he asked me which orgs/businesses are those so we can narrow down the API calls.

"results": [
            {
                "identifier": "XS1000661",
                "legalType": "XS",
                "name": "ABC",
                "score": 284.95627,
                "status": "ACTIVE"
            },
            {
                "bn": "123",
                "identifier": "S1000144",
                "legalType": "S",
                "name": "abc company",
                "score": 249.80449,
                "status": "ACTIVE"
            },
            {
                "bn": "123",
                "identifier": "S1000138",
                "legalType": "S",
                "name": "abc company",
                "score": 249.80449,
                "status": "ACTIVE"
            }
....
]
mstanton1 commented 1 year ago

@dimak1 thanks for working with Kial on this. Is there additional information I can provide? Catherine dug some requirements up on entity type that is allowed. I have a copy of her document and have updated my note above on what can be included.

dimak1 commented 1 year ago

@mstanton1 @tlebedovich @forgeuxGH5 thanks for the discussion. Based on what was discussed, we won't pre-populate the address fields. Everything else stays the same (in the search field). Please let me know if my understanding is correct. Thanks!

mstanton1 commented 1 year ago

@dimak1 thanks for summarizing. Yes, from what we discussed we won't pre-populate address fields. I've updated the AC in the body of this ticket. Since the Registries Search API does not have addresses either there will be a minor change in the design as the drop down list won't include addresses.

@tlebedovich @forgeuxGH5 please let me know if you think there's something I've missed.

tlebedovich commented 1 year ago

@dimak1 we are making some intro/help text updates, will ping when ready. The visual design dropdown already has the address removed.

tlebedovich commented 1 year ago

@mstanton1 @dimak1 - scott has updated the intro text, help, field text and subhead in the dropdown and we've added a spinner icon to the field if there is a delay in seeing look-up results. The design link above has the updated work. Do we want to create a spin off ticket for this new work?

dimak1 commented 1 year ago

@tlebedovich I think we can add to this ticket and bump up the estimate. I made some good progress today and can work on new updates tomorrow. But will refer to @mstanton1 to confirm.

mstanton1 commented 1 year ago

@dimak1 how significant is the additional effort? I notice we still have 13 points in the sprint backlog and 12 points in progress. If it's fairly minor (e.g. 1/2 day or less) please add it in. If not, let me know and I can make another ticket:)

JohnamLane commented 1 year ago

@mstanton1 FYI this call in the Business Registry (aka lear) API returns addresses when called using the identifier. https://bcregistry-demo.apigee.io/docs/businessproxy/1/routes/businesses/%7Bidentifier%7D/addresses/get

dimak1 commented 1 year ago

@mstanton1 I quickly looked at the new design and it shouldn't take long, as the changes are not significant.

tlebedovich commented 1 year ago

@mstanton1 - we reviewed the additional updates with Dima in detail this morning and it is enough to warrant an additional ticket. I am happy to make one, please let me know which zenhub column to put it into - Grooming or Sprint Backlog. Dima suggested a 2 estimate

mstanton1 commented 1 year ago

Grooming would be great. Can you send me the number when created? Thanks @tlebedovich

tlebedovich commented 1 year ago

@dimak1 @mstanton1 @forgeuxGH5 - additional required updates are in this ticket -> https://app.zenhub.com/workspaces/assets-team-space-61426544e7e2ea001d079597/issues/bcgov/entity/14383

mstanton1 commented 1 year ago

@tlebedovich thank you!!

dimak1 commented 1 year ago

@tlebedovich just a heads up, when you will UXA this ticket, there is no hover state for the deactivated Orgs in the list. I placed a tooltip on top of the row (workaround so it can be activated), but the whole row in the disabled state is not hover-able.

tlebedovich commented 1 year ago

@dimak1 thanks, here is my UXA for you:

Updated Validation Matrix - https://onedrive.live.com/view.aspx?resid=E52B0821EC98A357!24617&ithint=file%2cxlsx&authkey=!AGsk_T-db8T0f8M

Screen Shot 2022-11-25 at 2.18.56 PM.png

Screen Shot 2022-11-25 at 2.14.36 PM.png

Screen Shot 2022-11-25 at 2.15.07 PM.png

Screen Shot 2022-11-25 at 2.15.51 PM.png

Screen Shot 2022-11-25 at 2.17.36 PM.png

Screen Shot 2022-11-25 at 2.19.16 PM.png

Screen Shot 2022-11-25 at 2.33.45 PM.png

Screen Shot 2022-11-25 at 2.16.49 PM.png

Screen Shot 2022-11-25 at 2.16.44 PM.png

Screen Shot 2022-11-25 at 2.36.54 PM.png

tlebedovich commented 1 year ago

@doug-lovett - can you confirm the max characters for business name (owners for Transfer and Registration) and if we except special characters or only letters and numbers for business names? these aren't in our matrix.

I know in Business Registry names can be up to 150 characters.

c/c @mstanton1 @dimak1 @PatrickAHeath

doug-lovett commented 1 year ago

@tlebedovich the legacy DB2 max length for owner names is 70 characters. The API currently has no extra validation on name characters: any character within the UTF-8 character set is allowed.

tlebedovich commented 1 year ago

@mstanton1 @forgeuxGH5 - Legacy DB allows 70 max characters for Business name. Business Registry can have up to 150 characters. What should we do here? Hope noone selects a name over 70 characters from the look up?

@doug-lovett - is there a minimum character?

tlebedovich commented 1 year ago

@mstanton1 @forgeuxGH5 - the valid characters validation in the matrix says "Enter letters or numbers only", doug says it excepts any character within the UTF-8 character set. Which should we do?

mstanton1 commented 1 year ago

For the 70 Character Restriction let's get Sharon to walk us through the current state. If this is the current restriction I'm assuming it's already an issue (probably just cut off names on outputs). In that case we could just forge ahead and add it into a post data migration epic. If the legacy system does something more than we can look at interim options.

For the character set a business could include some punctuation (e.g. apostrophe). I could reach out to John to confirm what characters could be included in the business name since he leads the search team and we could ensure we restrict to align with them.

For both of these it seems like things we need to gather requirements on and then tackle in future tickets so we keep this moving.

dimak1 commented 1 year ago

@tlebedovich I'll take a look at your feedback and give an update on the items. Thanks for the feedback.

forgeuxGH5 commented 1 year ago

@tlebedovich @mstanton1 Agree on the name length - like for like with MH Online. I don't think we can restrict the character set or name format - the org name can be from anywhere in the world and doesn't have to be a business.

tlebedovich commented 1 year ago

@mstanton1 @dimak1 - So Dima can continue with this ticket let's:

  1. Keep max character limit/validation as 70 and create follow up ticket for error handling of longer names after talking to Sharon (Melissa - I saw in the matrix a note about staff using the suffix field if the name is longer than 70, but not sure non-staff users would know to do that)
  2. remove the invalid character error validation from matrix that says "must contain letters or numbers only" and allow letters, numbers and special characters.

c/c @forgeuxGH5

mstanton1 commented 1 year ago

@tlebedovich sounds good. Thanks for summarizing that direction. I will update the requirements meeting agenda for tomorrow to include this topic.

dimak1 commented 1 year ago

Updated the following:

PR is opened and under review.

dimak1 commented 1 year ago

Updated the following:

PR is opened and under review.

cc: @tlebedovich

tlebedovich commented 1 year ago

@mstanton1 - can you please update the AC with all of the Active business types that should be included in the business look up

tlebedovich commented 1 year ago

@dimak1 - from our call:

Screen Shot 2022-11-30 at 12.09.41 PM.png

dimak1 commented 1 year ago

@tlebedovich thanks for the feedback and checklist. Moving back to In Progress.

dimak1 commented 1 year ago

@tlebedovich updated as per your feedback above. Only keyboard up/down is a tricky one, and if a hard requirement would like to tackle it as a separate item.

tlebedovich commented 1 year ago

@dimak1 - looks great to me.

tiny update to the required field error message - can you update it to say "Enter a business or organization name" - I will move this along to RFQA in the meantime.

Screen Shot 2022-12-05 at 2.21.17 PM.png

dimak1 commented 1 year ago

Updated the message. Awaiting to deploy to dev.

chdivyareddy commented 1 year ago

Verified in TEST!

Screenshot (95).png

Error validation message:

image.png

Max Character validation: image.png

No matches found: image.png