---
title: "Fieldbuddy data model"
canonical: "https://help.fieldbuddy.com/space/FBDOCS/4907565057/Fieldbuddy%20data%20model"
format: markdown
---
> Macro (toc)

# Introduction

On this page, we will cover all objects that FieldBuddy uses and explain their functionality. The diagram below shows the relationship between each object and how they relate. If you click on one of the links below, there will be a separate data model for each functional area. 

### Viewing the datamodel

In any FieldBuddy-org you can go to the SETUP and search for ‘[Schema Builder](https://trailhead.salesforce.com/content/learn/modules/data_modeling/schema_builder)’. In the Schema builder you can select/deselect any object. 

Make sure to select all Custom Objects in order to view the entire FieldBuddy datamodel:

![image-20240919-144439.png](media://3797f3eb-53a9-4bf1-969c-3393e1e33421)

Since this is lots of tables and relations. It is better to make a select a few entities in which you are interested. The basics for example:

![image-20240919-144922.png](media://eeb95ec7-7920-4946-97ea-d45b592ad3a9)

## Functional area’s

> Macro (children)

# Work Order diagrams

## Work Order diagram based on a location with 1 installed product.

**One** work order for **one** location with **one** installed product.

> Macro (gliffy)

## Work Order diagram based on a location with multiple installed products.

**One** work order for **one** location with **multiple** installed products.

> Macro (gliffy)

# Functional area table

> ℹ️ Legend for the table below:
> ℹ️ 
> ℹ️ :FieldBuddy:  = Part of the core data model of FieldBuddy
> ℹ️ 
> ℹ️ :automation_icon:  = Part of an automatic process in the background, no action needed from employee. 
> ℹ️ 
> ℹ️ 📲   = Part of the briefcase that is being used by the FieldBuddy Swift (our mobile application).

| **Functional area** | **Label** | **Labels** | **Description** |
| --- | --- | --- | --- |
| Salesforce Object (CRM) | Account | :FieldBuddy: | Represents an individual account, which is an organization or person involved with your business (such as customers, competitors, and partners). |
| Swift Administration | Action | :automation_icon: 📲 | Actions are commands that are sent to FieldBuddy Mobile, FieldBuddy Swift or FieldBuddy Center for a system to execute something. Like a hard-reset. |
| Swift Administration | Configuration | :automation_icon: 📲 | A Configuration is a file in which the Mobile User Interface for FieldBuddy Swift and Briefcase is stored. |
| Swift Administration | Configuration Assignment | :automation_icon: 📲 | Link a FieldBuddy Swift Configuration to an User. Based on the assignment the user receives its Configuration. |
| Salesforce Object (CRM) | Contact | 📲  :FieldBuddy: | Represents a contact, which is a person associated with an account. |
| Contract Management | Covered Installed Product |  | Covered Installed Products are describing the the Installed Product that are covered by a Service Agreement. |
| Asset Management | Installed Product | 📲  :FieldBuddy: | An instance of a Product installed at a Location. |
| Invoice Module | Invoice |  | An Invoice for delivered services, often based on a completed Work Order. |
| Invoice Module | Invoice Configuration | :automation_icon: | Configuration of the way Invoices are created based on Invoiceable Items. |
| Invoice Module | Invoice Line |  | Lines on the Invoice. |
| Invoice Module | Invoice Line Item |  | The relation between Invoiceable Items and Invoice Lines. |
| Invoice Module | Invoice Payment |  | Invoice Payments by Account, to be assigned to Invoices. |
| Invoice Module | Invoiceable Item |  | Invoiceable Items are items that can be invoiced. Once part of the invoice, they are copied to Invoice Line Items. |
| Dispatch Panel Administration | Listing | :automation_icon: | Definition of a listing of records, including filters and columns to be displayed. A listing is displayed at the bottom of the Dispatch Panel. |
| Dispatch Panel Administration | Listing Column | :automation_icon: | Columns displayed by a Listing. |
| Dispatch Panel Administration | Listing Filter | :automation_icon: | Filters applied to a Listing. |
| Work Order Management | Location | 📲  :FieldBuddy: | Physical location of an Installed Product or Resource. Typically, an address or GPS-coordinates. |
| Swift Administration | Mobile Sync Log | :automation_icon: 📲 | For each data exchange request from Mobile a Log entry is stored. |
| Swift Administration | Mobile Sync Request | :automation_icon: 📲 | Stores the sequence of synchronization requests per user. |
| Invoice Module | Payment |  | Invoice payment. A payment done on an Invoice. |
| Asset Management | Product | :FieldBuddy: 📲 | Definition of a Product (type, manufacturer, model, etc.). |
| Resource Management | Resource |  | Human and non-human resources (technicians, equipment). |
| Resource Management | Resource Assignment |  | The appointment on a Work Order for the Resource Unit. |
| Resource Management | Resource Type |  | Type of human and non-human resources (electrician, plumber, van). |
| Resource Management | Resource Group |  | A Group of Resources, e.g. Unit West, Unit East, etc. |
| Contract Management | Service Agreement | 📲  :FieldBuddy: | An agreement(contract) with customer for describing services to install, run, maintain Installed Products or Locations. |
| Contract Management | Service Agreement Condition |  | Service Agreement Condition define default values for conditions like Service Agreement Period, Cancellation Period, Invoice Period, etc. |
| Contract Management | Service Agreement Coverage |  | Service Agreement Coverage defines in a Service Agreement the items that are covered by the Service Agreement, like Installed Products, Locations, etc. |
| Contract Management | Service Agreement Type | 📲 | A type of a Service Agreement, e.g. ‘24/7 contract’ or ‘Premium'. |
| Preventive Maintenance Module | Service Plan |  | A Service Plan describes the frequency of when Work Order should automatically be created by the system. |
| Preventive Maintenance Module | Service Plan Coverage |  | Installed Products covered by a Service Plan. |
| Preventive Maintenance Module | Service Plan Execution |  | Each time Work Orders are created automatically based on a Service Plan. A Service Plan Execution is created describing what was done. |
| Preventive Maintenance Module | Service Plan Item |  | A Service Plan Item describes which Work Order Items are automatically created with the Work Order when its generated by the system. |
| Work Order Management | Service Request | 📲  :FieldBuddy: | A request for service. This can lead to one or multiple Work Orders. |
| Technical Object | System Log | :automation_icon: | Used for logging info, warnings, errors, etc. of activities performed by the system or its end-users. |
| Time Registration Module | Timesheet | 📲 | Daily Timesheet of a User. |
| Time Registration Module | Timesheet Line Item | 📲 | Timesheet entry by a user on a Timesheet. |
| Work Order Management | Work Order | 📲  :FieldBuddy: | A description of Work that needs to be done by the technician. The central entity in FieldBuddy. |
| Work Order Management | Work Order Item | 📲 | A list of items (often articles from an external system) of the types Activities, Parts and Other Expenses. Technicians add these items to the Work Order. |
| Work Order Management | Work Order Item Detail | 📲 | Additional attributes on Work Order Items, for example a question in a checklist. |
| Work Order Management | Work Order Line Item | 📲 | An item that is added to the Work Order, for example an Activity, Part or Other Expense. |
| Work Order Management | Work Order Line Item Detail | 📲 | An filled in attribute of the Work Order Item, for example an answered question in a checklist. |
| Mobile Administration | Sync Filter | :automation_icon: | The 'Sync Filter' is the actual query that will be executed by FieldBuddy Mobile. It describes which Objects are queried by FieldBuddy Mobile during initialization and increment sync. When adding an Object you'll need multiple query's. |
| Mobile Administration | Sync Object | :automation_icon: | Sync Object records define the Objects to be synced to FieldBuddy Mobile |
| Mobile Administration | Sync Object Relationship | :automation_icon: | The Sync Object Relationship determines the relations between Models in FieldBuddy Mobile. It is the local datamodel. |
| Mobile Administration | Sync Template | :automation_icon: |  |

# Deprecated or inactive objects

These objects are currently not being used by FieldBuddy.

|  |  |  |
| --- | --- | --- |
| Capacity module | Activity Type | Type of a Planned Activity to executed by a Resource Unit |
| Capacity module | Capacity | Defining the Capacity of a Resource Unit for a certain Activity Type |
| Mobile Administration | Changeset | Changeset received from a FieldBuddy Mobile user containing a set of changed and/or new records to be processed by FieldBuddy Service Center |
| Mobile Administration | Mobile Page | Definition of a Mobile Page in FieldBuddy Mobile App |
| Mobile Administration | Field | Fields contained in a Fieldset |
| Mobile Administration | Field Action |  |
| Mobile Administration | Fieldset | A set of fields (section) on a FieldBuddy Mobile Page |
| Work Order Management | Work Order Logged Activity | Activity logged on a Work Order |
| Work Order Management | Work Order Logged Activity Detail | Additional attributes stored on a Work Order Logged Activity |
| Work Order Management | Work Order Other Expense | Other Expenses logged on a Work Order |
| Work Order Management | Work Order Other Expense Detail | Additional attributes stored on a Work Order Orther Expense |
| Work Order Management | Work Order Part | Part logged on a Work Order |
| Work Order Management | Work Order Part Detail | Additional attributes stored on a Work Order Part |
| Work Order Management | Work Order Planned Activity | Planned Activity on a Work Order |
| Dispatch Panel Administration | Timeslot | Definition of the Timeslots that divide the days in the Dispatch Panel. |
| Dispatch Panel Administration | Timeslot Instance | An Instance of a Timeslot for a particular day and Resource Unit. |
| Dispatch Panel Administration | Timeslot Instance Assignment | Relationship between Time Slot Instances and Resource Unit Assignments. |
| Resource Management | Resource Unit | A group of Resources (a team) that can be assigned to Work Orders. |
| Resource Management | Resource Unit Assignment :FieldBuddy: | The appointment on a Work Order for the Resource Unit. |
| Resource Management | Default Resource | A Resource that’s assigned by default when an Resource Unit Assignment is created on a Work Order. |
| Resource Management | Resource Unit Group | A Group of Resource Units, e.g. Unit West, Unit East, etc. |