Pulsar SFS UI Customizations

Custom HTML documents enable you to create your own tabs and pages within the Pulsar SFS environment. These pages have full access to the Pulsar JSAPI bridge, enabling you to modify and display data as you see fit. You can add a custom document to the SFS tab bar, as a card that exists on a particular SFS object type, or that launches from the Lightning Bolt menu.

Showing the Quick Status Change Flow Option in Pulsar

The Quick Status Change Flow Option allows the user to change the Service Appointment status directly from the Schedule Screen, without opening the Service Appointment.

1. Log into your Salesforce org as an admin.

2. Navigate to Setup > Field Service Mobile Settings.

3. Under Quick Status Change, click the pencil icon to edit the Flow Name. Enter the name of your Quick Status Change Flow.

4. The next time the user syncs Pulsar, this option should appear on the schedule screen or in the Lightning Bolt Menu for the Service Appointment.

Open

Open

Setting the List View on the Schedule Screen (Available in Pulsar 13.0+)

The Schedule Screen will use the search layout by default. Starting in Pulsar version 13.0, you can use a different list view on the Schedule Screen.

1. Log in to your Salesforce org as an admin.

2. Navigate to Field Service Mobile Settings.

3. Select Show Details under the drop-down menu for the desired Field Service Mobile Setting.

4. Scroll down to the Service Appointment Priming section.

5. Click the pencil icon to edit the Default List View Developer Name field.

Pulsar will output debug-level log entries to help you confirm the list view developer name was correctly added to Field Service Mobile Settings. Below are the possible log entries you may see:

When no default list view is defined:

When using a valid default list view:

When using an invalid default list view:

When using a valid default list view that has no fields available:

Custom Documents on the SFS Tab Bar

Adding a custom document to the tab bar is done through the pulsar.fsl.layout.tabs Pulsar setting. The values for this setting are separated by new lines and consist of a series of entries of either reserved words for standard SFS tabs or label : documentId pairs that will link to your custom documents. Optionally, you may add URI parameters as a third item for any custom document (e.g. label : documentId : key=value&param=text). Custom Document query parameters are available as of Pulsar 15.0.

The above values would place the standard SFS schedule tab at the far left, the inventory tab to the right of that and a custom tab with the label text “Create Order” in the third location that would link to a custom document pointed at by the Id 0696A000005Yr7i. The fourth tab in Pulsar’s SFS application is always labeled More. Any items after the third will be placed in a modal pop-up that is launched when the More tab is tapped.

Custom Documents as Cards within an Object Type

Adding custom HTML as a card as part of the display of an SFS object is done through the pulsar.fsl.{objectType}.{optionalRecordTypeDeveloperName}.order Pulsar setting. When you create this Pulsar setting you are defining all of the cards that will display when viewing SFS objects that match the object type / record type pair that you define in the setting. Optionally, you may add URI parameters as a third item for any custom document (e.g. label : documentId : key=value&param=text). Custom Document query parameters are available as of Pulsar 15.0.

pulsar.fsl.layout.workorder.order

The above value for the setting would display the cards listed from top to bottom on all WorkOrder objects. This would place two custom cards containing the HTML you defined in the files pointed to by the documents listed to the right of the colons. The text to the left of the colons will appear as the title of the card.

Custom Documents on the Lightning Bolt Menu

See: Pulsar SFS Lightning Bolt Menu Customizations

Accessing the Bridge

The Pulsar Platform - JS Bridge API is fully accessible from any custom document running in the Pulsar SFS environment.

Pulsar SFS Functions

In order to allow for rich user experience, Pulsar exposes a number of SFS specific methods in addition to the bridge.

Page and Component Resizing

Documents are displayed within iFrames in the Pulsar SFS document. The size of this iFrame is based upon the size of the content. However, there are cases in which a document may have a dynamic size or one that is created after the iFrame has sized itself. In these cases, we make use of the javascript postMessage function.

Changing the Number of Details Shown Throughout Pulsar SFS

