FSM Notification Record

A Field Service Notification represents one email request in Field Service Management (FSM). It identifies the source record and the configured email definition, retains the request identifier and timestamp, and records the associated sent Message when available.

The Notification is an FSM custom record. It is separate from the source record's Pending Notifications field, the email definition, and the native NetSuite Message. Creating a Notification records a request. It doesn't establish that an email has been rendered, sent, or delivered.

Record Information

Use the record and field IDs to distinguish the stored data from account-specific labels and FSM service attributes.

Property

Value

Record type

FSM custom record

Supplied record name

Field Service Notification

Record ID used for NetSuite records and searches

customrecord_nx_notification

Record identity

NetSuite Internal ID (internalid), mapped by FSM as id

FSM service schema

Notification. The service name is not a separate NetSuite record type.

The record's Internal ID identifies this Notification. Record Id identifies its source record. Message Id identifies a native Message when processing has linked one. These IDs represent different objects.

Record Relationships

FSM holds the source identity and Message identity as text on the Notification. They are not native List/Record fields or parent-child relationships.

Related record or data

Relationship and field ID

Purpose

Case, CRM Task, Project Task, or Employee

The Notification stores Record Type (custrecord_nx_notification_record_type) and Record Id (custrecord_nx_notification_record_id). The processing families use supportcase, task, projecttask, and employee, respectively.

Identifies the source for the requested email. Several Notifications can refer to the same source record.

Email definition

The Notification stores the definition name in Email (custrecord_nx_notification_email). Its Record Type determines the corresponding configuration family.

Selects a named definition from notification.caseEmail, notification.taskEmail, notification.projectTaskEmail, or notification.employeeEmail. This is a configuration reference, not a relationship to an Email record.

Message

The Notification stores Message Id (custrecord_nx_notification_message_id) as text. A Message internal ID other than 0 identifies a native NetSuite Message (message).

Connects the request to evidence of sending. A value of 0 means that the source record no longer exists. See Processing Indicators and Error Context for details.

Source Pending Notifications

The source Case, CRM Task, or Project Task stores custevent_nx_notification_pending. Employee uses custentity_nx_notification_pending.

Holds requests before they have corresponding Notification records. These fields are on the source records, not the Notification.

Field Service Error

Error records (customrecord_nx_error) can hold processing deployment, Action Type, and Action Payload context. There is no dedicated Error reference field on the Notification.

Supplies separate failure information when an operation reports an error. Error context must be interpreted for the affected action.

For example, a Notification with Record Type task, Record Id 123, and Email servicereport requests notification.taskEmail.servicereport for CRM Task 123. It doesn't select the Case definition with the same name or store the recipient address.

The Message's own record associations are separate from the Notification's source identity. Standard CRM Task service-report emails associate the Message with the linked Case and contact when supplied. Project Task emails associate it with the Project. A Notification referring to a CRM Task doesn't establish a direct Message association with that CRM Task. See Associating Messages with Records.

FSM Fields

The following labels are the supplied English labels. Accounts can change labels and presentation, so use field IDs to identify the underlying data. FSM attribute names are mapping aliases, not additional stored fields.

Field

Field ID

FSM attribute

Purpose and important values

Record Type

custrecord_nx_notification_record_type

recordtype

Text identifying the source record type. Interpret together with Record Id.

Record Id

custrecord_nx_notification_record_id

recordid

Source record's internal ID, stored as text. It is not the Notification's own ID.

Email

custrecord_nx_notification_email

email

Name of the requested email definition, such as servicereport or the Employee mobilelogin definition. It is not a recipient email address.

Idempotency Key

custrecord_nx_notification_key

key

Identifier used to recognize the same request and find its sent Message. Separate requests for the same source can have different keys. It is not the source record's business identifier.

Requested

custrecord_nx_notification_requested

requested

Request timestamp stored as Date/Time with time zone. The supplied record definition defaults it to the current time (NOW). It is not a scheduled send time, completion time, or delivery timestamp.

Message Id

custrecord_nx_notification_message_id

messageid

Text identifying the associated Message, or the special value 0 when the source record no longer exists. FSM notification processing maintains it.

Inactive (standard)

isinactive

inactive

Native custom-record inactivity flag. It is separate from the Message Id processing indicator. Don't use the flag as evidence that a request was sent or canceled.

Processing Indicators and Error Context

Message Id supplies a processing indicator, rather than a general business status or script execution status.

Message Id value

Meaning

Empty

The request has no linked Message and can be selected for email processing. It may be awaiting processing or have outstanding failure conditions. An empty value doesn't prove that no email was sent: sending and Message linking are separate steps.

A Message internal ID other than 0

FSM has linked a sent Message for the request. The Message may have been found during the duplicate check for the same request, so the latest execution may not have sent another email. The link doesn't establish receipt or reading.

0

FSM found that the source Case, CRM Task, Project Task, or Employee no longer exists. Processing records this value without sending that source's notification, so the request is no longer selected as unlinked work. 0 is not a sent Message.

The Notification has no separate fields for running status, send time, delivery status, recipients, attachments, or error messages. Requested and Message Id don't provide this information.

The source record's pending field can be cleared after Notification records are created for its requests, even before the emails are sent. A cleared source field and a completed script execution therefore don't establish that every request was sent. See Processing Model and Lifecycle for request processing, duplicate checks, and failure effects. For separately captured failure data, see FSM Error Record. For execution monitoring, see FSM Script Reference.

Creation and Update Sources

These sources create or maintain Notification data. Report generation and requesting an email are separate operations.

Source

Effect on the record

Notification background processing

Creates a Notification for a new request held on a source record, retaining the source type, source ID, email definition name, and request key.

Service-report actions and configured automatic rules

Add requests to the applicable service record's Pending Notifications field. Background processing creates the corresponding Notifications. A report preview alone doesn't create a sending request.

Employee Email Mobile Login action

Creates or reuses a Notification request through the FSM notification service for the Employee mobilelogin definition.

FSM notification service

Its creation path can reuse a Notification with the same request key rather than create another. This request identity is distinct from the Notification's saved Internal ID.

Email processing

Resolves the current email definition and saved source data, then records the found sent Message ID. It records 0 instead when the source no longer exists.

When an FSM record handler creates a Notification, it requests execution of Field Service Scheduled : Notification (customdeploy_nx_notification, under customscript_nx_scheduled). Source-record handlers also request execution when pending requests are saved. An execution request doesn't establish that the script is running.

Used by FSM Features

The following table shows how FSM Service Reports and Notifications uses the Notification record.

Feature or capability

How the record is used

FSM Service Reports and Notifications

Tracks requested service-report emails, manual and automatic requests, and associated sent Messages. The same processing supports employee login emails for FSM Mobile.

Record Constraints and Data Requirements

In the supplied record definition, all six custom fields are stored and none is required. Requested defaults to the current time, and the other five custom fields have no supplied initial value. A record can still lack data needed for notification processing.

To interpret a request, use Record Type and Record Id together with an Email definition name from the matching configuration family. Sending also depends on the source record, email definition, addressing, templates, attachments, permissions, and processing. For these requirements, see FSM Service Reports and Notifications and Configuring FSM Service Reports and Notifications.

The Notification doesn't preserve a snapshot of its recipients or report content. FSM resolves these from the current definition and saved source data during processing. Changes before processing can change the resulting email and attachments. The email that processing sends can differ from a preview or the data available when the request was saved.

Additional Information

Related Topics

General Notices