HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Welcome integration with Content Cloud

This topic describes how to set up Welcome in Content Cloud. (Beta program)

πŸ“˜

Beta

To become part of the beta program for integrating Welcome with Content Cloud, contact customer support.

The Welcome integration with Optimizely Content Cloud consists of two parts that you can use together or separately:

  • DAM Picker that lets an editor select and link resources from the Welcome DAM.
  • An integration with structured content (below) in Welcome that lets a marketer publish content to Content Cloud.

Welcome structured content integration

The Welcome integration with structured content to Optimizely Content Cloud uses primarily the Content Definitions API to read content types and the Content Management API to publish content, but also adds custom endpoints and configuration to Content Cloud through the EPiServer.CMS.WelcomeIntegration.StructuredContent package. The Welcome DAM Library Picker (EPiServer.CMS.WelcomeIntegration.UI) is optional and lets you view and edit assets within Content Cloud.

Both integrations share a Content Repository that is automatically added, that gives the URL to the DAM library a content identity in Content Cloud.

Welcome integration packages

  • EPiServer.CMS.WelcomeIntegration.UI – Adds UI component to make it possible to select assets from Welcome.
  • EPiServer.CMS.WelcomeIntegration.StructuredContent – Adds API endpoints required to publish content from Welcome.
  • EPiServer.CMS.WelcomeIntegration.Core – Shared library, a content provider that can store external links to Welcome.

Prerequisites

  • EPiServer.ContentManagementApi 3.4 or later
  • EPiServer.ContentDefinitionsApi 3.4 or later
  • EPiServer.OpenIDConnect.UI 3.4 or later
  • EPiServer.CMS.Core 12.8.0 or later
  • EPiServer.CMS.UI 12.9.0 or later

Known limitations

  • No block types, only pages
  • Only one language per content item
  • Only English (en) content is supported in Content Cloud
  • One way content push, only Welcome to Content Cloud
  • No automatic update when a content type changes in the Content Cloud
  • Cannot move an item in Welcome after it is published to Content Cloud
  • Cannot import content types with unsupported properties
  • Currently supported property types:
    • PropertyCategory
    • PropertyContentReference
    • PropertyJson
    • PropertyList
    • PropertyPageReference
    • PropertyAppSettings
    • PropertyAppSettingsMultiple
    • PropertyCheckBoxList
    • PropertyContentArea
    • PropertyDropDownList
    • PropertyTimeSpan

Install the integration

  1. Configure the OpenID before proceeding with the next steps. See API Authentication in the Content Delivery API.

  2. Run the following commands in the command-line interface to install the integration:

    $ dotnet add package EPiServer.CMS.WelcomeIntegration.UI
    $ dotnet add package EPiServer.CMS.WelcomeIntegration.StructuredContent
    
  3. In Startup.cs, add the following line in ConfigureServices:

    // method
    services.AddStructuredContentSupport();
    
  4. In Startup.cs, add the following line in Configure after UseAuthentication():

    app.UseStructuredContentPreviewAuthentication();
    
  5. If CORS is not already configured, in Startup.cs, add the following line in Configure after UseRouting():

    app.UseCors();
    
  6. Add an access key to be used in Welcome to communicate with Content Cloud.

    "EPiServer": 
    {
        "Cms":
        {
         "OpenIDConnect" : {
            "Applications" : [
              {
                "ClientId"     : "welcome_integration",
                "ClientSecret" : "<ENTER SECRET>",
                "Scopes"       : [ "epi_content_definitions", "epi_content_management" ]
              }
            ]
          }
        }
    }
    
  7. Go to Admin > Access Rights, select Root and apply the following to welcome_integration: Read, Create, Change, Delete, Publish.


Did this page help you?