FlowLog

Documentation for the FlowLog wrapper class used to structure and transmit log data from Flow Builder and Process Builder.

The FlowLog class provides a wrapper for passing log data from Flow or Process Builder.

Properties

@InvocableVariable(Required=false Label='Category')
public String category;               // Log category (defaults to Flow)

@InvocableVariable(Required=false Label='Type')
public String type;                   // Log type

@InvocableVariable(Required=true Label='Area')
public String area;                   // Functional area

@InvocableVariable(Required=true Label='Summary')
public String summary;                // Log summary

@InvocableVariable(Required=false Label='Details')
public String details;                // Log details

@InvocableVariable(Required=true Label='Interview GUID')
public String interviewGUID;          // Flow interview identifier

@InvocableVariable(Required=false Label='Flow API Name')
public String flowApiName;            // Flow API name

@InvocableVariable(Required=false Label='Level')
public String level;                  // Log level (defaults to INFO)

@InvocableVariable(Required=false Label='Operation')
public String operation;              // Operation name

@InvocableVariable(Required=false Label='Additional Fields')
public String additionalFields;       // JSON string of additional custom fields

Field Reference

Core Fields

Field	Required	Default	Description
category	No	Flow	Category classification for the log
type	No	-	Technical classification of the log entry
area	Yes	-	Functional area the log relates to
summary	Yes	-	Brief description of the log entry
details	No	-	Detailed information about the log entry
interviewGUID	Yes	-	Flow interview identifier ($Flow.InterviewGuid)
flowApiName	No	-	API name of the Flow
level	No	INFO	Log level for the entry
operation	No	-	Name of the operation being performed
additionalFields	No	-	JSON string of additional custom fields

Additional Fields Format

The additionalFields property accepts a JSON string mapping field API names to values:

{
    "pharos__Summary__c": "Custom summary",
    "pharos__Details__c": "Custom details"
}

Note: If the JSON string fails to parse, an error message will be added to the log details.