Objects

Objects are tables in the FieldFX database that store records. There are standard and custom objects. You can also configure the object settings and object relationships.

Object Settings

You can configure the following for each object:

Configurable Item Info

Custom Fields & Relationships

Fields in which you can enter data in records

Lookup Filters

Filters that control the records displayed in lookups

Validation Rules

Rules that prevent you from entering invalid data in records

Page Layouts

Layouts that control the fields on Detail and Edit pages

Compact Layouts

Layouts that control the key information displayed for records

Search Layouts

Layouts that control the fields in lookups and search features

Buttons, Links, and Actions

Options you can select to do something to a record

Record Types

Different types of records you can add

Standard Objects

Standard objects are Salesforce database tables. Examples of standard objects include Account and Contact.

A

Object Object API Name Info

Account

Account

Activity

Activity

Asset

Asset

Associated Location

AssociatedLocation

Authorization Form

AuthorizationForm

Authorization
Form Consent

AuthorizationFormConsent

Authorization
Form Data Use

AuthorizationFormDataUse

B

Object Object API Name Info

Business Brand

BusinessBrand

C

Object Object API Name Info

Contact

Contact

Master Object(s): Account

P

Object Object API Name Info

Price Book

FX5__Price_Book__c
Don’t grant FieldFX users access to this object in permission sets.

U

Object Object API Name Info

User

User

Custom Fields

Custom Objects

Custom objects are FieldFX or user-defined database tables. Examples of custom objects include Job and Ticket.

Best Practice

Don’t use same or similar names for FieldFX standard objects, fields, and API Names. Using the same or similar names could cause performance issues in Salesforce platform and FieldFX.

Here are the master-detail relationships for key objects:

A | B | C | D | E | F | G | I | J | L |M | N | P | Q | R | S | T | U | W

If an API name or custom field is written as: There is no space and the full name is:

FX5__Ticket_Item_
Record_Type__c

FX5__Ticket_Item_Record_Type__c

A

Object Object API Name Info

Asset Group

FX5__AssetGroup__c

Asset Groups are used to categorize individual Equipment, Bills of Materials, Standard Work Order Tasks and Model Work Orders.

Asset Stock Issue History

FX5__AssetStockIssueHistory__c

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.

Attachment Ext

FX5__Attachment_Ext__c

Attribute

FX5__Attribut__c

Attributes in the Noun-Modifier MRO Inventory Attribute Tracking

Audit Log

FX5__Audit_Log__c

Storage for sync (upload) errors and other similar data.

Back to Custom Objects

B

Object Object API Name Info

Bill of Materials

FX5__BillOfMaterial__c

A Bill of Material is a list of Catalog Item records accessible from a work order that serves as a list of repair parts.

BOM Item

FX5__BOMItem__c

Defines the Catalog Item records for a unique Bill of Material.

Building

FX5__Building__c

The Building is the parent object in the Building, Floor, Space data model. Assets can be related to Spaces.

Back to Custom Objects

C

Object Object API Name Info

Catalog Item

FX5__Catalog_Item__c

A master catalog item.

Custom Fields

CatalogItem
PriceBook

FX5__CatalogItem
PriceBook__c

Track the Price Books where Catalog Item is used

Master Objects(s): Catalog Item and Price Book

Chart of
Accounts

FX5__CoA__c

Checklist

FX5__Checklist__c

Checklist Step

FX5__Checklist_Step__c

Master Objects(s): Checklist

Classification

FX5__Classification__c

Contact Qualification

FX5__Contact_
Qualification__c

Master Object(s): Contact and Qualification

Craft

FX5__Craft__c

The Craft is used to identify types of Labor Resources that are available to a Work Order Work Task. Each Craft can have a specific planned Labor Rate. The Work Order backlog hours can be quantified by Craft for planning & scheduling purposes.

Crew

FX5__Crew__c

The Crew object is used to organize Crew Members (Users) into a single group. The Crews are selected on the (Scheduling) Dispatch Console and the Crew Members will be populated as Resources on the Timeline.

Crew
Member

