Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideRecipesAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

Optimizely Opal

Install the Optimizely Opal app in Optimizely Content Management System (CMS).

Optimizely Opal is an agent orchestration platform that helps you explore complex questions, provides clear answers about the Optimizely platform, and offers instructions with links to relevant articles. Opal automates tasks, surfaces insights, and guides decision-making. Opal adapts its communication style to your technical expertise, helping you work smarter and complete tasks more efficiently.

Prerequisites

  • You must use Optimizely Content Management System (CMS 12) in Optimizely Digital Experience Platform (DXP) to use Optimizely Opal with CMS 12.
  • You must use Opti ID.
  • You must have Opal provisioned at the organizational level. Contact your Customer Success Manager (CSM).
  • You must enable third-party cookies.

See Add-ons platform compatibility for package and version information. 

Install Optimizely Opal NuGet package

Steps to connect CMS 12 to Opal

Create or verify an Opal instance

If your organization already has an Opal instance, you can skip this step.

  1. In Turnstile, open your organization.
  2. Create a new group (if needed).
  3. Within the group, create an Opal instance.
    • The default settings in Properties are sufficient.
  4. If you encounter permission issues, contact Optimizely Support, Technical Support Services (TSS), or your service team.

Configure CMS site

Install and configure the Opal Chat add-on for your CMS site.

  1. Add the following NuGet package to your project.
    Optimizely.Cms.OpalChat
  2. In Startup.cs, register Opal Chat.
    services.AddOpalChat();
  3. Configure environments
  • Production – No additional configuration is required.

  • Local environment – If you want to run the add-on on your local environment, complete the following steps:

    • Configure Opti ID login on your local machine. Access the PaaS Portal to extract information.
    • Copy your Client Id, Client Secret, and Instance Id, and paste them into the configuration as follows.
    "EPiServer": {
      "Cms": {
        "OptimizelyIdentity": {
          "Authority": "https://login.optimizely.com/oauth2/default",
          "InstanceId": "Instance Id",
          "ClientId": "Client Id",
          "ClientSecret": "Client secret"
        }
      }
    }
    
    • Configure Opal Chat:
    "Optimizely": {
      "OpalChat": {
        "InstanceId": "the same instance ID used in Opti ID configuration",
        "ServiceUrl": "https://opal-backend.optimizely.com"
      }
    }
    • Grant your login username access rights to the CMS instance.

After completing the configuration, deploy your CMS site to your PaaS Portal project.

Associate CMS with Opal

CMSOpalCofigure
  1. In your organization's Admin Center, ensure you have the Opal Administrator role.
📘

Note

Contact Optimizely Support or TSS if you need access or role assignment.

  1. From the main menu, select Opal.
  2. Open the Connections tab.
  3. Select the instance associated with your CMS site.
  4. Click Save to complete the association.

When saved, your CMS 12 site is connected to Opal.

Documentation

See Optimizely Opal Chat for CMS 12 for information regarding Opal Chat.