FX Settings

Prerequisites

To configure FX Settings, you need the following permissions:

System permissions:
- Customize Application
- View Setup and Configuration

Basics

The FX Settings are global settings that control how select FieldFX features work.

Hierarchical Settings

You can configure FX Settings at three levels:

Level	Description
Org	Settings that apply org-wide
User Profile	Settings that apply to a user profile
User	Settings that apply to a user

Level

Description

Org

Settings that apply org-wide

User Profile

Settings that apply to a user profile

User

Settings that apply to a user

FX Settings rank one above the other in a hierarchy:

Level	Rank
Org	1
User Profile	2
User	3

The hierarchy logic checks the settings applicable to a user and applies the lowest level of settings.

If a user has applicable org-level and user-level settings, the user-level settings apply.

How it Works

Package Settings

The following custom settings are provided as part of the managed package:

FX Setting Description Recommended Setting

FX Setting	Description	Recommended Setting
AuditLogRetainingDays	Number of days after occurring that Audit Log entries get deleted automatically.	30
AuditLogTypeForTruncation	Types of Audit Log entries that get deleted automatically. Important: Never select to delete `LoggedOutWithData` or `SyncUploadError` entries automatically.	`SyncDownloadComplete`, `SyncUploadComplete`
Auto Follow Job and Ticket	Controls whether files attached to jobs and tickets in FieldFX Back Office sync to FieldFX Mobile.	Selected
AutoAddJobCreatorToCrew	Controls whether users who add jobs join the crew for those jobs automatically. IMPORTANT Only the org-wide default is honored for this setting.	Deselected
Bypass FLS and CRUD	Bypasses scheduling and dispatch field-level security so the user will be able to create, update, and delete the Job, Crew Planning, or Equipment Planning object or field without otherwise having proper permissions to do so.	Selected
CDN Builder Resource URL	URL of the JavaScript file that powers the Price Book Builder. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/pbb/LATEST`
CDN CMB Resource URL	URL of the JavaScript file that powers the Credit Memo Item Builder. IMPORTANT: Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`cmb/LATEST`
CDN FXFiles Sync Resource URL	URL of the JavaScript file that powers the File Sync. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/fxfilesListview/LATEST`
CDN Invoice Item Builder Resource URL	URL of the JavaScript file that powers the Item Builder. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`iib/LATEST`
CDN JSD Resource URL	URL of the JavaScript file that powers the Schedule & Dispatch app. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/jsd/LATEST`
CDN PacketViewer Resource URL	URL of the JavaScript file that powers the Packet Viewer in the Audit Log. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/pv/LATEST`
CDN PDF Template Editor Resource URL	URL of the JavaScript file that powers the PDF Template Editor. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/pte/LATEST`
CDN Quote Item Builder Resource URL	URL of the JavaScript file that powers the Quote Item Builder. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/qib/LATEST`
CDN Report Viewer Resource URL	URL of the JavaScript file that powers the Report Viewer for FX Reports. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/rv/LATEST`
CDN Shifts Resource URL	URL of the JavaScript file that powers the Shift Scheduling screen in the Job tab for Schedule and Dispatch. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`Shifts/LATEST`
CDN Ticket Item Builder Resource URL	URL of the JavaScript file that powers the Ticket Item Builder. IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	`prod/tib/LATEST`
CreditMemoBldr MaxFlyoutWidth	Defines the width of the Item Picker on the Credit Memo Builder page. Defaults to 80% of browser window with a minimum width of 500px.	–
CrewPlanningSkipAssignPriceBookItem	Disables the trigger that assigns a crew member’s Job Title from Catalog to new crew planning records.	Deselected
CustomEditorRenderPlaceHolder	When enabled, Custom Editor VisualForce pages list fields in the order as the Page Layout by enabling the rendering of blank spaces as place holders.	Deselected
DisableDetailPrompt	When enabled, disables the prompt in FieldFX Mobile asking users whether to add details to added quote or ticket items that do not have required fields.	Deselected
DisableEquipmentTriggerForPMS	Not in use.	–
Disable Mobile Quick Add	Enables system administrators to prevent field users from adding multiple copies of items with Quick Add when using a barcode scanner.	Deselected
EnableInventoryTracking	Activates the Inventory Tracking feature.	Selected
EquipTriggerSkipServiceHistory	Enable to not create Service History records on Equipment.	Deselected
EquipmentPlanningSkipAssignPriceBookItem	Disables the trigger that assigns an equipment record’s designated Price Book Item to new equipment planning records.	Deselected
Equipment exact match search field	Field on the Equipment object used to store equipment barcodes.	`FX5\__Barcode__c`
Force Inline Help	Objects for which to display inline help in FieldFX Mobile. Important: You must add this field manually when setting up the Inline Help feature.	`FX5__Quote__c, FX5__Job__c, FX5__Ticket__c`
Hide Jobs in Mobile	When enabled, jobs do not display in the mobile application.	Deselected
InvItemBldr PBI MaxFlyoutWidth	Controls how far across the page the Item picker displays on the Invoice Item Builder.	500
JSD Default Dashboard	Controls the dashboard that displays by default in Schedule & Dispatch.	Id of the default dashboard
Location	Name of your Salesforce org.	–
MixPanelSecurityToken	IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.	–
MixPanelStopTracking	IMPORTANT: Don’t change this URL unless directed to do so by LiquidFrameworks Support. Contact LiquidFrameworks Support for information about this setting specific to your integration user.	–
OverrideBatchSize	Number of records updated at the same time by the Override Engine. IMPORTANT Don’t change this setting unless directed to do so by LiquidFrameworks Support.	40
PacketViewer Instance URL Override	IMPORTANT Don’t change this setting unless directed to do so by LiquidFrameworks Support.	–
PBItem Bldr CatalogItem Max FlyoutWidth	Controls how far across the page the Catalog Item picker displays on the Price Book Builder.	500
PriceBookItem exact match search field	Field on the Price Book Item object used to store equipment barcodes.	–
QuoteItemBldr PBI MaxFlyoutWidth	Defines the width for the Price Book Item Picker on Quotes. Defaults to 80% of the browser window with a minimum width of 500px.	–
Skip Defaulting PriceBookItem Values	Not in use.	–
SkipCrewPlanningTriggerOnQualification	Disables the trigger that enforces qualification requirements for crew in Schedule & Dispatch.	Deselected
SkipEquipPlanningTriggerOnQualification	Disables the trigger that enforces qualification requirements for equipment in Schedule & Dispatch.	Deselected
SkipOverride	Define object(s) on which to Skip Override. Excludable objects include: `FX5__Job__c` `FX5__Ticket__c` `FX5__Ticket_Item__c` `FX5__Quote__c` `ALL`	–
SuspendRuleEngine	Suspends the FX CPQ rule engine for Back Office users only. The rule engine still runs for FX Mobile.	Deselected
Sync_ExcludedTypes	List of objects to ignore for syncing to mobile devices.	–
SyncEventKeptHistoryInDays	Number of days to retain deleted Sync Event records.	40
SyncMetadataCacheDurationMinutes	Controls how many minutes after a sync to wait before syncing metadata again.	1440
Sync Packet Size	Defines the size of packets used for mobile sync.	60
Sync v4 Config	Enable configuration options for Sync V4.	Deselected
SyncVersion	Not in use.	–
TicketItemWarehouseQty	Field on the Ticket Item object used to track the on hand quantity of warehouse items. Tip: When you update the quantity in this field, this updates the on hand quantity of the linked warehouse item.	`Qty__c`
TktItemBldr PBI MaxFlyoutWidth	Controls how far across the page the Item picker displays on the Quote Item Builder and Ticket Item Builder.	500
TurnOffJobPropagator	Disables the trigger that updates the Job lookup on tickets, ticket items, ticket logs, and ticket checklist steps with the ID of the parent job.	Deselected
TurnOffStatusHistoryTrigger	Disables the trigger that prevents you from deleting status history records.	Deselected
Use FileAPI	Enables using the Salesforce FileAPI instead of Chatter API for syncing file attachments with the mobile application.	Selected
UserTriggerKeepInactiveUserSyncConfigs	Disables the trigger that deletes a user’s sync configurations when you deactivate their user record.	Selected
UserTriggerSkipPackageLicenseCleanup	Disables the trigger that removes a user’s FieldFX licenses when you deactivate their user record.	Deselected

AuditLogRetainingDays

Number of days after occurring that Audit Log entries get deleted automatically.

AuditLogTypeForTruncation

Types of Audit Log entries that get deleted automatically.
Important: Never select to delete LoggedOutWithData or SyncUploadError entries automatically.

SyncDownloadComplete, SyncUploadComplete

Auto Follow Job and Ticket

Controls whether files attached to jobs and tickets in FieldFX Back Office sync to FieldFX Mobile.

Selected

AutoAddJobCreatorToCrew

Controls whether users who add jobs join the crew for those jobs automatically.

IMPORTANT Only the org-wide default is honored for this setting.

Deselected

Bypass FLS and CRUD

Bypasses scheduling and dispatch field-level security so the user will be able to create, update, and delete the Job, Crew Planning, or Equipment Planning object or field without otherwise having proper permissions to do so.

Selected

CDN Builder Resource URL

URL of the JavaScript file that powers the Price Book Builder.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/pbb/LATEST

CDN CMB Resource URL

URL of the JavaScript file that powers the Credit Memo Item Builder.

IMPORTANT: Don’t change this URL unless directed to do so by LiquidFrameworks Support.

cmb/LATEST

CDN FXFiles Sync Resource URL

URL of the JavaScript file that powers the File Sync.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/fxfilesListview/LATEST

CDN Invoice Item Builder Resource URL

URL of the JavaScript file that powers the Item Builder.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

iib/LATEST

CDN JSD Resource URL

URL of the JavaScript file that powers the Schedule & Dispatch app.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/jsd/LATEST

CDN PacketViewer Resource URL

URL of the JavaScript file that powers the Packet Viewer in the Audit Log.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/pv/LATEST

CDN PDF Template Editor Resource URL

URL of the JavaScript file that powers the PDF Template Editor.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/pte/LATEST

CDN Quote Item Builder Resource URL

URL of the JavaScript file that powers the Quote Item Builder.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/qib/LATEST

CDN Report Viewer Resource URL

URL of the JavaScript file that powers the Report Viewer for FX Reports.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/rv/LATEST

CDN Shifts Resource URL

URL of the JavaScript file that powers the Shift Scheduling screen in the Job tab for Schedule and Dispatch.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

Shifts/LATEST

CDN Ticket Item Builder Resource URL

URL of the JavaScript file that powers the Ticket Item Builder.

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

prod/tib/LATEST

CreditMemoBldr MaxFlyoutWidth

Defines the width of the Item Picker on the Credit Memo Builder page.
Defaults to 80% of browser window with a minimum width of 500px.

–

CrewPlanningSkipAssignPriceBookItem

Disables the trigger that assigns a crew member’s Job Title from Catalog to new crew planning records.

Deselected

CustomEditorRenderPlaceHolder

When enabled, Custom Editor VisualForce pages list fields in the order as the Page Layout by enabling the rendering of blank spaces as place holders.

Deselected

DisableDetailPrompt

When enabled, disables the prompt in FieldFX Mobile asking users whether to add details to added quote or ticket items that do not have required fields.

Deselected

DisableEquipmentTriggerForPMS

Not in use.

–

Disable Mobile Quick Add

Enables system administrators to prevent field users from adding multiple copies of items with Quick Add when using a barcode scanner.

Deselected

EnableInventoryTracking

Activates the Inventory Tracking feature.

Selected

EquipTriggerSkipServiceHistory

Enable to not create Service History records on Equipment.

Deselected

EquipmentPlanningSkipAssignPriceBookItem

Disables the trigger that assigns an equipment record’s designated Price Book Item to new equipment planning records.

Deselected

Equipment exact match search field

Field on the Equipment object used to store equipment barcodes.

FX5\__Barcode__c

Force Inline Help

Objects for which to display inline help in FieldFX Mobile.
Important: You must add this field manually when setting up the Inline Help feature.

FX5__Quote__c, FX5__Job__c, FX5__Ticket__c

Hide Jobs in Mobile

When enabled, jobs do not display in the mobile application.

Deselected

InvItemBldr PBI MaxFlyoutWidth

Controls how far across the page the Item picker displays on the Invoice Item Builder.

500

JSD Default Dashboard

Controls the dashboard that displays by default in Schedule & Dispatch.

Id of the default dashboard

Location

Name of your Salesforce org.

–

MixPanelSecurityToken

IMPORTANT Don’t change this URL unless directed to do so by LiquidFrameworks Support.

–

MixPanelStopTracking

IMPORTANT: Don’t change this URL unless directed to do so by LiquidFrameworks Support. Contact LiquidFrameworks Support for information about this setting specific to your integration user.

–

OverrideBatchSize

Number of records updated at the same time by the Override Engine.

IMPORTANT Don’t change this setting unless directed to do so by LiquidFrameworks Support.

PacketViewer Instance URL Override

IMPORTANT Don’t change this setting unless directed to do so by LiquidFrameworks Support.

–

PBItem Bldr CatalogItem Max FlyoutWidth

Controls how far across the page the Catalog Item picker displays on the Price Book Builder.

500

PriceBookItem exact match search field

Field on the Price Book Item object used to store equipment barcodes.

–

QuoteItemBldr PBI MaxFlyoutWidth

Defines the width for the Price Book Item Picker on Quotes.
Defaults to 80% of the browser window with a minimum width of 500px.

–

Skip Defaulting PriceBookItem Values

Not in use.

–

SkipCrewPlanningTriggerOnQualification

Disables the trigger that enforces qualification requirements for crew in Schedule & Dispatch.

Deselected

SkipEquipPlanningTriggerOnQualification

Disables the trigger that enforces qualification requirements for equipment in Schedule & Dispatch.

Deselected

SkipOverride

Define object(s) on which to Skip Override.

Excludable objects include:

FX5__Job__c
FX5__Ticket__c
FX5__Ticket_Item__c
FX5__Quote__c
ALL

–

SuspendRuleEngine

Suspends the FX CPQ rule engine for Back Office users only. The rule engine still runs for FX Mobile.

Deselected

Sync_ExcludedTypes

List of objects to ignore for syncing to mobile devices.

–

SyncEventKeptHistoryInDays

Number of days to retain deleted Sync Event records.

SyncMetadataCacheDurationMinutes

Controls how many minutes after a sync to wait before syncing metadata again.

1440

Sync Packet Size

Defines the size of packets used for mobile sync.

Sync v4 Config

Enable configuration options for Sync V4.

Deselected

SyncVersion

Not in use.

–

TicketItemWarehouseQty

Field on the Ticket Item object used to track the on hand quantity of warehouse items.
Tip: When you update the quantity in this field, this updates the on hand quantity of the linked warehouse item.

Qty__c

TktItemBldr PBI MaxFlyoutWidth

Controls how far across the page the Item picker displays on the Quote Item Builder and Ticket Item Builder.

500

TurnOffJobPropagator

Disables the trigger that updates the Job lookup on tickets, ticket items, ticket logs, and ticket checklist steps with the ID of the parent job.

Deselected

TurnOffStatusHistoryTrigger

Disables the trigger that prevents you from deleting status history records.

Deselected

Use FileAPI

Enables using the Salesforce FileAPI instead of Chatter API for syncing file attachments with the mobile application.

Selected

UserTriggerKeepInactiveUserSyncConfigs

Disables the trigger that deletes a user’s sync configurations when you deactivate their user record.

Selected

UserTriggerSkipPackageLicenseCleanup

Disables the trigger that removes a user’s FieldFX licenses when you deactivate their user record.

Deselected

Additional Optional Settings

The following fields can be added to Custom Settings if needed.

FX Setting	Description	Recommended Setting
pageSettings_IIB	Gives you the ability to hide components on the Invoice Item Builder. Use in combination with the optional settings listed below.	-
pageSettings_PBB	Gives you the ability to hide components on the Price Book Builder. Use in combination with the optional settings listed below.	–
pageSettings_QIB	Gives you the ability to hide components on the Quote Item Builder. Use in combination with the optional settings listed below.	–
pageSettings_TIB	Gives you the ability to hide components on the Ticket Item Builder. Use in combination with the optional settings listed below.	–
SyncInterval_Config_Minutes__c	Overrides the defaulted 24-hour interval for background sync of configuration data Important: To protect API Limits, changing this default setting is not recommended.	24 hrs
SyncInterval_Files_Minutes__c	Overrides the defaulted 120-minute interval for background sync of File API data Important: To protect API Limits, changing this default setting is not recommended.	120 minutes
SyncInterval_Fxforms_Minutes__c	Overrides the defaulted 60-minute interval for background sync of FX Form downloads Important: To protect API Limits, changing this default setting is not recommended.	60 minutes
SyncInterval_Jobs_Minutes__c	Overrides the defaulted 60-minute interval for background sync of jobs. Important: To protect API Limits, changing this default setting is not recommended.	60 minutes
SyncInterval_Lookups_Minutes__c	Overrides the defaulted 120-minute interval for background sync of lookup downloads Important: To protect API Limits, changing this default setting is not recommended.	120 minutes
SyncInterval_Pricebooks_Minutes__c	Overrides the defaulted 120-minute interval for background sync of Price Book downloads Important: To protect API Limits, changing this default setting is not recommended.	120 minutes
SyncInterval_Quotes_Minutes__c	Overrides the defaulted 60-minute interval for background sync of changes to Quotes. Important: To protect API Limits, changing this default setting is not recommended.	60 minutes
SyncInterval_Tickets_Minutes__c	Overrides the defaulted 60-minute interval for background sync of ticket downloads Important: To protect API Limits, changing this default setting is not recommended.	60 minutes

FX Setting

Description

Recommended Setting

pageSettings_IIB

Gives you the ability to hide components on the Invoice Item Builder. Use in combination with the optional settings listed below.

pageSettings_PBB

Gives you the ability to hide components on the Price Book Builder. Use in combination with the optional settings listed below.

–

pageSettings_QIB

Gives you the ability to hide components on the Quote Item Builder. Use in combination with the optional settings listed below.

–

pageSettings_TIB

Gives you the ability to hide components on the Ticket Item Builder. Use in combination with the optional settings listed below.

–

SyncInterval_Config_Minutes__c

Overrides the defaulted 24-hour interval for background sync of configuration data
Important: To protect API Limits, changing this default setting is not recommended.

24 hrs

SyncInterval_Files_Minutes__c

Overrides the defaulted 120-minute interval for background sync of File API data
Important: To protect API Limits, changing this default setting is not recommended.

120 minutes

SyncInterval_Fxforms_Minutes__c

Overrides the defaulted 60-minute interval for background sync of FX Form downloads
Important: To protect API Limits, changing this default setting is not recommended.

60 minutes

SyncInterval_Jobs_Minutes__c

Overrides the defaulted 60-minute interval for background sync of jobs.
Important: To protect API Limits, changing this default setting is not recommended.

60 minutes

SyncInterval_Lookups_Minutes__c

Overrides the defaulted 120-minute interval for background sync of lookup downloads
Important: To protect API Limits, changing this default setting is not recommended.

120 minutes

SyncInterval_Pricebooks_Minutes__c

Overrides the defaulted 120-minute interval for background sync of Price Book downloads
Important: To protect API Limits, changing this default setting is not recommended.

120 minutes

SyncInterval_Quotes_Minutes__c

Overrides the defaulted 60-minute interval for background sync of changes to Quotes.
Important: To protect API Limits, changing this default setting is not recommended.

60 minutes

SyncInterval_Tickets_Minutes__c

Overrides the defaulted 60-minute interval for background sync of ticket downloads
Important: To protect API Limits, changing this default setting is not recommended.

60 minutes

Optional Settings for pageSettings_xxx

Invoice Item Builder, Price Book Builder, Quote Item Builder, and Ticket Item Builder can be customized to hide elements that should not display.

Add the pageSettings_xxx FX Setting from the table above to FXSettings Custom Settings, then enter any combination of the options in the following table to hide various elements of the page.

Enter each option that should not display.Separate multiple options with commas.

Example 1. Hiding Item Search, Picker, Delete, and Copy

HideItemSearch, HidePicker, HideDelete, HideCopy

Setting Description

Setting	Description
`HideItemSearch`	Hide the search bar on top of the main grid.
`HideBarCodeReader`	Hide the barcode search/add control
`HidePicker`	Hide the Item Picker
`HideSelectChildren`	Hide the Select Children column on the grid
`HideHeader`	Hide the main header
`HideDelete`	Hide the Delete button
`HideCopy`	Hide the Copy button
`HideBulkEdit`	Hide the Bulk Edit button
`HideStagePricing`	Hide the Stage Pricing button
`HideSortByMostRecent`	Hide the link to sort by most recent

HideItemSearch

Hide the search bar on top of the main grid.

HideBarCodeReader

Hide the barcode search/add control

HidePicker

Hide the Item Picker

HideSelectChildren

Hide the Select Children column on the grid

HideHeader

Hide the main header

HideDelete

Hide the Delete button

HideCopy

Hide the Copy button

HideBulkEdit

Hide the Bulk Edit button

HideStagePricing

Hide the Stage Pricing button

HideSortByMostRecent

Hide the link to sort by most recent

Step-By Step Guides

Configuring FX Settings for the Org

Access FieldFX Back Office
Switch to Salesforce Classic
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
Click Manage next to FX Settings
Click Edit above the Default Organization Level Value section
Configure settings
Click Save

Creating FX Settings for a User Profile

Access FieldFX Back Office.
Switch to Salesforce Classic
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
Click Manage next to FX Settings
Click New
In Location, select Profile and then select the user profile
Configure settings
Click Save

Updating FX Settings for a User Profile

Access FieldFX Back Office
Switch to Salesforce Classic
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
Click Manage next to FX Settings
Click Edit next to the user profile
Make changes
Click Save

Creating FX Settings for a User

Access FieldFX Back Office
Switch to Salesforce Classic
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
Click Manage next to FX Settings
Click New
In Location, select "User" and then select the user
Configure settings
Click Save

Updating FX Settings for a User

Access FieldFX Back Office
Switch to Salesforce Classic
From Setup, enter "custom setting" in the Quick Find box, then select Custom Settings
Click Manage next to FX Settings
Click Edit next to the user
Make changes
Click Save