Object Reference for the Salesforce Platform
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Macro
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update(), upsert()
Fields
| Field | Details |
|---|---|
| Description |
|
| FolderId |
|
| FolderName |
|
| IsAlohaSupported |
|
| IsLightningSupported |
|
| LastReferencedDate |
|
| LastViewedDate |
|
| Name |
|
| OwnerId |
|
| StartingContext |
|
Usage
A macro definition consists of a Macro object and several associated MacroInstruction objects.
First, create a Macro object. Then, create MacroInstructions that specify objects, operations, conditions, and targets for the macro.
A macro contains an ordered list of macro instructions whose index field, sortOrder, is 0-based. If there’s an incorrect sequence of macro instructions, the macro doesn’t execute.
If you update a macro definition or add or remove instructions from a macro, make sure that the sortOrder field that defines the execution order is correct. To delete an entire macro definition, invoke the delete operation on the Macro object.
The table describes the supported macro instruction targets and how they relate to each other.
If a macro instruction listed in the table supports an implicit operation, you can use that operation as a direct child instruction without explicitly specifying a target. The hyphens used in the table illustrate the hierarchical relationship between targets. A target isn't available if its parent isn’t.
| Target API Name | Supported Operations |
|---|---|
| Tab.<EntityApiName> | SELECT, CLOSE (implicit) |
| - QuickAction.<EntityApiName>.<QuickActionName> | SELECT, SUBMIT (implicit) |
| - - Field.<QATargetEntityApiName>.<FieldApiName> | SET |
| - - Field.<QATargetEntityApiName>.<MultilineTextFieldApiName>.cursor | INSERT |
| - - Field.<QATargetEntityApiName>.<SinglelineTextFieldApiName>.end | INSERT |
| - QuickAction.Case.Email | SELECT, SUBMIT (implicit) |
| - - Field.EmailMessage.<FieldApiName> | SET |
| - - Field.EmailMessage.<MultilineTextFieldApiName>.cursor | INSERT |
| - - Field.EmailMessage.<SinglelineTextFieldApiName>.end | INSERT |
| - - Field.EmailTemplate | SET |
| - SidebarCmp.Knowledge | SELECT |
| - - SearchAction.KnowledgeArticle | SELECT |
| - - - Field.SearchString | SET, INSERT |
| - - - Command.Search | SUBMIT |
| - - SearchResult.KnowledgeArticle.MostRecentItem | SELECT |
| - - - Command.AttachToRecord | SUBMIT |
| - - - Command.InsertToEmail | SUBMIT |
| - - - Command.AttachToEmailAsPDF | SUBMIT |
Example
This example describes a macro that opens a quick action, sets some fields in the quick action, and submits the quick action.
0. SELECT Tab.Case
1. SELECT QuickAction.Case.Email
2. SET Field.EmailMessage.Subject
3. SET Field.EmailMessage.ToAddress
4. INSERT Field.EmailMessage.HtmlBody.cursor
5. SUBMITAssociated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
- MacroChangeEvent (API version 48.0)
- Change events are available for the object.
- MacroHistory
- History is available for tracked fields of the object.
- MacroOwnerSharingRule
- Sharing rules are available for the object.
- MacroShare
- Sharing is available for the object.