Create Custom Actions for the Field Service Classic Dispatch Console
Put the right actions at your dispatchers’ fingertips by adding custom actions to the Classic Dispatch Console. Custom actions can either call an Apex class or open a Visualforce page, and can be run on records in several areas of the Classic Dispatch Console. To keep the Classic Dispatch Console tidy, actions are shown in dropdown action lists with icons.
Required Editions
| Available in: both Salesforce Classic (not available in all orgs) and Lightning Experience |
| The Agentforce Field Service and Operations core features, managed package, and mobile app are available in Enterprise, Unlimited, and Developer Editions. |
| User Permissions Needed | |
|---|---|
| To define, edit, delete, set security, set version settings, and run tests for Apex classes: | Author Apex |
| To create and edit Visualforce pages: | Customize Application |
| To create custom permissions: | Manage Custom Permissions |
| To add custom actions to the Classic Dispatch Console: | FSL Admin permission set |
This is a Field Service managed package feature.
You can add custom actions to several areas in the Classic Dispatch Console:
- Individual or multiple appointments in the appointment list
- Individual or multiple appointments in the Gantt
- Individual service resources or resource absences in the Gantt
- Polygons on the map (the action runs on the appointments within a polygon)
For example, create an action that does one of the following things:
- Calls an Apex class that reassigns all selected service appointments to a different service resource
- Opens a Visualforce page where the dispatcher can update the Earliest Start Permitted on all appointments within a polygon—for example, if the polygon represents a flood in the service territory
- Decide what you want your action to do and where it appears on the Gantt.
-
Create an Apex class or Visualforce page to connect to an action.
Apex classes or Visualforce pages intended for custom Classic Dispatch Console actions must be configured a certain way. For details, see Code Samples: Custom Classic Dispatch Console Actions.
Important- Including flows or Lightning web components via Lightning Out in Visualforce pages isn’t supported. See Lightning Out Considerations and Limitations.
- Using iframes in Visualforce pages isn’t recommended. It can cause Content Security Policy (CSP) violations.
- Create and assign a custom permission to limit who sees the action, or select an existing permission to use.
- From the App Launcher, find and open the Field Service Admin app. Click the Field Service Settings tab, and then click Dispatcher Console UI > Custom Actions.
- In the left-hand column, select an action category to define the location and breadth of the action.
-
Click New Action and enter your details.
- Label in Classic Dispatch Console: Enter the action label that dispatchers see in the Classic Dispatch Console.
- Action Type: Select Apex Class or Visualforce.
- Apex Class: If you selected Apex Class as the type, select the Apex class that you want the action to call.
- Visualforce Page: If you selected Visualforce as the type, select the Visualforce page that you want the action to open.
- Required Custom Permission: Select the custom permission that users must have to see the action.
- Icon: Select an icon to display next to the action label.
- Click Save.
- Optionally, reorder the actions in the action category you selected. Custom actions appear in this order in an action list after standard actions.
When you create or edit a custom action, the Gantt must be refreshed for the changes to take effect.
Did this article solve your issue?
Let us know so we can improve!
