Installing The Portal Connector

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

Prerequisites

  • A web server running Sitefinity with one of the last two builds of the following Sitefinity versions:
    • Sitefinity 10.0 (6413, 6414)
    • Sitefinity 10.1 (6504, 6505)
    • Sitefinity 10.2 (6602, 6603)
    • Sitefinity 11.0 (6700, 6701, +)
    • The Portal Connector supports the last two revisions of each Sitefinity minor version. We don’t provide builds to other Sitefinity versions because of potential security issues and bugs present in the older versions. If you require a TPC build for a specific Sitefinity version, please contact support@crmportalconnector.com
  • No existing Portal Connector installation or The Portal Connector v4.0 - v4.3 installed
  • Visual Studio 2012 or greater
  • .NET Framework 4.5.2 Developer Pack (download here)

For Sitefinity 11.0 and above:

Setup

  1. Navigate to The Portal Connector customer portal to download the TPC build for your respective Sitefinity versionTPC 5.0 Downloads
  2. Back up your Sitefinity website and Sitefinity database.

Installation

If you already have The Portal Connector v4.0 to v4.3 installed you can skip this step and move to the “Activation” section

  1. Navigate to the “bin” directory of your Sitefinity installation.
  2. Copy and paste the contents of the downloaded zip file into this directory     
  3. Open the Sitefinity site project file (usually named SitefinityWebApp.csproj) in Visual Studio
  4. Open the SitefinityWebApp project properties by double clicking on the Properties item under the expanded project
    installation-2
  5. In the properties menu, open the Application sub-menu and change the target framework:
    • For Sitefinity 10.x: Select .NET Framework 4.5.2
    • For Sitefinity 11.0+: Select .NET Framework 4.7.1
    installation-3
  6. In the Solution Explorer on the right-hand side, right click References and click on “Add Reference…”installation-4
  7. On the left-hand side of the dialog, click on “Browse” then on the bottom of the dialog, click “Browse…”
  8. Browse to the “bin” folder and select the copied pavliks.PortalConnector.dll from step 2. Once selected: click “Add”, once added: click “OK”.installation-5
  9. If deploying to Azure, include the following dlls as well to your references list:
    • pavliks.PortalConnector.Mvc
    • pavliks.PortalConnector.Mvc.Forms
    • pavliks.PortalConnector.Mvc.Pages
    • pavliks.PortalConnector.Mvc.FormFlow
    • pavliks.PortalConnector.Migrations
    • pavliks.PortalConnector.Mvc.PowerBI
    • pavliks.PortalConnector.Mvc.KnowledgeBase
  10. In the Solution Explorer on the right-hand side of Visual Studio, double click on the “Global.asax” file. If this file does not exist, add a Global.asax file to your project.

    installation-6

     

  11. Inside this file, we need to make a few code changes. Add the following lines to the top of the Global.asax.cs file:

    using pavliks.PortalConnector; 
    using Telerik.Sitefinity.Security.Claims;
    
  12. Also inside this file, we need to add some code to enable user cache invalidation across the site, copy and paste the code below inside the Global class:

    public override string GetVaryByCustomString(HttpContext context, string custom)
    {
       if (custom.Contains(TpcCacheInvalidationSettings.UserIdKey))
        {
          var identity = ClaimsManager.GetIdentity(context);
          return identity != null ? identity.UserId.ToString() : Guid.Empty.ToString();
        }
        return base.GetVaryByCustomString(context, custom);
    }
    
  13. After copying these code snippets into the Global.asax.cs file, it should look like this:installation-7
  14. At the top of Visual Studio, under the Build menu, select Build Solution
    installation-8
  15. Once built, open the site by navigating to it in your browser.

Activation

Now that the Portal Connector binaries are installed, we need to activate the module in order to gain access to all of the custom widgets and functionality TPC provides.

If you are performing an upgrade from version 4.0 or higher, and The Portal Connector is already installed: you must copy the contents of the zip to the “bin” directory of your Sitefinity installation folder before proceeding.

To activate The Portal Connector, follow these steps:

  1. Navigate to the Sitefinity backend
  2. Under the Administration menu, select Modules & Services
    installation-9
  3. Scroll down until you find “The Portal Connector” module. On the right-hand side of this option, select “Actions” and then “Install”. This process usually takes between 2-4 minutes, depending on server speed.
    installation-10
  4. After installation and activation of this module, you are ready to use The Portal Connector
  5. For users wishing to utilize the new MVC features, you must also install and activate the module: “The Portal Connector (MVC)”. Once this module is installed, all new MVC widgets and features will be available to you within the toolbox.

Licensing

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

You can read The Portal Connector EULA here: https://www.crmportalconnector.com/license/eula.pdf

  1. Navigate to the license keys page on The Portal Connector web portal found here
  2. Select “View Keys” on the respective portal you wish to install the license to
  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”
    installation-11
  7. Read the EULA
  8. Paste the license key from your clipboard into to the license text area.
  9. Click “Update License”
    installation-12
  10. If the correct license was copied, the Portal Connector will be licensed with a valid license