Prerequisites for Optimizely Graph

4 min

Confirm the platform, service, and configuration prerequisites before you connect Optimizely Graph to a Content Management System (CMS) environment. Meeting these prerequisites lets the synchronization package push content to Graph and lets applications query content through the GraphQL API without configuration gaps.

Supported CMS versions

Optimizely Graph runs against specific CMS versions. Confirm the CMS version in use before you install the synchronization package, because licensing and packaging differ across versions.

Optimizely Graph is included with the CMS service or available as an add-on, depending on the CMS edition. When CMS runs on-premises, Optimizely hosts Graph in the cloud. Graph does not run on-premises.

Run one of the following CMS versions:

CMS 13CMS 13 – Includes Optimizely Graph.

CMS 12CMS 12 – Offers Optimizely Graph as an add-on. The Frontend Hosting add-on also includes Optimizely Graph.

CMS SaaSCMS SaaS – Includes Optimizely Graph.

Service enablement

Enabling the service connects CMS to Optimizely Graph and gives the application the authentication key it needs to query content. Complete the steps in this section before any other Graph configuration.

Install the Optimizely Graph synchronization package in the CMS project. The package performs the following actions:

Connects the CMS instance to Optimizely Graph.

Transforms and indexes content for Optimizely Graph.

During onboarding, Optimizely issues an authentication key. Use this key to send queries to the GraphQL API.

Content synchronization

Content synchronization keeps the data in Optimizely Graph aligned with the source CMS content. Without an active synchronization, queries return stale data or no data, so confirm the synchronization method before you run queries.

Synchronize content before you send queries. Synchronization runs in one of the following modes:

Scheduled.

Triggered automatically when CMS publishes content.

An active synchronization keeps the data in Optimizely Graph current.

Use with Commerce Connect

Optimizely Graph integrates with Commerce Connect to expose catalog data, pricing, and inventory to GraphQL clients. Apply the additional configuration in this section when the implementation includes Commerce Connect alongside CMS.

For an integration with Commerce ConnectCommerce Connect, apply the additional configuration that syncs catalog data, pricing, and inventory.

After you install Optimizely Graph, complete the configuration, and synchronize the content, start writing queries and integrating content delivery into the application.