Loading
Salesforce now sends email only from verified domains. Read More
Automate Your Business Processes
Table of Contents
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

          Search all of Salesforce Help
          $Flow Global Variables Resource

          $Flow Global Variables Resource

          In a flow, a $Flow global variable provides information about the running flow interview. Some variables contain system-provided values. You can update the other variables throughout the flow by using Assignments or by storing output values in the variables.

          Required Editions

          View supported editions.

          This video explains what variables are and how flows use them to hold data.

          View this video in a separate tab.

          This video explains variable types including common types, Boolean, Apex-defined, and collection variables.

          View this video in a separate tab.

          Global Variable Supported Resource Types Description Value Set By
          $Flow.ActiveStages Stage

          A collection of stage resources that are relevant to the current path of the flow.

          The stages that appear in the standard progress indicator at run time.

          Stage resources set to Active by Default are in the $Flow.ActiveStages global variable when the flow interview starts.

          System and Assignment
          $Flow.CurrentDate Text, Date, and Date/Time Date when the flow interview executes the element that references the global variable. System
          $Flow.CurrentRecord Text

          ID of a related record. The value must be a single ID for a valid object. All custom objects and most standard objects are valid.

          When a user pauses the flow interview or the interview executes a Wait element, the interview is associated with this record by creating a FlowRecordRelation record. If the ID isn’t valid, the interview fails to pause.

          Assignment
          $Flow.CurrentStage Stage

          The stage the screen flow running user is in.

          In the standard progress indicator, the stage associated with the current screen element at run time.

          The stage that's highlighted in the standard progress indicator.

          System and Assignment
          $Flow.CurrentDateTime Text, Date, and Date/Time Date and time when the flow interview executes the element that references the global variable. System
          $Flow.FaultMessage Text System fault message that can help flow administrators troubleshoot runtime issues. System
          $Flow.InterviewGuid Text Unique identifier for the interview. System
          $Flow.InterviewStartTime Text, Date, and Date/Time Date and time when the flow interview started. For a flow launched by a Subflow element, $Flow.InterviewStartTime indicates when the initial master flow started. System
          Example
          Example A flow is used internally by call center personnel. For each flow element that interacts with the Salesforce database, a fault connector leads to a screen. A Display Text screen component displays the system fault message and instructs the flow user to provide that message to the IT department.
          Sorry, but you can't
                  read or update records at this time. 
          Please open a case with IT, and include the following error message:
          {!$Flow.FaultMessage}
          Example
          Example If a customer asks to be forgotten, make sure to delete all references to information that could personally identify the customer, including data in paused flow interviews. When an interview executes a Wait element or is paused by a user, all the interview data is serialized and saved to the database as a Paused Flow Interview record. When the interview is resumed, the Paused Flow Interview record is deleted.

          To identify which paused interviews include personal data for a contact, lead, or user, build a custom object to track the interview’s GUID and the affected contact, lead, or user. When an interview references personal data, such as a lead’s email or credit card number, create a record of the custom object using the lead’s ID and {!$Flow.InterviewGuid}. Before the final screen, delete all records of the custom object referencing the interview’s GUID. That way, the custom object tracks only interviews that are saved to the database.

          When a customer asks to be forgotten, create a report that lists all the custom object records where LeadId matches the customer’s record. Then for each custom object record, delete the flow interview that corresponds to the provided GUID.

           
          Loading
          Salesforce Help | Article