Available in: Axsy Mobile for Salesforce, Axsy Field Service, Axsy Public Sector, Axsy Retail Execution
The Axsy Mobile App can be configured to provide users with access to offline-first dashboards which provide key information at-a-glance. Up to two separate dashboards - with configurable labels - can be added to Event, Work Order or Visit records. The exact record to which dashboards can be added depends on the mobile solution in use - see the table below for more details.
Figure 1 - Up to two Dashboards can be configured to be accessible on Event, Work Order or Visit records
Axsy Solution | Record that Supports Dashboards |
---|---|
Axsy Mobile for Salesforce | Event |
Axsy for Field Service | Work Order |
Axsy for Public Sector | Visit |
Axsy for Retail Execution | Visit |
Table 1 - Which records support Axsy Dashboards
Launching Dashboards in the Mobile App
If enabled, each dashboard can be launched via a dedicated button when viewing an Event, Work Order or Visit record:
- Select an Event, Work Order or Visit to view the record.
- Select the dashboard you would like to view.
Figure 2 - A dashboard configured with label "Event Dashboard" is configured to be launched from Event records
Dashboard Widgets and Layout Types
Each dashboard can consist of up to 4 Widgets. A dashboard is intended to convey a configurable set of information using a pre-defined layout, with 5 layout types available:
- Label-Value Widget
- Table Widget
- Record List Widget
- Deep Link Widget
- File List Widget
When the maximum of 4 Widgets are enabled for a dashboard, they each take up an equal-sized quadrant of the screen on a tablet device. If less than 4 Widgets are enabled, then on tablet devices the Widgets will re-size accordingly. On phone devices, Widgets are always the same size and displayed vertically one after another.
Figure 3 - Layout for 4 Widgets on a tablet
Figure 4 - Layout for 3 Widgets on a tablet
The size of each Widget is pre-determined by the Axsy Mobile App based on how many Widgets are enabled. It is not possible to individually configure the dimensions of each Widget in a dashboard.
More information on each Widget type is given below.
Label-Value Widget
Label-Value Widgets have a layout that presents key information as a set of label-value pairs. For a Label-Value Widget, the following information is configurable for each Widget:
- The title of the Widget
- The display order amongst all Widgets in the dashboard
- The underlying Salesforce Flow that is used to populate the Widget information
- The Label portion of each label-value pair
- The output variables from the Salesforce Flow which should populate each Value portion of each label-value pair
The maximum number of label-value pairs that can be configured for a single Label-Value Widget is 6 pairs.
Figure 5 - Example of a Label-Value Widget
Figure 6 - Label-Value Widget configuration in the Axsy Config Tool
Table Widget
Table Widgets have a layout that presents key information in a tabular format. For a Table Widget, the following information is configurable:
- The title of the Widget
- The display order amongst all Widgets in the dashboard
- The underlying Salesforce Flow that is used to populate the Widget
- The Label for each column in the table's first row
- The output collection variables from the Salesforce Flow which should populate each column of the table
The maximum number of columns that can be configured for a single Table Widget is 5 columns. The maximum number of rows, excluding the first row of the table with the column labels, is 50 rows.
Figure 7 - Example of a Table Widget
Figure 8 - Table Widget configuration in the Axsy Config Tool
Record List Widget
Record List Widgets have a layout that presents a list of Salesforce records that can be selected to view more information on the chosen record. For a Record List Widget, the following information is configurable:
- The title of the Widget
- The display order amongst all Widgets in the dashboard
- The underlying Salesforce Flow that is used to populate the Widget
- The output record collection variable from the Salesforce Flow containing the records to include in the list
The fields displayed for each record in the widget are the first 5 fields of the record's Compact Layout. For these fields to be displayed correctly, the output record collection variable must include those fields.
The maximum number of records displayed by the Record List Widget is 50 records.
Figure 9 - Example of a Record List Widget
Figure 10 - Record List Widget configuration in the Axsy Config Tool
File List Widget
File List Widgets have a layout that presents a list of Files, i.e. Salesforce Content Document records, that can be selected to view the file. For a File List Widget, the following information is configurable:
- The title for the Widget
- The display order amongst all Widgets in the dashboard
- The underlying Salesforce Flow that is used to populate the Widget
- The output record collection variable - which must be for the Content Document object - from the Salesforce Flow containing the Content Document records to include in the list
For the above output record collection variable, the following Content Document fields must be included:
- Id
- ContentModifiedDate
- ContentSize
- Title
- FileExtension
- FileType
The maximum number of files displayed in the File List Widget is 50 files. For a file to be viewable when the app is offline, it must have been previously synced to the app , either as part of initial sync or on-demand while the user was online.
Figure 11 - Example of a File List Widget
Figure 12 - File List Widget configuration in the Axsy Config Tool
Deep Link Widget
Deep Link Widgets have a layout that presents a single button that, on selection, launches to another app installed on the mobile device. For the Deep Link Widget, the following information is configurable:
- The title of the Widget
- The display order amongst all Widgets in the dashboard
- The label to include as a description for the deep link
- The underlying Salesforce Flow that is used to create the URL for the deep link and, optionally, the URL for the image to use to launch the deep link
- The output variable from the Salesforce Flow containing the URL – which can be created dynamically – for the deep link
- The output variable from the Salesforce Flow containing the URL – which can be created dynamically – for the image to be used to launch the deep link
- An optional hardcoded URL to use for the deep link
If the optional hardcoded URL is defined, this will take precedence over any URL that is created by any configured Flow. If the optional Flow output variable for determining the URL for the image to display is not provided or does not resolve to a valid URL, then:
- If the domain for the deep link is for saleforce.com, the image will default to a Salesforce image
- If the domain for the deep link is for slack.com, the image will default to a Slack image
- Otherwise, a generic image will be used
Figure 13 - Example of a Deep Link Widget
Figure 14 - Deep Link Widget configuration in the Axsy Config Tool
Using Salesforce Flow to Populate Dashboard Data
Each Widget in a dashboard is tied to an underlying Salesforce Flow which will populate any data in the dashboards that is meant to be dynamic. This is achieved by defining Flow Output Variables that can be assigned using the query abilities of Flow. As the Axsy Mobile App is able to run Flows offline, using Flows means that dashboards can be displayed even under situations of poor internet connectivity.
When creating the Flows that populate a dashboard Widget, please make sure to do the following:
- The Flow should run autonomously without the need for user input
- The Flow should not include any screens
- The Flow should not include any sub-Flows
- The Flow should not modify any data via Create, Update or Delete actions
- Create an input text variable with label recordId to pass to the Flow the Salesforce ID of the Event to which the dashboard is related
- Define the appropriate number and types of Flow Output Variables based on the Widget type that is intended to be populated
Example: For a Label-Value Widget intended to show key information on the parent Account for an Event, the Flow can be designed to query the parent Account of the Event and then assign the key fields of the Account record to up to 6 Flow Output Text Variables.
Example: For a Table Widget intended to show the key Contacts and their contact information for a given Location, the Flow can be designed to query all the Contacts assigned to the Location, then assign the names of each to a Flow Collection Output Variable, then assign the phone numbers of each to a 2nd Flow Collection Output Variable and then assign the email address of each to a 3rd Flow Collection Output Variable.
Example: For a Record List Widget intended to show upcoming Promotions for the next calendar month, the Flow can be designed to query all Promotion records that are active in the next month and then assign the found records to a Flow Record Collection Output Variable.
Configuring Dashboards with the Axsy Config Tool
For more information on how to configure dashboards with the Axsy Config Tool, please see: Configuring Dashboards.