Skip to main content

Flow Structural Conventions

Per-Flow Design

  1. Flows should have one easily identifiable Triggering Element.
    This relates to the Naming Conventions.
    For Record-Triggered Flows, this is easy - it is the Record that triggers the DML.
    For Event-based Flows, this should be a single event, as simple as possible.
    For Screen Flows, this should be either a single recordId, a single sObject variable, or a single sObject list variable. In all cases, the Flow that is being called should query what it needs by itself, and output whatever is needed in its context.
    For Subflows, the rule can vary - it can be useful to pass multiple collections to a Subflow in order to avoid recurring queries on the same object. However, passing multiple single-record variables, or single text variables, to a Subflow generally indicates a design that is overly coupled with the main flow and should be more abstracted.

    image-1644417867237.png

    A good example of Triggering Elements naming
  2. Fill in the descriptions.
    You'll thank yourself when you have to maintain it in two years.
    Descriptions should not be technical, but functional. A Consultant should be able to read your Flow and know what it does technically. The Descriptions should therefore explain what function the Flow provides within the given Domain (if applicable) of the configuration.

    image-1644417872437.png

    Descriptions shouldn’t be too technical.
  3. All Pink (DML or Query) elements should have Error handling.
    Screen Flow? Throw a Screen, and display what situation could lead to this.
    Record-triggered Flow? Throw an email to the APEX Email Exception recipients. Hell, better yet throw that logic into a Subflow and call it from wherever.
    Or send a Notification.
    (Note that if you are in a sandbox with email deliverability set to System Only, regular flow emails and email alerts will not get sent.)

    image-1644417882117.png

    If the DMLs fail, the user gets presented with an error message written in the screen.
  4. Don't do DMLs or Queries in Loops. Simpler: No pink squares in loops.
    Salesforce now actually warns you when you're doing this, but it still bears saying.
    To avoid doing this, ASSIGN a single record that you want to process to a collection variable in your loop, then do the DML outside of the loop at the end of your Flow. *1

    image-1644417893729.png

    Don’t do this
  5. If you have the same logic happening in various places, you should repackage this logic into a Sub-flow.
    This will avoid you having to modify the same thing in 6 places. It also makes the Flows easier to read. *2

  6. Don't exit loops based on decision checks.
    The Flow engine doesn't support that well and you will have weird and confusing issues if you ever go back to the main loop.

    image-1644417909572.png

    Don’t do this either - always finish the loop
  7. Do not design Flows that will have long Wait elements and will be called by thousands of records.
    You'll exceed your Paused Interview limits. This kind of use case it should be a Scheduled flow anyway.

  8. Do not rely on implicit references.
    This is when you query a record, then fetch parent information via {MyRecord.ParentRecord__c.SomeField__c}. While this is useful, it’s also very prone to errors (specifically with fields like RecordType and makes for wonky error messages.

Cross-Flow Design

  1. Try to pass only one Record variable or one Record collection to a single Subflow.
    See Per-Flow design item 1.
    Initializing a lot of Record variables on run often points to you being able to split that subflow into different functions. Passing Records as the Triggering Element, and configuration information as variables is fine within reason.

    image-1644417918698.png

    Example - the Pricebook2Id variable should be taken from the Order variable.
  2. Try to make Subflows are reusable as possible.
    A Subflow that does a lot of different actions will probably be single-use, and if you need a subpart of it in another logic, you will probably build it again, which may lead to higher technical debt.
    If at all possible, each Subflow should execute a single function, within a single Domain.

  3. Each Flow should be tied to a single Domain, and communication between Domains should be handled by Events.
    See Domain-Driven Design.
    In short, if a Flow starts in Sales (actions that are taken when an Opportunity closes for example) and finishes in Invoicing (creates an invoice and notifies the people responsible for those invoices), this should be two separate Flows, each tied to a single Domain.

    image-1644417931475.png

    In this example, the Technician On Site flow signals that an Intervention has started, which triggers a Work Order related flow.
  4. Communication between Flows should ideally be handled via Events to avoid heavy coupling.
    In the example above, a Flow that starts in Sales should fire an “Opportunity Closed” event, which will be listened to by the “Start Invoicing” flow to trigger the actions tied to Invoicing.
    See above example

  5. Avoid cascading Subflows wherein one calls another one that call another one.
    Unless the secondary subflows are basically fully abstract methods handling inputs from any possible Flow (like one that returns a collection from a multipicklist), you're adding complexity in maintenance which will be costly.

Domain-Driven Design

  1. Identify the Domain of your Flow when you create it.
    One flow should have exclusively one attributable Domain.

  2. If you need to modify elements from another Domain in your Flow, emit an Event matching the current status instead, and use that to start another flow which has said attributed Domain.

  3. Domains are definable as Stand-alone groupings of function which have a clear Responsible Persona.

image-1644417943258.png

High-level communication between Domains

 

Record-Triggered Flow Design

  1. Create only one Flow per Object and per Operation type - meaning one BEFORE Create, one BEFORE Update, one AFTER Create, etc.
    In all cases apart from BEFORE flows, you can leverage Subflows to ensure order of execution and ease of maintenance.
    For BEFORE Flows, for the moment it should still be best practice to have a single flow, of which the functions are split via Decision nodes.

    1. In the case of BeforeUpdate, the "decisions" should be done in a vertical tree reminiscent of Process Builder, and the actual actions and logic to the right side. This is done to familiarize Admins with Flows if they open them, and to ease migrating to Subflows when possible.

    2. In the case of AfterUpdate, the "decisions" should be done in a vertical tree reminiscent of Process Builder, and the logic should be stored in Subflows whenever possible, and called on the right side of the decision.

  2. Prioritize BEFORE-save operations whenever possible.
    This is more efficient in every way for the database, and avoids recurring SAVE operations.

  3. Try to leverage Sub-Flows in all designs, including Record-Triggered Flows, for the reasons outlined above.

  4. Flows that exclusively are Email handlers should be their own record-triggered flows.
    This is done because the conditions for evaluating Flows can impact how Email sending is handled. Another advantage is that you can turn off your “email handler” flows while making changes or testing your other flows.

  5. You may want to start out in Autolayout Mode which makes it easier for beginners and keeps things nice and neat, and then turn it off as needed since it doesn’t support everything you might want to do. You can turn it on and off as needed so there’s no commitment involved in that decision.

On Delayed Actions

Flows allows you to do complex queries and loops as well as schedules. As such, there is virtually no reason to use wait elements or delayed actions, unless said waits are for a platform event, or the delayed actions are relatively short.

Any action that is scheduled for a month in the future for example should instead set a flag on the record, and let a Scheduled Flow evaluate the records daily to see if they fit criteria for processing. If they do in fact fit criteria, then execute the action.

A great example of this is Birthday emails - instead of triggering an action that waits for a year, do a Scheduled flow running daily on contacts who's birthday it is. This makes it a lot easier to debug and see what’s going on.

*1  This is easy to work around for DML, but sometimes less so for Get Records. There are apex actions you can install to work around this issue, with the caveats mentioned above about installed actions. If you are building a screen flow, this is less of an issue.

*2 (Note that as of Spring 21, record-edit flows do not yet support calling subflows. You may consider waiting to use them until they do.)