Dashboard Background

The dashboard can be customized to show more, less, or the entire background image.

Here’s a comparison showing a color block vs no color block.

institutions/mxmobile/config/themes/theme_light.json

1
2
3
4
5
6
7
"dashboard_scroll_background_styles": {
      "DASHBOARD_SCROLL": {
        "is_visible": true,
        "color": "NEUTRAL_100",
        "opacity": 255,
        "vertical_offset": 48
      }

is_visible adds a color block. You can set its color and determine its offset from the top of the screen.

Dashboard Cards

Dashboard cards are sections of the dashboard that display an at-a-glance view in the dashboard of a particular feature of the app. For example, the transactions card in the dashboard shows the three most recent transactions.

Dashboard cards are the primary way a user navigates to a particular feature of the app.

The institutions/mxmobile/assets/dashboard.json file provides a way to configure:

Which cards appear in the dashboard.
The order in which each card is displayed (lowest order being the top most card).
Whether the card is enabled.
The state, which indicates whether the card can be moved or toggled on/off by the user in the Settings > Customize Dashboard (assuming this view is enabled).

Cards

In the following example for a card in the dashboard.json file:

The card type is the name of the object (ENVELOPES).
dashboard_order represents what order the panel should appear in by default.
state represents the customization level the user has access to for reordering and hiding.
enabled represents whether a panel is currently enabled. Set to false if it shouldn’t be displayed.

institutions/mxmobile/assets/dashboard.json

1
2
3
4
5
"ENVELOPES": {
  "dashboard_order": 23,
  "state": "STATIC",
  "enabled": false
}

Values for state:

State	Description
`UNKNOWN_STATE`	Don’t use. It’s the default state if the entry is incorrect or if there’s an error and is only be for debugging purposes.
`MOVEABLE`	Can change `dashboard_order`.
`MOVEABLE_TOGGLE`	Can change `dashboard_order` and `enabled`.
`STATIC`	Can’t change `dashboard_order`.
`STATIC_TOGGLE`	Can’t change `dashboard_order` but can change `enabled`.
`HIDDEN`	A non-default state that’s used when hiding panels that support the `TOGGLE` functionality.

Dashboard Search

Dashboard Search lets users search for common features and tasks within the SDK’s capabilities.

This is done with a few JSON files:

File	Description
`hyperion.json`	This should not be edited.
`augmentations.json`	This is how you add to or replace values in the `hyperion.json` file.
`dependencies.json`	These are results that are related to other results. The `before` and `after` indicate if the dependency is displayed before or after the original.
`relevancy.json`	If we know what feature the user is referring to, but are unsure of the actions, we will display all the actions in the features list in this file.
`replacements.json`	Replacements is a helper file that lists groups of words that are all indicated by the same pattern for the `hyperion.json` and `augmentations.json` files.
`suggestions.json`	This file contains suggestions that are displayed to the user beneath the search bar before they perform a search.

The default files are located in the client/default/config/hyperion folder.

However, to override any changes you must copy these files to the config/hyperion/ folder and make your changes there.

Routes

Dashboard Search uses a list of pre-defined routes that can be triggered to display certain cards with different displays and interactable items below the search bar.

Dashboard Search routes are formed by adding an action to a feature name (for example, accounts://view).

The app parses the search for context, and the routes adapt to the identified context.

Accounts Routes

Route	Default Behavior	Context
`accounts://balance`	Shows account balances for the top 3 accounts.	AccountType: Shows balances only for accounts that belong to the specified type.
`accounts://view`	Shows an action result to navigate to the accounts view.	None.
`accounts://create`	Shows an action result to navigate to institution list view (to add a new account).	None.

Billpay Routes

Route	Default Behavior	Context
`billpay://create`	Shows action results for all billpay entry points (billpay, zelle etc).	None.
`billpay://upcoming`	Shows the next three bills that will be due in the next three weeks (or were due last week).	None.

Budgets Routes

Route	Default Behavior	Context
`budgets://remaining`	Shows how much you have remaining in your budget.	None.
`budgets://create`	Shows an action result to navigate to the manage budgets poptart.	Category: If the category already exists, it shows the info result to alert the user instead. If the category is a sub category, the action result navigates to the add sub budget poptart, otherwise it navigates to the manage budgets poptart.
`budgets://view`	Shows an action result to navigate to the budgets view.	Category: If the category already exists, shows action result to navigate to the budget details view, else informs the user that no budget for the category exists.
`budgets://update`	Requires context. You must provide a category for this route to work.	Category: Shows an action result to navigate to the budget details view.
`budgets://delete`	Requires context. You must provide a category for this route to work.	Category: Shows an action result to navigate to the budget details view and presents the deletion modal.

Net Worth Routes

Route	Default Behavior	Context
`networth://current`	Displays your current net worth.	None.
`networth://view`	Shows an action result to navigate to the net worth view.	None.

Remote Deposit Routes

Route	Default Behavior	Context
`remote_deposit://create`	Shows an action result to navigate to the remote deposit landing view.	None.

Transfers Routes

Route	Default Behavior	Context
`transfers://create`	Shows action results to navigate to all transfer entry points (to linked account, to another member, zelle etc).	None.

Transactions Routes

Route	Default Behavior	Context
`transactions://view`	Shows an action result to navigate to transactions view.	Category: Shows an action result to navigate to transactions view with the filter set to a particular category. Merchant: Shows an action result to navigate to transactions view with the search term set to a merchant.

Resources Routes

Route	Default Behavior	Context
`resources://appointments`	Shows an action result to navigate to the appointments view.	None.
`resources://locations`	Shows an action result to navigate to the branch locations view.	None.
`resources://nearest_location`	Shows a map tile displaying the nearest branch location.	None.
`resources://help`	Shows an action result to navigate to the Help and Legal view.	None.

Settings Routes

Route	Default Behavior	Context
`settings://view`	Shows an action result to navigate to the settings view.	None.
`settings://organize_dashboard`	Shows an action result to navigate to the organize dashboard view.	None.
`settings://reorder_accounts`	Shows an action result to navigate to the reorder accounts view.	None.
`settings://manage_accounts`	Shows an action result to navigate to the manage accounts view.	None.
`settings://app_lock`	Shows an action result to navigate to the app lock settings view.	None.
`settings://notifications`	Shows an action result to navigate to the notification settings view.	None.
`settings://profile`	Shows an action result to navigate to the profile view.	None.
`settings://login_history`	Shows an action result to navigate to the login history view.	None.
`settings://popmoney`	Shows an action result to navigate to the popmoney settings view.	None.
`settings://zelle`	Shows an action result to navigate to the zelle settings view.	None.
`settings://transaction_rules`	Shows an action result to navigate to the transaction_rules view.	None.
`settings://text_size`	Shows an action result to navigate to the text size setting view.	None.
`settings://theme`	Shows an action result to navigate to the theme setting view.	None.

Spending Routes

Route	Default Behavior	Context
`spending://summary`	Shows an info result displaying the amount you spent in the last month.	DateRange: Modifies the date range for which spending is analyzed. Category: Restricts the information to a particular category.
`spending://view`	Shows an action result to navigate to the spending view.	None.

Context

Dashboard Search searches the search string for context so that it can refine the results.

If there is no context for a particular route, the search will go through without filtering for whatever the context is looking for.

This doesn’t apply for budgets://update and budgets://delete, as mentioned in their route behavior.

Dashboard Search currently parses for:

Account_Type — A particular type of account (Checking, Savings, Credit Card, etc.).
Category — A spending category (Gas, Food, Travel, etc.).
DateRange — A range of time the user is interested in (“Today”, “Yesterday”, “This week”, “This month”, etc.).
Merchants — Any word following an “at” is treated as a merchant (e.g “Show me transactions at Starbucks” would treat “Starbucks” as the merchant).

Default List of Search Patterns

The hyperion.json file contains the default list of search patterns. These patterns indicate which sequence of words (or placeholder words) will match a particular feature and action. There can be multiple search patterns, and they can include multiple words, separated with spaces, and identifiers that are found in replacements.json.

The pattern in the JSON:

1
2
3
4
5
6
7
{
  “<FEATURE_NAME>”: {
    “<ACTION_NAME>”:  [
      “<MATCHING_PATTERN>”
    ]
  },...
}

Example

1
2
3
4
5
6
7
8
{
  "accounts": {
    "balance": [
      "_VIEW balance",
      "_LEFT balance"
    ]
  },...
}

Add or Change a Feature

The augmentations.json file follows the exact same pattern as the hyperion.json file, but should be used for adding new features or changing existing features.

Please refer to the default list of search patterns section for more details.

Display Related Search Results

The dependencies.json file sets up some related actions when certain actions are matched in a feature. For instance, if a user is looking up their accounts balance, their top 3 accounts will display their balances directly in the search results and directly link to the accounts view.

The JSON format:

1
2
3
4
5
6
7
8
9
{
  “<FEATURE_NAME>”: {
    “<ACTION_NAME>”: {
      “<before or after>”: [
        “<ROUTE>”
      ]
    }
  },...
}

If the <before or after> portion is before, it will appear before the related feature/action route section when it’s hit, if it is after it will appear after.

Example

1
2
3
4
5
6
7
8
9
{
  “accounts”: {
    “balance”: {
      “before”: [        
       "accounts://view"
      ]
    }
  },...
}

Configure Relevant Actions

The relevancy.json file is used when you know the feature, but not the action the user wants. This is likely because they are using a word that isn’t used in either the hyperion.json or augmentations.json search patterns. Another option could be that the pattern matches too many actions. This file shows a list of all the actions that are relevant to that feature.

Format

1
2
3
4
5
{
  "<FEATURE_NAME>": [
    "<ACTION_NAME>"
  ],...
}

Example

1
2
3
4
5
6
7
8
{
  "accounts": [
    "balance",
    "view",
    "create",
    "open"
  ],...
}

These should match the feature and action names in hyperion.json and augmentations.json.

Group Potential Keyword Suggestions

The replacements.json file contains definitions for “placeholder” actions that can match words that have many synonyms. For example, the user may search for “See transactions” or “View transactions.” Matching patterns should use “placeholder” actions whenever it’s possible that a user will search using a number of common synonyms. If you use a placeholder, such as “_VIEW,” be sure to define the synonyms in replacements.json.

Example

1
2
3
4
5
6
7
{
  "_VIEW": [
    "Show",
    "View",
    "See"
  ],...
}

With this, whenever _VIEW is referenced in a hyperion.json or augmentations.json action pattern, it searches for all the listed words, instead of just one pattern.

Display Suggested Search Items

The suggestions.json file is used to display some potential queries to the user.

The feature names match to the icon name by this list (feature : icon_name):

Feature	Icon Name
accounts	bank
billpay	billpay
budgets	budgets
card_manager	credit_card
chat	chat_bubbles
document_list	loan
net_worth	net_worth
resources	utilities
remote_deposit	remote_deposit
rewards	shopping_cart
settings	gear
spending	spending_pie
transfers	move_money
transactions	transactions

Cards

Was this page helpful?