MacroInstruction

Represents an instruction in a macro. An instruction can specify the object that the macro interacts with, the context or publisher that the macro works within, the operation or action that the macro performs, and the target of the macro’s actions. It is a useful way to programmatically define instructions, instead of using the macro widget in the console.

Supported Calls

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

Fields

Field Name Details
MacroId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the macro that contains this instruction.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, Sort
Description
Name of the instruction.
Operation
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The action that the macro instruction performs.
SortOrder
Type
int
Properties
Create, Filter, Group, Sort, Update
Description
Order of this instruction in the macro.
Target
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Object in the case feed that is the target of the operation. For example, the target might be the active case tab or a quick action.
Value
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Value of a field. If the operation is Select, then the value is null, because the operation selects the object on which the macro performs an action. An instruction can contain both a Value field and a ValueRecord field, but only one of these fields can have a value. The other field value must be null.
ValueRecord
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the value or record. The ValueRecord can be either a value or a record, but not both. An instruction can contain both a Value field and a ValueRecord field, but only one of these fields can have a value. The other field value must be null.