This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Installing the Lionbridge Connector

Important: Before installing the Connector, back up the Optimizely databases.

You use Visual Studio NuGet to install the Connector package. There are two ways to install the Connector, depending on whether you received the installation package directly from Lionbridge or you will download it from the Optimizely NuGet feed.

Optimizely version numbers in Lionbridge Connector packages

Important: There are different Connector packages for Optimizely 12, Optimizely 11 and Optimizely 10. Ensure that you download and install the correct package for your version of Optimizely.

You can identify the Optimizely version for the Lionbridge Connector from the last four digits of the NuGet package name, as described in the following table below.

Optimizely Version Lionbridge Connector Versioning
(MajorVersion.MinorVersion.Patch.Optimizely Version)
Example
Optimizely 12 2.x.x.1200 2.0.0.1200

To download and install the Connector:

Important: Follow these instructions if you did not receive the Connector as a NuGet package (with file extension .nupkg) directly from Lionbridge.

  • In Visual Studio, open the NuGet Package Manager Console. In the command line, type:
    Install-Package LionbridgeConnector.

To install the Connector:

Important: Follow these instructions if you received the Connector as a NuGet package (with file extension .nupkg) directly from Lionbridge.

  1. In Visual Studio, open the NuGet Package Manager Console.
  2. Type the following command in the command line, ensuring that you specify the latest Connector version for your CMS version:
    Install-PackageLionbridgeConnector -source [.nupkg file path] - version.x.x.1200
    For example, to install version 2.0.0 of the Connector on CMS version 112, type:
    Install-Package LionbridgeConnector -source C:\LionbridgeConnector -version 2.0.0.1200

Third-Party Libraries required:

The following compatible third-party libraries are required to be installed.

Name Description Minimum Version
Newtonsoft.Json Json.NET is a popular high-performance JSON framework for .NET 13.0.1
Serilog.Sinks.Graylog The Serilog Graylog Sink project is a sink (basically a writer) for the Serilog logging framework. Structured log events are written to sinks and each sink is responsible for writing it to its own backend, database, store etc. This sink delivers the data to Graylog2, a NoSQL search engine. 2.3.0
Serilog Simple .NET logging with fully-structured events 2.10
Microsoft.Extensions.Logging.Log4Net.AspNetCore Allows to configure Log4net as Microsoft Extensions Logging handler on any ASP.NET Core application 6.1
log4net.dll Log for Net Core 2.0.13

Note: The Serilog libraries will be installed by the Connector package.

Installation location

The Connector is installed in the \modules_protected folder of the Optimizely web root. If you use another folder for add-ons, you must manually move the Connector files to your modules folder.

Important: For debugging in development environment: Copy folder LionbridgeConnector in the \bin\modules_protected folder to project folder as path \modules_protected

1 - Updating Your Connector Installation

If the Lionbridge Connector (Connector) is already installed, follow the steps below to update your version of the Connector.

Using the Nuget Site:

  1. In Visual Studio, open the NuGet Package Manager Console.
  2. In the command line, type: Update-Package LionbridgeConnector. Always use the latest available version of the Connector.

Using the NuGet package (with file extension .nupkg) directly from Lionbridge:

  1. In Visual Studio, open the NuGet Package Manager Console.
  2. In the command line, type: Update-Package LionbridgeConnector -source. [.nupkg file path] -version MajorVersion.Minor Version.Patch.OptimizelyVersion.

For example, type: Update-Package LionbridgeConnector -source C:\LionbridgeConnector -version 2.0.0.1200

Optimizely version numbers in Lionbridge Connector packages:

You can identify the Optimizely version for the Lionbridge Connector from the last four digits of the NuGet package name, as described in the following table.

Optimizely Version Lionbridge Connector Versioning
(MajorVersion.MinorVersion.Patch.Optimizely Version)
Example
Optimizely 12 2.x.x.1200 2.0.0.1200

Important: If you are upgrading from Connector version earlier than 1.7.x and you have Jobs still In Translation with Lionbridge, then these will need to be completed before the migration else contact Connector Support.

2 - Uninstalling the Connector

Before uninstalling the Connector, ensure that the site is stopped in Visual Studio.

To uninstall the Connector:

  1. In Visual Studio, open the NuGet Package Manager Console.
  2. In the command line, type: Remove-LionbridgeConnector.