Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

 

 

Name

Customized Carousel Items

Key

pulsar.fsl.layout{.objectType}.carouselItems

Value

A list of valid values separated by commas or new lines. Valid strings are:

work-plans
location
products
feed

Default Value (if any)

work-plans
location
products
feed

Description

Use this setting to customize the set of carousel items on an SObject page in SFS.

Notes/Comments

...

Providing specific object type for this setting is available in 13.0+

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.

 

 

Name

SFS: Show Assign Contact Button

Key

pulsar.fsl.layout.showAssignContactButton

Value

TRUE/FALSE

Default Value (if any)

TRUE

Description

Use this option to display/hide the assign contact button.

Notes/Comments


Hiding The Map on

...

Schedule Screen

Some customers have asked us if they can hide the map on the appointment overview 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.

 

 

Name

Hide Map Component on Schedule Screen

Key

pulsar.fsl.layout.

serviceappointment

schedule.displayMap

Value

TRUE/FALSE

Default Value (if any)

TRUE

Description

Use this option to display/hide the map component on the

overview

schedule screen.

Notes/Comments

Users can still get Driving Directions by clicking on the button in the section.

...

Hiding The Map 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 defaultSome 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.

 

 

Name

Hide

Get Directions

Map Component

Key

pulsar.fsl.layout.serviceappointment.

displayDrivingDirectionsButton

displayMap

Value

TRUE/FALSE

Default Value (if any)

TRUE

Description

Use this option to display/hide the

get driving directions button

 

 

Name

Display Resource Absences

map component on the overview screen.

Notes/Comments

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.

Users can still get Driving Directions by clicking on the button in the section.

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.

 

 

Name

Hide Get Directions Component

Key

pulsar.fsl.layout.

schedule

serviceappointment.

showResourceAbsences

displayDrivingDirectionsButton

Value

TRUE/FALSE

Default Value (if any)

FALSE

TRUE

Description

Use this option to display

resource absences

/hide the get driving directions button on the

schedule view

overview screen.

Notes/Comments

None.

Hiding the App Browser

...

 

...

 

...

Name

...

Display App Browser

...

Key

...

pulsar.home.toolbar.enableappbrowser

...

Value

...

TRUE/FALSE

...

Default Value (if any)

...

TRUe


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.

 

 

Name

Display Resource Absences

Key

pulsar.fsl.layout.schedule.showResourceAbsences

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Use this option to display

or hide the 9 squares icon

resource absences on the

bottom toolbar

schedule view.

Notes/Comments

None.

Overriding the Calendar Display Dates

...

Hiding the App Browser

 

 

Name

Display App Browser

Key

pulsar.home.toolbar.enableappbrowser

Value

TRUE/FALSE

Default Value (if any)

TRUE

Description

Use this option to display or hide the 9 squares icon on the bottom toolbar

Notes/Comments

None.

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).

 

 

Name

SFS Schedule - Number of Days Before
or
SFS Schedule - Number of Days after

Key

pulsar.fsl.schedule.numDaysBefore
or
pulsar.fsl.schedule.numDaysAfter

Value

a number of days

Default Value (if any)

Will use the value in SFS mobile settings

Description

Controls the number of days to display in the calendar navigation component before and after the current date.

Notes/Comments

None.

Displaying the Gantt Label for Resource Absences in the Schedule

...

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.

 

 

Name

Show Gantt Label for Resource Absences

Display Work Week Days Only

Key

pulsar.fsl.

layout

calendar.

schedule.showGanttLabelForResourceAbsences

enableworkweekonly

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Use this option to display the Gantt label on resource absences in the schedule view

Controls if the calendar only displays the days of the work week (Monday through Friday).

Notes/Comments

None.

Displaying a Lightning Bolt Menu on Appointments in the Schedule View

...

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.

 

 

Name

Display Lightning Menu on Schedule Items

Set the First Day of the Week

Key

pulsar.fsl.

layout

calendar.

schedule.showLightningButton

firstdayofweek

Value

TRUE/FALSE

0 or 1 (Sunday == 0, Monday == 1)

Default Value (if any)

FALSE

0 (Sunday)

Description

Use this option to display a lightning menu button on each service appointment in the list of appointments on the schedule page

 

 

Name

Hide Empty Service Report Sections

Key

pulsar.fsl.layout.serviceReport.hideEmptySections

Sets the first day of the week organization-wide.

