Dev guideRecipesAPI ReferenceChangelog
Dev guideRecipesUser GuidesNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
Dev guide

Prerequisites for Optimizely Graph

Understand the platform, service, and configuration prerequisites that Optimizely Graph needs to work with other Optimizely Products

To use Optimizely Graph with your Content Management System (CMS) environment, ensure you have the correct configuration and access in place before getting started.

Applications of Graph

Optimizely Graph service is included or available as an add-on depending on your CMS service. If you choose to host CMS on-prem, Graph can be used but it is hosted by Optimizely and cannot be hosted on-prem.

You must run one of the following:

  • CMS 13 – Graph is included.
  • CMS 12 – Graph is available as an add-on and is also included with the Frontend Hosting add-on.
  • CMS SaaS – Graph is included.

Service enablement

Install the Optimizely Graph synchronization package in your CMS project. This package:

  • Connects your CMS instance to the Graph service.
  • Transforms and indexes content for Graph.

During onboarding, you receive an authentication key. Use this key to send queries to the GraphQL API.

Content synchronization

Ensure your system synchronizes content before sending queries. Synchronization can be:

  • Scheduled.
  • Triggered automatically when content is published.

Maintaining up-to-date synchronization ensures that the data in the Graph remains current.

Use with Commerce Connect

If you integrate with Commerce Connect, you need additional configuration to sync catalog data, pricing, and inventory.

Once the Graph service is installed, configured, and content is synchronized, you can start writing queries and integrating content delivery into your applications.