> ## Documentation Index
> Fetch the complete documentation index at: https://support.fieldko.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration Reference

> Look up every FieldKo custom setting and custom metadata type that affects the app, with labels, defaults, and effects.

This reference lists every FieldKo custom setting and custom metadata type that changes how the FieldKo Atlas app behaves, with each one's fields, defaults, and effects in the app. Settings are grouped by the area of the app they affect. To find a setting, start with the [Find a Setting](#find-a-setting) table, or search the page (Ctrl+F or Cmd+F) for the setting's label.

## User Permissions Needed

| To do this | You need |
| - | - |
| Use the **FieldKo Configuration** tab | FieldKo Manager Permission Set |

## Find a Setting

| To Change This in the App | Go To |
| - | - |
| Basic, calendar, map, visit, and survey options you can set without Setup | [FieldKo Configuration Tab](#fieldko-configuration-tab) |
| Items in the side menu, and objects reps can open from it | [Side Menu](#side-menu) |
| Buttons and actions on the visit screen | [Visit Actions](#visit-actions) |
| Background sync, sync batch sizes, and the **Sync Images** default | [Sync](#sync) |
| Which photos and files download and how photos upload | [Photos and Files](#photos-and-files) |
| Check-in and check-out button colors, and encryption | [Appearance and Security](#appearance-and-security) |
| Check-in distance, geolocation, visit types, visit names, reminders, and automated check-out | [Visit Configurations](#visit-configurations) |
| Account coordinate fields | [Account Location Fields](#account-location-fields) |
| Calendar views, account cards, and account search | [Calendar](#calendar) |
| Minimum visit length, visit type records, and visits from other objects | [Visit Duration, Visit Types, and Visit Creation](#visit-duration-visit-types-and-visit-creation) |
| Survey instructions, numbering, partial save, and navigation | [Surveys](#surveys) |
| The order screen, order PDF, and cart | [Orders](#orders) |
| The core ranging screen | [Core Ranging](#core-ranging) |
| Which records, objects, profiles, and accounts sync | [Sync Scope and Metadata](#sync-scope-and-metadata) |
| Which page layout the app shows | [Page Layouts](#page-layouts) |
| Leave requests and pack-out values | [Objects Outside the FieldKo Packages](#objects-outside-the-fieldko-packages) |

## Before You Begin

From Setup, in the Quick Find box, enter `Custom Settings` or `Custom Metadata Types`, select that item, and then click **Manage** (custom settings) or **Manage Records** (custom metadata types) next to the setting.

For hierarchy settings, the app uses the most specific value: user, then profile, then org default.

### How to Read the Tables

* **Setting line:** Each table starts with the setting's name as shown in Setup, and whether it's a hierarchy or list custom setting or a custom metadata type.
* **Field:** The field label as shown in Setup.
* **What It Does:** The effect in the app when the field is on or filled in.
* **Default:** The package default for a new record. A blank default means the field is empty or has no package default.

<Note>
  Settings marked † are available in newer package versions. If you don't see one in your org, your package version doesn't include it, and the app uses its default behavior. Their labels in your org may differ slightly from the names shown on this page.
</Note>

## FieldKo Configuration Tab

From the App Launcher, find and select **FieldKo Configuration**. Each section of the tab saves to the settings in the following table, so you can change these options here instead of in Setup.

| Section | Option | Saves To |
| - | - | - |
| Basic | Select Account Record Types for Visit Planning | **Account Record Type** setting, **Type** field |
| Basic | Fiscal Year Start Month | **Fiscal Year Settings** setting, **Fiscal Year Start Month** field |
| Basic | User Reporting Hierarchy (Manager or Role; for Public Group, see [Set Up Manager Visibility](/platform/access/manager-visibility)) | **User Hierarchy Base** setting, **DependentOn** field |
| Basic | Transfer Data On Change Of Account Owner | **Transfer Account Data Configuration** setting |
| Basic | Account Filters (fields, sort, limit up to 2,000, descending) | **Account search result Configuration** setting |
| Calendar and Map | Display Salesforce Events, busy slots, event color, old calendar version | **Calendar Configurations** setting |
| Calendar and Map | Google Map API Key, Account Field for Map Pin Color, Consider Traffic for Routing | **Map Configurations** setting |
| Calendar and Map | Distance Unit | **Distance Unit** setting, **Unit** field |
| Calendar and Map | Calendar Language, Map Language | **Language Support** setting |
| Visit | Minimum Default Duration (In Minutes) | **Visit Duration** setting, **Duration (In Minutes)** field |
| Visit | Capture geolocation, Chatter feed, default template, template name prefix, contact-based planning, copy incomplete tasks, special visits | **Visit Configurations** setting |
| Visit | Notify Rep on Visit Planning using Field Campaign | **Visit Notification** setting |
| Survey | All options | **Survey Settings** setting |

If the Calendar Language or Map Language doesn't save, set it in the **Language Support** custom setting.

You set every other setting on this page in Setup.

## Mobile App

The settings in this section control the app's side menu, visit screen, sync, photos, and appearance.

### Side Menu

**Menu Configuration** (hierarchy custom setting) controls which items appear in the app's side menu.

<Warning>
  If no Menu Configuration record exists, the app shows Accounts, Visit Map, and Visit Calendar. After a record exists, **any unchecked or missing field hides that item**. Before you create a record, decide which items reps need and select each one.
</Warning>

| Field | What It Does | Default |
| - | - | - |
| Display Accounts | Shows **Accounts** in the side menu | On |
| Display Visit Calendar | Shows **Visit Calendar** in the side menu | On |
| Display Visit Map | Shows **Visit Map** in the side menu | On |
| Display Dashboard | Shows **Dashboard** in the side menu | Off |
| Display Chatter | Shows **Chatter** in the side menu | Off |
| Objects To Be Shown | Adds these objects to the side menu. Enter the objects' API names, separated by commas. Find each one in Setup > Object Manager. | |
| Display Photos † | Shows **Photos** in the side menu | Off |
| App Name, App Version, Brand Color, Logo URL † | Sets the name, version label, header color, and logo in the menu footer | |

**My Visits**, **Sync**, **Settings**, and **Logout** always appear. The current app doesn't use Display Expense, Display My Objectives, Display Order 2.0, or Display Planogram.

**Objects To be Fetched** (list custom setting). Add one record per object you want in the app. See [Add an Object to the App](/admin/offline-data#add-an-object-to-the-app).

| Field | What It Does | Default |
| - | - | - |
| Name / Object Name | Enter the object's API name. Find it in Setup > Object Manager. Use Object Name for names over 40 characters. | |
| Upsertion Order Value | Required. Sets the order in which the app saves records during sync. Use a value above 50. | |
| Show In Menu | Adds the object to the side menu | |
| Menu Label Override | Replaces the object's plural label in the side menu | |
| List View Fields | Sets the fields shown on list cards. Enter the fields' API names, separated by commas. Find each one in Setup > Object Manager. You can include a field from a related record, such as the account name through the Account lookup field. If blank, the app uses the object's search results layout. | |

### Visit Actions

**Visit Actions Configuration** (hierarchy custom setting). Each checkbox shows an action on the visit screen. As with Menu Configuration, after a record exists, a blank field hides that action.

| Field | What It Does | Default |
| - | - | - |
| Display Cancel Visit | Shows **Cancel Visit**. Also lets reps check out with unfinished tasks through the Checkout Visit screen. When off, reps must finish every task before they check out. | Off |
| Display Set Visit Type | Shows **Set Visit Type** | Off |
| Display Add Note | Shows **Add Note** | On |
| Display Add Task | Shows **Add Task** | On |
| Display View Account | Shows **View Account** | On |
| Display Attach File | Shows **Attach File** and **Capture Photo** | On |
| Display Log An Incident | Shows **Log an Incident** (checked-in visits only) | On |
| Display Display | Shows **Display** (checked-in visits only) | Off |
| Display Place Order | Shows **Place Order** (checked-in visits only) | On |
| Display Core Ranging | Shows **Core Ranging** (checked-in visits only) | On |
| Display Next Visit ToDo's | Shows **Next Visit To Do's** | On |
| Log an Incident Label Translation | Replaces the **Log an Incident** label (up to 40 characters) | |
| Enable Layout Based Log An Incident | Shows the Incident page layout instead of the fixed incident form | Off |
| More Objects As Actions | Adds actions from **Object for visit action** records. Enter comma-separated record names. | |

**Object for visit action** (custom metadata type). Adds an action that lists or creates related records from a visit.

| Field | What It Does | Default |
| - | - | - |
| Object API name | The object the action shows. Enter the object's API name. Find it in Setup > Object Manager. | |
| Action Label / Action label API Name | The action's label, or the name of a custom label for translated labels | |
| Fields to filter | The account lookup field on the object, such as the Account lookup field on Contact. Enter the field's API name. Find it in Setup > Object Manager. The action shows records for the visit's account. | |
| Tabular View? / Number of Columns | Shows the records in an editable table with this many columns | 5 columns |
| Hide Previous Records | Shows only records created on this visit | |
| Show Before Checkin / Show After Checkout | Shows the action before check-in or after check-out | |

The package includes sample records: Asset, Contact, Create Task, Orders, Pack Out, and Visit. To use them, add their names to **More Objects As Actions**. Pack Out shows the [pack-out screen](/field-work/pack-outs).

### Sync

**Sync Configurations** (hierarchy custom setting) controls background sync, the **Sync Images** default, and sync batch sizes.

<Note>
  If there's no Sync Configurations record, the app turns background sync off. Installing the package creates the org default record. If reps say background sync isn't running, check this record in Setup.
</Note>

| Field | What It Does | Default |
| - | - | - |
| Enable Background Sync | Lets the app sync in the background while it's open | On |
| Interval for Background Sync | Sets the minutes between background syncs | 60 |
| Background Sync within Business Hours | Runs background sync only within the org's default business hours | Off |
| Always Sync attachments | Sets the default for the **Sync Images** toggle | On |
| Batch Size For Native App | Sets the size of each upload batch, in KB | 100 if blank |
| Number of Records | Sets how many records the app downloads per request | 999 |

The current app doesn't use Background Sync Batch Size, Enable Location Tracking, or Interval for Location Tracking. Enhanced Sync screen is deprecated.

### Photos and Files

**Object Names for Attachment Sync** (list custom setting). Add one record per object. For the record **Name**, enter the object's API name. Find it in Setup > Object Manager.

| Field | What It Does | Default |
| - | - | - |
| Capture From Native FieldKo App | Turns on **Attach File** for the object | On |
| Capture Photo? / Capture File? | Shows the photo and document options. On objects other than Account, photo options need Capture Photo? selected. | Off |
| Fetch Files | Downloads Salesforce Files for the object's records | Off |
| Past N Weeks | Downloads attachments from the last N weeks (1 to 52) | 1 |
| All | Downloads all attachments, ignoring Past N Weeks | Off |
| User Specific | Downloads only attachments the rep owns | On |
| Fetch From Team Member / Field API Name for Account | Also downloads attachments owned by account team members, through this account lookup | Off |
| Fetch Only Most Recent | Downloads only the latest attachment per record | Off |
| Skip Sync | Stops the app from downloading this object's images | Off |

Questions and FieldKo products always download all their images. Survey answer photos download from the start of last month.

**File Configurations** (hierarchy custom setting) controls how photos upload and where survey answer photos are linked.

| Field | What It Does | Default |
| - | - | - |
| Enable File | Uploads photos as Salesforce Files instead of attachments | |
| Link Answer Photo to Visit / Link Answer Photo to Account | Also links survey answer photos to the visit or account | |

### Appearance and Security

**Fieldko Native Theme Colors** (list custom setting). You can also edit these on the **FieldKo Theme** tab.

| Field | What It Does | Default |
| - | - | - |
| Visit Checkin button colour, Visit Checkout button colour | Sets the color of the check-in and check-out buttons. Enter a color name or hex code. | |

**Security Configuration** (hierarchy custom setting) controls the app's extra encryption.

| Field | What It Does | Default |
| - | - | - |
| Enable encryption | Turns on the app's extra encryption. Set it at the org level. | |

## Visit Configurations

**Visit Configurations** (hierarchy custom setting). Controls check-in, visit types, visit names, reminders, and check-out in the app. You can also set several of these fields on the **Visit** section of the [FieldKo Configuration tab](#fieldko-configuration-tab).

| Field | What It Does | Default |
| - | - | - |
| Capture Geolocation | Records the rep's location at check-in and check-out | On after install |
| Max Distance From Store To Checkin | Sets the check-in distance in meters. Reps who are farther away must confirm, and the app records the distance. | 1000 |
| Allow Special Visits | Turns on visit types and colors | Off |
| Make Visit Type Required | Requires reps to choose a visit type | Off |
| Allow Multiple Visit Type Selection | Lets reps choose several visit types | Off |
| Filter Task Type by Visit Type | Shows only task types whose Group Name matches the visit type | Off |
| Require Task Per Visit Type | Requires at least 1 task per selected visit type | Off |
| Make Task Survey Selection Default? | Opens **Select Individual Tasks** instead of **Use Visit Template** when reps create a visit | Off |
| Enable Default Visit Template | Creates a visit right away, with the template's tasks, when a rep adds an account that has a default visit template | Off |
| Visit Template As Visit Name Prefix | Adds the template name to the start of the visit name | Off |
| Account Field API Name For Visit Name | Adds an account field to the visit name: "Visit - Account - value" | |
| Do not allow Recurring Visits? | Hides recurring visit options | Off |
| Copy All Incomplete Tasks | Preselects copying unfinished tasks to the next visit when a rep cancels | On |
| Hide Note Title | Hides the note title. The app uses the first 20 characters of the note instead. | Off |
| Preserve Completed Visit Values | Keeps a completed visit closed when someone adds a task to it | Off |
| Enable Visit Checkin Checkout Reminders **and** Enable Visit Reminders On Mobile | Turns on [mobile reminders](/visits/reminders). Both must be on. | Off |
| Enable Visit Reminders On Backend | Sends Salesforce notifications for missed visits. Needs a scheduled job. | Off |
| Visit Reminder Delay Minutes | Sets the minutes after the planned start or end before a reminder | 30 if blank |
| Post Checkin - Checkout Feed On Account | Posts check-ins and check-outs to the account's Chatter feed | On |
| Enable Automated Checkout / Maximum Distance for Automated Check Out | Checks out visits left in progress overnight | Off / 500 m |
| Do not Allow Visit Creation † | Hides visit creation in the app | |
| Require Visit Note For Checkout † | Requires a visit note before check-out | |
| Make Survey Selection Read Only † | Locks each task's survey to the task type's default survey | |

Other fields affect Salesforce screens only, not the app: Skip Event Creation For Visit, Hide Subject on Add Task Popup, Expand All Task Groups By Default, Do Not Override Planned End Date?, and the Summary PDF dates.

### Account Location Fields

**Account search result Configuration** (hierarchy custom setting). Besides account search results, this setting also holds these app settings.

| Field | What It Does | Default |
| - | - | - |
| Account Latitude Field API Name / Account Longitude Field API Name | Sets custom account coordinate fields for the check-in distance check and maps. If blank, the app uses the FieldKo latitude and longitude fields, then shipping coordinates, then billing coordinates. | |
| Hide Capture Geolocation action | Hides **Capture Geolocation** on accounts in the app | |

### Calendar

**Calendar Configurations** (hierarchy custom setting) controls calendar views, account cards, and account search.

| Field | What It Does | Default |
| - | - | - |
| Default View | Sets the calendar's starting view: `month`, `agendaWeek`, or `agendaDay`. Reps can override it in Settings. | |
| Scroll To Time Slot | Sets the first time shown in week and day views, as `HH:MM:SS` | |
| Account Panel Extra Info fields | Sets the account fields shown on account cards. Enter comma-separated fields. Replaces the default fields. | |
| Field API Names For Search | Sets the account fields that account search looks in | |
| Field API Name for Account Filter | Shows only accounts where this Account checkbox field is true | |
| Field API Name to Show Title | Sets the visit field shown as the visit's title on the calendar | |
| Filter Field API Name | Sets a picklist to filter accounts by, instead of Grade | |
| Hide Weekends | Hides Saturday and Sunday on the Salesforce calendar | |

### Visit Duration, Visit Types, and Visit Creation

**Visit Duration** (list custom setting, record "Default Minimum") sets the minimum visit length.

| Field | What It Does | Default |
| - | - | - |
| Duration (In Minutes) | Sets the minimum visit length. When a visit's tasks need longer, FieldKo extends its planned end. | |

**Visit Type** (custom metadata type). To set up visit types, see [Set Up Call Cycles, Tasks, and Visit Templates](/admin/call-cycles-and-visits).

| Field | What It Does | Default |
| - | - | - |
| Label | The visit type name reps see | |
| Color | The visit type's color | |
| Is Default? | Makes this the default type. Select it on one type only. | |
| Object API Name | Limits the type to visits created from one object. Leave blank for all objects. | |

**Visit Creation Configuration** (custom metadata type). Lets reps create visits from objects other than Account. See [Create Visits from Other Objects](/admin/call-cycles-and-visits#create-visits-from-other-objects). The sample Account and Opportunity records are inactive.

## Surveys

**Survey Settings** (hierarchy custom setting). You can also set these options on the **Survey** section of the [FieldKo Configuration tab](#fieldko-configuration-tab).

| Field | What It Does | Default |
| - | - | - |
| Show Instructions | Shows survey instructions to reps | |
| Allow Editing and Partial Save | Lets reps save incomplete surveys and come back to them | |
| Allow Survey Completion Without Checkin? | Lets reps complete surveys before they check in, for every survey. The survey-level checkbox of the same name does this for one survey. | |
| Hide Question Number / Show Custom Question Number | Hides question numbers, or shows each question's custom number instead | |
| Show Save And Next / Show Save And Prev / Show Completed Survey / Skip Survey | Controls survey navigation on Salesforce screens | |

On each question, you can set **Answer Not Required?**, **Include Photo on Question**, **Make Photo Required**, and **Max Answer Photos** † (up to 5). On each survey, you can set **Allow Survey Completion Without Checkin?**. See [Build Surveys](/admin/surveys).

## Orders

**Order PDF Setting** (list custom setting, record "PDF"). For the main fields, such as currency, hidden prices, and discounts, see [Order Settings](/admin/products-ordering-ranging#order-settings).

| Field | What It Does | Default |
| - | - | - |
| Default Sort Field API Name † | Sets the field products are sorted by on the order screen | |
| Total Price Field API Name † | Sets the total price field | |

**Pricebook Entries Configurations** and **Order Line Items Configurations** (list custom settings). Add extra columns to the order screen. For each record's **Name**, enter the field's API name. Find it in Setup > Object Manager.

| Field | What It Does | Default |
| - | - | - |
| Index | Sets the column's position | |
| Is\_Currency | Formats the column as currency | |
| Is Number | Formats the column as a number (price book entries only) | |
| Formula | Sets a formula for the column (order lines only) | |

**Do Show Cart On Place Order** (hierarchy custom setting) controls the cart on the order screen.

| Field | What It Does | Default |
| - | - | - |
| Show Cart | Shows the cart on the order screen | On |

## Core Ranging

**Core Ranging Configurations** (hierarchy custom setting) adjusts the ranging screen, and **Ranging Columns Configuration** (custom metadata type) sets the columns reps fill in. For their fields, see [Core Ranging](/admin/products-ordering-ranging#core-ranging).

## Sync Scope and Metadata

These settings decide which records, objects, layouts, and accounts reach the app. Each row is a separate setting.

| Setting | What It Does | Default |
| - | - | - |
| Duration of the data to be fetched (list custom setting) | Filters which records sync for each object. See [Narrow Records with Duration of the Data to Be Fetched](/admin/offline-data#narrow-records-with-duration-of-the-data-to-be-fetched). | |
| Objects To Exclude (list custom setting) | Lists objects that are never collected or synced | |
| Profiles To be Fetched / Profiles To Exclude (list custom settings) | Sets the profiles whose layouts are collected | |
| Metadata Configurations (list custom setting, record "Metadata Configuration") | **Record Type size** sets record types per metadata request. **Skip Child Objects Metadata** skips child objects. | Record Type size: 5 |
| User Hierarchy Base (list custom setting, record "Hierarchy") | Shown as **User Reporting Hierarchy** on the FieldKo Configuration tab. Setting it to `Public Group` changes how reps' accounts are chosen. See [Accounts in Scope](/admin/offline-data#accounts-in-scope). | |
| Account Record Type (hierarchy custom setting) | Sets the account record types used for visit planning | |
| Branding (list custom setting, record "Brands") | **Enabled** limits reps to accounts for their brands. The record must exist, or sync fails. See [Diagnose Rep Issues](/admin/support-diagnostics#rep-cant-sync-at-all). | |

## Page Layouts

The app uses the page layout assigned to each rep's profile and record type. To show a different layout in the app, add a **FieldKo Layout Override** (custom metadata type) record.

| Field | What It Does | Default |
| - | - | - |
| Object Name | Required. Enter the object's API name. Find it in Setup > Object Manager. | |
| Layout Name | Required. The layout name as shown in Setup, without the object prefix. For layouts that come with a package, include the package prefix that comes before the layout name. | |
| Record Type Developer Name | Limits the override to a record type | Blank applies to all record types |
| Profile Names | Limits the override to these profiles. Enter comma-separated profile names. | Blank applies to all profiles |
| Priority | Decides which override wins when overrides conflict. The lower value wins. | |
| Is Active | Turns the override on | |

An override adds a layout for those reps alongside their assigned layout. After you add overrides, re-run the [Metadata Collector](/admin/offline-data#run-the-metadata-collector). Read-only layout fields are read-only in the app.

## Objects Outside the FieldKo Packages

**Leave requests** and pack-out **Principal** and **Category** values aren't part of the FieldKo packages. If your org has a custom **Leave** object, add it to **Objects To be Fetched** with **Show In Menu** selected to give reps [leave requests](/field-work/leave-requests).

## See Also

* [FieldKo for Admins](/admin/overview)
* [Control What Syncs to the App](/admin/offline-data)
* [Set Up Call Cycles, Tasks, and Visit Templates](/admin/call-cycles-and-visits)
* [Export FieldKo Data and Photos](/admin/export-data)
* [Diagnose Rep Issues](/admin/support-diagnostics)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.