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 REST API
Field Service Metadata API
Field Service Tooling API
Field Service Apex Reference
ConnectApi Namespace
FSL Apex Namespace
AdvancedGapMatrix Class
AdvancedGapMatrix Properties
AppointmentBookingService Class
AppointmentBookingSlot Class
GradeSlotsService Class
AppointmentInsightsResult Class
BlockingRule Class
GroupData Class
OAAS Class
OAASRequest Class
PolygonUtils Class
RecurringAppointmentsManager Class
RecurringPattern Class
RecurringSequence Class
ResourceScheduleData Class
ScheduleJobsApi Class
ScheduleResult Class
ScheduleService Class
SchedulingOption Class
TimeInterval Class
Field Service Custom Triggers
Field Service Code Examples
Field Service Mobile App
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

AdvancedGapMatrix Class

Represents a matrix of service resource IDs and graded time slots. An instance of this class is used only within the context of the results returned by the GradeSlotsService class.

Namespace

FSL

Example

For an example of how to parse the class results, see GradeSlotsService Class.

AdvancedGapMatrix Properties

AdvancedGapMatrix contains the following properties.

FSLOperationId

This field only applies to scheduling service appointments that don’t use Enhanced Scheduling and Optimization (ESO). Populated when scheduling a chain of two service appointments with scheduling dependencies, also known as complex work. An asynchronous call is made to schedule both service appointments in the chain. This property contains the FSL__FSL_Operation__c ID.

Signature

public Id FSLOperationId {get; set;}

Property Value

Type: Id

Usage

To learn more about the complex work feature, see Create Scheduling Dependencies Between Service Appointments.

partialResults

Relevant only when Limit Apex Operations is enabled in the Field Service Admin app. If the processing time of the ScheduleService is about to exceed the maximum CPU limits, it returns the results that were already calculated and halts the process. This list contains the details of the partial, processed results. All other parameters are the same.

Signature

public List<FSL.PartialResultsInfo> partialResults {get; set;}

Property Value

Type: List<FSL.PartialResultsInfo>

resourceIDToScheduleData

A map that returns service resource IDs and their corresponding available slots stored in the ResourceScheduleData class.

Signature

public Map<Id, FSL.ResourceScheduleData> resourceIDToScheduleData {get; set;}

Property Value

Type: Map<Id, FSL.ResourceScheduleData>

Service

The service appointment for which the AdvancedGapMatrix was run.

Signature

public Service {get; set;}

Property Value

Type: ServiceAppointment