Additional configuration values

This content is for Spring ’26. Switch to the latest version for up-to-date documentation.

These values sit in the JSON editor alongside your Mobile Config record in Aforza Admin.

Advanced synchronisation control

Control whether commercial policy, orderable products and audit information are synced by default for accounts that are not being visited.

"DeferAccountRelatedSyncDown": true

Background sync

Used to determine whether background syncing can take place and at what trigger points.

"AutoSyncLocations": {
"AccountCreate": true,
"ConfigurableRecord": true,
"TaskEnd": true,
"VisitCreate": true,
"VisitEnd": true
},

Conflict Resolution:

Configuration required to enable conflict resolution.

"EnableConflictResolution": true,

Visit Synchronisation:

Control the number of days that visits are synced down for.

"Visits": {
"NumberOfPreviousDaysToSync": 1,
"NumberOfUpcomingDaysToSync": 14
}

In Progress Visit Check:

Field 25 includes a validation check to prevent overlapping visits. When a user attempts to check in, the system verifies whether there is already an active visit in progress.

If an existing visit is detected, the user is prompted to close any open visits before starting a new one. This helps ensure accurate visit tracking and prevents incomplete or duplicated visit records.

"Visits": {
"StartVisitChecks": {
"CheckForInProgressVisits": true
}
}

Today’s Route:

Control whether nearby and prospect account filtering is available on the route map. Where prospects are targeted, assign categories to match relevant business types.

{
"Details": {
"TodaysRouteWidgetOptions": {
"DisabledRouteInfo": true,
"EnableNearbyAccounts": true,
"EnableProspectAccounts": true,
"ProspectTypes": [
"drink",
"cafe"
]
}
},
"Type": "TodaysRoute"
},

KPI Association:

There are currently five out of the box KPI endpoints that can be configured for use with KPI charts. These charts are included in the Aforza managed package and therefore colour and chart type cannot be adjusted:

KPI Name Context Endpoint

Audits Completed Account ‘/services/apexrest/aforza/v1/kpi/completedauditcount/*’

Visits Per Month User ‘/services/apexrest/aforza/v1/kpi/visitspermonth/*’

Sales Per Month User ‘/services/apexrest/aforza/v1/kpi/salespermonth/*’

Top 5 performing objectives User ‘/services/apexrest/aforza/v1/kpi/topobjectives/*‘

Promotion Usage User ‘/services/apexrest/aforza/v1/kpi/toppromotions/*’

Custom KPI’s may be used in place of out of the box KPI’s where the need arises. These KPI’s can be targeted for use within the Consoles and Guides. Each area of configuration will require a target location, this is where the apex is stored.

Custom KPI’s have a greater level of customisation including:

Chart type
Chart title and subtitle
Axis definition
Chart colour
Custom Actions

*For Console Configuration:*

"Details": {
"Actions": [
{
"Target": "action:startGuide/a1F4K000000u751UAA",
"Type": "INTERNAL"
}
],
"ChartDataSource": "Aforza",
"ChartEndpoint": "/services/apexrest/aforza/labs/home?",
"CustomButtonLabel": "Capture"
},
"Type": "KPIGraph"
},

*For Guide Configuration:*

Embedded Camera:

Use to enable an embedded camera. This can be used to prevent unintended app minimisation on devices with limited memory.

"UseEmbeddedCamera": true

Extended View:

Used to control whether the ‘See More’ button is displayed on the custom object details view or list view side panel on Tablet.

"RecordSettings": {
"DisableExtendedView": true
}

Audit Check All:

Used to control whether the user is able to select all items contained in an audit in a single action.

"AuditCheckAllEnabled": true

*Delivery:* Used to enable whether or not delivery invoices and receipts are generated.

"Delivery": {
"EnableDeliveryInvoices": true,
"EnableDeliveryReceipts": true
}

*Team Calendar:* Used to determine whether a team calendar view is accessible within the Field app.

"Calendar": {
"EnableTeamCalendar": true
}

*AVA:* Used to determine whether AVA triggers are accessible within the Field app. This functionality is also dependent upon license access.

"AvaEnabled": true

*Geofencing:* Used to set levels of control and data setting of geo location on visits and tasks. Additional information can be found here.

"Geofencing": {
"CaptureEndVisitLocation": true,
"CaptureTaskEndLocation": true,
"CaptureTaskStartLocation": true,
"CheckInLock": false,
"CheckInRadiusKm": 0
}

*Geo-Tracking:* Allow the app to monitor and record a user’s device location in both the background and foreground. In addition to continuous tracking, one-off location captures can be made for key events, for example, capturing the user’s position at Visit End, Task Start, or similar moments.

"Geofencing": {
"LocationTrackingEnabled": true
}

*Order Status Validation:* Setting this to true will turn off the validation that ensures orders created on device have a ‘Draft’ status. This validation exists because non-draft statuses can’t be synced up to SFDC for new orders.

"DisableOrderStatusValidation": true

*Auto Download Assets:* Setting this to true will ensure all resources (for example any brochure PDFs or manuals for merchandise setup that are attached to the visit) are downloaded when the user logs into the app and after each full sync.

"AutoDownloadResources": true

*Order Grid Keypad:* When using a tablet device to view orders, you can decide whether or not to make use of the Aforza keypad. Setting this to true will enable the floating keypad in the order grid quantity/manual discount fields on the tablet, instead of showing the keyboard. This allows a larger number of rows to be visible because the keyboard isn’t taking up 50% of the screen.

"KeypadEnabled": true

*Order Grid Custom Columns - Tablet only:* When using a tablet device to view orders, you can determine which columns/fields are visible. The following objects can be added to the order grid to customise the UX:

Product
Inventory Product
Pricebook Entry
Outlet Asset

To add a column to your grid use the following configuration:
\

"ColumnHeader": "Type",
"FieldName": "aforza__Type__c",
"ObjectType": "Product2"