CRM.web v15.5: Show a MessageBox on FI Record Open When FI.7100 Is Empty or 0 (Use a Render Hook)

Solution

Issue

A popup (MessageBox) should appear when opening an FI record in CRM.web if FI field 7100 is empty or 0, but earlier implementations did not trigger reliably on record open.

Environment

• ACRM / CRM.web
• Version: 15.5

Root cause

A Hook Function / Field Hook executes when a field value changes and is not a reliable “on record open” trigger in CRM.web. For “on open / on render” behavior, use a Render Hook.

Resolution (Render Hook approach)

1) Ensure FI.7100 is included in the FI Expand field group

Render Hooks are executed only if the field is part of the view configuration.

• In CRM.designer, locate the FI Expand configuration / field group used in CRM.web.
• Add FI field 7100 to the Expand field group (it can be visible or hidden).

2) Load your custom JavaScript in CRM.web

Ensure your custom JS file is loaded when the Expand renders (so the hook function exists).

• Add your JS file (for example: custom-alerts.js) to the CRM.web custom scripting mechanism used by your system (per your standard web customization deployment).

3) Define a Render Hook on FI field 7100

In CRM.designer, set the Render Hook attribute on FI.7100 to call your function, for example:

u8.custom.Alerts.renderFIalerts($);

4) Implement the hook function (basic popup)

Example implementation:

u8.custom = u8.custom || {};
u8.custom.Alerts = u8.custom.Alerts || {};

u8.custom.Alerts.renderFIalerts = function ($) {
  var v = $.getValue(); // value of the current field (7100)
  v = (v === null || v === undefined) ? "" : String(v).trim();

  // Note: numeric values can arrive as text, e.g. "0"
  if (v === "" || v === "0") {
    u8.Base.Widgets.MessageBox.show({
      caption: "Attention",
      message: "Field 7100 is missing. Please complete it.",
      buttons: "Ok"
    });
  }
};

Prevent the popup from appearing multiple times (“show once per FI record”)

Render Hooks can execute more than once due to re-rendering. To show the message only once per FI record (but show it again when a different FI record is opened), add a guard stored on the current ExpandView, keyed by the current record UID.

u8.custom = u8.custom || {};
u8.custom.Alerts = u8.custom.Alerts || {};

u8.custom.Alerts.renderFIalerts = function ($) {
  var expandView = $u(".ExpandView", "current")[0];
  var uid = expandView.model.getUid();

  // Reset guard when navigating to a different FI record
  if (expandView._fiAlertUid !== uid) {
    expandView._fiAlertUid = uid;
    expandView._fiAlertShown = false;
  }

  // If already shown for this FI record, do nothing
  if (expandView._fiAlertShown) {
    return;
  }

  var v = $.getValue();
  v = (v === null || v === undefined) ? "" : String(v).trim();

  if (v === "" || v === "0") {
    expandView._fiAlertShown = true;

    u8.Base.Widgets.MessageBox.show({
      caption: "Attention",
      message: "Field 7100 is missing. Please complete it.",
      buttons: "Ok"
    });
  }
};