How To Update The API Based Portals

The API Based Portals are web-based interfaces that allows Clients & Debtors (Consumers) access to their accounts.

These modules are dependent on the Collect! REST API. Before updating the Portals, please ensure that you are on the latest release of Collect!. Please refer to the Help topic How To Upgrade Collect! for more information.

1. Download the latest files from the Installers Section of the Member Center.
2. Unpack the installation package(s) into the {Collect}\bin\companion\ folder. Say yes to overwriting files.

If you are using different folder names than the default, then unpack the files into the applicable folders.

3. Navigate to the applicable folder folder in Powershell Admin mode.
   • Authorization Server: cli
   • Client Portal: client-portal
   • Debtor/Consumer Portal: consumer-portal
   • Dashboard Portal: dashboard-portal
cd {Collect}\bin\companion\{folder-name}
4. Run the Setup Script.
./setup.ps1
5. If you are updating the Authorization Server:
   • Navigate to the {Collect}\bin\companion\server folder in Powershell Admin mode
   • Run the Setup Script.
6. If you are updating the Client Portal or Debtor Portal, navigate to the CLI folder in Powershell Admin mode.
cd {Collect}\bin\companion\cli
7. Update and Seed the database.
node .\main.js database migrate:latest node .\main.js database seed
8. Key in Y to the warning and push Enter.
9. Scroll up or down with the arrow keys on the keyboard until you find 07_default_consumer_settings or 08_default_client_settings.
10. Use the spacebar to select the 07_default_consumer_settings or 08_default_client_settings option.

WARNING: Make sure that no other option is selected. Selecting the wrong option can cause damage.

11. Push Enter on the keyboard.
12. If you are updating both the Client and Debtor portals, then repeat for the one you didn't do above.