bcgov / entity

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

All PPR documents are generated through the new report API #13161

Closed RFK250 closed 1 year ago

RFK250 commented 1 year ago

Note

Please check with Doug before taking this ticket.

AC

GIVEN I am a PPR user WHEN I perform a PPR search (e.g. by owner name, by registration #, etc) THEN My documents are generated via the new Report API (Gothenburg) AND The table of contents includes page numbers and URLs

Requirements

Need to migrate these documents

Large search result report notes: Total # of search requests in PROD: 690920 Total # over 700: 110 Total # over 1000: 48 Some of these are duplicates for failed attempts: New large search report light format for reports containing over 700 registrations.

Performance: 843 registrations: time to generate 10:48, files size 19MB. 1333 registrations: time to generate 14:41, file size 32MB.

Note: removing page numbers and links from the TOC reduces the above time to generate significantly.

RFK250 commented 1 year ago

@doug-lovett to add more detail

RFK250 commented 1 year ago

Please add your planning poker estimate with Zenhub @doug-lovett

doug-lovett commented 1 year ago

Search example:https://app.zenhub.com/files/157936592/04820a48-46bd-4d64-a9e0-660e475971b7/download

doug-lovett commented 1 year ago

Large search format example: https://app.zenhub.com/files/157936592/fa5488b6-a259-4baf-90c2-0164fa1ee45c/download

doug-lovett commented 1 year ago

Mail amendment and discharge verification examples:https://app.zenhub.com/files/157936592/298c7d47-faf1-4e79-b5c2-218fd35ba3f6/download https://app.zenhub.com/files/157936592/8bdfb6bc-33f9-4bc4-bca6-ef6442740db8/download

doug-lovett commented 1 year ago

Verification amendment example: https://app.zenhub.com/files/157936592/351bfd8f-df89-4395-8cd3-2c4ed0038921/download

doug-lovett commented 1 year ago

Move to staging until 13860 development is complete.

RFK250 commented 1 year ago

@doug-lovett Is that necessary? Releasing this ticket as is would still be an improvement over the status quo, would it not? i.e. we'll still see some manual file retrievals from large requests, but fewer than we're currently seeing. Am I missing something? I ask because I don't know when we'll get to 13860.

doug-lovett commented 1 year ago

@RFK250 we can move this to RFQA for the non-large reports. I was thinking that the 13860 change would go into DEV within the next few days. Release management is different for significant PPR API changes. After internal QA we release to the SANDBOX environment for at least 1 week before PROD to give the API clients an opportunity to test the change. With this change we will also run some load tests in the SANDBOX environment.

RFK250 commented 1 year ago

@doug-lovett Okay, let's do RFQA on this ticket for the non-large reports, and we'll QA the large ones with 13860 assuming that you expect to get to it soon. That way we'll have at least partially implemented in the event we aren't able to get to 13860 soon as we hope. cc @chdivyareddy

tlebedovich commented 1 year ago

@forgeuxGH5 - tagging you here to review with Doug

tlebedovich commented 1 year ago

@RFK250 - we ran out of time to review so far - if you want to move this along, we can do UXA as a separate spin off UXA ticket if you want to create a new one and leave it in this column?

RFK250 commented 1 year ago

Thanks @tlebedovich - I'll do that, as I'd like to move it along minus the large reports.

RFK250 commented 1 year ago

@chdivyareddy Please note: This ticket should be QA'd only for non-large reports, and UXA is still to do but there's a separate ticket #13972 for that.

chdivyareddy commented 1 year ago

@doug-lovett , Quick question - When the search result is added to the table 'i' icon is displayed, can the user click on the i icon to generate PDF once it is ready? Currently, when the i icon is clicked, the 'Unable to open document' modal is displayed and only once the user reloads the dashboard, then the PDF gets generated:

Is there UI work required here? Can you please take a look, thanks!

image.png

doug-lovett commented 1 year ago

@chdivyareddy nice catch. The search report generation is now identical to that of verification reports. The search completion now returns without waiting for the report generation to complete. The report request is queued and there is slight delay (in most cases) before the report is available for download. So the UI behaviour should probably be updated (and maybe the messaging) as you suggest.

RFK250 commented 1 year ago

Ooo sounds like a good opportunity to make a tech debt ticket like we talked about at retro! :) @chdivyareddy I would do it myself except I wouldn't be sure what to include in the AC - do you mind making that ticket please?

