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 Call Center, Field Service 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)
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
1// FSL.ScheduleService class2// The Schedule method returns a ScheduleResult result3FSL.ScheduleResult myResult = new FSL.ScheduleResult();45// static FSL.ScheduleResult Schedule(SCHEDULING_POLICY_ID, SERVICE_APPOINTMENT_ID)6myResult = FSL.ScheduleService.schedule(SCHEDULING_POLICY_ID,SERVICE_APPOINTMENT_ID);78System.debug(myResult);
Where SCHEDULING_POLICY_ID and SERVICE_APPOINTMENT_ID are variables.
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)
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.
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 FSL.AppointmentInsightsResult<FSL.AppointmentInsightsResult> getAppointmentInsights(Id policyId, Id serviceAppointmentId))
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.
1// FSL.ScheduleService class2// The getAppointmentInsights method returns a AppointmentInsightsResult result3FSL.AppointmentInsightsResult myresult = new FSL.AppointmentInsightsResult();45// static FSL.AppointmentInsightsResult6myresult = FSL.ScheduleService.getAppointmentInsights(Service Appointment ID,Scheduling Policy ID);78System.debug(myresult);
Schedules a service appointment to a specific service resource at a designated time. To use this method, enable Enhanced Scheduling and Optimization. Otherwise, the method fails.
Signature
global static List<FSL.ScheduleResult> scheduleHere(Datetime startDate, Id usedPolicyId, Id serviceAppointmentId, Id newResourceId)
The desired start date and time to schedule the service appointment. Use the getAppointmentCandidates results to select a time slot. The startDate value must fall within the getAppointmentCandidates scheduling horizon. The default horizon is 10 days and can be configured up to 30 days.
Returns a list of ScheduleResult objects containing the scheduled service appointment details, including the scheduled service appointment with updated start and end times, the assigned service resource, the grade or score of the scheduling option, and additional scheduling metadata.
Usage
Use this method after calling the getAppointmentCandidates method to schedule a service appointment to a specific candidate slot and resource.After the service appointment’s start time is set, the end time is calculated based on the service duration and the service resource efficiency. To prevent scheduling conflicts, the method performs resource locking and collision detection.
The method handles dependent service appointments in a complex work chain. For service appointments that are part of a complex work chain, all dependent appointments in the chain are scheduled synchronously, and the method returns a ScheduleResult for each. To schedule a chain explicitly, see scheduleExtended. If sliding and reshuffling is enabled, this method applies reshuffle logic during scheduling. A higher-priority incoming appointment can cause an existing appointment to be dropped. See reshuffle.
j