Installing Portal Connector on Sitefinity

  • 1. Setup
  • 2. Installation
  • 3. Activation
  • 4. Licensing

This guide covers a fresh installation of Portal Connector using NuGet. If you’re upgrading an existing portal site, refer to Upgrading a Portal Site.

Portal Connector is a middleware layer that connects your Sitefinity web application to Microsoft Dataverse (including Dynamics 365 apps) to enable secure, real-time data integration.

Setup

  1.  In Visual Studio, Navigate to Tools -> NuGet Package Manager -> Package Manager Settings. Click on the + icon in package sources and add the name and Source of NuGet packages.
  2. Name: Portal Connector
  3. Source:   https://nuget.portalconnector.com/index.json  
     
  4. Click OK and it will add the Portal Connector NuGet Package feed to your Visual Studio. 

  5. Before installing on Sitefinity versions prior to 15.4, please remove potentially conflicting references from your Web App. The list includes:
    • Azure.Core
    • HtmlAgilityPack
    • Microsoft.Rest.ClientRuntime
    • System.ClientModel
    • System.Threading.Channels

    This can be done by opening the References section in Visual Studio Solution Explorer, scrolling down to the reference, and deleting it. To delete, simply right‑click the reference and select Remove.

Installation

  1. In the Solution Explorer in Visual Studio on the right-hand side, right-click References and then click Manage NuGet Packages…
    NuGetInstall1
  2. In the NuGet Package Manager select the package source Portal Connector set in prior step.
    NuGetInstall2
  3. Find the PortalConnector.All package that matches your current Portal Connector and Sitefinity version and click the Install/Update button. If you are developing against a class library rather than a Sitefinity site, you can install the PortalConnector.Core package.
    NuGetInstall3

    Portal Connector package versions follow a standard convention. We can look at the following example to understand that convention.

    Example: PortalConnector.All - 7.0.153.126

    7.0 – This indicates that the package is for Portal Connector version 7.0.

    153 – This indicates that the package is for Sitefinity 15.3 (compatible with any patch version).

    126 – This indicates that the patch number is 126.

  4. After installation completes, your Sitefinity project will include all Portal Connector dependencies and is ready for configuration.

Activation

Now that Portal Connector is installed, we need to activate the modules in order to gain access to all of the widgets and functionality Portal Connector provides.

To activate Portal Connector, follow these steps:

  1. Navigate to the Sitefinity backend
  2. Under the Administration menu, select Modules & Services under the System section, or go to the page ~/Sitefinity/Administration/ModulesAndServices. 
  3. Scroll down until you find “The Portal Connector” module. On the right-hand side of this option, select “Actions” and then “Install”. Do the same for “The Portal Connector (MVC)”. This process usually takes between 2-4 minutes, depending on server speed. At this point you can install any add-on modules should you have a valid license.

Licensing

This section will show you how to apply your license to your Portal Connector installation. For more information on licensing please contact support at supportTPC@sylogist.com

 

  1. If you manage your own licenses, navigate to the license keys page on Portal Connector web portal found here.
  2. Select View Keys next to the portal where you wish to install the license.
  3. On the next page, click View on the appropriate TPC version for your installation.
  4. Copy the contents of the License Key in the text box to your clipboard.
  5. Log in to the Sitefinity backend of your portal.
  6. Under the Administration menu, select Portal Connector Licensing.
     
  7. Paste the license key from your clipboard into to the license text area.
  8. Click Update License.
     
  9. If the correct license was copied, the Portal Connector will be licensed with a valid license.