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

Visit Task Template Activity — entity reference

One activity inside a visit task template entry: a typed capture, such as Take Order, a checklist or a signature, that shows as one activity row inside the entry's task card on every visit carrying the template. Visits do not get copies of template activities when they are planned. The web and mobile visit screens read the activities live each time the visit is opened, and create the visit's own Visit Task Activity record only when the executive first works the activity. That record copies the activity's name, type, sequence, checklist template and record binding at that moment. Activity Type decides which capture form opens. Mandatory and Hidden decide the order, locking and visibility of the activities in the task. Several stored fields (Require Picture, Show Details, Related Activity Action, Related Visit Task Template Activity, Report URL, Dashboard URL, Description, Record, Unique Identifier) have no effect on the visit screens.

Fields

FieldLabelTypeRequiredWhat it does
ActivityTypeActivityTypePickListWhich capture form opens when the executive works the activity. The list on the form offers the delivered values. Some are older names that open a renamed capture: Checklist opens the pre-visit checklist (Previsit), Photo Capture opens the Customer KYC capture (selfie, OTP and a shop photo), Returns Pickup opens Return Pickup, Time & Expense opens Time & Expenses, and Custom Form opens the create form of the record type named in Object Name. An empty or unrecognised value opens a simple start-and-complete form. Values: Checklist, Take Order, Digital Signature, Photo Capture, General Task, Stock Check, Payment Collection, Returns Pickup, Merchandising Audit, Asset Verification, Competitor Capture, New Outlet Registration, Parts Consumption, Meter Reading, Proof of Delivery, Time & Expense, Barcode Scan, Safety Compliance, Schedule Follow-up, Lead Capture, Log Case, Custom Form, Product Demo, Generate Invoice, Delivery Fulfillment, Service Order Execution, Generic Component.
ChecklistTemplateIdChecklist TemplateLookup → ChecklistTemplateThe checklist the activity runs when its Activity Type is Checklist. It is copied onto the visit's activity record when the activity is first worked.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DashboardURLDashboard URLLongMultiLineTextStored but not used: no visit screen reads it.
DescriptionDescriptionTextFree-text notes for administrators. It is not shown to the executive.
DurationDuration (Mins)NumberPlanned minutes for the activity. Defaults to 0. The mobile day-end summary adds up the durations of a visit's activities to judge whether the executive stayed long enough (at least half the planned time). The task card shows the entry's Task Duration, not this value.
FieldNameField NameTextThe visit field that holds the id of the record the activity is bound to, for example AccountId for the visited customer, read together with Object Name. Generic Component opens that record in its Form Layout, and a visibility rule in UI Props reads its field from that record instead of from the visit. Copied onto the visit's activity record when the activity is first worked.
FieldValueField ValueTextFor Lead Capture, Log Case, Custom Form and Generic Component activities it can hold a layout id: when it contains one and Form Layout is empty, that layout opens instead of the record type's default create form. Copied onto the visit's activity record when the activity is first worked.
FormLayoutIdForm LayoutExternalIdThe layout that Lead Capture, Log Case, Custom Form and Generic Component activities open instead of the record type's default create form. Generic Component needs it. It is on no delivered form; Field Value can hold the layout id instead.
IdIdGuidYes
IsHiddenIs HiddenBooleanYesTakes the activity out of use without deleting it. A hidden activity is not shown on visits where it has not been worked yet and is left out of the day-end scores. On a visit where it was already worked, it stays visible. A task whose activities are all hidden is not shown.
IsMandatoryIs MandatoryBooleanYesMakes the activity compulsory. Mandatory activities are listed first in the task, must be completed in sequence before the task's optional activities unlock, count towards the mobile day-end must-do score, and on the mobile app block ending the visit as Productive while pending. The flag is read live from the template, so changing it also affects visits already in progress.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextThe activity name the executive sees on the activity row. It is copied onto the visit's activity record when the activity is first worked, so later renames reach only visits on which it has not been worked yet. If Name is empty, the row is titled Activity.
ObjectApiNameObject Api NameTextAn alternative to Object Name, used only when Object Name is empty.
ObjectNameObject NamePickListThe record type the activity works with. For Custom Form it is the record type whose create form opens. For Generic Component it is the record type whose layout opens. Together with Field Name it also names the record a visibility rule in UI Props is read from. Values: Delivery Order, Payment, Order, Account Stock.
OwnerIdOwnerLookup → UserAccountYes
RecordIdRecordText, uniqueNot used by the visit flow. It must be unique across the tenant when filled in.
RecordTypeIdRecord TypeGuid, hidden
RelatedActivityActionRelated Activity ActionPickListStored but not used. The values Repeat By Value, Visible By Value and Enabled By Value are not acted on by the server or the visit screens. Values: Repeat By Value, Visible By Value, Enabled By Value.
RelatedVisitTaskTemplateActivityIdRelated Visit Task Template ActivityLookup → VisitTaskTemplateActivityStored but not used by the visit screens or the server. It was meant to pair with Related Activity Action, which is not acted on.
ReportURLReport URLLongMultiLineTextStored but not used: no visit screen reads it.
RequirePictureRequire PictureBooleanYesStored but not used: no visit screen reads it. Each capture form decides its own photo requirements.
SequenceNumberSequence NumberNumberThe position of the activity inside its task, lowest first. Defaults to 0. Mandatory activities are always listed before optional ones, each group in its own sequence order, and the lowest-numbered incomplete mandatory activity is the only one that can be worked until all mandatory activities are done.
ShowDetailsShow DetailsBooleanStored but not used: no visit screen reads it.
UIPropsUI PropsTextOptional visibility rule in JSON, for example {"visibleWhen": {"field": "FieldX", "equals": "Value"}}. The activity then shows only when that field is ticked (or equals the value) on the bound record named by Object Name and Field Name, or on the visit when no Field Name is set. A record that cannot be read hides the activity; malformed JSON is ignored. It is on no delivered form.
UniqueIdentifierUnique entifierText, uniqueAn optional external key, for example for an integration. It must be unique across the tenant. Nothing in the visit flow reads it.
UpdatedDateTimeModified DateDateAndTimeYes
VisitTaskTemplateEntryIdVisit Task Template EntryLookup → VisitTaskTemplateEntryThe task (template entry) the activity belongs to. Filled in when the activity is added from the entry's Related tab.

Actions

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