ScheduleService Class

Represents the scheduling of a given service appointment in the best available slot based on the applied scheduling policy.

Namespace

FSL

Usage

This class calls the scheduling engine and schedules the given service appointment in the highest-scoring available slot.

When using Enhanced Scheduling and Optimization, calling this API triggers a callout to the Enhanced Scheduling and Optimization service to retrieve results. When not using Enhanced Scheduling and Optimization, you can make a callout to obtain required travel times when:
  • SLR or point-to-point predictive travel is the selected routing, and
  • Results aren’t stored in the local cache
We recommend that you avoid performing any DML in the same Apex transaction before calling this API.

When scheduling a service appointment, the user scheduling the appointment must have one of four managed package permission sets: Field Service Admin, Field Service Dispatcher, Field Service Agent, Self-Service. If you’re using platform events to schedule appointments, you must explicitly configure the user so that the user has the correct permissions. Without the proper configuration, the platform event runs as the Automated Process system user and doesn’t have the correct permissions to schedule an appointment. To learn more, see Configure the User and Batch Size for Your Platform Event Trigger.

Note

ScheduleService Methods

ScheduleService includes the following static methods.

schedule(policy, serviceId)

Returns FSL.ScheduleResult with the result of the scheduling process.

Signature

public static FSL.ScheduleResult schedule(Id policy, Id serviceId)

Parameters

policy
Type: Id
The record ID of the scheduling policy being used to schedule the service appointment.
serviceId
Type: Id
The record ID of the service appointment being scheduled.

Return Value

Type: FSL.ScheduleResult

Usage

This method schedules the service appointment in the best available slot. If there are no available slots, the appointment isn’t scheduled. This method can be called with only one service appointment at a time. To schedule multiple service appointments, use an Apex batch class. Call this method in batches of one.

If you are using the schedule method with the appointment booking method, perform a time zone conversion. The results of appointment booking are returned in the time zone specified in the method signature. Convert these values back to UTC.

Example

// FSL.ScheduleService class
// The Schedule method returns a ScheduleResult result
FSL.ScheduleResult myResult = new FSL.ScheduleResult();

// static FSL.ScheduleResult Schedule(Scheduling Policy ID, Service Appointment ID)
myResult = FSL.ScheduleService.schedule(Scheduling Policy ID,Service Appointment ID);

System.debug(myResult);

scheduleExtended(policy, serviceId)

Returns List<FSL.ScheduleResult> with the result of the scheduling process for appointments in a complex work chain.

Signature

public static List<FSL.ScheduleResult> scheduleExtended(Id policy, Id serviceId)

Parameters

policy
Type: Id
The record ID of the scheduling policy that’s used to schedule the service appointment.
serviceId
Type: Id
The record ID of a service appointment in a complex work chain of service appointments being scheduled.

Return Value

Type: List<FSL.ScheduleResult>

Usage

Use this method to schedule two service appointments in a complex work chain. This method respects the complex work setting Use all-or-none scheduling for related appointments. If there are no available slots, appointments in the complex work chain aren’t scheduled.

The scheduleExtended method is valid for a chain of two appointments; if the appointment in serviceId has dependencies with more than one other appointment, scheduling results can be different than expected.

This method can be called with only one service appointment at a time, and runs asynchronously. To examine results that the asynchronous method returns, use the streaming API and subscribe to MstCompletedChannel, the channel for the Field Service managed package.

If Enhanced Scheduling and Optimization (ESO) is enabled:

  • The method runs synchronously.
  • The method always uses the ESO behavior, which is all-or-none for related appointments scheduling of complex work.
  • The method is valid for a chain of up to five to appointments.

If you’re using the scheduleExtended method with the appointment booking method, perform a time zone conversion. The results of appointment booking are returned in the time zone specified in the method signature. Convert these values back to UTC.

getAppointmentInsights

Returns an AppointmentInsightsResult class with details about why a service appointment can’t be scheduled on the Gantt, including blocking rules, blocked slots, and resource availability.

Signature

public static List<FSL.AppointmentInsightsResult> getAppointmentInsights(Id policyId, Id serviceAppointmentId))

Parameters

serviceAppointmentId
Type: Id
The ID of the appointment for which insights are being requested.
policyId
Type: Id
The ID of the policy under which the appointment is evaluated.

Example

The following code sample uses the getAppointmentInsights method to return an AppointmentInsightsResult class that provides details about a specific service appointment that can’t be scheduled on the Gantt.


// FSL.ScheduleService class
// The getAppointmentInsights method returns a AppointmentInsightsResult result
FSL.AppointmentInsightsResult myresult = new FSL.AppointmentInsightsResult();

// static FSL.AppointmentInsightsResult 
myresult = FSL.ScheduleService.getAppointmentInsights(Scheduling Policy ID,Service Appointment ID);

System.debug(myresult);