Overview
The Quick Ribbon App from North52 is a ready-go-to solution for Microsoft Dynamics 365 that allows you to call a North52 Formula from the Ribbon on a form. You can download the Quick Ribbon App here.
It consists on a single JavaScript web resource that you connect using Ribbon WorkBench. You can also get Ribbon WorkBench from XrmToolBox.
You can see a video demonstrating how to set all of this up on our YouTube channel below
In this article we will demonstrate how to clone a Quote using Quick Ribbon and have it automatically open the newly cloned quote.
The Ribbon button will call a North52 Formula of type ClientSide - Calculation. This type of formula can carry out an action and then return a result back to the calling screen.
Note 1: Quick Ribbon requires that you have North52 BPA Version 529 or later installed.
Note 2: After version 1.0.0.530 North52 supports calling other formula types like this, but only ClientSide - Calculation will allow you to return a response to the calling screen.
Compatible Versions
| North52 Decision Suite | Quick Ribbon Version |
|---|---|
| 1.0.0.606 | 1.10 |
| 1.0.0.610 | 1.11 |
| 1.0.0.616 | 9.16 |
Step 1: Configure the North52 Formula
The below formula will clone the existing Quote, and then pass the instruction back to the form to open the newly created clone.
- Create a new formula, setting the following values in the Formula Guide
- Source Entity set to Quote
- Set Formula Type to ClientSide - Calculation
- Select the Decision Table editor
- Click the Create button
- Change the Name of the formula to Quote - Clone - Quick Ribbon
- Click Save
- Right-click in column A and select Delete > Delete Column
- Right-click again in column A and select Insert > Insert Table Calculation
- Replace the Set Name placeholder text with Cloned Quote
- Select cell A4
- Select the Functions tab, type clone into the Search functions input box and press enter
- Shift-click the Clone function to open the function wizard
- Ignore the Friendly Name field as we are going to insert the function directly in the Decision Table
- Entity Name: Select Quote from the search list
- Record ID: Select Quote from the search list
- Child Records: Select quote_details from the search list (this will include the Quote Products associated to the Quote in the cloning operation)
- Enable Prefix: Leave set to true
- Click Generate
- Select cell B4
- Select the Functions tab, type open into the Search functions input box and press enter
- Shift-click the OpenEntityForm function to open the function wizard
- Ignore the Friendly Name field as we are going to insert the function directly in the Decision Table
- Entity Name: Select Quote from the search list
- ID: Select the Source tab
- Expand the Decision Table Calculations node
- Expand the DecisionTable node (Decision Table's have a node for each sheet, in this case the sheet is called DecisionTable by default, unless you choose to rename it)
-
- Click on Cloned Quote to add the text GetVar('Cloned Quote')
- Parameters: Leave blank
- Click Generate
- Click Save
Make sure to note the shortcode of the formula as you will need this when you use Ribbon Workbench.
Step 2: Add the Quick Ribbon to the entity using Ribbon Workbench.
Open the Workbench and connect to your instance of Dynamics 365.
We have created a solution with just the Quote entity added to it.
Command
Configure a Command by clicking on the + icon. We change the name to new.quote.N52.CloneCommand.
We will be adding 1 JavaScript Actions to this button.
The Javascript Action will use $webresource:north52_quick_ribbon.js and the function should be set to N52QuickRibbon.ExecuteFormulaOnForm.
It will take 2 Parameters:
- Crm Parameter: PrimaryControl
- String Prameter: The shortcode of the North52 Formula you want to execute - in this example we are using s8q.
Button
Drag a button onto the form. We set the ID to be new.quote.N52.CloneButton and name it Clone Quote.
Set the Command to be the newly created command.
If you want to add an icon to your button in the Unified Interface it will need to be of type svg. In this example I am using one I already added as a web resource called new_cloniconsvg. It will need to be specified in the 'ModernImage' field on your button.
Note: You can download svg icons from various sites on the internet or convert existing images into them using tools. When you have your svg icons ready, you will need to added them as web resources to your Dynamics instance and then you can use them in your ribbon buttons.
Publish the Solution.
Quote Record on Dynamics 365
When we open a quote record on Dynamics 365 we will see the Clone Quote button listed on the Ribbon:
Click the ribbon button, the quote is cloned and the new quote opens.
Confirmation Dialog
It is possible to include a confirmation dialog in a Quick Ribbon on a form. To do this you would simply add another string parameter to the Quick Ribbon containing the text you want to display. In this example, before executing the formula GFW, we will ask the user if they are sure that they want to charge this customer.
A pop up dialog will ask me to confirm that I want to do this.
When they click OK the formula will execute, if they Cancel then the formula will not be called.
Processing Message
By default North52 Quick Ribbon will display a message on screen when the Ribbon button is clicked (v9 systems and above) that will say Processing...
If you want to add a custom message, then you can add an additional parameter to the Quick Ribbon command:
Note: If you want to display a processing message without configuring a confirmation message, set the middle string parameter to NoOp
