Launch Flows from a Dashboard

Modified on Wed, 4 Feb at 4:39 PM

The Axsy Mobile App supports Flows being launched from a dashboard widget via a Flow Button. These Flows can be used to process data or update records without leaving a Dashboard. The supported widgets are label-value widgets, and table widgets.

Please see this article for more information on creating Dashboards in Axsy Mobile: Dashboards on Any Object

Configuring a Flow Button

In order to launch a Flow from a dashboard, you must first configure a flow button on a supported widget. To configure a flow button, the label must follow the following pattern:

Axsy_Flow_Button/{Flow_API_Name}/{icon}/{label}/{size}

Variable	Description	Example
Flow_API_Name	This is the API name of the Flow that should be run from the button.	Update_Contacts
icon	This is the icon that is displayed in the value field of the widget. This is taken from the ion-icon library.	information-circle
size	Optional: Controls if the flow is run in fullscreen, or opens in a smaller window. The supported values are "fullscreen", and "halfscreen". If left blank, the flow will be run in fullscreen.	halfscreen

NOTE: For label-value widgets, the Flow Variable specified will be displayed alongside the icon.

Additionally, for any input variables for the Flow that is being launched, for example a record ID, additional widget labels can be configured to provide this. They must be configured directly after the flow button, and must follow the following pattern:

Axsy_Flow_Context/{flowVariable}

When a Flow has been completed, the dashboard will refresh to show any updates to data.

Example Flow Button

To configure a flow button with a label of "Change Primary Contact", with a person-circle icon, that is shown in fullscreen on the Axsy Mobile App, and runs a "Account Dashboard Change Primary Contact" flow, the label used would be:

Axsy_Flow_Button/Account_Dashboard_Change_Primary_Contact/person-circle-outline/Change Primary Contact/fullscreen

As the flow takes in some input variables, the following labels are also configured:

Axsy_Flow_Context/currentPrimaryContactId 

Axsy_Flow_Context/accountId