Notes/Comments

None.

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.

If set, any user locale will be overridden by this setting so all users have the same first day of the week.

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.

 

 

Name

Show Gantt Label for Resource Absences

Key

pulsar.fsl.layout.schedule.showGanttLabelForResourceAbsences

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Hides a standard service report section if all data fields that would be displayed contain no values during service report generation

Use this option to display the Gantt label on resource absences in the schedule view.

Notes/Comments

None.

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.

 

 

Name

Hide Empty Service Report Related Lists

Display Lightning Menu on Schedule Items

Key

pulsar.fsl.layout.

serviceReport

schedule.

hideEmptyRelatedLists

showLightningButton

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Hides service report related list sections that have no rows of data during service report generation

Use this option to display a lightning menu button on each service appointment in the list of appointments on the schedule page.

Notes/Comments

None.

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.

 

 

Name

Hide

Add Resource Absence

Empty Service Report Sections

Key

pulsar.fsl.layout.

profile

serviceReport.

hideAddResourceAbsence

hideEmptySections

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Hides

the add resource button on the profile page of SFS

a standard service report section if all data fields that would be displayed contain no values during service report generation.

Notes/Comments

None.

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:

 

 

Name

Hide

Add Product Request Line Item Button

Empty Service Report Related Lists

Key

pulsar.fsl.layout.

productRequest

serviceReport.

hideAddProductRequestLineItem

hideEmptyRelatedLists

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Hides

the add Product Request Line Item button on the profile page of SFS

service report related list sections that have no rows of data during service report generation.

Notes/Comments

None.

Optionally Hide “Complete” Work Step

...

Hiding the Add Resource Absence Button

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

 

 

Name

Display “Complete” Work Step

Hide Add Resource Absence

Key

pulsar.fsl.layout.

WorkStep

profile.

displayCompleteStep

hideAddResourceAbsence

Value

TRUE

or

/FALSE

Default Value (if any)

TRUE

FALSE

Description

Notes

Hides the add resource button on the profile page of SFS.

Notes/Comments

Available in 13

None.

0+

Optionally Hide “Mark Not Applicable” Work Step

...

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:

 

 

Name

Display “Mark Not Applicable” Work Step

Hide Add Product Request Line Item Button

Key

pulsar.fsl.layout.

WorkStep

productRequest.

displayMarkNotApplicableStep

hideAddProductRequestLineItem

Value

TRUE

or

/FALSE

Default Value (if any)

TRUE

FALSE

Description

Hides the add Product Request Line Item button on the profile page of SFS.

Notes/Comments

Available in 13

None.

0+

Hiding Get Driving Directions from the Schedule Page

...

Optionally Hide “Complete” Work Step

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

 

 

Name

SFS: Hide Schedule Page Directions

Display “Complete” Work Step

Key

pulsar.fsl.layout.

schedule

WorkStep.

hideDirections

displayCompleteStep

Value

TRUE

/

or FALSE

Default Value (if any)

FALSE

TRUE

Description

Hides the Get Driving Directions option from Service Appointment item context menus on the SFS Schedule page.

Notes/Comments

None

Available in 13.

Hiding Create Service Report Buttons

Static Pulsar Setting

...

0+

Optionally Hide “Mark Not Applicable” Work Step

A customer 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.“Mark Not Applicable” Work Step choice.

 

 

Name

SFS: Hide Service Appointment Create Service Report Button

Display “Mark Not Applicable” Work Step

Key

pulsar.fsl.layout.

serviceappointment

WorkStep.

displayCreateServiceReportButton

displayMarkNotApplicableStep

Value

TRUE

/

or FALSE

Default Value (if any)

TRUE

Description

Hides the “Create Service Report” and + button on a Service Appointment Service Report detail component card.

Notes/Comments

None

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.

 

 

Name

SFS: Dynamically Hiding Service Appointment Create Service Report Button

Notes/Comments

Available in 13.0+

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.

 

 

Name

SFS: Hide Schedule Page Directions

Key

  • pulsar.fsl.layout.

serviceappointment
  • schedule.

displayCreateServiceReportButton.dynamic
-or-
pulsar.fsl.layout.workorder.displayCreateServiceReportButton.dynamic
-or-
pulsar.fsl.layout.workorderlineitem.displayCreateServiceReportButton.dynamic

Value

