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 — entity reference
REFERENCE · Last reviewed

Macro — entity reference

A macro is a named list of ordered steps an agent runs against one open record in a single click: set fields, change status, add a note, create a task, draft or send an email, or call one of the entity's actions. Macros are built at Setup, Feature Hub, Service, Macros, for one target entity each. Agents run them from the Macros drawer in the workspace status bar, which needs the record's entity to have an active Run Macro action that the agent's security profile grants. Every run adds a Macro entry to the record's timeline. The Macro Name Setting numbering series (MA) replaces the name of a newly created macro, so rename it once after creating it.

Fields

FieldLabelTypeRequiredWhat it does
CategoryCategoryPickListOptional free-text label shown as a tag next to the macro in the Macros drawer and searchable there. The builder accepts any text; the picklist suggests Triage, Response, Closure and Escalation. Values: Triage, Response, Closure, Escalation.
DescriptionDescriptionTextOptional explanation shown when a macro is expanded in the Macros drawer. The macro builder has no Description box; it is set on the Macro record form.
EntityNameTarget EntityTextThe entity the macro is built for and listed on, set from the Entity picker on the Macros setup screen (Case when nothing else is given). Running a macro on a record of a different entity is refused with Macro targets X, not Y.
IsActiveActiveBooleanOnly active macros are listed in the Macros drawer, and running an inactive macro is refused with Macro is inactive. The builder saves every macro as active, including when you edit an inactive one, so switch it off again from the Active column afterwards if needed.
LayoutIdLayoutLookupOptional record layout. It limits the macro to the record-page Macros widget on that layout. The status bar Macros drawer ignores it and lists the macro on every record of the entity.
NameNameTextThe name agents see in the Macros drawer and the name written to the timeline (Ran macro followed by the name). On create the Macro Name Setting numbering series replaces the typed name with an MA number; open the macro with Edit, type the name again and save to keep it.
RunModeRun modeTextWhen run: Apply for review (Review, also used when empty) or Run and save (Save). Run and save applies field and status steps and saves the record at once. Apply for review only stages them in the open form when the macro is run from a record-page Macros widget; the shipped layouts do not include that widget, and the status bar Macros drawer always applies and saves them.

Actions

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