chdivyareddy commented 1 year ago

@doug-lovett Thanks for confirming:)

@RFK250 created #13980 for the issue, thanks:)

RFK250 commented 1 year ago

Awesome, thanks @chdivyareddy ! :)

forgeuxGH5 commented 1 year ago

I thought we had this handling already for ppr - I thought it was working like the registrations table with the spinner on a timer and it would check for the reports while spinning. If we need that re-spec'd I can see if I can find the old ticket.

RFK250 commented 1 year ago

Thanks @forgeuxGH5 that's a good idea and would be helpful.

RFK250 commented 1 year ago

@doug-lovett @chdivyareddy @forgeuxGH5 Being mindful of Kaine's attention on this right now, I still think we should aim to get non-large reports into the next release if at all possible. There's clearly an operational need to mitigate things as soon as practicable. Is there any reason we can't do that for Monday?

chdivyareddy commented 1 year ago

@RFK250 We can probably get this into the next release, I'll get some examples from Doug on Monday to test various scenarios and 13980 should also be fixed to get this through.

forgeuxGH5 commented 1 year ago

@RFK250 see my comments in #13890 regarding the UI - I don't think that has to block anything for this ticket (13161).

doug-lovett commented 1 year ago

@chdivyareddy 13860 is in review but already deployed to test for unit testing. You can now test large search results > 700 registrations. Also, I reverted the dashboard search history behaviour with saving to doc storage. The first time a download is requested it is saved to doc storage. Subsequent requests will download the doc storage report. By not changing the search report request behaviour there is no impact to the direct API clients so we can get this change into PROD more quickly.

chdivyareddy commented 1 year ago

@doug-lovett Sure, will take a look, thanks!!

doug-lovett commented 1 year ago

DEV: AF serial numbers: 1273 :white_check_mark: 128 :white_check_mark: 1295 :white_check_mark: 1315 :white_check_mark: 151 :white_check_mark: 160 :white_check_mark: 1695 :white_check_mark: Sample Output of AF serial number: 1273 https://app.zenhub.com/files/157936592/1f8cc6b9-0159-42d3-ad4b-6f6bfeb13323/download

MV Serial Numbers: 00000008824CN3063 :white_check_mark: 0000000FD3S500836 :white_check_mark: 000000-1179-160 :white_check_mark: 000000MBPGSIN8014 :white_check_mark: 0000023NFE0400109 :white_check_mark: 00000BL3B20FFG999 :white_check_mark: 00001L47L61132054 :white_check_mark: 00001Z37W2S503253 :white_check_mark: 000020201204 :white_check_mark: 0000316274 :white_check_mark: 00003526 :white_check_mark: 0000676 :white_check_mark: 000089G :white_check_mark: 0000NL96Q102920LE :white_check_mark: 000101741610 :white_check_mark: 000288412 :white_check_mark: 0003115424 :white_check_mark: 00032740000945 :white_check_mark:

Sample Output of MV Serial Number: 00003526 (including similar matches) https://app.zenhub.com/files/157936592/95e5f910-5518-4d57-96ff-311023e51763/download

doug-lovett commented 1 year ago

