FXL Data Grid v2 Configurable Fields

The FXL Data Grid v2 is a lightning component that can be used on these objects:

  • Catalog Items

  • Price Book Items

  • Quote Items

  • Ticket Items

  • Invoice Items

You can configure these fields to make the Data Grid appear differently depending on where you use it.

To use the FieldFX Lightning package starting with version 1.225, you must use the FieldFX Managed Package version 1.529 or higher.

To find the version numbers you have installed, see Check Version Number for FieldFX Managed Package and FieldFX Lightning Managed Package.

Attribute Categories

Required

This attribute is required.

Optional

Optional

You do not need to enter any values in these attributes in order for the grid to be operational. In many cases, you do not need to ever enter values in these attributes. These attributes focus on cosmetic aspects of the grid, rather than functional aspects.

Optional but recommended

Optional, but recommended

You do not need to enter any values in these attributes in order for the grid to be operational. However, the grid may not work as expected unless you enter values for these attributes. These attributes are focused on functional behavior of the grid.

Optional Performance Related

Optional - Performance Related

You do not need to enter any values in these attributes in order for the grid to be operational. The attributes listed here relate to the performance of the grid. In many cases, you will never need to enter any values here. If you are working with very large data sets, or very wide, or very complex datasets then you may need to experiment with different settings.

Configurable Fields Table

These fields are arranged in alphabetical order. Click the letter to jump to that section.

A | B | D | E | G | I | L | N | O | R | S

- A -

Settings Description Category
(See Attribute Categories above)

Action Button settings
(JSON String)

Enter the JSON String for additional buttons to appear on the grid.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional but recommended

Allow Users to
wildcard searches checkbox

Select to allow users to use % and _ when doing wildcard searches.

Api Name of the Parent Column

Enter the API Name for the Parent Column.

This attribute identifies the field in that controls the parent-child relationship.

Example 1. Example of use
For Use this API Name

Ticket Items

FX5__Parent_Ticket_Item__c

Quote Items

FX5__Parent_Quote_Item__c

If there is no an entry in this attribute, the grid won’t show any parent-child relationships, even if they are defined in the data. This is normal functionality.

If this grid is used on an object that does contain parent-child relationships, this field should be considered required!

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

API Field Name
for setting item order

Enter the API Field Name for setting the item order. Don’t put anything in to deactivate.

Api Name of the Item
Requires a Parent Column

Enter the API Name of the Item that requires a Parent Column.

This attribute identifies the field that indicates an item is required to have a parent and cannot be a stand-alone item. This attribute is intended to support objects that use Price Book Items. You should leave this field blank on unrelated objects.

Example 2. Example of use
For Use this API Name

Ticket Items

FX5__PBI_Requires_Parent_Item__c

Quote Items

FX5__PBI_Requires_Parent_Item__c

If you are showing Accounts, then this attribute would not be appropriate.

Example 3. Example of CPQ use

This attribute is mainly intended to support CPQ. When the rule engine adds a required item it will mark the item as required in this field. By adding the field name to this attribute, then the grid will not allow the user to delete this required item. If this attribute is not set, then the user will be able to delete the item from the grid, but Salesforce will reject the change and it will generate an error for the user.

For API Name

Ticket Items

FX5__Rule_Required_Item__c

Quote Items

FX5__Rule_Required_Item__c

If you are showing Accounts, then this attribute would not be appropriate.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional but recommended

Api Name of the Item
is Required Column

Enter the API Name of an item for the Required Column.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional but recommended

Api Name of the
isArchived Column

Enter the API Name of a column marked isArchived.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional but recommended

Back to Index

- B -

Settings Description Category
(See Attribute Categories above)

Bypass Page
Level Permissions checkbox

Select to bypass the page level permissions based on the page layout(s).

Back to Index

- D -

Settings Description Category
(See Attribute Categories above)

Disable multi-select
and use single section
checkbox

Select to not enable multiple items to be selected at once and only allow one item to be selected at a time.

Optional

Disabled Grid Features

Enter the name of the feature to disable.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Display link
view record checkbox

Select to display an icon next to each record so the user can navigate to the record when they click the record name.

Optional

Back to Index

- E -

Settings Description Category
(See Attribute Categories above)

Editing refreshes page
checkbox

Select so when a change is made, the page is automatically refreshed.

Enable Drag
and Drop BundleMaker
checkbox

Select to enable the drag and drop FXL Bundle Maker.

Expand Children
by default checkbox

Select to automatically show child records when a parent record is selected.

When this attribute is selected, then the grid will display all children when the grid loads. If this option is not selected, then only the parents will be visible until the user clicks the icon to display children.

