xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Macro Step — entity reference
REFERENCE · Last reviewed

Macro Step — entity reference

One ordered step inside a macro. Steps are written by the macro builder at Setup, Feature Hub, Service, Macros, which numbers them 1, 2, 3 in the order shown and, when a macro is edited, deletes the old steps and writes the current list again. When the macro runs, its steps are read in Step Order and each one reports applied or skipped with a reason; a step that cannot apply is skipped and the rest still run. The builder offers Set field, Change status, Add note, Create task, Send email (template), Send email (compose) and Call server action. The runner also still understands the older PauseSla, ResumeSla and CloseCase types (they set the record's Stopped flag, or set Status to Closed and stamp Date/Time Closed), but the builder does not offer them. Build steps in the macro builder rather than on the Macro Steps form, which has no Target Field.

Fields

FieldLabelTypeRequiredWhat it does
MacroIdMacroLookup → MacroYesThe macro this step belongs to. The runner only reads steps of the macro being run.
StepOrderStep OrderNumberPosition of the step in the macro. Steps run in ascending order. The builder renumbers every step 1, 2, 3 each time the macro is saved, so the order is the order shown in the builder.
StepTypeStep TypePickListWhich operation the step performs. The builder stores SetField, ChangeStatus, AddNote, CreateTask, SendTemplate, SendEmail or CallServerAction; the runner also accepts PauseSla, ResumeSla and CloseCase. Any other value is skipped with Unknown step type. The picklist on the Macro Steps form lists only the older values, so create steps in the macro builder. Values: SetField, SendTemplate, PauseSla, ResumeSla, AddNote, CreateTask, CloseCase.
TargetFieldTarget FieldTextFor Set field, the name of the field to change. For Change status, empty means the Status field. For Call server action, the name of the entity action to call. Not used by other step types. A field the record does not have, or cannot be written, makes the step skip.
TemplateIdEmail TemplateGuidFor Send email (template), the email template to render against the record. The builder offers active templates only. If no template is chosen the step skips; if rendering fails the step still drafts an email with a placeholder subject and body.
ValueValueTextHolds the step's parameter, up to 2,000 characters. Set field and Change status: the value to write, converted to the field's type (a value that does not convert makes the step skip). Add note: the note text. Create task: the task subject. Send email (template): send or draft. Send email (compose): the To, From, Cc, Subject, Body and draft or send choice, stored together. Call server action: optional arguments as JSON. Only the compose email step replaces merge tokens (a field name inside double curly braces) with the record's values; notes, tasks and field values are used exactly as typed.

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
DeleteEntityDeleteDeleteDeleteEntity
DeleteHeaderDeleteDeleteDeleteHeader
DeleteRowDeleteDeleteDeleteRow
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit in page.
EditRowEditEditEdit
NewNewNewNew
  • Macro — looks up via MacroId