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

Planogram — entity reference

The expected shelf for a merchandising audit, kept in the Field Sales Setup app under Shelf Vision. The planogram decides two things. First, which reference image the View planogram button shows on a Merchandising Audit. Second, when shelf photos are analysed, which products and minimum facings the photo is scored against. A planogram is used only while its Status is Active and the current time is inside its effective window. It applies to one account, to every account whose Account Type matches, or to every outlet when both are empty. The narrowest match wins. New planograms start as Draft. The delivered New form has no Name field and no numbering setting is delivered, so a numbering setting or a Name field on the create layout is needed before a new planogram can be saved.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountScopes the planogram to one outlet. A planogram for the visited account beats any account-type or tenant-wide planogram. When Account is set, Account Type is ignored.
AccountTypeAccount TypeMultiLineTextScopes the planogram to every account whose Account Type has this value, for example Customer - Channel. Typed as free text and compared without regard to letter case, so it must match the account's Account Type value exactly. Used only when Account is empty. Leave both Account and Account Type empty for a tenant-wide planogram.
DescriptionDescriptionMultiLineTextFree-text instructions or notes for merchandisers. Not used in scoring.
EffectiveFromEffective FromDateAndTimeDate and time from which the planogram can be matched. Empty means it has no start. Compared with the current time when the audit form opens and when a photo is analysed, not with the visit's date.
EffectiveToEffective ToDateAndTimeDate and time after which the planogram is no longer matched. Empty means open-ended.
LabelLabelMultiLineTextThe planogram's display name. It is shown on the View planogram panel of a Merchandising Audit; when it is empty the record's Name is shown instead.
LayoutJsonLayout JsonMultiLineTextThe expected shelf in JSON: targetBrandLabels (detection labels that count as yours for share of shelf) and expected (one entry per product with label, minFacings and an optional shelfBand, 1 being the top shelf). Nothing checks it on save: invalid JSON or a missing section is silently treated as empty, so no compliance score is produced.
StatusStatusPickListDraft, Active or Retired. New planograms are Draft. Only Active planograms are ever matched to an audit or a shelf photo; Draft and Retired are ignored. Status is not on the New or Edit form: change it in place on the record page or in the list. Values: Draft, Active, Retired.

Actions

ActionLabelTypeWhat it does
DeleteEntityDeleteDeleteDeleteEntity
DeleteHeaderDeleteDeleteDelete Header
EditEntityDetailEditEditEditEntityDetail
EditInLineEntityEditEditInlineEditInLineEntity
EditInLineHeaderEditEditInlineEdit In Line Header
NewHeaderNewNewNewHeader