PSL logic with SetResult action returning TRUE or FALSE.
  • hideDirections

Value

TRUE/FALSE

Default Value (if any)

n/a

FALSE

Description

Executes the PSL logic in order to hide the “Create Service Report” and + button on a Service Appointment Service Report detail component card

Hides the Get Driving Directions option from Service Appointment item context menus on the SFS Schedule page.

Notes/Comments

Available in 13.0+.

This dynamic setting will take precedence over the static setting.

...

None.

Hiding Create Service Report Buttons

Static Pulsar Setting

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

...

 

...

 

...

Name

...

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.

 

 

Name

SFS: Hide Service Appointment Create Service Report Button

Key

pulsar.fsl.layout.

serviceReport

serviceappointment.

hideServiceNote

displayCreateServiceReportButton

Value

TRUE/FALSE

Default Value (if any)

FALSE

TRUE

Description

Hides the

Service Note section of the

“Create Service Report” and + button on a Service Appointment Service Report detail component card.

Notes/Comments

None

.

Applying logic before allowing the user to create a Service Report

...

Dynamic Pulsar Setting

The dynamic version of the setting allows an admin to use Pulsar’s PSL capability to allow the PSL execute custom logic to execute and confirm all validations business rules have been met before letting the user proceed to in order to hide the display of the Create Service Report button as well as the small “+” button on the service report signature capture stepcomponent.  

 

 

Name

SFS:

Allow

Dynamically Hiding Service Appointment Create Service Report

Creation

Button

Key

pulsar.fsl.layout

.serviceReport.beforeCreate

Value

TRUE/FALSE

.serviceappointment.displayCreateServiceReportButton.dynamic
-or-
pulsar.fsl.layout.workorder.displayCreateServiceReportButton.dynamic
-or-
pulsar.fsl.layout.workorderlineitem.displayCreateServiceReportButton.dynamic

Value

PSL logic with SetResult action returning TRUE or FALSE.

Default Value (if any)

TRUE

n/a

Description

Executes the PSL logic

before the service report shows. Otherwise, an alert window will show the error message to the user why they are not allowed to create a service report yet

in order to hide the “Create Service Report” and + button on a Service Appointment Service Report detail component card.

Notes/Comments

None.

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.

...

Available in 13.0+.

This dynamic setting will take precedence over the static setting.

Hiding the Service Note

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

 

 

Name

SFS:

Using Google Maps KeyKey

Hide Service Note on the Service Report Detail Card

Key

pulsar.fsl.layout.

googleMapsAPIKey

serviceReport.hideServiceNote

Value

A string value for the Google Maps API key

TRUE/FALSE

Default Value (if any)

The default will resolve to the Luminix API key which has a limited number of uses and may stop working for you at any time.

Description

Enables you to control the access to Google Maps API. This is a paid feature that Luminix offers for free on a very limited basis. If you have many users, you will want to configure your app to use your own key.

Notes/Comments

None.

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

...

FALSE

Description

Hides the Service Note section of the Service Report detail component card.

Notes/Comments

None.

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.  

 

 

Name

Maps Provider - Bing

SFS: Allow Service Report Creation

Key

pulsar.fsl.layout.serviceReport.

mapsProviderDefault

beforeCreate

Value

Domain components of map API providers like: “maps.google.com” and “bing.com” and “cn.bing.com”. Others are not supported at this time.

TRUE/FALSE

Default Value (if any)

TRUE

Description

Disables all map UI components in SFS and replaces the “Get Directions” feature with a direct request to directions from the supplied provider.

Notes/Comments

None.

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.

 

 

Name

SFS: Hide Submit Button for Time Sheets

Executes the PSL logic before the service report shows. Otherwise, an alert window will show the error message to the user why they are not allowed to create a service report yet.

Notes/Comments

None.

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.

 

 

Name

SFS: Using Google Maps Key

Key

pulsar.fsl.googleMapsAPIKey

Value

A string value for the Google Maps API key

Default Value (if any)

The default will resolve to the Luminix API key which has a limited number of uses and may stop working for you at any time.

Description

Enables you to control the access to Google Maps API. This is a paid feature that Luminix offers for free on a very limited basis. If you have many users, you will want to configure your app to use your own key.

Notes/Comments

None.

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.

 

 

Name

Maps Provider - Bing

Key

pulsar.fsl.layout.mapsProvider

Value