FX5__Crew_Member__c

Crew Members are a list of Users that make up the Crew. The Crew Members are displayed in the Resource listing on the Dispatch Console Timeline.

Crew Planning

FX5__Crew_Planning__c

CustomFieldInfo

FX5__CustomFieldInfo__c

CustomObjectInfo

FX5__CustomObjectInfo__c

The Credit Memo functionality in FieldFX has been deprecated. Contact your account representative for another solution.

Back to Custom Objects

D

Object Object API Name Info

Data Store

FX5__DataStore__c

Deep Copy

DeepCopyRequest__c

This object can be used for deep copying any custom sobjects, managed or unmanaged and to queue up the deep copy requests. The requests would be run sequentially by a single process and avoids locking on sobject entities, for example lock on CatalogItem at PriceBook cloning.

See FXL Deep Copy for more information.

Back to Custom Objects

E

Object Object API Name Info

eForm Config

FX5__eForm_Config__c

Equipment

FX5__Equipment__c

Custom Fields

Equipment
Planning

FX5__Equipment_Planning__c

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.

Equipment
Qualification

FX5__Equipment_Qualification__c

Error Log

FX5__ErrorLog__c

This Error Log object is used to log all the exceptions that are thrown from apex code inside the EAM managed package and to record errors encountered in managed flows.

Back to Custom Objects

F

Object Object API Name Info

Field Action

FX5__Field_
Action__c

Field Rule

FX5__Field_
Rule__c

Floor

FX5__Floor__c

The Floor is the intermediate object in the Building, Floor, Space data model. Assets can be related to Spaces.

Form

SVMXDG__DG_
Form__c

Metadata for the Advanced Forms in DataGuide.

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Criteria

SVMXDG__DG_Form_
Criteria__c

Defines fields of an object to which keywords to be applied.

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Data

SVMXDG__DG_
Form_
Data__c

Contains the raw json result of a form, either completed or still in progress.

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

(To End of Form Data Fields)

Form
Expression

