FXL Components Overview

Introduction

FieldFX Lightning (FXL) Components are available through the FieldFX Lightning Managed Package, You can use the FXL Components in FieldFX Back Office when using Lightning Experience.

You must enable Salesforce My Domain prior to setting up, configuring, or using FXL Components.

Or you can configure custom labels for the Lightning Component.

Getting Started

The set up and configuration of FXL Components is done through using the Salesforce Lightning AppBuilder.

For FXL Components to work properly, you must be add them to a FieldFX record page. For correct configuration of FXL Components, you must obtain the API name of objects as part of the set up process. On first setup of an FXL Component on a page, activate the configuration of the page as Org default.

Starting with version 1.180 of the FX Lightning Package, you will need at least version 1.458 or later of the FX5 Managed Package. Using version 1.180 of the FX Lightning Package without the updated FX5 Managed Package causes the install and use of FX Lightning to fail.

Check FX5 Managed Package and FX Lightning Managed Package Versions

  1. Log into your org.

  2. In Salesforce Classic, click Setup.

  3. In the Quick Find box, type installed and select Installed Packages.

  4. In the table of installed packages,

    1. Find FieldFX Lightning in the Package Name column and then note the version number in the Version Number column.

    2. Find FieldFX Base Package in the Package Name column and then note the version number in the Version Number column.

  5. If the versions isn’t 1.458 for FX5 Managed Package and you are trying to install version 1.180 of the FX Lightning Managed Package, contact support.

Adding a FXL Component to a FieldFX Page

  1. Access FieldFX Back Office.

  2. Switch to Lightning Experience.

  3. From the page, click the gear icon and select Edit Page to access the Lightning AppBuilder.

    Highlighting the Edit Page link from the menu
  4. From the list of available Custom or Custom Managed Lightning Components, drag the FXL Component to where you want it on the record page.

    Example of dragging FXL Data Grid to the page
  5. Click Save.

Getting an API Name From the Object Manager

  1. Access Setup in a new browser tab or window.

  2. You can find the API Name from a Salesforce object or from an object field:

    1. Obtain the API name of a Salesforce object.

      • In the Quick Find box, enter object manager and select it.

      • In the Object Manager, select the object that you need the API Name for.

      • Access the Details tab of the object.

      • Copy the API name from the API Name field.

        Where to find the API Name for an object
    2. Or you can get the API name of an object field.

      • Access the Fields & Relationships tab.

      • Find the desired object.

      • Copy the API name of the field from the FIELD NAME column.

        Where to find the API name for a field
  3. Switch back to the original tab or window.

  4. Paste the API name into the applicable field.

Activating the Page Configuration as Org Default

  1. Click Activation.

    Activation button
  2. Click Assign as Org Default.

    Activation page’s Assign as Org Default button
  3. Click Save.

    Set as Org Default page’s Save button

Working with Records in Lightning

Each record in the FieldFX Lightning Managed Package currently has a Details and Related tab.

Each editable field in a record has field-level help defined, which you can access by hovering your mouse over the i icon.

Example of field level help
Figure 1. Example of field level help

For records in the FieldFX Lightning Managed Package, you can edit record details and add related items.

Editing Record Details

  1. From the Details tab of the record, click Edit.

    A Job record’s Edit button
  2. Update the details of the record.

  3. Click Save.

    An Edit Job window’s Save button
  1. From the Related tab, click New for the related item you want to add to the record.

    Reloaded tab’s New buttons
  2. Select the record type for the item if asked to and click Next.

    New record’s Record Type Save button
  3. Complete the details for the record.

  4. Click Save.

    New record’s Save button