Objects
This page lists objects used by FieldFX and grouped by FieldFX module. Not all the objects are for FX5 and some objects need additional licenses to use. Some objects are background objects that function as data containers and have no user interaction.
It is intended as a complete object reference for administrators, architects, and integrators.
Objects are grouped by FieldFX module for clarity. Use the A–Z index below (use Click to Expand to see the table) if you know the object name and want to jump directly to it.
Click to expand
FieldFX Base (Core Platform)
Core objects that exist regardless of which optional modules are enabled.
| Object | Object API Name | Primary Module | Description | Notes | |
|---|---|---|---|---|---|
|
FX E-Ticketing |
Stores extended metadata and sync‑related information for file attachments associated with FieldFX records, supporting mobile upload, retrieval, and audit behavior. |
|||
|
FX E-Ticketing |
Records auditable changes to FieldFX records, enabling change tracking, compliance reporting, and event‑driven notifications. |
|||
|
Core object referenced across all modules |
Represents a job or work engagement, acting as the parent record for tickets, resources, logs, planning, and invoicing workflows in FieldFX. |
|||
|
The Location is used to specify the physical location where an Asset resides in a facility or a site. Locations can be organized in a Parent/Child hierarchical relationship. |
||||
|
Core pricing control / FX E-Ticketing |
Defines a catalog of billable items and pricing used for quotes, tickets, jobs, and invoices, and serves as the foundation for advanced pricing rules in FieldFX. |
Shared across multiple workflows:
|
||
|
|||||
|
FX E-Ticketing |
Represents an individual billable item within a price book, defining pricing, sequence, and usage across quotes, tickets, jobs, invoices, and advanced pricing rules. |
Shared across all transactional workflows and drives:
|
||
|
|||||
|
FX E-Ticketing |
This object stores the master list of statuses for all entities using record types. Note that not all status attributes are applicable to all entity types |
|||
|
FX E-Ticketing |
Represents a unit of work executed under a job, capturing field activity, billable items, logs, and execution details across Back Office and Mobile workflows. |
Shared across Back Office and Mobile is central to mobile workflows, sync profiles, pricing enforcement, and invoicing readiness. Master Object(s): Job |
||
FX E‑Ticketing
FX E‑Ticketing is built around a core transactional object model (Jobs → Tickets → Items), with supporting master‑data and workflow objects. The following custom FieldFX objects are explicitly used by the FX E‑Ticketing module.
These objects make up the quote‑to‑cash execution flow.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
FX E-Ticketing (Core) |
Storage for sync (upload) errors and other similar data. |
||
|
FX E-Ticketing (Core) |
A master catalog item. |
||
Credit Memo |
|
Invoicing |
Represents credits issued to customers. |
AR workflow |
Credit Memo Item |
|
Invoicing |
Line items on a credit memo. |
Child object |
|
FX E-Ticketing (Core) / Invoicing |
Represents customer invoices. |
Billing |
|
|
FX E-Ticketing (Core) / Invoicing |
Line items on invoices. |
Master object(s): Invoice |
|
Job |
||||
|
Job Logs |
Records job‑level activity logs. |
Mobile and Back Office |
|
|
FX E-Ticketing |
Represents an estimate for work to be performed, capturing priced items and conditions that may later be converted into tickets for execution and billing. |
Quoting |
|
|
FX E-Ticketing |
Represents an individual, priced line item on a quote, capturing catalog items, quantities, and pricing that may later be converted into ticket items for execution and billing. |
Quoting |
|
|
FX E-Ticketing |
Represents an individual step within a ticket checklist, used to track required actions, completion status, and execution progress during field work. |
||
FX E-Ticketing |
Represents an individual item recorded on a ticket, capturing catalog items, quantities, pricing, and execution details used for billing, inventory updates, and reporting. |
|||
|
FX E-Ticketing |
|||
eForms
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
eForm |
|
Master Data (Back Office) |
Stores submitted electronic form records that capture structured data related to a job or ticket using FieldFX eForms. |
|
eForm Config |
|
Forms Master Data (Back Office) |
Configures legacy eForms behavior. |
Distinct from DataGuide Defines configuration settings that control how eForms are presented, sequenced, and associated with jobs or tickets in FieldFX |
|
Reporting |
Defines templates for FieldFX reports. |
Mobile and Back Office |
Dispatch & Work Orders
Objects supporting planning, dispatch, and execution outside ticketing.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
Contact Rotation |
|
Dispatch |
Supports rotational contact assignments. |
Scheduling logic |
Craft |
|
Work Orders |
Defines labor types and planned labor rates for tasks. |
Capacity planning |
|
Scheduling and Dispatch |
Groups users into dispatchable crews. |
Timeline Usage |
|
|
Schedule & Dispatch (Crew Planning) |
Represents an individual crew member assigned to a job, defining role, assignment dates, and job access for scheduling and mobile execution. |
Resource modeling |
|
|
Schedule & Dispatch (Crew Planning) |
Stores planned crew assignments and capacity. |
Newer planning object |
|
|
PM / EAM |
Defines PM route stops that generate work orders. |
Preventive maintenance (PM) |
|
|
Dispatch |
Organizes work by geographic/service regions. |
Assignment |
|
|
Scheduling |
Defines work shifts for crews and equipment. |
Planning |
|
|
Asset Management |
Represents spaces within floors/buildings. |
Asset placement |
|
|
Work Orders |
Library of predefined work tasks. |
Templates |
|
Task Labor |
|
Ticketing / |
Records labor time and effort logged against a work task for a work order, supporting execution tracking and reporting. This object also functions as a labor‑tracking child of Work Tasks, complementing Work Task and Work Task Step objects in both Back Office and Mobile workflows. |
These objects are automatically included and synced when the Work Order module is enabled in Sync Profile Manager. |
Work Order |
|
The work order is a representation of planned and actual work done to satisfy a need related to equipment such as a preventative maintenance action, a corrective maintenance action or an inspection. |
||
Work Order Item |
|
Stores individual line items associated with a work order, such as planned or used parts, services, or materials. |
||
|
Represents an individual task or step of work associated with a work order, used to plan, track, and execute work. It is explicitly referenced as a child transaction object that becomes active when the Work Order module is enabled. |
|||
|
Represents an individual step within a work task, used to break down and track execution of work at a detailed level. It is explicitly listed as a child transaction object that is automatically included and synced when the Work Order module is enabled in Sync Profile Manager. |
Inventory & Equipment
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
Job Inventory - Back Office |
Asset Groups are used to categorize individual Equipment, Bills of Materials, Standard Work Order Tasks and Model Work Orders. |
Organizes equipment into logical groups used to filter and present model work orders, bills of material, and standard work tasks during job and maintenance planning. |
|
|
Job Inventory Historical / audit object – not directly user‑managed |
Stores a historical record of stock or asset issue transactions, enabling audit and traceability of inventory usage associated with jobs and tickets. The Asset Stock Issue History object is a Junction object in Master-Detail relationship with both the Equipment and Stock Item objects. This object is populated via APEX and contains a record for each Stock Item issued to a unique Equipment. |
It is an internal / audit‑history object, not one that users interact with, configure, or report against directly. |
|
|
Inventory |
Attributes in the Noun-Modifier MRO Inventory Attribute Tracking. |
Used with Catalog Items. |
|
Bill of Materials |
|
Job Inventory |
Defines lists of repair parts associated with work orders. |
BOM Header |
BOM Item |
|
Job Inventory |
Defines catalog items included in a Bill of Material. |
BOM line |
|
Asset Management |
Represents facilities in the Building–Floor–Space hierarchy. |
Parent of Floor |
|
Catalog Item |
|
Pricing / Inventory |
Master catalog definition for billable and stock items. |
Core pricing foundation |
Catalog Item Price Book |
|
Pricing |
Tracks which price books include a catalog item. |
Pricing linkage |
Chart of Accounts |
|
Financials |
Defines accounting structures used for GL postings. |
Back‑office |
Checklist |
|
Ticketing / Work Orders |
Represents procedural checklists tied to tickets or tasks. |
Execution control |
Checklist Step |
|
Ticketing / Work Orders |
Represents procedural checklists tied to tickets or tasks. |
Execution control |
Classification |
|
Inventory |
Categorizes catalog and stock items. |
Master data |
Contact Qualification |
|
Master Data |
Stores qualifications held by contacts. |
Skills/certs |
|
Job Inventory |
Represents a physical equipment asset in FieldFX that can be planned at the job level and dispatched to tickets for operational tracking across Back Office and Mobile workflows. |
Core asset object |
|
|
Job Inventory |
This object tracks the actual equipment that is scheduled on the job. It will eventually be used to track non-job locations for equipment as well such as repair shops or inspection facilities. |
Planning & dispatch |
|
|
Job Inventory |
Defines qualification attributes and eligibility rules for equipment records, enabling FieldFX to validate whether specific equipment can be planned or dispatched for a job or ticket. |
Validation |
|
|
Asset Management |
Represents floors within buildings. |
Facility model |
|
|
Inventory |
Stores on‑hand quantities per warehouse/location. |
Stock control |
|
|
Inventory |
Records stock movements such as issue, receipt, or adjustment. |
Operational |
|
|
Job Inventory |
This object lists the records for job resources and represents a resource assigned to a job—such as equipment, materials, or bundled items—that can be tracked, grouped, and consumed on related tickets in Back Office and Mobile workflows. |
They co‑exist by design and are not interchangeable, even though the names are confusingly similar. |
|
Job Resource |
|
Job Inventory |
Represents a job-level resource record used to plan and organize materials, equipment, or bundled items that can be consumed on related tickets in Back Office and Mobile. |
They co‑exist by design and are not interchangeable, even though the names are confusingly similar. |
|
Inventory |
Stores planned material demand for work orders. |
MRP input |
|
|
Procurement |
Purchase order header for inventory and services. |
Supply chain |
Time & Labor
Objects related to labor capture and time tracking.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
Timecards |
Stores payable time entries for field users, supporting time tracking, payroll, and timesheet processing. Individual time entry. |
||
|
Timecards |
The Timesheet Object represents a set of Timecard entries for a given Pay Period. Payable timesheet (rollup) |
||
|
Timecards |
Represents an individual time entry line recorded against a timesheet, capturing work time for payroll and reporting. |
Advanced Pricing Module (APM)
Objects that define pricing rules, conditions, and actions.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
APM |
Defines the specific compliance or pricing action executed when a Field Rule is triggered, such as adding required items, prohibiting items, or overriding price or cost |
Compliance |
|
|
APM |
Stores condition logic used by Field Rules to evaluate operational data (for example, temperature, pressure, waste type, or location attributes). |
||
|
APM |
Defines pricing and compliance rules that evaluate conditions and trigger actions (required, recommended, prohibited items, or price/cost overrides) across Back Office and Mobile. |
Rule Engine |
|
|
Financials |
Captures individual GL transactions for posting |
Accounting |
|
|
APM - legacy CPQ |
Defines CPQ pricing and applicability rules used during quote and ticket creation in Back Office, controlling item selection, pricing behavior, and approval logic. |
||
|
APM - legacy CPQ |
Defines the action executed when a CPQ Rule is triggered, such as adding items, adjusting pricing, or enforcing approval behavior during quote and ticket creation in Back Office. |
||
|
APM |
Temporarily stores pricing rules and related data for dispatch and enforcement in FieldFX Mobile via sync profiles. |
For more information, see Staged Data. |
System, Sync & Internal Objects
Objects primarily visible to admins for sync, layout, and internal processing.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
Master Data (Back Office) |
The Mobile Sync Log object is used to track the logs of mobile syncs every time a mobile device syncs with Back Office. It records a summary of each FieldFX Mobile sync operation, providing administrators with visibility into sync timing, status, and overall success or failure. |
||
|
Master Sync (Back Office) |
Controls which records are assigned to users or crews for synchronization, determining the scope of data downloaded and kept in sync for FieldFX Mobile and Back Office users. |
||
|
Master Sync (Back Office) |
This controls which data the mobile client users will receive when they sync. Users will only get information related to the offices listed here. |
||
|
Master Data (Back Office) |
Records individual sync events and errors generated during FieldFX data synchronization, providing detailed diagnostics for troubleshooting and support. |
Core Salesforce Objects (Used by FieldFX)
These are Salesforce platform objects leveraged across multiple FieldFX workflows, including Jobs, Tickets, Mobile sync, and reporting. They are not specific to a single feature area but provide foundational data structures and capabilities that support FieldFX’s core functionality and integration with Salesforce. They are automatically installed with FieldFX.
| Object | Object API Name | Primary Module | Description | Notes |
|---|---|---|---|---|
|
Core |
For more information, see: Salesforce Help: Account Objects |
||
|
Core |
|||
Core |
||||
|
Core / Shared |
Stores legacy file attachments associated with FieldFX records such as jobs, tickets, and logs. |
||
ContentDocument |
|
Core / Shared |
Stores Salesforce Files (documents, images, and reports) linked to FieldFX records, supporting attachments, sharing, and mobile access across jobs, tickets, and related workflows. |
|
ContentDocumentLink |
|
Core / Shared |
Links Salesforce Files (ContentDocument records) to FieldFX records, enabling attachments, sharing, and mobile access across jobs, tickets, and related workflows. |
Files uploaded in FieldFX Mobile or Back Office rely on |
ContentNote |
|
Core / Shared |
Stores rich‑text notes that can be linked to FieldFX records, enabling users to capture comments and contextual information alongside jobs, tickets, and related workflows. |
Notes can be attached to multiple record types and are not tied to a single FieldFX module, which makes it appropriate to group it with other Core Salesforce objects used by FieldFX rather than under Ticketing, Jobs, or Pricing. |
|
Core |
Metadata registry for FieldFX custom fields. |
System |
|
|
Core |
Metadata registry for FieldFX objects. |
System |
|
|
Core |
Stores serialized configuration and system data. |
System |
|
|
Core |
Tracks deep‑copy operations for records. |
Admin tool |
|
|
Core |
Captures Apex and flow execution errors. |
System diagnostics |
|
Event |
|
Core / Shared |
Represents a scheduled activity or calendar event that can be related to FieldFX records, enabling date‑ and time‑based tracking of work, appointments, and operational activities. |
Events can be related to Jobs, Tickets, Quotes, and other records for scheduling or visibility, making them platform‑level objects rather than feature‑specific FieldFX objects. For standard Salesforce field definitions, see Event Fields - Salesforce Help |
Task |
|
Core / Shared |
Represents an actionable activity or to‑do item that can be related to FieldFX records, enabling tracking of follow‑ups, work items, and operational actions. |
For details about standard fields and behavior of the Task object, see Task Fields - Salesforce Help. |
DataGuide Objects
This is a list of the FieldFX objects used by the ServiceMax DataGuide package.
|
These objects are only usable when the ServiceMax DataGuide package is installed. They are primarily internal / admin‑driven objects rather than end‑user workflow objects. |
| Object | Object API Name | Description | Notes |
|---|---|---|---|
Application Log |
|
Records internal DataGuide processing events and messages, supporting troubleshooting and audit of DataGuide form execution. |
Custom Object |
DataGuide Form |
|
Defines a DataGuide form used to drive guided data capture and validation.Root object for a DataGuide definition; active only when the DataGuide package is installed. |
DataGuide core |
DataGuide Form Version |
|
Stores versioned definitions of a DataGuide form. Enables version control and lifecycle management of DataGuide forms. |
Lifecycle |
DataGuide Form Criteria |
|
Defines criteria that control when a DataGuide form is applicable or triggered. Used for conditional execution of DataGuide logic. |
|
DataGuide Form Expression |
|
Stores logical expressions evaluated by DataGuide rules. Supports conditional logic and rule evaluation within DataGuide. |
|
DataGuide Form Lock |
|
Controls record‑locking behavior enforced by DataGuide rules. Used to restrict edits based on DataGuide validation outcomes. |
|
DataGuide Form Data |
|
Stores data captured or evaluated by a DataGuide form. Runtime data produced during DataGuide execution. |
|
DataGuide Form Response |
|
Captures user or system responses generated by DataGuide processing.Represents evaluated outcomes or responses tied to form execution. |
|
DataGuide Report Template |
|
Defines report templates associated with DataGuide forms. Used for reporting or output formatting related to DataGuide results. |
Step-by-Step Guides
Add Notification Checkbox to the Account Object
To enable email notifications for the Email Notifications Admin Tool, a new Notification checkbox must be created and enabled for the Account object and a Notification Config field set up in the Custom Metadata Types.
-
Click on Account to open that object.
-
At the Account screen, click on Fields & Relationships.
-
Click New to add a new field.
-
For Data Type, select the Checkbox option and click Next.
-
Enter the following details and click Next:
Field Name Enter… Field Label
NotificationDefault Value
Set to either Checked or Unchecked
Field Name
Notification -
Leave the Permission sets with object permissions checkbox checked in the Establish field-level security step. You can also check the Read Access and Edit Access checkboxes.
This list includes permission sets that have Create, Read, Edit or Delete access for this field’s object. If no permission sets have that access for this field’s object, the list includes all permission sets.
-
Click Next.
-
In the Add to page layouts step, select the page layouts that should include this field. The field will be added as the last field in the first 2-column section of these page layouts. The field will not appear on any pages if you do not select a layout.
To change the location of this field on the page, you will need to customize the page layout. To change the values that appear, you will need to customize the Record Types.
-
When finished, either click Save & New to create more custom fields or Save.
Add 'ReportTemplate' Value to Type Picklist
-
In the Object Manager, find and open the Content Version object.
-
Select Fields & Relationships to open it.
Use the Quick Find box to search for the specific field. -
Find the Type field and open it.
-
Click Edit to make changes.
-
Scroll down to the Values section.
-
Click New to add a new value.
-
At the Type screen, add
ReportTemplateand click Save.Add one or more picklist values below.
-
Each value should be on its own line and it is used for both a value’s label and API name.
-
If a value matches an inactive value’s API name, that value is reactivated with its previous label.
-
If a value matches an inactive value’s label but not the API name, a new value is created.
-
-
At the list of values, click Edit next to the just added ReportTemplate value.
-
Ensure that the values in Label and API Name are correct. Select the checkbox in the Default value to make this value the default for the master picklist. In the Chart Color field, it is assigned dynamically but a custom color can be chosen by clicking the palette color icon. Click Save or Cancel if the values are correct.
-