DVMXDG__DG_Form_`
Expression__c

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Lock

SVMXDG__DG_
Form_Lock__c

Used to indicate that a form, where the Multiple Technicians checkbox is set to true, is claimed for edit by a user for a specific target record.

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Report
Template

SVMXDG__DG_Form_
Report_Template__c

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Response

SVMXDG__DG_Form_
Response__c

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Version

SVMXDG__DG_Form_
Version__c

This is a child of the Form object and contains the actual form definition to be used with the metadata in the Form object.

Present if ServiceMax DataGuide is installed in the org.

Custom Fields

Form Version
Tag

SVMXDG__DG_Form_
Version_Tag__c

This object acts as a junction object between the Form Version Object and Tag Object.

Only present if ServiceMax DataGuide is installed in the org.

Custom Fields

fxConfiguration

FX5__fxConfiguration__c

Stores a collection of configuration items.

fxConfigurationItem

FX5__Configuration
Item__c

G

Object Object API Name Info

GL Detail

FX5__GLDetail__c

The GL Detail is use to capture a single entry General Ledger Transaction which can subsequently be transferred to an accounting solution and posted as a journal entry.

GL Variable

FX5__GLVariable__c

The GL Variables serve to support sub ledger account segment used as a company, cost center, asset, work order, etc.

Back to Custom Objects

I

Object Object API Name Info

Inventory
Location

FX5__Inventory
Location__c

The Inventory Location Contains the On Hand Qty for an Inventory Item Record.

Inventory
Transaction

FX5__Inventory
Transaction__c

Stock Inventory Transactions. A user may enter a Gain/Shrink/Issue type transaction. Order and Receipt type transactions are entered programmatically thru APEX and should NOT be manually entered.

Custom Fields

Invoice

FX5__Invoice__c

Invoice Item

FX5__Invoice_
item__c

Master object(s): Invoice

Item Attribute

FX5__ItemAttribute__c

Contains the Catalog Item Attributes for the Catalog Item based on the selected Noun-Modifier.

Back to Custom Objects

J

Job | Job Audit | Job Log | Job Resource |

Object Object API Name Info

Job

FX5__Job__c

Job Audit

Job_Audit_
Form__c

Tracks safety compliance for each job.

Custom Fields

Job Contact

FX5__Job_
Contact__c

Job Log

FX5__Job_Log__c

This custom object is for Job Log Records.

Custom Fields

Validation Rules
(See Validation Rules)

  • Job_Ticket_Correlation

Job Resource

FX5__JobResource__c

This object lists the records for job resources.

Custom Fields

Formula Options

Custom Field Formula

On Site
Quantity
in reference to
Job Resources

 
CASE( Text(FX5__Catalog_Item__r.FX5__ffx_Item_Type__c) ,
"bulk consumables", FX5__Qty_Delivered__c - FX5__Qty_Consumed__c - FX5__Qty_To_Be_Returned - FX5__Qty_Returned__c ,
"bulk asset", FX5__Qty_Delivered__c - FX5__Qty_To_Be_Returned -  FX5__Qty_Returned__c ,
"serialized asset", FX5__Qty_Delivered__c - FX5__Qty_To_Be_Returned - FX5__Qty_Returned__c,
"serialized consumable", FX5__Qty_Delivered__c - FX5__Qty_Consumed__c - FX5__Qty_To_Be_Returned -  FX5__Qty_Returned__c,
"service", FX5__Quantity__c - FX5__Qty_Consumed__c,
"labor", FX5__Quantity__c ,
0
)

Back to Custom Objects

L

Object Object API Name Info

Location

FX5__Location__c

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.

Back to Custom Objects

M

Object Object API Name Info

Meter

FX5__Meter__c

A Meter is used to track time (hourmeter), distance (odometer), cycles (cumulative cycle counter) or usage. Meters can be used to schedule preventive maintenance.

Meter Reading

FX5__Meter
Reading__c

Meter Readings are used to record time (hours), distance (odometer readings) or usage (cycle counts) for a Meter on a specific Date/Time.

Mobile Sync Log

FX5__Mobile_
Sync_Log__c

The Mobile Sync Log object is used to track the logs of mobile syncs every time a mobile device syncs with Back Office.

Custom Fields

Modifier

FX5__Modifier__c

Modifier Object in Noun-Modifier MRO Inventory Attribute Tracking

Back to Custom Objects

N

Object Object API Name Info

Notification
History

FX5__Notification
History__c

Back to Custom Objects

O

Object Object API Name Info

Override

FX5__Override__c

Override
Config

FX5__Override_
Config__c

Back to Custom Objects

P

Payment | Payment Applied | Planned Stock | Price Book Item | PM Group Detail | PM Route | PM Schedule | PO Misc Cost |
PO Misc Cost Receipt | PO Stock Item | PM Criterion (Deprecated) | Price Book | Price Book Assignment | Price Book Item |
Price Book Item Service Type | Purchase Order | Price Book Item Service Type

Object Object API Name Info

Payment

FX5__Payment__c

Payment
Applied

FX5__Payment_
Applied__c

Planned
Stock

FX5__Planned
Stock__c

The Planned Stock record is used to record the Planned Qty of a Stock Item for a Work Order. This record (Open Commit Qty) is used as demand input for parts commitments (reservations). Also used to record Planned Inventory Cost vs. Actual Inventory Cost.

PM Group
Detail

FX5__PMGroup
Detail__c

PM Group Detail specifies the PM schedule to run for any given Monthly Interval e.g, every month, quarter or annual etc. This object stores information as to when the PM Schedule on an Asset is due next, current Work Order etc.

PM Route

FX5__PMRoute__c

PM Routes are used to organize PM Route Stops which are comprised of an Equipment and a Standard Work Task. The PM Route contains calendar based scheduling logic to create and release Route & Route Stop Work Orders in a Parent/Child relationship.

PM Schedule

FX5__PMSchedule__c

Preventive Maintenance Schedules are used to schedule & release Work Orders using a Model Work Order as a template and a predefined Calendar or Meter Interval.

PO Misc Cost

FX5__POMiscCost__c

Purchase Order Miscellaneous Cost Line - Represents all lines that are not linked to Stock Item inventory

PO Misc Cost
Receipt

FX5__POMisc
CostReceipt__c

PO Misc Cost Receipts are recorded to recognize the receipt of a Service / Non-stock Part. A PO Misc Cost Receipt will automatically record a Work Order (WO) Misc Cost Receipt if the PO Misc Cost record is linked to a WO Misc Cost record.

PO Stock
Item

FX5__POStockItem__c

Purchase Order Lines for Stock Item Inventory

Preventative
Maintenance
Criterion
Deprecated

FX5__Preventative_Maintenance_Criterion__c

Custom

Price Book

FX5__Price_Book__c
Grant FieldFX users access to this object in permission sets.

Custom Fields

Back to P objects index

Price Book
Assignment

FX5__Price_Book_Assignment__c

Price Book
Item

FX5__Price_Book_Item__c

Custom Fields

Price Book
Item Service
Type

FX5__Price_Book_Item_Service_Type__c

Master Object(s): Service Type

Purchase Order

FX5__PurchaseOrder__c

Purchase Order Header

Back to P
Back to Custom Objects

Q

Object Object API Name Info

Qualification

FX5__Qualification__c

Qualification
Requirement

FX5__Qualification_Requirement__c

Master Object(s): Qualification

Quote

FX5__Quote__c

New Fields

  • Projected End Date (FX5__eProjected_End_Date__c)

  • Projected Start Date (FX5__eProjected_Start_Date__c)

Quote Item

FX5__Quote_Item__c

Back to Custom Objects

R

Object Object API Name Info

Report Template

FX5__Report_Template__c

This object describes a template for various reports, primarily for Mobile users.

Rotation

FX5__Rotation__c

Route Stop

FX5__RouteStop__c

PM Route Stops contain an Asset and a Standard Work Task. A Route Stop Work Order will be created for each Route Stop and will the child of the Route Work Order generated for the parent PM Route.

Rule

FX5__Price_Book_Rule__c

This object contains the criteria used to apply actions in the CPQ module.

Master Object(s): Price Book

Rule Action

FX5__Price_Book_Rule_Action__c

These actions are triggered by the criteria on the Rule object for the CPQ module.

Master Object(s): Rule

Back to Custom Objects

S

Object

Object API Name

Info

Service History

FX5__Service_History__c

Master Object(s): Equipment

Service Region

FX5__Service_Region__c

The Service Region is referenced on the Equipment/Asset and the Work Order. It is used to organize work for assignment.

Service Type

FX5__Service_Type__c

Shift

FX5__Shift__c

Space

FX5__Space__c

The Space is the child object in the Building, Floor, Space data model. Assets can be related to Spaces.

Staged Data

FX5__Staged_Data__c

For more information, see Staged Data.

Standard
Work Task

FX5__StdWork_Task__c

Standard Work Tasks serve as a Library of predefined Work Tasks which may be selected and applied to a Work Order. The Work Task Description, Planned Hours and Instructions are copied.

Standard
Work Task
Step

FX5__StdWork_TaskStep__c

The Standard Work Task Steps are used as checklist items on a Work Task.

Status

FX5__Status__c

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

Custom Fields

Status History

FX5__Status_History__c

Status Workflow

FX5__Status_Workflow__c

Stock Item

FX5__StockItem__c

The Stock Item object contains a lookup to the Catalog Item (catalog master) and the Warehouse (warehouse) and is where all of the inventory stocking policies for a specific Item in a specific Warehouse are managed; i.e. min stock qty, on hand qty, bin locations, preferred vendor, costs, etc.

Sync Assignment

FX5__Sync_Assignment__c

User’s Syncable Jobs.

Sync Configuration

FX5__Sync_Configuration__c

This controls which data the mobile client users will receive when they sync. Users will only get information related to the offices listed here.

Sync Event

FX5__Sync_Event__c

Back to Custom Objects

T

Object Object API Name Info

Task Labor

FX5__TaskLabor__c

The Task Labor object contains the Actual Labor Entries recorded against a Work Order Task.

Ticket

FX5__Ticket__c

Master Object(s): Job

Ticket
Checklist
Step

FX5__Ticket_Checklist_Step__c

Ticket Item

FX5__Ticket_Item__c
You can use an optional CheckArchivedItemOnNew Lookup filter. See Lookup Filter Builder on how to build a lookup filter.
This lookup filter is optional but the filtering logic is enforced on the validation rule only when creating a new record on this object

Custom Fields

Ticket Log

FX5__Ticket_Log__c

Time Off

FX5__TimeOff__c

Timecard

FX5__Timecard__c

Timesheet

FX5__Timesheet2__c

The Timesheet Object represents a set of Timecard entries for a given Pay Period.

Transfer Order

FX5__TransOrder__c

The Transfer Order is used to support inter-Warehouse sourcing for Stock Items.

Transfer Order
Line

FX5__TransferOrderLine__c

The Transfer Order Line represents a single Stock Item on a Transfer Order.

Transfer Order
Transaction

FX5__Transfer_OrderTransaction__c

The Transfer Order Transaction object represents the fulfillment or receipt of Stock Items on a Transfer Order Line.

Back to Custom Objects

U

Object Object API Name Info

UNSPSC Class

FX5__UNSPSCClass__c

The UNSPSC is a four-level hierarchical classification system; Segment - Family - Class - Commodity used to categorize goods and services.

For more information, see UNSPSC Taxonomy.

UNSPSC Commodity

FX5__UNSPSCCommodity__c

UNSPSC Family

FX5__UNSPSCFamily__c

UNSPSC Segment

FX5__UNSPSCSegment__c

UOM

FX5_UOM__c

Custom Fields

Back to Custom Objects

W

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.
Object Object API Name Info

Warehouse

FX5__Warehouse__c

Warehouse Item
(Deprecated)

FX5__Warehouse_Item__c

Well

FX5__Well__c

WO Misc Cost

FX5__WOMiscCost__c

Work Order (WO) Miscellaneous Costs are used to record charges against a work order that are NOT labor derived from time entry (i.e. Task Labor records) or issued parts (Actual Costs on WO Parts).

WO Misc Cost Receipt

FX5__WOMiscCost
Receipt__c

Work Order Misc Cost Receipts are recorded to recognize the receipt of an expense item/charge to a Work Order. This receipt record can be automatically recorded from a Purchase Order if the PO Misc Cost Line is linked to the WO Misc Cost.

Work Assignment

FX5_WorkAssign
ment__c

The Work Assignment object is used to represent which users are assigned which Work Tasks, and optionally when they are to scheduled to perform the work.

Work Order

FX5__WorkOrder__c

The Work Order is the top level work document and is where costs are accumulated. A Model Work Order serves as a job template used in Preventive Maintenance Scheduling.

Work Order
(Deprecated)

FX5__Work_Order__c

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 (Deprecated)

FX5__Work_Order_
Item__c

Work Order
Qualification
(Deprecated)

FX5__Work_Order_
Qualification__c

Work Order
Task (Deprecated)

FX5__Work_Order_
Task__c

Back to Custom Objects

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.

  1. Access Setup and use the Quick Find to search for Object.

  2. Select Object Manager.

  3. Click on Account to open that object.

  4. At the Account screen, click on Fields & Relationships.

  5. Click New to add a new field.

  6. For Data Type, select the Checkbox option and click Next.

  7. Enter the following details and click Next:

    Field Name Enter…​

    Field Label

    Notification

    Default Value

    Set to either Checked or Unchecked

    Field Name

    Notification

  8. 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.

  9. Click Next.

  10. 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.

  11. When finished, either click Save & New to create more custom fields or Save.

Create a New Custom Object for FX Forms and eForms

FX Forms eForms

Parent

Click here.

Click here.

Child

Click here.

Click here.

Recommended Reading

FieldFX Documentation Salesforce Documentation

  • n/a