Skip to main content

​
Real-World Example

ABC Collections creates a creditor account, but they have not connected a merchant account yet. Because required setup is incomplete, the sidebar should show Set Up Wizard with the number of required steps still left. When the creditor logs in, the wizard should open and show a checklist of missing setup items. Normal portal access should stay restricted until every required blocker is complete. After ABC Collections connects the merchant account, that step should show a checkmark and the sidebar count should decrease. Once all required setup steps are complete, the wizard should disappear and the creditor should use the normal portal navigation.

​
Visual Flow

​
What The Wizard Includes

The wizard is a high-level checklist and progress tracker. It should help the creditor know what is missing and where to go, but it does not need to fully explain every setup form.

​
Required Steps

Required steps are blockers. They are counted in the sidebar and control whether the creditor can use the normal portal.
  1. Connect merchant account.
  2. Create header profiles for imports.
  3. Set pay term offers.
  4. Create terms and conditions templates.
  5. Create About Us profile.

​
Optional Steps

Optional steps can appear in the checklist, but they are non-blockers. They should not count in the sidebar and should not prevent portal access.
  1. Set up SFTP connection.
  2. Configure logo, colors, and embed code.

​
How It Should Work

  • It should show only when at least one required setup step is missing.
  • It should automatically guide the creditor to the missing setup items when required setup is incomplete.
  • The sidebar count should equal missing required blockers only.
  • The checklist can include both required and optional setup items.
  • Completed items should show a checkmark.
  • Completing a required step should decrease the sidebar count.
  • Completing an optional step should not affect portal access.
  • Normal portal access should remain restricted while required blockers exist.
  • Once every required step is complete, the wizard should be removed and the creditor should gain full portal access.
  • After setup is complete, required and optional setup items should be managed from Manage Account in the left menu navigation.

​
How It Should Not Work

  • It should not stay visible as incomplete after all required setup is done.
  • It should not allow a creditor to skip required setup when that setup is needed for portal features.
  • It should not block portal access because optional setup steps are incomplete.
  • It should not inflate the sidebar count with optional setup helpers.
  • It should not show setup steps that are irrelevant to the creditor account.
  • It should not try to replace the detailed Manage Account pages for each setup area.

​
Developer Notes

  • Core rule:
  • Sidebar count means missing required blockers.
  • Checklist means required plus optional setup steps.
  • Optional checklist items must not be included in access-control decisions.
  • Check both SetupWizardPage and SetupWizardService before changing setup behavior.
  • Any setup-dependent feature should respect required setup completeness before allowing normal portal activity.
  • app/Services/SetupWizardService.php
  • app/Livewire/Creditor/SetupWizardPage.php
Last modified on May 27, 2026