Refreshing Dynamics 365 Forms and Ribbons Using Global Functions

Introduction

In Dynamics 365, refreshing a form or its ribbon is a common requirement, especially when dealing with updates from popup windows or external triggers. With Xrm.Page deprecated, we're exploring the use of formContext and global functions for form and ribbon refresh. This article will guide you on how to use these methods and explain the scope of the window object in Dynamics 365.

Using Global Functions for Form and Ribbon Refresh

Global functions can be a powerful tool for triggering form and ribbon refreshes across different parts of your Dynamics 365 application. Understanding their scope and limitations is crucial.

Setting Up a Global Refresh Function

1. Define the Function in the Form's OnLoad Event: In your form's OnLoad event script, define a function that refreshes the form using formContext and attach it to the window object.

   javascript
   function onLoad(executionContext) {
       var formContext = executionContext.getFormContext();
   
       window.refreshForm = function() {
           formContext.data.refresh().then(
               function success() {
                   console.log("Form refreshed successfully.");
                   formContext.ui.refreshRibbon(); // Refresh the ribbon after the form data
               },
               function error(reason) {
                   console.error("Error refreshing form: " + reason);
               }
           );
       };
   }
   
   
   

2. Calling the Global Function: You can now call window.refreshForm from anywhere within the same browser tab to refresh the form.

   javascript
   if (typeof window.refreshForm === "function") {
       window.refreshForm();
   }

Understanding the Scope of window in Dynamics 365

• Tab-Specific Scope: The window object is specific to each browser tab or window. A global function defined in one tab (e.g., window.myFunction) is not accessible from another tab, even if both tabs are accessing the same Dynamics 365 environment.

• 
  

• Persisting Across Navigation: Within the same browser tab, a global function persists even when navigating between different records. However, this is generally not a concern in Dynamics 365 main forms, as navigation to a different record typically involves opening a new tab or window.

• 
  

• Best Practices: Be cautious when using global functions and variables. They should be used judiciously, keeping in mind their scope and potential impact on the application's state and behavior.

• 
  

Conclusion

Utilizing global functions for tasks like form refresh can be effective in Dynamics 365, but it's important to understand the scope of these functions. Since they are confined to the browser tab in which they are defined, they offer a degree of isolation that can be beneficial in managing state and interactions within a specific user session. Always consider the broader application context and test thoroughly to ensure a seamless user experience. This approach becomes particularly relevant with the deprecation of Xrm.Page, emphasizing the need to use formContext for current Dynamics 365 customizations.