Spike : Auth Web & Auth API: display continuation in filing in intermediate states (MBR)

[severinbeauvais]

Figma: https://www.figma.com/design/wVF8EcUCUR20YyqA0wHVJp/Continuation-In-V5?node-id=2154-3491&t=Z3R4v4o9NHwJk6nC-0

As with the Filings UI ticket #21977, we need to determine what a continuation in filing in AWAITING_REVIEW state or CHANGE_REQUESTED state should look like in MBR and what actions are available to the user.

When filing is DRAFT:

• same as today
• can resume or delete

When filing is AWAITING_REVIEW:

• should look like current draft continuation application
• status should be "Pending Staff Review"
• action should be "Open Application"
• no delete
• don't show Future Effective; Awaiting Review is more important

When filing is CHANGE_REQUESTED:

• should look like current draft continuation application
• status should be "Change Requested"
• action should be "Make Changes"
• no delete
• don't show Future Effective; Change Requested is more important

Other states once approved:

• same as today

When filing is REJECTED:

• should look like current draft continuation application

• status should be "Rejected"

• action should be "Open Application"

• no delete

• Spike: what needs to be updated?

  • Auth Web enums? interfaces?
  • Auth API enums? validation? db updates?

Once the above spike is completed, then we can groom this ticket (or create a new ticket).

[severinbeauvais]

@andyyanggov Do you have a link to a design that shows what the MBR page will look like for bootstrap filings in the different states?

[andyyanggov]

Yes, it's in the same link as the entity dashboard designs. Here's a link directly to the frame.

[ArwenQin]

The items in the Affiliated Entity Table are of Type Business.
So in Auth Web, we need to update the Business interface and store.

• Business interface: add a property Business.isFutureEffective: boolean
• Add an enum for Business.status
• Update AffiliationAction.vue for correct actions
  Question: When to show status "Future Effective - Paid"? Is it for approved only?

For Auth API & db, update the enum for Business.status, and add the property Business.isFutureEffective: boolean

[severinbeauvais]

Thanks, Arwen. That sounds reasonable.

As for future effective, I was thinking that we might want to show something special in the MBR when an application has been Filed and Paid (and Approved if applicable) and is just awaiting the FE date/time to arrive. Right now we label those "Drafts" but they are different from drafts that still need to be filed.

@NaveenHebbale @andyyanggov @janisrogers , what do you think we should show as status for these future businesses?

Also, should we show something special in the MBR if an application has been filed but payment is stuck? (In this case, the application state is Pending.) Either the user needs to retry payment (or try to pay another way) or Ops needs to reset some software module or something.

---

@vysakh-menon-aot , @PaulGarewal , are you familiar enough with Auth API affiliations data to estimate what changes are needed to Auth db tables or Auth API calls to Legal API or queue message changes? Specifically, how will Auth API know what status a continuation application is in?

[severinbeauvais]

The items in the Affiliated Entity Table are of Type Business.

Just a small correction here. The items in the MBR may be:

• name requests (NR)
• applications (ATMP, CTMP, RTMP, TMP)
• businesses (BCxxx, Cxxx, CPxxx, FMxxx)

[vysakh-menon-aot]

We can include a status here, which will be a small change in legal-api

here: https://github.com/bcgov/lear/blob/main/legal-api/src/legal_api/resources/v2/business/business.py#L183

[severinbeauvais]

Thanks, Vysakh. We'll need to add isFutureEffective to that response as well.

So it looks like no changes are needed to Auth API?

[vysakh-menon-aot]

