Customize the template for bookings

Applies to: Dynamics 365 Field Service

This article explains how to configure the schedule board in Dynamics 365 Field Service to show additional information on the scheduled booking of a bookable resource. The bookings are shown on the schedule board based on booking templates. This article describes how to modify the booking template to show an icon that indicates the type of work that the booking is for, based on logic captured at the work order level. With this information, the dispatchers or users who are looking at the schedule board can quickly see the type of work that the bookings represent based on a visual indicator icon.

Prerequisites

In Dynamics 365 Field Service, frontline workers are one type of bookable resources. Equipment and facilities are other types of bookable resources. Learn more at Set up bookable resources. To apply the template to bookings in your solution, you must first do the following:

  • Prepare the environment.

    Set up the data in an attribute on the bookable resource booking. Alternatively, use a system entity record related to the booking entity that supports the method you choose for displaying the image or icon on the schedule board.

  • Obtain a working knowledge of HTML for editing the booking template.

Use case

A dispatcher might have to manage the workloads of many resources at a time. The schedule board provides text-based information for each booking to keep the scheduler informed, but depending on the layout this information might be too long to display, especially in a compact layout. A graphic or icon representation can serve as a quick visual indicator for the dispatcher.

For example, a dispatcher wants to identify the type of work already booked to a frontline worker. Maybe they prefer to not book a lot of the same work type for any frontline worker in one day to make sure they have sufficient spare parts available.

This information can be retrieved from the work order itself, either from standard attributes such as the associated primary incident type, or from a custom attribute, which would provide more flexibility in terms of naming.

Sample code

Select an attribute or a custom attribute on the bookable resource booking, or on a system entity with a relationship to the booking entity that you use to drive the logic for your visual indicator.

Note

Only the use of attribute values from system entities is supported.

Tip

If you're using a custom attribute, it might not show on the schedule board after you apply the template changes. Refresh the schedule board, and the attribute should show up.

You can use HTML and CSS styling for formatting or adding color or conditional values. Learn more at Advanced booking template styling using CSS.

For this example, we use the name of the primary incident on the work order related to the booking. The name of the incident type matches the name of an icon from Font Awesome. As an alternative, you can use a custom attribute field to hold the Font Awesome character so that the name of the incident type can remain more descriptive and reference that field instead of the primary incident from this sample.

Edit the booking template

  1. In the schedule board, navigate to scheduler settings, choose the link to open All board settings, expand the Schedule Types section, and then select the entity that you want to change the booking template for.

    For the example code in the next step, the entity is Work Order. The edits to the booking template apply only to the schedule board tab that the settings were opened from.

  2. Toggle the Custom Booking Template field to On, and then add the following snippet to the HTML code:

    <i class="fa fa-{msdyn_msdyn_workorder_bookableresourcebooking_WorkOrder.msdyn_primaryincidenttype}"></i>
    
  3. Save your changes.

The following screenshot shows the fire icon populated from an incident type using the provided snippet and adding color styling. In this screenshot, a fire extinguisher icon was added directly from the web resource to show the different types of changes to the styling.

Screenshot of the Field Service app, focusing on a work order.

Tip

Custom HTML is sanitized automatically, so unsupported code might get stripped out. You can receive an error message if your customization results in sanitization. Update the code to remove any unsupported code, and then save again.