Field Service Developer Guide

Field Service Developer Guide
Get Ready to Develop with Field Service
API End-of-Life Policy
Field Service Data Objects
Field Service Core Data Model
Field Service Inventory Management Data Model
Field Service Preventive Maintenance Data Model
Field Service Product Service Campaign Data Model
Field Service Warranty Management Data Model
Field Service Pricing Data Model
Field Service Object References
Field Service Standard and Custom Objects
Field Service Custom Fields on Standard Objects
AssignedResource Custom Fields
ResourceAbsence Custom Fields
ServiceAppointment Custom Fields
ServiceResource Custom Fields
ServiceResourceCapacity Custom Fields
ServiceTerritory Custom Fields
TimeSlot Custom Fields
WorkOrder Custom Fields
WorkOrderLineItem Custom Fields
Supplementary Field Service Objects
Field Service REST API
Field Service Metadata API
Field Service Tooling API
Field Service Apex Reference
Field Service Custom Triggers
Field Service Code Examples
Field Service Mobile App
PDF

ServiceAppointment Custom Fields

Custom fields associated with an appointment to complete work for a customer in Field Service.

The standard fields are documented in the ServiceAppointment object reference.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

Field Service managed package must be installed.

Fields

FSL__Appointment_Grade__c

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The appointment grade of the scheduled appointment using the Appointment Booking feature.

FSL__Auto_Schedule__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if the appointment is created and scheduled in the same action.

    For more info, view the Schedule an Appointment Automatically Help article.

  • Default value: false

FSL__Duration_In_Minutes__c

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: The duration in minutes of the scheduled appointment. It calculates the time between the scheduled start and end times in minutes. This is a calculated field.
  • Formula: 
    1IF (ISBLANK(SchedStartTime), 0, 
2(SchedEndTime - SchedStartTime)*24*60)

FSL__Emergency__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if the Emergency Wizard global action schedules the appointment. If true, the service appointment has an emergency icon in the Field Service dispatcher console’s Gantt chart.
  • Default value: false

FSL__GanttColor__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Hex color of the service appointment in the Field Service dispatcher console’s Gantt chart and the resource calendar.

FSL__GanttIcon__c

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A custom icon for the service appointment that appears in the Gantt chart, map, and appointment list. This helps dispatchers quickly identify appointment characteristics. For example, use a custom icon to indicate that an appointment is for a VIP or first-time customer. The format is a URL ending in an image suffix, such as .png or .gif. The image is scaled to 16 x 16 pixels.

    For more info, view the Create Custom Appointment Icons Help article.

FSL__GanttLabel__c

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The label of the scheduled service appointment in the Field Service dispatcher console’s Gantt chart. This replaces the service appointment number in the chart.

FSL__Gantt_Display_Date__c

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The Gantt Display Date filter in the date field dropdown menu in the Field Service dispatcher console to control which appointments are visible in the appointment list. When a service appointment’s Gantt Display Date falls within the Gantt time frame, the appointment is visible on the Gantt. For example, if a maintenance appointment must be completed within the next six months, you can set the date so that you see it on the Gantt every day. You can set up this field to update an important appointment’s Gantt Display Date to today’s date on a daily basis.

    For more info, view the Control Which Appointments Appear in the Dispatcher Console Help article.

FSL__InJeopardyReason__c

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The reason for when the service appointment is in jeopardy. Use this field only when the FSL__InJeopardy__c status is true. You can add custom picklist values.
  • Possible values:
    • Delayed Finish
    • Delayed Start
    • Due Date Approaching
    • No Response
    • Rejected by Contractor

FSL__InJeopardy__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if a service appointment is in jeopardy. This helps dispatchers gain visibility to service appointments at risk. A user can manually set the service appointment status to In Jeopardy or this can be done automatically using, for example, process builders or triggers.
  • Default value: false

FSL__IsFillInCandidate__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if this service appointment is considered as a candidate when filling in a schedule with the Fill-In Schedule feature. If a service appointment’s parent record is a work order or work order line item, the parent record’s FSL__IsFillInCandidate__c field must also be set to true for the appointment to be a candidate. Alternatively, instead of using this field, you can create a custom checkbox field, including formula fields, to evaluate whether this appointment is considered as a candidate. This can be done through the Field Service Settings page

    For more info, view the Fill Schedule Gaps Help article.

  • Default value: true

FSL__IsMultiDay__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if this service appointment spans over multiple days. Alternatively, instead of using this field, you can create a checkbox formula field through the Field Service Settings page to evaluate whether it spans over multiple days or not.

    For more info, view the Enable Multiday Service Appointments Help article.

  • Default value: false

FSL__Pinned__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if this service appointment is pinned to the Field Service dispatcher console’s Gantt chart. Pinned service appointments can’t be manually dragged or automatically scheduled by any scheduling operation. Pinned service appointments have a lock icon in the Field Service dispatcher console’s Gantt chart.
  • Default value: false

FSL__Prevent_Geocoding_For_Chatter_Actions__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if the service appointment’s BeforeUpdate Platform Apex trigger disables the Chatter Actions’s geolocation cleanup on address change. When this field is set to true, it prevents Chatter Actions to geocode the address and waits until Field Service does it after the address changes. This field is set to false after the cleanup completes.
  • Default value: false

FSL__Schedule_Mode__c

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Unrestricted picklist, Sort, Update
  • Description: The type of the scheduling operation. For example, when not using Enhanced Scheduling and Optimization, if the service appointment is scheduled using drag and drop, the value is Manual. If the service appointment is scheduled using the Appointment Booking feature, the value is Automatic. When using Enhanced Scheduling and Optimization, if the service appointment is scheduled using drag and drop, the value is Drag and Drop. If the service appointment is scheduled using the Appointment Booking feature, the value is Schedule. This field is populated by the system. Don't edit this field.

    Additional values for each scheduling operation, available only with Enhanced Scheduling and Optimization:

    • Drag and Drop
    • Schedule
    • Global Optimization
    • In-Day Optimization
    • Resource Optimization
  • Default value: None
  • Possible values:
    • Automatic
    • Manual
    • None
    • Optimization

FSL__Schedule_over_lower_priority_appointment__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines whether you can schedule critical service appointments over lower priority appointments.

    For more info, view the Schedule Appointments Using Priorities Help article.

  • Default value: false

FSL__Scheduling_Policy_Used__c

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A scheduling policy used by the scheduler for the service appointment. If you edit this field, the policy overrides the default one on the Field Service Settings page. If this field is empty, the field populates with the policy used by the scheduler after the service appointment gets scheduled.

    This is a relationship field.

  • Relationship Name: FSL__Scheduling_Policy_Used__r
  • Relationship Type: Lookup
  • Refers To: FSL__Scheduling_Policy__c

FSL__UpdatedByOptimization__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if the service appointment is updated by the optimizer. This field is populated by the system. Don't edit this field.
  • Default value: false

FSL__Use_Async_Logic__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if the scheduling features related to the service appointment run asynchronously. If you use UI features, such as the Appointment Booking global action, the managed package takes care of this async response for you.
  • Default value: false

FSL__Virtual_Service_For_Chatter_Action__c

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Determines if the service appointment is a candidate or dummy appointment. If the value is true, the appointment is ignored by your custom triggers. This field is populated by the system. Don't edit this field.
  • Default value: false

Internal Fields

These internal fields are used by the Field Service managed package for Street Level Routing calculations. Although they’re publicly accessible, they must only be updated by the managed package.
  • FSL__InternalSLRGeolocation__Latitude__s
  • FSL__InternalSLRGeolocation__Longitude__s
  • FSL__InternalSLRGeolocation__c