Andrew Fawcett edited this page Nov 30, 2017 · 8 revisions

Welcome to the Flow Toolbelt Wiki

The Flow Toolbelt is a managed package that is designed to increase the power of Flow by exposing it to platform areas currently not immediately accessible in a clicks not code way.

  • Dynamic Flow Component, can be used to display Flows dynamically while tracking user navigation and record edits. Additionally it allows Flow logic to interact with Lightning Experience features such as Utility Bar and associated API's to drive navigation to other records, pages, display notifications, popups and more, all 100% declarative of course!
  • Run Flows from Report Subscriptions, when using the Report Subscribe feature, run a Flow when the report criteria is reached. Future.
  • Run Flows during Sandbox Clone, when using Sandbox cloning, run a flow to setup Sandbox configuration and data. Future.
  • Run Flows from Lightning Actions, add custom Lightning Actions or Lightning Action Overrides that utilize Flow - Future.
  • Schedule Flows, ability to schedule when Flows run (not sure if Wait element in Flow already allows this?). Future

For developers there is also the following features

  • Dynamic Flow API, ability to define at runtime the Flow to run in Apex.

Dynamic Flow Component

With this component you can enhance your Flows by making them contextual as the user navigates through Lightning Experience by placing the component in the Utility Bar. The Flow shown will automatically refresh as the user navigates. Further more you can enhance what your Flow does by sending popup message, navigating and utilising the Utility Bar in cool ways!


  • You can use this component on Record Pages and Utility Bar (future Lighting Actions support!)
  • You can use screen based Flows and Autolaunched Flows
  • Currently you can define a Flow per Standard or Custom Object (via a Dynamic Flow Component custom metadata)
  • Flows can define special output variables that tell the component to perform cool actions
  • Flows can be run automatically even when the Utility Bar is minimised
  • Flows can automatically pop open the Utility Bar
  • Flows can automatically highlight the Utility Bar icon to draw the users attention
  • Flows can send a number of navigation events to navigate to record, tab or refresh the current page
  • Flows can run other flows, you can chain flows!
  • Flows are rerun automatically when the record data on the page is changed

Input Parameters:

  • flowtb_record, this must be defined and will receive the record displayed on the screen, fields populate will be per the current layout shown to the user. This must be an SObject variable type.

Output Parameters:

  • flowtb_event, provide the name of a Lightning Experience event, such as c.force:showToast, see here for others. This should be String parameter. You may also need to use flowtb_param_xxxx parameters depending on the event.
  • flowtb_param_xxxx, where xxxx is the name of the event parameter applicable to the event defined above. For the c.force.showToast event, create two variables, flowtb_param_title and flowtb_param_message.
  • flowtb_runFlow, runs another flow when the current flow finishes
  • flowtb_open_utility, opens the utility bar! The type and value of this variable does not matter. Note that if the user did not have the utility bar open prior to this, the component automatically closes it when the user navigates away or a different flow is run.
  • flowtb_minimize_utility, minimise the utility bar!
  • flowtb_utility_highlighted, highlights the utility bar to draw the users attention. This will be automatically cleared when the user navigates away.

Other Notes:

  • Due to some current platform limitations, you must tell the component (via the applicable Dynamic Flow Component custom metadata record) if your flow is an Autolaunched flow. Further more if you are using flowtb_param_xxxx output variables, you must list these on the record.
  • If you use an Autolaunched flow and want to follow its execution by running a Screen based flow, just use the flowtb_runFlow output variable in the Autolaunched flow
  • Use the Flow Factory tab to create a small class in your org that supports the ability to dynamically create a Flow within Apex. This is only required if you are using Autolaunched Flows via the above component or you want to use the API in this package.
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.