Optional

Back to Index

- G -

Settings Description Category
(See Attribute Categories above)

Grid Heading

Use this setting to define the heading for the grid element. You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Grid Title

Enter the title for the grid. If the field is empty, the item’s object label is used. You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Back to Index

- I -

Settings Description Category
(See Attribute Categories above)

Initial Sort Direction

Use ASC (Ascending) or DESC (Descending) to set how the records are sorted.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional

Initial Sort Column

Enter the API name of the column that will be used to initially sort.

The API name of the column to use for sorting the first time the grid is displayed.

The grid remembers the user’s last sort preference. This value determines the initial view of the page.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional

Back to Index

- L -

Settings Description Category
(See Attribute Categories above)

Level Three
Information

Enter the names for:

  • Column Label

  • API Field Name for Cell Content

  • API Field Name for parent/child relationship

  • callable class for third level items

  • action string used by callable (optional).

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Back to Index

- N -

Settings Description Category
(See Attribute Categories above)

Number of sticky columns

Enter the number of columns that stick to the left of the screen. This number excludes the section column which is always sticky.

Optional

Number of Rows in Page

Enter the number of rows for a server side request. The request from the server in a single call.

Keep this number small to increase performance for most objects. Given the variability in the number and types of columns, it may be necessary to experiment with different values to optimize performance.

  • When retrieving objects with a very small number of columns but a large number of rows, performance may improve with a very large value in this field.

  • When retrieving a very large number of columns, performance may improve by using smaller numbers for this attribute.

Optional Performance Related

Number of Pages in Buffer

Enter the number of pages to be held in memory for past pages being viewed. This is the number of pages held in memory. In general, increasing this value will increase performance. However, holding too much in memory will eventually use all available memory and performance will degrade quickly.

Optional Performance Related

Back to Index

- O -

Settings Description Category
(See Attribute Categories above)

Object fields

Enter the comma-separated API Names of fields to appear in the grid.

The grid will not be useful without something entered in this field. The field names should be separated by a comma. Do not end the list of fields with a comma.

Example 4. Adding Ticket Items to a Ticket

If you are adding Ticket Items to a Ticket, you might use the following list of fields:

Name,FX5Price_Book_Itemc,FX5Standby_Pricec,FX5Pricec

If the grid does not display the expected results, verify this list is correct.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Required

Back to Index

- R -

Settings Description Category
(See Attribute Categories above)

Read-Only
checkbox

Select to make the entire grid and non-editable.

This attribute forces the grid to always be in read-only mode regardless of permissions, status, or any other attribute.

Optional

Read only fields
(API Names)

Enter the read only fields that are API Names.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Related Object Lookup

Enter the API Name of a lookup field for the object that relates to the current record page.

Example 5. Use of the Related Object Lookup in Tickets

This field should have the API name of the object (FX5__Ticket__c) so that the grid is constrained to show only ticket items for the current ticket. If you leave this field blank, then the grid would show all ticket items for all tickets.

  • For the Lookup to properly filter results, Remote Site Settings must be defined.

  • If a connection to the remote site is not defined, an error results when the Lookup is called.

  • Add the domain (not the entire URL) listed in the error message to the Remote Site Settings to resolve the error.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Required

Remember selected items
after refresh checkbox

Select so when the screen is refreshed, previously selected items are still selected.

When selected, items marked as selected in the grid remain selected after the grid reloads, such as taking an action on the selected items.

Use this when generating an invoice from selected tickets.

Resource Server (Unused)

Resource Uri (Unused)

Back to Index

- S -

Settings Description Category
(See Attribute Categories above)

Salesforce Object

Enter the name of the API Name of the Salesforce Object to pull the correct data from.

Table 1. FieldFX API Names
For API Name

Ticket Items

FX5__Ticket_Item__c

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Required

SOQL filter for determining
which records to show.

Enter a SOQL filter to determine which records to show.

Any user viewing this must have read access to all fields to the filter.

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Optional

Scanning Information

Enter the names for:

  • Column Label

  • API Field Name for Scancode

  • Column Index

  • callable class for Scancode search

  • action string used by callable (optional).

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Set Component Visibility
Drop down

For more information, see

Back to Index

- U -

Settings Description Category
(See Attribute Categories above)

Unique Id

Use this field to display the current user settings that are saved.

The grid needs a unique name so that it can communicate correctly with other Lightning components.

You can enter anything in this field, as long as it is unique.

Example Unique acceptable values such as:
“Ticket Item Grid”, "George", and "FDG-1234"

You can use an expression to define its custom label.

The correct format is {!$Label.customLabelName}.

Required

Back to Index

Recommended Reading