Views:

Overview

The re-configuration changes listed below means that Quick Ribbon is no longer reliant on using Xrm.Page or  parent.Xrm.Page as Micrrosoft have marked these as deprecated. No date has been given yet as to when these will be removed from the Dynamics365 platform but we want to have all our customers ready for this change.

 

Note: The minimum version of Quick Ribbon to support this is v9.16 and North52 Formula Manager 1.0.0.616.

Step 1 - Identify Quick Ribbons that need to be upgraded

You will need to identify all the positions in your Dynamics 365 environment that you are using Quick Ribbon.

The easiest way to do this is to download and install XrmToolBox. Connect this instance to your Dynamics 365 environment and then open the Fetch-XML Builder.

Run the following Fetch Query:

<fetch top="50" >
  <entity name="ribboncommand" >
    <attribute name="command" />
    <attribute name="entity" />
    <filter>
      <condition attribute="commanddefinition" operator="like" value="%north52_quick_ribbon%" />
    </filter>
  </entity>
</fetch>

In the example below you can see all the Ribbon Commands where North52 Quick Ribbon is in use:

Step 2 - Create Temporary Solution for Ribbon Changes

From within your Dynamics 365 environment create a new Solution called Ribbon Upgrades and add the entities identified in the FetchXML results from step 1.

In the scenario above there are 3 entities that are using the North52 Quick Ribbon:

  • account
  • north52_testheader
  • north52_testquickribbon

Step 3 - open the solution in Ribbon Workbench

Return to XrmToolBox and open the solution created in Step 2 in Ribbon Workbench.

  • Use the Entity drop down to switch between the entities in the Solution

Step 4 - Perform the Upgrade

Each Commands that is using North52 Quick Ribbon will need to be upgraded.

In the example below, a Formula with a Short Code of aid is being called from a ribbon button on the Account entity.

4.1 Upgrade - N52QuickRibbon.ExecuteFormulaOnForm

If the custom JavaScript function relates to N52QuickRibbon.ExecuteFormulaOnForm, apply the following steps:

  1. Click the Add Parameter and select CRM Parameter
  2. Select PrimaryControl
  3. Place your cursor to the left of the Crm Parameter and 3 vertical dots will appear. Click the dots and drag the control to the first position in the command:

    Before:

    After reposition:
  4. Repeat these steps for any Commands or EnableDisable Rules that are using North52 Quick Ribbon.

The PrimaryControl has to be the first parameter in the Quick Ribbon.

4.2 Upgrade - N52QuickRibbon.ExecuteFormulaOnView

Set the PrimaryControl on a List View command as per the steps in section 4.1:

4.3 Upgrade  - N52QuickRibbon.EnableDisableRibbonButtonForm

Set the PrimaryControl on a Form EnableDisable rule as per the steps in section 4.1:

4.4 Upgrade - N52QuickRibbon.EnableDisableRibbonButtonView

Set the PrimaryControl on a List view EnableDisable rule as per the steps in section 4.1:

4.5 Upgrade  - Publish

Once you have updated all your rules, click on the Publish button to commit your changes to Dynamics 365.

 

4.6 Upgrade  - Testing

You are then complete - Quick Ribbon will be compliant with the latest version of Dynamics 365.

Keywords: quick ribbon