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 directly from within Optimizely CMS 12's Editorial content block.
The IntelligenceBank Connector for Optimizely CMS 12 is currently only compatible with the PaaS version of Optimizely, and with a target framework of .net 6.0. Compatibility with .net 8.0 is current under implementation. Support for the SaaS version of Optimizely CMS 12 may also be implemented in the future.
Installation Steps
Step 1
To install the IntelligenceBank 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.
Step 2
Upon installation, verify that 'wwwroot' contains the folder 'MyTinyMCEPlugin'.
Step 3
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");
}
}
}
Step 4
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.
Step 5 (optional)
You can configure the IntelligenceBank Connector default login options in a file called 'markbutton.js', located under wwwroot\MyTinyMCEPlugin\ClientResources.
- Under 'webAppURL', options are:
- 'https://ucprod.intelligencebank.com/app/?app=optimizely_public' - this will surface the ability to insert your IntelligenceBank platform assets as Public CDN links from the connector. In that instance, assets are not physically copied into your Optimizely instance. Any update to the original asset in IntelligenceBank will get automatically pushed to any location where the Public CDN link is used.
- Learn more about how to optimize Image Assets with Public CDN Links in IntelligenceBank CMS Connectors here.
- 'https://ucprod.intelligencebank.com/app/?app=optimizely_no_public' - this will surface the ability to download your IntelligenceBank platform assets from the connector. In that instance, assets are physically copied into your Optimizely assets library, and updates to the original asset in IntelligenceBank are not pushed to any location where the local copy is used.
- 'https://ucprod.intelligencebank.com/app/?app=optimizely_public' - this will surface the ability to insert your IntelligenceBank platform assets as Public CDN links from the connector. In that instance, assets are not physically copied into your Optimizely instance. Any update to the original asset in IntelligenceBank will get automatically pushed to any location where the Public CDN link is used.
- Under 'customURL', select 'true' if your IntelligenceBank platform has a custom URL, and you want to configure the IntelligenceBank Connector to load with that option pre-selected.
- Under 'platformURL', provide either your platform 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, and you want to configure the IntelligenceBank Connector to load with that value by default.
- Under 'enableBrowserLogin', select 'true' if your IntelligenceBank platform has Single Sign On enabled, and you want to configure the IntelligenceBank Connector to load with that option pre-selected.
Admin Settings
In complement or as an alternative to modifying the 'markupbutton.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 IntelligenceBank Connector, you will therefore need to add an Editorial Block to your page layout. If you already have Editorial Blocks setup, the IntelligenceBank option will now automatically appear there as a new option.
Upon clicking on IntelligenceBank within the Editorial Block, the IntelligenceBank 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 the 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.
Future:
- Support for surfacing the IntelligenceBank DAM Connector and assets from a dedicated custom Content Block.
Comments
0 comments
Please sign in to leave a comment.