Install Opal Chat in CMS 13

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

• Use Optimizely Content Management System (CMS 13) in Optimizely Digital Experience Platform (DXP) to use Optimizely Opal with CMS 13.
• Enable Opti ID for your CMS instance.
• Have Opal provisioned at the organizational level. Contact your Customer Success Manager (CSM) to learn more.
• Enable third-party cookies.

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

Install the Optimizely Opal NuGet package

• Install Opal through NuGet.

Connect CMS 13 to Opal

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.
   C#

   services.AddOpalChat();

3. Configure your local environment.

   1. Configure Opti ID login on your local machine. Access the PaaS Portal to extract information.

      

   2. 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"
          }
        }
      }

   3. Configure Opal Chat.

      "Optimizely": {
        "OpalChat": {
          "InstanceId": "THE_SAME_INSTANCE_ID_USED_IN_OPTI_ID_CONFIGURATIONn",
          "ServiceUrl": "https://opal-backend.optimizely.com"
        }
      }

   4. Grant your login username access rights to the CMS instance.

📘

Note

For production environments no additional configuration is required.

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

Associate CMS with Opal

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

   📘

   Note

   Contact Optimizely Support if you need access or role assignment.

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

After you save, your CMS 13 site connects to Opal. See Get started with Optimizely Opal tools for a list of CMS 13 tools you can call from Opal.