How to set up the Optimizely 12 extension – iLangL

Overview

1. Requirements for Optimizely 12 extension installation

2. Optimizely 12 extension installation

3. Connecting Optimizely 12 extension to Localization Hub

4. How to connect Optimizely to another Workspace or Localization Hub

5. Time interval setup for completed job retrieval

6. Report on job delivery outcomes

Requirements for Optimizely 12 extension installation

Optimizely supported version: 12.x

Microsoft .Net Core 6.0 or later

Note: If your setup doesn't meet these requirements, contact support@ilangl.com to discuss the possibility of integrating with other versions.

Installation

1. Install NuGet package.

Your IT department can set up the iLangL Optimizely Connector to your Optimizely website by installing the nuget packages for iLangL Optimizely Connector from NuGet.

Optimizely CMS only

If you use only CMS without Commerce, you need to install the following NuGet Package: iLangl.Extension.Optimizely.V12

Optimizely CMS + Commerce

In case you use Optimizely CMS with Commerce, you need the following NuGet Package: iLangl.Extension.Optimizely.V12.Commerce

2. Register iLangl.Extension.Optimizely.V12 as a ProtectedModule

3. In appsettings.json add the iLangl.Extension.Optimizely.V12 as a ProtectedModule:

"EPiServer": {

"CmsUI": {

"ProtectedModule": {

"Items": [

{

"Name": "iLangl.Extension.Optimizely.V12"

}

]

}

...

}

Modify Startup.cs. Method ConfigureServices.

Add to services: Localization Extension AddLocalizationExtension()

In case of Commerce support, it should be:

AddLocalizationExtensionWithCommerce()

Example

services

.AddCmsAspNetIdentity<ApplicationUser>()

.AddCms()

.AddAlloy()

.AddAdminUserRegistration()

.AddEmbeddedLocalization<Startup>()

.AddLocalizationExtension();

For Development Environment, copy the iLangl.Extension.Optimizely.V12.zip to the Project to follow path /modules/_protected/iLangl.Extension.Optimizely.V12/iLangl.Extension.Optimizely.V12.zip

Important: It's highly recommended that you deploy and test the iLangL Extension in the staging environment before deploying it to production.

Environment specifics

When the Optimizely databases need to be copied from the production environment to staging or backward, environment-specific items should not be overwritten. Anything that is environment-specific should be externalized into custom deployment patch files.

The environment-specific settings for the Optimizely gadget can be found in the DB view:

VW_iLangl.Extension.Optimizely.V12.Settings.SettingsModel in tblBigTable with StoreName equal ‘iLangl.Extension.Optimizely.V12.Settings.SettingsModel’

Connecting Optimizely 12 extension to Localization Hub

To properly configure the installed extension, you need to follow these steps:

1. Open the Toggle Assets Pane, click the Settings gear icon, and select the Add Gadgets menu item.

In the Gadgets modal window, click the Localization widget.

3. The Localization widget will be added to the Assets pane. Click Settings.

4. Enter Localization Hub URL — the URL of your Localization Hub.

Copy the link from the Localization Hub URL field in the Instructions for Optimizely Extension Installation you received via email.

5. Select I have the Workspace ID if you already have the Workspace for managing translation from Optimizely in Localization Hub.

Copy the Workspace ID from the Instructions for Optimizely Extension Installation you received via email.

Alternatively, you can copy the Workspace ID from the Workspace settings in the Localization Hub.

Enter the Workspace ID into the Workspace ID field.

Select I want to create a new Workspace if you need to create one and enter your preferred name in the Workspace Name field.

You should see the success message.

How to connect Optimizely to another Workspace or Localization Hub?

If for some reason you need to connect to another Localization Hub or change the Workspace at the existing Localization, open Settings.

Click Edit Settings.

Enter the URL of your new Localization Hub or the new Workspace ID. You can also create a new Workspace. Click Connect.

Time interval setup for completed job retrieval

You can set up a specific time interval for checking the Localization Hub for completed translation jobs.

The default time interval is 5 minutes. This means that your server will check the Localization Hub and download the completed translation back to your website every 5 minutes.

1. To modify the settings, go to Settings > Scheduled Jobs and open the Translation Delivery Job.

2. Navigate to the Settings tab.

3. Set up the required Start Date and time interval. Click Save Scheduled Jobs.

4. To initiate instant job delivery to the website, click Start.

If you need to stop the started the process, click Stop.

Report on job delivery outcomes

To see the translation job statuses that were initiated for delivery, go to the History tab. You will find there:

the date when the delivery was triggered
the result (Succeeded/Failed)
the duration of delivery
the message with the delivery details (how many items were delivered or the code of system error)