Skip to main content

Configure the widget

The Universal Connect Widget (UCW) enables you to manage a local institution list and your routing preferences. The widget uses cached data on the server. This means it doesn't rely on any UCP hosted services and remains fully functional given any outages to those services.

Both your institutions and your preferences can be configured locally on the widget server. Each of these files are located in ./apps/server/cachedDefaults. The Connect Widget server requires both the Preferences and Institution files to be present. These files are loaded in a redis cache.

Cached Institutions​

When you fork the ucw-app project, the most recent version of the institutions list is automatically available in the ./apps/server/cachedDefaults folder. This file is a .json file that includes a list of all institutions exported from the UCP database. The widget is built to index and search this file. At this time, the institution list is static and no additional lists are available for update.

Routing​

Before you can configure your preferences, you must provide your own credentials for each of the aggregators you plan to support in the ./apps/server/.env file. At least one aggregator is required.

Route aggregator connections by defining your preferences by aggregator and volume. Preferences are defined in a .json file that is cached.

Configuration options include:

  • Supported and default aggregators
  • Aggregator and institution volume
  • Hidden and recommended institutions