Configuring FSM Service Report Buttons

The three button definitions have the same property structure. The following sections describe each definition because the notification families and record conditions differ.

This topic includes the following sections:

Case Service Report Button

views/case/servicereport

The standard button is available in view mode when the case has a Field Service Case Type and its stage is Closed. Its notification value selects a definition from notification.caseEmail.

CRM Task Service Report Button

views/task/servicereport

The standard button is available in view mode when the task has a Field Service Task Type and its status is Completed. Its notification value selects a definition from notification.taskEmail.

Project Task Service Report Button

views/projecttask/servicereport

The standard button is available in view mode when the project task has a Field Service Task Type and its status is Completed. Its notification value selects a definition from notification.projectTaskEmail.

Button Properties

The following table lists button properties, accepted values, standard defaults, and effects for each of the three view definitions.

Property

Accepted Value

Standard Default

Effect

hidden

Boolean.

false

When true, turns off this button component. This setting doesn't turn off automatic notification rules.

name

Page-button ID string.

"custpage_nx_servicereport"

Identifies the button on the form. Retain this ID unless you need to change it. Avoid duplicate IDs.

label

Label string or FSM translation identifier.

Record-specific translated Service Report label.

Changes the button text.

notification

Name of a definition in the corresponding notification family.

"servicereport"

Selects the notification definition used by this button.

send

Confirmation text or a translation identifier. Use "" for preview only.

Record-specific translated confirmation message.

Nonempty text enables the preview-and-confirm action. An empty string selects preview only.

success

Message string or translation identifier.

Record-specific translated success message.

Displays after the send request succeeds. A successful send request doesn't prove that the recipient has received the email.

error

Message string or translation identifier.

Translated generic error message.

Displays if the send request fails.

delay

Nonnegative number of milliseconds.

1000

Delay before displaying the confirmation after the preview window loads.

For example, this custom configuration fragment makes the CRM task button preview-only:

            {
  "views/task/servicereport": {
    "send": ""
  }
} 

          

The selected notification definition and PDF remain. This change removes that button's send confirmation and send request. Other actions or automatic rules can still send the same notification.

PDF preview still renders the associated notification definition. Retain a valid email-body template even when this button is configured for preview only.

Changing label, name, or notification doesn't remove the standard record eligibility conditions.

When a user confirms sending, FSM queues the selected notification for processing. A successful request is distinct from PDF generation, background processing, and receipt of the email. For information about product behavior, see FSM Service Reports and Notifications. For associated execution and deployment information, see FSM Script Reference.

The preview and the queued email are rendered separately. If record data or configuration changes before notification processing, the report sent by email can differ from the preview.

Additional Information

Related Topics

General Notices