We can remove this if condition from auth-api (https://github.com/bcgov/sbc-auth/blob/main/auth-api/src/auth_api/services/affiliation.py#L467), its covered in legal-api. I don't see any more changes required in auth-api

[andyyanggov]

As for future effective, I was thinking that we might want to show something special in the MBR when an application has been Filed and Paid (and Approved if applicable) and is just awaiting the FE date/time to arrive. Right now we label those "Drafts" but they are different from drafts that still need to be filed.

@severinbeauvais What about just labelling them 'Future Effective'? Perhaps with a tooltip indicating the date? I seem to recall there was a ticket for this.

Also, should we show something special in the MBR if an application has been filed but payment is stuck? (In this case, the application state is Pending.) Either the user needs to retry payment (or try to pay another way) or Ops needs to reset some software module or something.

Whatever the state is on the entity dashboard, the MBR should reflect that. Either 'Pending' with an alert/tooltip or more explicitly 'Pending | Payment Incomplete' or something along those lines is my first thought.

[ArwenQin]

@andyyanggov
May I know what is the status for an immediate filing (or an overdue FE), paid, but the Filer hasn't processed yet - maybe "Paid | Pending"?

[andyyanggov]

@ArwenQin Are you referring to this state?

[ArwenQin]

@andyyanggov
Yes, it's an overdue future effective filing.

@severinbeauvais Just to double check. Is it a paid and pending status?
So are there 2 situations:

• immediate filing, paid but that the Filer hasn't processed yet
• overdue FE
  ?

@andyyanggov @severinbeauvais What should be displayed as the status for the 2 situations

[ArwenQin]

@andyyanggov
Andy, just to confirm:

Should we display the FE time too?

[severinbeauvais]

@severinbeauvais Just to double check. Is it the paid and pending status?

It's just "PAID" (or APPROVED), but you can check if there's a future effective date-time.

Filings UI displays these a bit differently if the FE date is future or past:

• if future, subtitle is "FUTURE EFFECTIVE FILING | PAID" and the body says "date and time will be ..."
• if past, subtitle is "FILED AND PENDING | PAID" and the body says "data and time has been recorded as ..." (even though the Filer hasn't processed it yet)

So there are 3 situations, but ideally we can combine the FE ones.

[ArwenQin]

So there are 3 situations, but ideally we can combine the FE ones.
@severinbeauvais @andyyanggov

Thanks a lot.
In summary:

1. Paid, FE, time in future - show 'Future Effective' and a tooltip showing the FE date; question: do we show the FE time too?
2. Paid, immediate filing, not a FE, filer not processed yet - question: what to display for the status? maybe 'Paid | Pending'?
3. Paid, overdue FE, time in the past - question: what to display for the status? should we show the tooltip?
4. Status is PENDING - question: Pending will always say 'Pending | Payment Incomplete', is that ok?

[severinbeauvais]

In summary:

1. Paid, FE, time in future - show 'Future Effective' and a tooltip showing the FE date; question: do we show the FE time too?

I think yes but up to @andyyanggov.

2. Paid, immediate filing, not a FE, filer not processed yet - question: what to display for the status? maybe 'Paid | Pending'?

From a state point of view, it can't be paid and pending, but for the user, maybe this makes sense...? The user has paid and the application is pending the Filer processing it. @andyyanggov , what do you think?

3. Paid, overdue FE, time in the past - question: what to display for the status? should we show the tooltip?

@andyyanggov , does the user care that this was initially future effective? As above, this is now waiting for the Filer. As for the tooltip, should it state the FE date-time in past tense?

4. Status is PENDING - question: Pending will always say 'Pending | Payment Incomplete', is that ok?

Yes, good. This matches what Filings UI says.

[andyyanggov]

Agree with 1 and 4.

For 2 and 3, I don't think we need to specifically call out that it's been paid since that's not unique to these states. The entity dashboard says 'Filed and Pending', so that should reflect in the MBR. We could also rename it to something like 'Processing' in both places. Ultimately, I think whatever the state is, it should be consistent across screens.

[severinbeauvais]

OK, then let's go with "Filed and Pending" for both scenarios 2 and 3.

Thanks, Andy!

[severinbeauvais]

@ArwenQin If this spike is done (you have all your answers) then please move this ticket to Done pipeline. Thx!