About the IntelligenceBank Connector for Optimizely CMS 12

Modified on Wed, 17 Jun at 12:30 AM

The IntelligenceBank Connector for Optimizely CMS 12 makes it easy for users to browse, search and insert their approved IntelligenceBank assets as Public CDN links or local copies, either as a dedicated custom assets block, or directly from within Optimizely CMS 12's Editorial content block (legacy version).

Compatibility

Both versions of the connector documented below are built for Optimizely CMS 12 on a target framework of .NET 8.0. They work with any standard CMS 12 deployment — whether self-hosted (on-premise or your own cloud) or cloud-hosted on Optimizely DXP (PaaS). Self-hosted and DXP run the same .NET application and differ only in where it is hosted, so the connector installs identically on both.

These connectors are not compatible with Optimizely SaaS (SaaS Core). SaaS Core is a separate, headless, versionless product — not a "version" of CMS 12 — and does not run a server-side .NET application, so it cannot load the NuGet packages or the server-side TinyMCE configuration these connectors depend on. SaaS Core support may be added in the future.

IntelligenceBank Assets Block (Recommended)

Installation

To install the IntelligenceBank Custom Assets Block Connector, download the NuGet package here, and install it into your Optimizely CMS 12 project. Make sure you re-build the solution after the update.

Once installed, follow the configuration instructions in the README.md file.

As part of the configuration, you have the ability to set:

  • Whether assets are inserted as local copies or CDN public links
  • The default platform URL
  • Whether browser login should be enabled by default

Add New Block

To get started, select the newly available IntelligenceBank Assets block and configure it.

Inserting IntelligenceBank Media Assets

Once the block has been added to your page, click edit to load it. You will then be able to login to your IntelligenceBank platform, browse, search and insert media assets. Note that multiple assets can be inserted against the same block.

Editorial Rich Text Block Integration (Legacy)

Installation

To install the IntelligenceBank Editorial Block Connector, download the NuGet package here, and install it into your Optimizely CMS 12 project. Make sure you re-build the solution after the update.

Upon installation, verify that 'wwwroot' contains the folder 'MyTinyMCEPlugin'.

Under 'Configuration', verify that a file 'CustomTinyMceConfigurator.cs' is present.

Here is an extract of the code present in that configuration file.

If the folder and/or file are not present, create it/them with the following code snippet:

using EPiServer.Cms.TinyMce.Core;
using Microsoft.Extensions.Options;

namespace AlloyCMS.Configuration
{
    public class CustomTinyMceConfigurator : IConfigureOptions<TinyMceConfiguration>
    {
        public void Configure(TinyMceConfiguration options)
        {
            options.Default()
                 .AddEpiserverSupport()
                 .AddExternalPlugin("backgroundplate", "/js/markbuttons.js")
                 .AppendToolbar("backgroundplate");
        }
    }
}

Next, add the following code to the Configuration function of the file "Startup.cs", which will allow for the plugin to load:

app.UseStaticFiles(new StaticFileOptions
{
    FileProvider = new PhysicalFileProvider(
      Path.Combine(_webHostingEnvironment.WebRootPath, @"MyTinyMCEPlugin\ClientResources")),
    RequestPath = new PathString("/js")
});

Also add services.ConfigureOptions<CustomTinyMceConfigurator>(); to the ConfigureServices(IServiceCollection services) section.

You can configure the IntelligenceBank Connector default login options in a file called 'markbuttons.js', located under wwwroot\MyTinyMCEPlugin\ClientResources.

SettingDescription
webAppURLSets how assets are inserted. Two options are available:
  • https://ucprod.intelligencebank.com/app/?app=optimizely_public — surfaces the ability to insert your IntelligenceBank platform assets as Public CDN links. Assets are not physically copied into your Optimizely instance, and any update to the original asset in IntelligenceBank is automatically pushed to every location where the Public CDN link is used. Learn more about how to optimize image assets with Public CDN links in IntelligenceBank CMS Connectors.
  • https://ucprod.intelligencebank.com/app/?app=optimizely_no_public — surfaces the ability to download your IntelligenceBank platform assets. Assets are physically copied into your Optimizely assets library, and updates to the original asset in IntelligenceBank are not pushed to locations where the local copy is used.
customURLSet to true if your IntelligenceBank platform has a custom URL and you want the connector to load with that option pre-selected.
platformURLProvide either your IntelligenceBank sub-domain value (without https://) if using the default intelligencebank.com domain, or the entire domain (without https:// but with www. if applicable) if using a custom URL, so the connector loads with that value by default.
enableBrowserLoginSet to true if your IntelligenceBank platform has Single Sign-On enabled and you want the connector to load with that option pre-selected.

Admin Settings

In complement to, or as an alternative to, modifying the markbuttons.js file as per the steps above, the NuGet package installation will automatically create a page called 'Admin Settings', which surfaces the same configuration options in the front end.

On this page, you will also be able to set the Web App URL, and the default login options for the Platform URL, Custom URL, and Browser Login fields.

The page can be removed if not needed.

Editorial Block & The IntelligenceBank Connector

The IntelligenceBank Connector will surface as a new source option of the standard Optimizely CMS 12 Editorial Block. To access the connector, you will therefore need to add an Editorial Block to your page layout. If you already have Editorial Blocks set up, the IntelligenceBank option will now automatically appear there as a new option.

Upon clicking on IntelligenceBank within the Editorial Block, the connector will load as a new window. Login fields will be pre-populated as per the configuration options covered in the previous section of this article. Enter your IntelligenceBank login credentials, or enable Browser Login to authenticate via Single Sign-On.

Once authenticated, you will be able to browse folders, search and find assets, exactly as if you were directly logged in to your IntelligenceBank platform.

To insert an asset into the Editorial Block, simply click on the card / thumbnail. If the asset is an image, you can also select any of the available Transformation Presets.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article