One common way that information about various SObjects is displayed in Pulsar SFS is through what we call Display Fields. These fields are defined by the compact, search and related list layouts on those objects. We define the header as the first field in the set of fields on any of those layouts. We define the details as the remaining fields, excluding the header. Generally, whenever we show a list of details we separate them with a “•” (bullet character). By default, Pulsar SFS shows up to 4 detail fields in addition to the header. If an SObject does not have a value for a given display field, it will not show the field. It is important to make sure that your header fields are required fields or your users may have a confusing UI experience.

We have created a Pulsar Setting pulsar.fsl.layout.detailFieldCount to allow the user to control how many detail fields are displayed throughout the app in situations like the one shown below. Pulsar will try to show up to 4 fields by default unless overridden by this setting. The number of fields displayed is also determined by the associated layout. The details below are driven by the related list layout between the WOLIs and their parent WorkOrder. If the related list has only 3 total fields defined, then one will be used as the header and only two detail fields could possibly be shown. Remember, if the field is undefined on the object, it will not be shown (see the bottom most set of details, which appears to not have an AssetId property defined).

To determine where a set of details or a header is coming from, refer to Pulsar SFS Screens and the data that feeds them for more information.

Customizing the SObject Page Carousel Items

In Pulsar SFS, SObject pages have a series of tabs displayed in a carousel identified to the right. Three of these elements (Overview, Details and Related) are always present but there are four optional carousel items that may or may not be displayed when available to a given SObject. The Work Plans, Location, Products and Feed tabs are displayed by default but a user can select any or none of these to display with the following Pulsar Setting pulsar.fsl.layout.carouselItems.

The values that are valid for this setting are: work-plans, location, products and feed. These are case-sensitive so be careful when adding them. You may separate them with new lines or commas. Removing the setting will show all four items if present on the object.

Certain items, like Work Plans, may not appear if there are no associated Work Plans with the object (for instance, a Work Order).

Starting with Pulsar 13.0, you may define object-level carousel items using the Pulsar Setting pulsar.fsl.layout.{objectType}.carouselItems for more granular control. For example, you can define pulsar.fsl.layout.workorderlineitem.carouselItems with different items compared to pulsar.fsl.layout.carouselItems.

Starting with Pulsar 14.0, you may define object-level carousel items to be excluded using the Pulsar Setting pulsar.fsl.layout.{objectType}.carouselItems.excludedItems.

Hiding the Assign Contact Button

The SObject overview page contact component will by default display a button to assign a Contact to the Service Appointment. Use this setting to hide the button if desired by setting the value to false.

Hiding The Map on Schedule Screen

Some customers have asked us if they can hide the map on the schedule screen because it takes a significant amount of screen real estate on phones. You can do this by specifying a Pulsar Setting in your org.

Hiding The Map on Service Appointment Overview Screen

Some customers have asked us if they can hide the map on the appointment overview screen because it takes a significant amount of screen real estate on phones. You can do this by specifying a Pulsar Setting in your org.

Hiding Get Driving Directions Button on Service Appointment Overview Screen

This setting allows users to remove the Get Driving Directions button from the Service Appointment detail component on the overview page. It is important to note that this button is displayed by default.

Displaying Resource Absences in the Schedule

It may be useful to your users to see resource absences displayed in the Field Service Lightning schedule screen in Pulsar. You can achieve this through this setting. Resource absences will not display in the scrolling calendar navigation view as “dots” (implying the presence of a Service Appointment) but they will be shown in the list of events for a selected day and on the full calendar display.

Hiding the App Browser

Overriding the Calendar Display Dates

Some users may wish to display more dates on the calendar navigation control – as well as more appointments and absences – than Salesforce field service mobile settings allows (45 days before and after).

Display Work Week Days Only on the Calendar

Some users may wish to only display the days of the work week(Monday through Friday) on the calendar. The default(FALSE) is to display the weekends.

Set the First Day of the Week on the Calendar

