Field Service Lightning Developer Guide

Field Service Lightning Developer Guide
Get Ready to Develop with Field Service Lightning
Field Service Lightning in the SOAP API
Field Service Lightning Core Data Model
Field Service Lightning Inventory Management Data Model
Field Service Lightning Preventive Maintenance Data Model
Field Service Lightning Pricing Data Model
Field Service Lightning SOAP API Objects
Supplementary Field Service Lightning Objects
Field Service Lightning in the Metadata API
Field Service Lightning in the Tooling API
Field Service Lightning in the REST API
Field Service Lightning Code Samples
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Field Service Lightning Core Data Model

Use Field Service Lightning’s core objects to complete essential field service tasks like managing work orders, defining your service territories, and tracking your workforce.

Asterisks in the following diagrams signify required fields.

Note

Work orders represent work to be completed for your customers, and are central to field service operations in Salesforce. To divide the work further for billing purposes or to track subtasks, add work order line items, which are child records of work orders.
Work Order diagram
Work orders offer a great deal of flexibility. They can be associated with many types of records, including:
  • Assets, to track work performed on a specific asset
  • Cases, to indicate that the work is being performed as part of a customer case
  • Accounts and contacts, representing the customer
  • Entitlements and service contracts, to indicate that the work is being done to fulfill a service-level agreement
While work orders describe the work to be performed, service appointments represent the visits your team makes to the field to perform the work. They include scheduling settings such as an arrival window, scheduled start and end times, and appointment duration. Every service appointment has a parent record. The parent record is typically a work order or work order line item, but you can also add child service appointments to accounts, opportunities, or assets to track related visits. A record can have multiple child service appointments; for example, a work order may have two service appointments if two visits were needed to complete the work.
Service appointment diagram
If your team often performs the same tasks for multiple customers, create work types to standardize your field service work. Work types are templates that can be applied to work orders and work order line items. On a work type, you can define the duration of the work and add skill requirements to indicate the level of expertise needed to complete the work. You can also opt to auto-create a child service appointment on any record that uses the work type.

Work orders and service appointments are supported by a variety of objects that control when and where the work occurs, the nature of the work, and who performs it.

Core diagram

Who Performs the Work

Members of your mobile workforce are represented in Salesforce as service resources. A service resource represents an individual technician who can be assigned to a service appointment. You can also create service crews, which are groups of service resources with complementary skills and experience that can be assigned to appointments as a unit.

To assign a service resource to a service appointment, create an assigned resource record. Assigned resources contain lookups to a service resource and a service appointment. To assign a service crew to an appointment, first create a representative service resource record with a resource type of Crew. Then, create an assigned resource record that looks up to the Crew service resource.

Service resources come with several objects that let you define their skills and availability:
  • Service resource skills represent a service resource’s certifications or levels of expertise.
  • Resource capacity records track the hourly or job-based capacity of contractors.
  • Resource absences represent time when a service resource needs to miss work.
  • Resource preferences designate specific service resources as preferred, required, or excluded on a work order or account.

Where the Work Occurs

Service territories are the places where your team can perform field service work and are a way to organize your service resources. They typically represent geographic territories such as cities or counties but may also represent functional divisions like sales versus service. A work order can be associated with one service territory. Service resources are assigned to one or more service territories as service territory members to indicate that they are available to work in the territory.

Territory diagram

When the Work Occurs

Operating hours indicate when your team can perform field service work. They can be assigned to accounts, service territories, and service territory members. To add detail to operating hours, create time slots, which represent the hours of operation in a particular day.

Operating hours diagram

If a customer entitlement includes terms regarding when the customer has access to field service, you can track these hours on the entitlement using the Operating Hours field (API name: SvcApptBookingWindowsId). For example, if Customer A is entitled to service Monday through Friday from 8 AM to noon, but Customer B is entitled to 24/7 service, you can create operating hours for each customer and assign them to the related entitlement.