What is the Alkami Widget?

Alkami is a platform that provides online banking services to many of our credit union members. Alkami provides a SDK that can be used to develop widget that run on the Alkami platform to extend functionality. Quavo has developed a widget using this SDK so that our create case and status widgets are available to end users within the Alkami online banking system.

Widget Installation

The FI will need to open a Jira ticket with Alkami https://jira.alkami.com and request the latest version of our widget to be installed. The official name of our widget is Quavo.Client.Widget.Disputes and as of 1/27/23 the latest version is 1.1.8. Once installed the FI will need to configure widget settings, generic proxy provider and site text.

The FI will need to whitelist the qfd urls (only the subdomain.domain.com part) used by the widget. For example, xxx-app-stg.quantumdisputes.com. If needed multiple URLs can be whitelisted by separating each URL with a ;

Widget Settings

There are currently 4 widget settings that can be found in the Alkami admin portal under Setup > Widget Settings > QuavoDisputes

accessTokenURL - URL the widget will reach out to for oauth authentication. Example: https://xxx-appstg.quantumdisputes.com/prweb/PRRestServices/oauth2/v1/token
clientId - Used for oauth authentication
clientSecret - Used for oauth authentication
qfdApiUrl - URL the widget will use to call the get case URL rest endpoint. Example: https://xxx-appstg.quantumdisputes.com/prweb/api/FFRestServices/v1/url The settings will different depending on the environment. You will have different values for development and production

GenericProxy Provider

The GenericProxy provider can be found in the Alkami admin portal under Setup > Integration Settings > Providers > GenericProxy.

The FI will need to whitelist the QFD URLs (only the subdomain.domain.com part) used by the widget. For example, xxx-app-stg.quantumdisputes.com. If needed multiple URLs can be whitelisted by separating each URL with a ;

Quavo strongly encourages our clients to whitelist Quavo's production IP address with Alkami so that Quavo can assist with testing and troubleshooting the widget while it is running in the client's Alkami lower environments.

Package Enablement

Once the widget is enabled and setup, the widget will need to be added to and turned on in various packages. This can be done within the Alkami Admin tool by going to Setup > Packages. Within selected packages, you will turn the toggle on or off to make it visible to end-users.

Widget Naming & Navigation Configuration

Alkami allows FIs to specify where they want each of their features to be grouped together, and what they want to name their features. This is done through the Alkami Admin tool by going to Setup > Navigation Builder.

Within each navigation that is built, the widget will need to be added to a defined "bucket". Occasionally, Alkami has the widget name title that does not update and is note sitetext for the FI to self-serve. A ticket will need to be opened with Alkami for resolution.

If it is a newly adeded or created widget, a feature name will need to be defined, and a Spanish translation will need to be added.
You also define where you want the widget to be available on the Alkami platform: Desktop, Mobile and Tablet

Site Text

Our widget allows for customization of the text that appears within the widget. Site text configuration c an be found in the Alkami admin portal under Setup > Integration Settings > Site Text. The namespace is QuavoDisputes. Site Text is available for English and Spanish for FIs that want to offer localization.

BackButton - This text appears inside of the button used to navigate back
BotPageCustomText - If the FI wants to add text below our widget buttons they can put it here
ExistingDisputeButton - This text appears inside of the button used to navigate the user to the status widget
MobileTitle - This text appears as the widget title for users running on a mobile device
NewDisputeButton - This text appears inside the button used to navigate the user to the create case widget
Title - This text appears as the widget title for users running on a non mobile device
TopPageCustomText - If the FI wants to add text above our widget buttons they can put it here

Site Text supports html. Even images can be included if you base64 encode the image.

Widget Skin

We built the UI controls within the widget to use the classes used by Alkami's Iris Design system. What this means is once the widget is installed all buttons should appear with the proper color and shape according to how the FI has configured the Iris Design system stylesheets. If issues arise, this will need to be resolved with Alkami.

Widget Usage

As previously mentioned the widget can be used to access the create case and case status QFD widgets. Alkami end users can access our widget via multiple channels desktop, mobile, tablet etc. Our widget can be launched from the navigation menu. Once launched the user will be presented with 2 buttons. One button will launch the new case flow and the other button will launch the case status flow.