Some users may wish to set the first day week(Sunday or Monday) Organization-wide on the Pulsar FSL Calendar.

Displaying the Gantt Label for Resource Absences in the Schedule

If resource absences are shown in the Field Service Lightning schedule screen with the previous setting, they will display in the format of “RA: <unique RA #>”. Alternatively, you can choose to display the Gantt label in place of the RA number. You can achieve this through this setting.

Displaying a Lightning Bolt Menu on Appointments in the Schedule View

It may be useful to your users to have quick access to the Lightning Bolt Menu for a given Service Appointment directly from the schedule and not have to click into the object itself. This can be achieved via a pulsar setting.

Hiding Empty Sections in Generated Service Reports

Service report generation can be customized to hide sections which lack data. Service report sections can be customized through templates on Salesforce.com. There are three types of sections – normal, related list, and signature. Pulsar allows you to hide normal or related list sections that contain only empty values or have no rows.

Hiding the Add Resource Absence Button

The + button on the Profile page in SFS can be hidden through the following setting:

Hiding the Add Product Request Line Item Button(s)

The + button (and larger Add Product Request Line Item button) on the Product Request page in SFS can be hidden through the following setting:

Optionally Hide “Complete” Work Step

A customer may wish to hide the “Complete” Work Step choice.

Optionally Hide “Mark Not Applicable” Work Step

A customer may wish to hide the “Mark Not Applicable” Work Step choice.

Hiding Get Driving Directions from the Schedule Page

Each Service Appointment on the schedule page has a context menu with some actions. You can hide the ‘Get Driving Directions’ action through the following Pulsar setting.

Hiding Create Service Report Buttons

Static Pulsar Setting

A user may wish to hide the display of the Create Service Report button as well as the small “+” button on the service report component card. This may be useful when trying to control when users may create a service report. By hiding the buttons you can allow the user to create service reports only through a Service Report Flow.

Dynamic Pulsar Setting

The dynamic version of the setting allows an admin to use Pulsar’s PSL capability to execute custom logic to confirm business rules have been met in order to hide the display of the Create Service Report button as well as the small “+” button on the service report component.

Hiding the Service Note

A user may wish to hide service note portion of the Service Reports detail card on an objects overview page.

Applying logic before allowing the user to create a Service Report

An admin might wish to apply some rules before allowing the user to create a service report. This uses Pulsar’s PSL capability to allow the PSL logic to execute and confirm all validations have been met before letting the user proceed to the service report signature capture step.  

Hide “Mark Not Present” option in Service Report signature capture

An admin might wish to force the user to provide a signature before allowing the user to create a service report. This setting allows the admin to hide the “Mark Not Present” option in the Service Report signature block, so the user will not see this option and clicking on a signature will take them directly to the signature capture screen.

Using Your Own Google Maps API Key

Luminix provides a limited but free number of Google Maps API requests per month to all of our users. This is a single pool of requests and will frequently run out before the end of the month and disable maps for all users using the shared pool.

You should connect your own Google Maps API key so that the maps work for you and you can take control of the number of requests you will have access to.

Use a different maps provider than out of the box options.

Some users may wish to use different sources for getting directions from within SFS. This is especially useful in countries where Google and Apple maps are not supported.

Hiding Submit Button on TimeSheet Screen

A customer may wish to hide the Submit button on the Time Sheet screen because they have implemented a specific flow for it, so that it meets all the criteria. This setting will help do exactly that.

Displaying Future Time Sheets on the TimeSheet Screen

A customer may wish to add a list view to the TimeSheet screen that displays future time sheets.

Optionally Displaying a Native Detail Screen for Service Appointments

A customer may wish to display the native version of the detail screen for ServiceAppointments depending on the outcome of custom PSL written for the ServiceAppointment.

Enabling Back Navigation in Flows

Customizing Additional Display Fields in the Pricebook Products List

Determining if the User Can or Cannot View an Object using beforeView (available in Pulsar 14.0+)