Domain components of map API providers like: “maps.google.com” and “bing.com” and “cn.bing.com”. Others are not supported at this time.

Default Value (if any)

Description

Disables all map UI components in SFS and replaces the “Get Directions” feature with a direct request to directions from the supplied provider.

Notes/Comments

None.

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.

 

 

Name

SFS: Hide Submit Button for Time Sheets

Key

pulsar.fsl.layout.timesheets.displaysubmitbutton

Value

TRUE/FALSE

Default Value (if any)

TRUE

Description

Hides the “Submit” button on the Time Sheet page.

Notes/Comments

None.

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.

 

 

Name

SFS: Display Future Time Sheets

Key

pulsar.fsl.layout.timesheets.displayFutureTimeSheets

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Displays an option to show up to 100 Future Time Sheets from after today’s date.

Notes/Comments

None.

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.

 

 

Name

SFS: Native Display Choice

Key

pulsar.fsl.layout.timesheets.

displaysubmitbutton

displayFutureTimeSheets

Value

PSL that returns TRUE

/

or FALSE via SetResult

Default Value (if

any)

TRUE

Description

Hides the “Submit” button on the Time Sheet page

any)

No PSL will execute, resulting in the FSL detail page being shown.

Description

When the provided PSL evaluates to TRUE, the user will see a Native Detail Screen compared to an FSL detail screen.

Notes/Comments

None.

Displaying Future Time Sheets on the TimeSheet Screen

...

Enabling Back Navigation in Flows

 

 

Name

SFS:

Display Future Time Sheets

Enable Back Button in Flows

Key

pulsar.fsl.

layout.timesheets.displayFutureTimeSheets

enableFlowBackButton

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

Displays an option to show up to 100 Future Time Sheets from after today’s date

When set to TRUE, the Pulsar will enable display of the Back button where appropriate in a properly configured SFS Mobile Flow.

Notes/Comments

None.

Optionally Displaying a Native Detail Screen for Service Appointments

...

For more information about SFS Mobile Flow behavior, see this documentation: Considerations for Using Flows in the Field Service Mobile App (salesforce.com)

NOTE:

  • Salesforce data changes that occur before displaying a screen are committed to the database and will not be rolled back when the Back button is clicked.

  • Flows retain variable values after they’re entered. Clicking the Back button in a flow doesn’t clear the value.

Customizing Additional Display Fields in the Pricebook Products List

 

 

Name

SFS:

Native Display Choice

Fields to Display in Pricebook Products List

Key

pulsar.fsl.

layout

pricebookentry.

timesheets.displayFutureTimeSheets

displayfields

Value

PSL that returns TRUE or FALSE via SetResult

Default Value (if any)

No PSL will execute, resulting in the FSL detail page being shown.

Description

When the provided PSL evaluates to TRUE, the user will see a Native Detail Screen compared to an FSL detail screen.

Notes/Comments

None.

...

Comma or newline separated list of fields from the PricebookEntry object

Default Value (if any)

Description

The Pricebook product list, by default, will show only the product name in the list. Specifying additional PricebookEntry fields in this setting will display these fields under the Product Name line and separated by the “•” (bullet character).

Here is an example where this setting was specified with these fields: ProductCode, UnitPrice

Image Added

Notes/Comments

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

 

 

Name

SFS: Enable Back Button in Flows

Before View

Key

pulsar.

fsl.enableFlowBackButton

Value

TRUE/FALSE

Default Value (if any)

FALSE

Description

When set to TRUE, the Pulsar will enable display of the Back button where appropriate in a properly configured SFS Mobile Flow.

Notes/Comments

For more information about SFS Mobile Flow behavior, see this documentation: Considerations for Using Flows in the Field Service Mobile App (salesforce.com)

NOTE:

  • Salesforce data changes that occur before displaying a screen are committed to the database and will not be rolled back when the Back button is clicked.

Flows retain variable values after they’re entered. Clicking the Back button in a flow doesn’t clear the value.

beforeView.<Object API Name> (e.g. pulsar.beforeView.ServiceAppointment)

Value

This setting executes when a user tries to view a record. PSL can be used to implement business rule validations to determine if the current user can or cannot view an object

Code Block
languagejs
DEFAULT{ 
Action=SetResult;
Result=Service Appointment viewing access denied.;
ResultValid=false;
}

Default Value (if any)

Description

image-20240805-123627.pngImage Added

Notes/Comments