FX Settings

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

Prerequisites

To configure FX Settings, you need the following permissions:

  • System permissions:

    • Customize Application

    • View Setup and Configuration

Hierarchical Settings

You can configure FX Settings at three levels:

Level Description Rank

Org

Settings that apply org-wide

1

User Profile

Settings that apply to a user profile

2

User

Settings that apply to a user

3

FX Settings uses this ranking in a hierarchy to check the applicable settings.

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 FX Settings Work

Package Settings

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

Click the letter to jump to that section:
A B C D E F H I J L M O P Q S T U

FX Setting Description Recommended Setting

- A -
Back to Top

AuditLogRetainingDays

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

30

AuditLogTypeForTruncation

Never select to delete LoggedOutWithData or SyncUploadError entries automatically.

Types of Audit Log entries that get deleted 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

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

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

Deselected

- B -
Back to Top

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

FX Setting

Description

Recommended Setting

- C -
Back to Top

CDN Advanced Report Resource URL

To see this custom setting, you must be using version 1.159 or later of the FX5 Managed Package.

URL of the JavaScript file that powers the Advanced Report Template Editor.

-

CDN Builder Resource URL

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

prod/pbb/LATEST

CDN FXFiles Sync Resource URL

URL of the JavaScript file that powers the File Sync.

prod/fxfilesListview/LATEST

CDN Invoice Item Builder Resource URL

URL of the JavaScript file that powers the Item Builder.

iib/LATEST

CDN JSD Resource URL

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

prod/jsd/LATEST

CDN PacketViewer Resource URL

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

prod/pv/LATEST

CDN PDF Template Editor Resource URL

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

prod/pte/LATEST

CDN Quote Item Builder Resource URL

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

prod/qib/LATEST

CDN Report Viewer Resource URL

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

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.

Shifts/LATEST

CDN Ticket Item Builder Resource URL

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

prod/tib/LATEST

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

FX Setting

Description

Recommended Setting

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

- D -
Back to Top

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

- E -
Back to Top

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

FX Setting

Description

Recommended Setting

- F -
Back to Top

Force Inline Help

You must add this field manually when setting up the Inline Help feature.

Objects for which to display inline help in FieldFX Mobile.

FX5__Quote__c, FX5__Job__c, FX5__Ticket__c

- H -
Back to Top

Hide Jobs in Mobile

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

Deselected

- I -
Back to Top

InvItemBldr PBI MaxFlyoutWidth

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

500

- J -
Back to Top

JSD Default Dashboard

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

Id of the default dashboard

- L -
Back to Top

Location

Name of your Salesforce org.

FX Setting

Description

Recommended Setting

- M -
Back to Top

MixPanelSecurityToken

Don’t change this URL unless directed to do so by support.

MixPanelStopTracking

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

- O -
Back to Top

OverrideBatchSize

Don’t change this setting unless directed to do so by support.

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

40

- P -
Back to Top

PacketViewer Instance URL Override

Don’t change this setting unless directed to do so by 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.

- Q -
Back to Top

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.

FX Setting

Description

Recommended Setting

- S -
Back to Top

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.

FX Setting

Description

Recommended Setting

- T -
Back to Top

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

The Warehouse Item record has been deprecated and is no longer supported or updated. Use the Stock Item record instead which requires a FX EAM license.

Once FX EAM is installed, follow the steps in to add stock items.

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

- U -
Back to Top

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

FX Setting

Description

Recommended Setting

Additional Optional Settings

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

Click the letter to jump to that section:
P S

FX Setting Description Recommended Setting

- P -
Back to Top

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.

- S -
Back to Top

SyncInterval_Config_Minutes__c

Overrides the defaulted 24-hour interval for background sync of configuration data

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

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

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.

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

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

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.

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

To protect API Limits, changing this default setting is not recommended.

60 minutes

Optional Settings for pageSettings_xxx

FieldFX has deprecated these items, for the same functionality, use the listed alternative.

Deprecated item Alternative
Configure the FX Item Picker Lightning Component

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

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

Access FX Settings

  1. Access FieldFX Back Office.

  2. Switch to Salesforce Classic.

  3. From Setup, enter custom setting in the Quick Find box, then select Custom Settings.

  4. In the table of Custom Settings, click Manage next to FX Settings.

    These are FX Settings that can be changed:

    FX Settings
  5. You can complete these tasks:

    For the Org For a User Profile For a User

Configure FX Settings for the Org

  1. Click Edit above the Default Organization Level Value section.

  2. Configure settings.

  3. Click Save.

Create FX Settings for a User Profile

  1. Click New.

  2. In Location, select Profile and then select the user profile.

  3. Configure settings.

  4. Click Save.

Update FX Settings for a User Profile

  1. Click Edit next to the user profile.

  2. Make changes.

  3. Click Save.

Create FX Settings for a User

  1. Click New.

  2. In Location, select "User" and then select the user.

  3. Configure settings.

  4. Click Save.

Update FX Settings for a User

  1. Click Edit next to the user.

  2. Make changes.

  3. Click Save.