xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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 — entity reference
REFERENCE · Last reviewed

Macro — entity reference

A reusable, named set of ordered MacroStep actions an agent runs against a record in one click - set a field, send an email template, pause or resume the SLA, add a note, create a task, or close the record. Declared for one target entity via entityName (defaults to Case, but the runner is entity-agnostic and any entity with a registered RunMacro action can use it); layoutId optionally restricts the launcher to one layout. runMode decides whether reversible field edits are staged into the open form for review (Review, the default) or persisted immediately (Save); irreversible steps such as notes, emails and tasks always run at execution time. Steps that need a field the entity lacks are skipped rather than failing the run, and every executed step is recorded as a polymorphic Activity on the record's timeline.

Fields

FieldLabelTypeRequiredWhat it does
CategoryCategoryPickListOptional grouping for the macro picker: Triage, Response, Closure or Escalation. Values: Triage, Response, Closure, Escalation.
DescriptionDescriptionText
EntityNameTarget EntityTextThe one entity this macro targets (e.g. Case). The runner refuses to run a macro against any other entity; when empty the macro is not entity-scoped.
IsActiveActiveBooleanAn inactive macro is refused at run time (the RunMacro action fails validation), so deactivating retires a macro without deleting its steps.
LayoutIdLayoutLookupWhen set, the macro's launcher appears only on that entity layout; when null it appears on all of the target entity's layouts.
NameNameText
RunModeRun modeTextReview (the default, also used when null) stages the reversible field edits into the open form for the agent to check and save, running only the irreversible steps (notes, emails, tasks) immediately; Save applies and persists everything at once.

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteEntityDeleteDeleteDeleteEntity
DeleteRowDeleteDeleteDeleteRow
EditEntityEditEditEditEntity
EditInLineEditEditInlineEdit in page.
EditRowEditEditEditRow
NewNewNewNew