Dynamics CRM Hub

• Overview

• Prerequisites

• How to Install the SmartHub Solution

• How to Configure the SmartHub Solution

• How to See All Configurable Entities

• How to Add SmartHub Local Search Component

• How to Remove the SmartHub Solution

• How to Update the SmartHub Solution

 

Overview

The integration with Dynamics is done by installing the SmartHub solution into your Dynamics 365. 

The SmartHub solution for Dynamics exposes two types of integration:

• Full search 
  •  Where SmartHub Search Center is displayed as a full page.
  • This will be accessible from the navigation menu BA Insight → SmartHub.
• Local search 
  •  Where SmartHub Search Center is displayed as part of a section on the page (with the ability to interact between SmartHub and Dynamics).
  • This will be accessible from the pages where the SmartHub Local Search component is added - see "How to Add Local Search to Other Pages" in the sections below.

Prerequisites

SmartHub must be installed and accessible using HTTPS

• This requires a trusted, valid certificate to be configured in the IIS bindings

How to Install the SmartHub Solution

1. To install the SmartHub Dynamics App navigate to the SmartHub installation directory under the /integrations/dynamics/SmartHubApp folder and create a zip archive with all the contents of the folder.
   
2. Navigate to your Dynamics → Settings → Solutions page.
   
   
   
   
3. Click on Import and choose to upload the application archive you created in step 1.
   
4. Once the upload is complete you can proceed with configuring the SmartHub solution in your Dynamics CRM.

How to Configure the SmartHub Solution

1. Navigate to your Dynamics → Settings → Solutions page.
   
2. Click on SmartHubCrm's display name to open the SmartHub configuration page, shown here:
   
   

Options to Configure

Property Name	Usage	Sample values
Local search URL	The SmartHub HTTPS address of the page to be opened by the Local Search component. This needs to be accessible from the machine where you are accessing Dynamics 365 from. If this page is hosted internally on your intranet, users must be connected to your intranet to access the page.  You can use the following parameters to control page behavior: ribbon=false: Hides the ribbon from the SmartHub page.	https://smarthub.contoso.com/integrations/dynamics/DynamicsResults.html?ribbon=false
Full search URL	SmartHub HTTPS address of the page that should be opened by the Full Search page. Must be accessible from the machine where you are accessing Dynamics 365 from. If this page is hosted internally on your intranet, users must be connected to your intranet to access the page.	https://smarthub.contoso.com/Index.html
Entities to search	Comma separated list of [object].[field] that should be passed as search to SmartHub when navigating to a page that loads that record. SmartHub Local Search automatically runs a search with the value of the configured properly for the page you are viewing.  For example, if you are on the Accounts page and you configured this property to be account.name then the Local search passes the current account's name to be searched when the page is loaded. You can configure as many properties as you want in the format:  object1.field1,object2.field2. You cannot configure multiple fields form the same object: object1.field1,object1.field2 To find the required object and field go to: Settings → Customizations → Customize the System → Open up the Entities drop down → Open up the required object drop down → Click the fields button.	account.name,contact.assistantname

How to See All Configurable Entities

1. Navigate to Dynamics → Settings → Customize the System.
   
2. On the left side menu, under Components, expand the Entities.
   
3. Expand the desired entity, click on Fields to see all properties for an entity.
   
   

How to Add SmartHub Local Search Component

1. Navigate to a record where you want to show the Local Search integration.
   
2. At the top menu, click on the Form button to edit the form.
   
3. On the Form Properties → Form Libraries add the shcrm_frame.js.
   
   
4. On the Form Properties → Event Handlers add as a Form control and OnLoad event the SmartHubCrm.loadEntity function from shcrm_frame.js library and check Pass execution context as first parameter.
   
   
   
   
5. Insert a new One Column Tab on the page.
   
   
   
6. In the new Tab created insert the shcrm_frame.html as a Web Resource.
   
   
   * To change the SmartHub Local Search component height on page, go to properties of the component's section → Formatting tab and change the Number of Rows from Row Layout section (max value is 40).

How to Remove the SmartHub Solution

1. Remove the Local Search component (both web resource HTML and JavaScript form library) from all pages where you've added it.
   
2. Navigate to your Dynamics → Settings → Solutions page.
   
3. Select the SmartHub solution and delete it.

How to Update the SmartHub Solution

1. Navigate to your Dynamics → Settings → Solutions page.
2. Click on Import and select the new zip archive with the solution to upload.
   * Be sure to check Maintain customizations in case you customized the Hub before.