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

Checklist Template — entity reference

A reusable list of questions. The questions are its Checklist Template Line records; answers are saved as Checklist Line records against the record the checklist was filled on (a visit activity, delivery order, service order, claim line and so on), never on the template. Screens find a template in different ways: a visit activity or a Checklist widget can name it directly; mobile visit activities can match it by Type, honouring Is Active, the date window and the customer scope; claim lines take the newest Claim template for the item; health checks use a fixed template or every template for the asset's item; and Populate Checklist copies the questions of every template whose Type is exactly Delivery or Service Order. Kept in the Field Sales Setup app under Templates.

Fields

FieldLabelTypeRequiredWhat it does
AccountGroupIdAccount GroupLookupA customer group the template is for. Group-scoped templates do not currently match on visits, because the group check is not wired.
AccountIdAccount NameLookupOne customer the template is for. When a mobile visit activity looks a template up by Type, a template for the visit's customer beats a template with no scope, and a template for a different customer is never used.
CodeCodeTextA short reference for your own use. No checklist screen reads it.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
FrequencyFrequencyTextHow often the checklist is meant to be done, as free text. Nothing schedules or limits checklists by it.
FromDateFrom DateDateStart of the period the template is valid for. Honoured only by mobile visit activities that look a template up by Type; blank means no start limit.
IdIdGuidYes
IsActiveIs ActiveBooleanYesWhether the template is in use. Only mobile visit activities that look a template up by Type skip a template with this cleared (a template where it was never set still counts). Checklist widgets, claim checklists, health checks and Populate Checklist ignore it.
IsMandatoryIs MandatoryBooleanNot on any delivered form and not read anywhere. To require answers, mark individual questions mandatory; to require a checklist on a visit, make the activity that runs it mandatory.
ItemIdItemLookup → ItemThe product the checklist is for. Claim-line Open Checklist uses the newest Claim template for the line's item, and the Health Check widget in asset mode uses every template for the asset's item.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextThe checklist's title, shown on checklist screens and in pickers. Required.
OwnerIdOwnerLookup → UserAccountYes
ParentChecklistIdParent ChecklistLookupAnother template this one is grouped under, for your own organisation. No checklist screen reads it.
PartnerAccountGroupIdPartner Account GroupLookupNot on any delivered form and not read anywhere.
PartnerAccountIdPartner AccountLookup → AccountThe company the template belongs to, shown in the record header. It does not limit where the template is used.
RecordTypeIdRecord TypeGuid, hidden
ResourceGroupIdResource GroupLookupA resource group the template is for. Not on any delivered form, and group-scoped templates do not currently match on visits.
ResourceIdResourceLookupA resource (person) the template is for. Not on any delivered form. On mobile, a template for the executive's own resource ranks after customer scope and before unscoped templates; a template for someone else is never used.
ToDateTo DateDateEnd of the period the template is valid for. Honoured only by mobile visit activities that look a template up by Type; blank means no end limit. When two templates tie on scope, the shorter window wins.
TypeTypePickListWhat kind of checklist this is, chosen from the Type picklist (delivered values: Claim, Competitor Capture, Health Check, Inspection, Merchandising Audit, New Outlet Registration, Product Demo, Window Display Onboarding). Mobile visit activities match it against their activity type, ignoring case; claim lines need Claim; Populate Checklist compares the text exactly against Delivery for delivery orders and Service Order for service orders, values a tenant must add to the picklist first. Values: Claim, Training, Generic, Delivery, Training Repository.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEdit in page.
EditListHeaderEditEditInlineEditListHeader
EditListRowEditEditEditListRow
NewNewNewNew