Versions Compared

Key

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

...

Code Block
languagejs
var pulsar = window.parent.pulsar;

// Go back to the previous Pulsar page
// * only relevant to pages launched from a Pulsar SObject page
// * Tab bar pages will be the "root" of that tab, so back will be ignored
pulsar.goBack();

// Go home to the schedule page
// * useful if you navigate from one custom document to another
// * safe way to exist a stack of custom navigated pages
pulsar.goHome();

// Go back to the last non-custom-document on this tab's navigation history.
// * a user can create a series of custom documents which work together and
// and then call this method to dismiss them all and return to the initial
// page in the navigation history that launched the first custom document.
pulsar.goBackToTab();

// Open another custom document
// * Important - you must specify a document Id or title. If both are null,
// this method will fail, if you want to open by title, pass null for the Id
pulsar.displayContentDocument(aDocumentId, aDocumentTitle, { "someParameter": "a value" }, function () {
  alert("Document has been displayed.");
});

// Show/Hide a Spinner that disables the Pulsar FSLSFS UI
pulsar.showSpinner();
// do some time consuming work
pulsar.hideSpinner();

// Set Page Title
// Custome pages will have an empty title unless set explicitly.
pulsar.setTitle("My Title");

// Show/Hide the Pulsar FSLSFS navigation bar
pulsar.hideNavBar();
// Your page is responsible for re-displaying the navigation bar
pulsar.showNavBar();

// Create a named handler that will execute whenever a sync finishes
// IMPORTANT: Please clean up your handler as shown below.
pulsar.addSyncFinishedHandler('myHandler', function(syncFinishedInfo) {
  console.log('Sync finished with info!', syncFinishedInfo);
  pulsar.removeSyncFinishedHandler('myHandler');
});

// Create a named handler that will execute whenever a sync update event occurs
// IMPORTANT: Please clean up your handler as shown below.
pulsar.addSyncUpdateHandler('myHandler', function(updateInfo) {
  console.log('Sync updated with info!', updateInfo);
  pulsar.removeSyncUpdateHandler('myHandler');
});

...

Code Block
languagejs
// Once you have determined the height you'd like the iFrame to conform to...
// inform Pulsar FSLSFS of that height formatted as you would CSS.
var myHeight = "800px";

window.parent.postMessage({
  "type": "refresh",
  "height": myHeight
}, "*");

// Note: sending "*" as the origin is acceptable since this will never carry sensitive data

...

 

 

Name

Customized Carousel Items

Key

pulsar.fsl.layout.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 FSLSFS.

Notes/Comments


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

FSLSFS: 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


...

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.

 

 

Name

FSLSFS: Hide Service Appointment Create Service Report Button

Key

pulsar.fsl.layout.serviceappointment.displayCreateServiceReportButton

Value

TRUE/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.

...

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

FSLSFS: Allow Service Report Creation

Key

pulsar.fsl.layout.serviceReport.allowCreate

Value

TRUE/FALSE

Default Value (if any)

TRUE

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.

Notes/Comments

None.

...

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

FSLSFS: Hide Service Appointment Create Service Report Button

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.

...

Some users may wish to use different sources for getting directions from within FSLSFS. 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 FSL SFS and replaces the “Get Directions” feature with a direct request to directions from the supplied provider.

Notes/Comments

None.

...

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

FSLSFS: 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.