Individual Debtor searches from PROD: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "gerjit", "second": "", "last": "dosanjh"}}, "clientReferenceId": ""} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Cheryl", "second": "", "last": "Bratton"}}, "clientReferenceId": ""} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "RYAN", "second": "DANIEL", "last": "VANDAMME"}}, "clientReferenceId": "22179-156077"} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "CHRISTOPHER", "last": "COTRELL"}}, "clientReferenceId": "0887RI"} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "RYAN", "second": "DANIEL", "last": "VAN"}}, "clientReferenceId": "22179-156077"} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Yi", "second": "Lin", "last": "Shou"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "G", "last": "Lam"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "WESLEY", "second": "GLENN", "last": "LEVESQUE"}}, "clientReferenceId": "22179-156077"} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Michael", "last": "Boast"}}, "clientReferenceId": "160760282"} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Louie", "last": "Baptiste"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Kristopher", "last": "Coles", "middle": "Leslie"}}} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "GRACE", "last": "ERICKSON"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Dallas", "last": "Goldie"}}, "clientReferenceId": ""} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "dillon", "second": "", "last": "rose"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "B", "last": "Loewen"}}, "clientReferenceId": ""} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Alnoor", "last": "Jiwan"}}, "clientReferenceId": "23868-1727"} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Anthony", "last": "Cheung"}}, "clientReferenceId": ""} {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "V", "last": "LEWIS"}}, "clientReferenceId": ""} :white_check_mark: {"type": "INDIVIDUAL_DEBTOR", "criteria": {"debtorName": {"first": "Bronwyn", "last": "Cheung"}}, "clientReferenceId": ""}

Sample Output of Individual Debtor search: "first": "RYAN", "second": "DANIEL", "last": "VANDAMME"

https://app.zenhub.com/files/157936592/1ff16ce7-e879-453e-8a22-7124b2d09d9d/download

doug-lovett commented 1 year ago

Some business debtor searches from PROD: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "B&W MRI SERVICES LTD."}}, "clientReferenceId": "9449308 "} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "ROCK SOLID INDUSTRIES INC."}}, "clientReferenceId": "BR64-RR265883"} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "TYCROP MANUFACTURING LTD"}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "T & A Rock Works Inc."}}, "clientReferenceId": "18726590"} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "OEM CORPORATION"}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "OEM CORPORATION"}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "COBOTIX MANUFACTURING INC."}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "CORONA EXCAVATIONS LTD."}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "Reliable Tube Ltd."}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "COHO VENTURES LTD."}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "Reliable Tube Ltd."}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "HOHMANN BROS. CONTRACTING LTD."}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "Midtown Bistro"}}, "clientReferenceId": ""} {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "MEDI-TRAN SERVICES (1993) LTD."}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "1169629 B.C. LTD."}}, "clientReferenceId": ""} :white_check_mark: {"type": "BUSINESS_DEBTOR", "criteria": {"debtorName": {"business": "BETTER SEAFOOD SUPPLY LTD."}}, "clientReferenceId": "18727298"} :white_check_mark:

Sample Output of Business Debtor search: "MEDI-TRAN SERVICES (1993) LTD." (Includes similar search)

https://app.zenhub.com/files/157936592/80124807-7c78-4520-b1dd-4f4a622fd683/download

chdivyareddy commented 1 year ago

@forgeuxGH5 @tlebedovich , Sample outputs for the non-large reports for each category were added above from DEV. I took random examples added by Doug to verify and added checkmarks for the ones which I verified and successfully downloaded reports. Please take a look at the attached examples for UXA review or can use the BCREG0057 account in DEV to download more examples, thanks!!

tlebedovich commented 1 year ago

@doug-lovett @chdivyareddy - thanks for the examples! I just added UXA for the non-large PPR outputs into the new UXA specific ticket https://github.com/bcgov/entity/issues/13972

tlebedovich commented 1 year ago

Moving this to RFQA since the UXA was done in ticket #13972 instead

chdivyareddy commented 1 year ago

@tlebedovich , it's already in QA - you have moved it to Done :wink:

Moving back to QA in progress as it is not in TEST env, thanks!

tlebedovich commented 1 year ago

hahha, oops.