Visit Task Activity — entity reference

The record of one activity actually worked on a visit, such as a taken order, a filled checklist or a captured signature. It sits under the visit's task record and points back to the template activity it came from. Visits are not given activity records in advance: the web and mobile visit screens show the template's activities live and create this record the first time the representative works an activity, or when the representative adds an extra activity to a task during the visit. A visit nobody worked therefore has no activity records. The record holds a short summary of what was captured, the full capture as structured text, an amount where one applies, and a link to any document the activity created (order, invoice, payment, delivery order, service order or product demo). Photos and signatures are attached to it as files, and checklist answers are stored as checklist lines that point to it. Saving any change to an activity that is not yet Completed marks it Completed and stamps its End Time. Only the resource the visit plan is assigned to can start or complete it.

Fields

Field	Label	Type	Required	What it does
`ActivityName`	Activity Name	Text		The name shown on the activity row of the visit's task card. Copied from the template activity when the record is created, or typed by the representative when they add an extra activity during the visit.
`ActivityType`	Activity Type	PickList		Decides which capture form opens, for example Take Order, Checklist, Digital Signature or General Task. Copied from the template activity, or chosen by the representative for an extra activity. A type the visit screens do not recognise opens a simple start-and-complete form. Values: Take Order, Checklist, 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.
`BooleanValue`	Boolean Value	Boolean	Yes	Not written by the visit screens.
`ChecklistTemplateId`	Checklist Template	Lookup → ChecklistTemplate		The checklist a checklist-type activity runs, copied from the template activity. Its answers are stored as checklist lines that point to this activity, or to the service order when the template activity routes them there.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`CurrencyValue`	Currency Value	Currency		The amount captured, where the activity type records one. Take Order on the web stores the order's net total here.
`Date`	Date	TimeOnly
`DateTimeValue`	Date Time Value	DateAndTime
`DateValue`	Date Value	DateAndTime
`DecimalValue`	Decimal Value	Number
`DeliveryOrderId`	Delivery Order	Lookup → DeliveryOrder		The delivery order worked by a Delivery Fulfillment activity.
`Duration`	Duration	Calculated (calculated)		Minutes between Start Time and End Time, calculated on save. It is 0 when Start Time is empty, which is common.
`Email`	Email	Text
`EndTime`	End Time	TimeOnly		Stamped by the server, in UTC, when the activity changes to Completed.
`FieldName`	Field Name	Text		For activity types that bind to a field of a record, the field to use. Copied from the template activity; the template is the fallback.
`FieldValue`	Field Value	Text		For activity types that bind to a field of a record, the value to use. Copied from the template activity; the template is the fallback.
`FormLayoutId`	Form Layout	ExternalId		For entity-form activity types, the create form to open instead of the record type's default one. Copied from the template activity; the template is the fallback.
`GeolocationValue`	Geo Location Value	Text		Not written by the visit screens. Captures that record a location keep it in the full capture text.
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup → Invoice		The invoice linked by a Payment Collection activity.
`IsActivityCompleted`	Is Activity Completed	Boolean		Not stored. The visit screens send it when an activity is completed, but the value is dropped, so Status is the only completion signal on a saved record.
`IsDisabled`	Is Disabled	Boolean	Yes	Not set by the visit screens and not read by them.
`IsHidden`	Is Hden	Boolean	Yes	Copied from the template activity when the record is created. A hidden activity is not shown on the visit.
`LongTextValue`	Long Text Value	MultiLineText		The full capture as structured text, written when the activity is completed: entered values, product lines, readings or the linked record, depending on the activity type. Reopening a completed activity during the visit edits this capture.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text
`NumericValue`	Numeric Value	Number		Not written by the visit screens. Numeric checklist answers are stored on the checklist lines instead.
`ObjectName`	Object Name	PickList		For entity-form activity types, the kind of record the activity creates. Copied from the template activity; if it is missing on the record, the visit screens read it from the template. Values: Sale Order, Sale Invoice, Repair Order.
`OrderId`	Order	Lookup → Order		The order the activity created or linked, for Take Order and Generate Invoice activities.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PaymentId`	Payment	Lookup → Payment		The payment recorded by a Payment Collection activity.
`PerformAutomatically`	Perform Automatically	Boolean	Yes	Not read by the visit screens.
`Phone`	Phone	Text
`PlannedDuration`	Planned Duration	Calculated (calculated)		Minutes between Planned Start Time and Planned End Time, calculated. Usually 0 because the planned times are not filled in.
`PlannedEndTime`	Planned End Time	Date		Not filled in by the visit screens.
`PlannedStartTime`	Planned Start Time	TimeOnly		Not filled in by the visit screens. Planned times for the visit are kept on the visit itself.
`ProductDemoId`	Product Demo	Lookup → ProductDemo		The product demo recorded by a Product Demo activity.
`RecordTypeId`	Record Type	Guid, hidden
`RNAExternalId`	RNA External	Text
`SequenceNumber`	Sequence Number	Number		The activity's position inside its task, copied from the template activity. An extra activity added during the visit is placed after the task's existing activities.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The service order an activity worked on, for service-order activity types and for checklists whose answers are stored against the service order.
`StartTime`	Start Time	TimeOnly		Stamped by the server only when an existing activity record changes to Started. Activities the visit screens create already started, which is the usual case, keep Start Time empty. The task record carries the task's own start time.
`Status`	Status	PickList		Started when the record is created by the web visit screen and when a General Task is started; Completed when the activity is finished. Any saved change to an activity that is not yet Completed sets it to Completed, so editing the record by hand also completes it. A completed activity cannot be set back by the visit screens. The visit screens treat Started and Ongoing as in progress. Completed is written by the system even though it is not one of the listed values, and Draft is never set by the system. Values: Started, Draft.
`TextValue`	Text Value	Text		A one-line summary of what was captured, for example the order number and amount, Signature captured, or the name of the record an entity form created.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`URL`	URL	Text
`VisitId`	Visit	Lookup → Visit		The visit the activity was worked on. Filled in by the visit screens.
`VisitTaskId`	Visit Task	Lookup → VisitTask		The visit's task record that the activity belongs to. The task record is created first, from the template entry, and the activity is created under it.
`VisitTaskTemplateActivityId`	Visit Task Template Activity	Lookup → VisitTaskTemplateActivity		The template activity this record was created from. Empty for an extra activity the representative added during the visit. The visit screens use it to match the record to its place in the template, and read the Mandatory flag from the template activity, so extra activities are never mandatory.

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditEntity`	Edit	Edit	EditEntity
`EditInLine`	Edit	EditInline	Edit
`EditInList`	Edit	EditInline	Edit In List Header
`New`	New	New	New

VisitTask — looks up via VisitTaskId
UserAccount — looks up via CreatedById
UserAccount — looks up via OwnerId
UserAccount — looks up via ModifiedById
ServiceOrder — looks up via ServiceOrderId
Visit — looks up via VisitId
Order — looks up via OrderId
DeliveryOrder — looks up via DeliveryOrderId
Payment — looks up via PaymentId
Invoice — looks up via InvoiceId
VisitTaskTemplateActivity — looks up via VisitTaskTemplateActivityId
ChecklistTemplate — looks up via ChecklistTemplateId
ProductDemo — looks up via ProductDemoId
ShelfAuditResult — referenced by via VisitTaskActivityId

Visit Task Activity — entity reference

Fields

Actions

Related entities

Related topics