Newer Version Available

This content describes an older version of this product. View Latest

ExpressionFilter

Represents a logical expression that’s used to control the execution of macro instructions. This object is available in API version 46.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field Details
ContextId
Type
reference
Properties
Create, Filter, Group, Sort
Description
Required. The ID of the MacroInstruction object that contains the expression.
FilterConditionLogic
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Optional. The filter conditions to use and the order in which to apply them. For example, ‘1 AND 2’ evaluates condition 1 and then condition 2.
FilterDescription
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Optional. A description of the filter expression that helps to explain the logic to users. For example, ‘Applies to New cases.’
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Optional. A label for the expression.

Usage

The ExpressionFilter object is used with the IF and ELSEIF operations in a MacroInstruction. It lets you specify a logical expression that determines whether macro instructions are executed. The object indicates whether any or all conditions must be true.

To represent the conditions that are evaluated, this object uses one or more ExpressionFilterCriteria child objects. The ExpressionFilter to be used with each criteria is specified in the ExpressionFilterCriteria’s ExpressionFilterId field.

For example, to represent the following conditional statement, the ExpressionFilter object specifies the FilterConditionLogic field as 1 AND 2, where 1 and 2 are ExpressionFilterCriteria objects. In this example, condition 1 is Case.Status EQUALS New, and condition 2 is Case.Origin EQUALS Phone.

1IF (Case.Status EQUALS New) AND (Case.Origin EQUALS Phone)
2      Select Email QuickAction
3      Set Subject…
4      Set To…
5      Set Body…
6      Submit
7ENDIF