Overview
The dashboard is the home screen a user sees after logging into the mobile app. It provides access to the information you deem important to the user’s needs. This information is organized into modular blocks called “cards.” Each card contains and displays specific type of information.
Dashboards are specified in your authentication response.
How It Works
The platform allows you to create multiple dashboards for different types of users. For example, a user in one division could see a different dashboard than a user in another division. This assignment happens when a user logs in. The dashboard is specified in your authentication response. There are two ways to do this:
Return a string for the
dashboard_codeproperty. This string is a code that references a dashboard you have built and saved in App Manager. This is the most common approachDynamically build the dashboard inside the API response itself. This is done by providing a full
dashboardobject, which contains an array of all cards and properties to display.
NOTE: The authentication response must include either
dashboardordashboard_code. When providing both, the inlinedashboardobject will always take precedence.
Key Components
When building a dashboard using the inline dashboard object, you will work with these key components:
logo_ref: An optional property that allows you to specify an image to display branding at the top of the dashboarddashboard_items: This is a required array of cards that make up the dashboard’s layout - each object in this array defines one card, its title (header), and an optional icon (icon_ref)
NOTE: To use
logo_refyou must submit your logo(s) to support@eleostech.com. Our Support Team will upload the image asset and provide you with the string value to use for this property. For more info on image requirements refer to Branding Your App.
Card Types
Each card on the Dashboard has a specific function and appearance.
The available card types are:
messages: Shows a preview of the user's three most recent messages and access to all messagesloads: Displays information about the user's current load and stop and access to the loads listThis card can also be configured to show summary counts of loads by status
news: Shows the most recent unread news item and access to all news itemstodo: Lists any pending tasks assigned to the user and access to all taskspayroll: Presents a summary of payroll information and access to payroll historyThis card can not be added via App Manager and must be defined within the inline
dashboardobject in your authentication responseIMPORTANT: The payroll card displays payroll for the primary logged-in user, and may be visible to team drivers sharing one device.
hos: Displays a summary of the user's hours of service information and optionally deep links to an Electronic Logging Device (ELD)my-truck: Shows the geolocation of a physical asset (such as a truck or trailer) on a map along with any associated textinfo: Generic flexible-use card that can display a combination of text, image and/or action buttonscarousel: Rotates through a series of text and/or images at a set interval
One/Two Column Layout
Users can choose how the dashboard is displayed to better suit their device’s size and orientation.
This option is available to users in the mobile app’s Settings screen. By default, the app uses “Auto Layout,” which typically shows one column in portrait mode and two in landscape. Drivers can override this behavior by selecting a different layout.
Available layout options include:
Auto (default)
Always 1 Column
Always 2 Columns
NOTE: The dashboard layout setting is only available in mobile app v1.61 and newer.