Move from using Xrm.Page to formContex in UCI form based PowerApps WebResources

The usage of Xrm.Page is currently deprecated, still available due to it’s high usage, but still deprecated. When will it go away, we don’t really know yet. How then can we use it’s formContext replacement within a web resource. Well Microsoft recently added a the getContentWindow() function to the context which allows us to get the actual content of a web resource. By adding an onload function to our form and utilizing getContentWindow() we can now call javascript on our web resource and pass it the formContext. Additionally you can add the context to the window object of the web resource so that the formContext can be used throughout the lifecycle of the web resource.

Here is a quick tutorial on how to pass the formContext to a WebResource on a UCI Form.
formContext in WebResource
Canvas App Video

Form OnLoad Code

// This should be in a script loaded on the form. 
// form_onload is a handler for the form onload event.
function form_onload(executionContext) {
    var formContext = executionContext.getFormContext();
    var wrControl = formContext.getControl("WebResource_getCurrentFormId");    
    if (wrControl) {
        wrControl.getContentWindow().then(
            function (contentWindow) {
                var contentAvailable = self.setInterval(function () {
                    //we need to check that the content window was actually loaded
                    // and that our function is available to call on the web resource.
                    if (contentWindow.setClientApiContext) {
                        clearInterval(contentAvailable);                  
                        contentWindow.setClientApiContext(formContext);                                               
                    }                    
                }, 100);                
            }
        )
    }
}

WebResource Code

<!DOCTYPE html>
<html>
    <head>
        <script>
            // This script should be in the HTML web resource.
            // No usage of Xrm or formContext should happen until this method is called.
            function setClientApiContext(formContext) {
                // Optionally set the formContext as global variables on the page.
                window._formContext = formContext;
                
                // Add script logic here that uses xrm or the formContext.
                // For this test we will just get the current form id
                document.getElementById('formIfo').innerHTML =_formContext.ui.formSelector.getCurrentItem().getId();
                document.body.style.display = "block";
            }
        </script>    
    </head>
    <body style="display: none;">
        Current Form Id: <span id="formIfo"></span> 
    </body>
</html>

Comments

  1. Evan HJanuary 18, 2021 at 10:03 PM

    Hello, I would like to create a "Batch Confirm" invoice button that is located on my Invoice home grib. I am currently able to navigate to all the Invoice forms that were selected using Xrm.Navigation.navigateTo but I am unable to get the formContext. I need to get the form context in order to use the OOTB invoice confirm function that requires formContext. Any ideas?

    ReplyDelete
  2. aplikasi invoiceMarch 29, 2023 at 9:50 PM

    thanks for sharing this

    ReplyDelete

Post a Comment

Popular posts from this blog

Add User As Local Administrator On Domain Controller

I recently was settting up a new Microsoft SharePoint 2010 machine and had promoted the machine to a domain controller before creating my SharePoint admin accounts.  I needed to add several of my accounts to the local Administrators group.  Unfortunately after you promote a server to a domain controller you can no longer access the GUI for Local Users and Groups.  Instead I had to use the command line to add the users. Open a command promt using the "Run as administrator" function and then run the following command. net localgroup Administrators /add {domain}\{user} Note: do not include the {} brackets.
Read more

Calling Dataverse Web API in PowerShell using Client Credentials

Image
Connecting to Dataverse using PowerShell can be very helpful for data migrations and use within Azure DevOps. Connecting to an instance in a non-interactive way can be tricky though. This article will provide you the links you need for creation and App registration and adding the app user to your environment. You can then utilize the script provided to call Web API requests including ones you define using the new Custom API functionality now available. The script was written so that it is not dependent on any outside libraries such as the Microsoft.Xrm.Tooling connector. This is helpful in situation where involving an outside library will slow down your deployment time by having to be approved in a change control board. If utilizing an outside code library is not a concern you can create a connection to Dataverse utilizing the Microsoft.Xrm.Tooling connector Get-CrmConnection cmdlet. Create App Registration The first thing to do is create an App Registration within Azure AD for ...
Read more

Windows Server 2008R2 VMs Shut Down After 1 to 2 Hours

Image
When created a lab environment to test ADFS 2.0 I utilized the Windows 2008R2 VM baselines distributed by Microsoft.  After a few days I was told that I had to activate.  The VMs included a 180 day license for use but I didn't feel like adding another network adapter into Hyper-V to connect them to the internet.  I started having issues though where the servers would shut down every hour or so.  I though that maybe there was a memory issue and Hyper-V was shutting them down in order to free up RAM.  Turns out that if Server 2008R2 is not activated it automatically shuts down after a period of time.  After connecting the server to the internet and activating them the problem went away. Finally the madness of the unknown shut downs has ended :)
Read more