Blog posts by Hieu Nguyen2026-03-04T09:38:12.0000000Zhttps://world.optimizely.com/blogs/hieu-nguyen/Optimizely WorldOptimizely CMS SaaS Migration Tool<h2>Introduction</h2>
<p>Migrating and synchronizing environments in <strong>Optimizely CMS SaaS</strong> can be challenging, especially when working with multiple environments such as development, staging, and production.</p>
<p>Currently, CMS SaaS provides <strong>export/import functionality</strong>, but it does <strong>not yet include built-in tools for comparing or migrating entities between environments</strong>. As a result, developers often need to manually verify whether content types, display templates, or other entities exist in another environment before performing imports. This process can be time-consuming and error-prone.</p>
<p>The <strong>Optimizely CMS SaaS Migration Tool</strong> aims to help address this gap by providing a lightweight interface to compare environments and assist with migration tasks.</p>
<h2>Key Capabilities</h2>
<ul>
<li>
<p>Connect to multiple CMS SaaS environments using OAuth2 (Client Credentials) + CMS APIs</p>
</li>
<li>
<p>Compare <strong>content types</strong> and <strong>display templates</strong> between source and target environments</p>
</li>
<li>
<p>View structured differences to quickly identify missing or mismatched entities</p>
</li>
<li>
<p>Export comparison results as JSON for reference or automation</p>
</li>
<li>
<p>Track environment parity before performing export/import operations</p>
</li>
</ul>
<p>This makes the tool particularly useful for <strong>tracking down differences in content types and display templates</strong> across environments, something that currently requires manual investigation when using the native SaaS tooling.</p>
<h2>Current Status</h2>
<blockquote>
<p><strong>Note:</strong> Content comparison and migration functionality is still under active development. At the moment, the tool should primarily be used to check whether a content item (with the same ID) exists in the target environment rather than relying on it for full content synchronization.</p>
</blockquote>
<h2>Access the Tool</h2>
<ul>
<li>
<p><strong>GitHub Repository</strong><br /><a href="https://github.com/chrno1209/optimizely-cms-saas-migration-tool">https://github.com/chrno1209/optimizely-cms-saas-migration-tool</a></p>
</li>
<li>
<p><strong>Live Deployment (Vercel)</strong> – use instantly in the browser<br /><a href="https://optimizely-cms-saas-migration-tool.vercel.app/">https://optimizely-cms-saas-migration-tool.vercel.app/</a></p>
</li>
</ul>
<h2>Why This Tool Matters</h2>
<p>As members of the <strong>Optimizely community (“Optimizers”)</strong>, many of us are looking forward to <strong>official built-in capabilities for environment comparison and migration</strong> within CMS SaaS. While those features are being developed, tools like this can serve as a helpful interim solution.</p>
<p>This project provides an <strong>alternative approach to visualize differences and verify environment parity</strong>, helping developers reduce manual checks and better manage schema consistency across environments.</p>
<p>If you are working with <strong>Optimizely CMS SaaS today</strong>, this tool may help simplify part of your workflow while we wait for the official platform features to arrive.</p>
<h2>Screenshots</h2>
<p><img class="clickable" style="width: 100%; height: auto;" src="/link/69d8728032d8498fb8a1f0ff48fb277f.aspx" alt="" width="2560" height="1353" /></p>
<p><img class="clickable" style="width: 100%; height: auto;" src="/link/3e4fe90153c64ce195a78dc5c148bb48.aspx" alt="" width="2560" height="1353" /></p>
<p><img class="clickable" style="width: 100%; height: auto;" src="/link/0998194709744c829bb9695128255ce1.aspx" alt="" width="2560" height="1353" /></p>
<p> </p>2026-03-04T09:38:12.0000000ZBlog postSimplify Optimizely CMS Configuration with JSON Schema<p> </p>
<p> </p>
<p>Optimizely CMS is a powerful and versatile platform for content management, offering extensive configuration options that allow developers to fine-tune their applications. However, navigating and correctly setting up these options in <code>appsettings.json</code> can sometimes feel daunting—especially for new developers or those unfamiliar with the full breadth of available settings.</p>
<p>To address this challenge, I’m excited to introduce the <strong>Optimizely JSON Schema.</strong> This schema is designed to streamline the configuration process for developers, providing them with an enhanced, developer-friendly experience in popular IDEs like Visual Studio Code and JetBrains Rider.</p>
<p><img src="/link/f20b7f222812411dbf02bfb8a991a3a2.aspx" alt="" width="1082" height="396" /></p>
<hr />
<h3>Why a JSON Schema?</h3>
<p>When configuring Optimizely CMS, developers rely on <code>appsettings.json</code> to define their application's behavior. While the official <a href="https://docs.developers.optimizely.com/content-management-system/docs/configuration">Optimizely CMS documentation</a> provides thorough information, manually looking up settings and ensuring their correctness can slow down development and increase the risk of errors.</p>
<p>Here’s how the Optimizely JSON Schema helps:</p>
<ul>
<li><strong>Autocomplete Support</strong>: Provides autocomplete suggestions for configuration keys, reducing the need to memorize or constantly refer to external documentation.</li>
<li><strong>Validation on the Fly</strong>: Highlights invalid or unsupported configuration keys and values, ensuring your <code>appsettings.json</code> is always accurate.</li>
<li><strong>Inline Documentation</strong>: Displays descriptions and valid values for settings directly in the IDE, offering context as you type.</li>
<li><strong>Consistent Structure</strong>: Encourages adherence to best practices in structuring and naming settings.</li>
</ul>
<hr />
<h3>Features of the Optimizely JSON Schema</h3>
<ol>
<li>
<p><strong>Comprehensive Coverage of Optimizely CMS Settings</strong><br />The schema encapsulates all documented configuration options for Optimizely CMS, based on the official <a href="https://docs.developers.optimizely.com/content-management-system/docs/configuration">Optimizely Configuration Documentation</a>. More options will be added in future (e.g: eCommerce).</p>
</li>
<li>
<p><strong>IDE Integration</strong><br />It works seamlessly with IDEs that support JSON Schema, such as:</p>
<ul>
<li>Visual Studio Code</li>
<li>JetBrains Rider</li>
<li>Visual Studio</li>
</ul>
</li>
<li>
<p><strong>Quick Start Setup</strong><br />Simply <a href="https://github.com/chrno1209/Optimizely-Json-Schema">download here</a> and reference the schema in your <code>appsettings.json</code> file:</p>
<pre><code class="language-json">{
"$schema": "appsettings-schema.json",
...
}
</code></pre>
</li>
</ol>
<hr />
<h3>Benefits for Developers</h3>
<ul>
<li><strong>Faster Configuration</strong>: Save time with instant suggestions and error-checking.<br /><img src="/link/45709fbc0b914588b37f78e1a6bed474.aspx" alt="Image image.png" /><br /><br /></li>
<li><strong>Error Reduction</strong>: Minimize misconfigurations that could lead to runtime errors.<br /><img src="/link/f19a95cfc24740da96c0c0a04a43492e.aspx" /><br /><br /></li>
<li><strong>Improved Developer Experience</strong>: Eliminate the constant back-and-forth between code and documentation.<br /><img src="/link/96dea71452a349239427eb5c4857f182.aspx" /></li>
</ul>
<hr />
<h3>How to Get Started</h3>
<ol>
<li>
<p><strong>Install the schema</strong>: Head over to the <a href="https://github.com/chrno1209/Optimizely-Json-Schema">GitHub repository</a> to download JSON Schema.</p>
</li>
<li>
<p><strong>Reference the Schema</strong>: Add the schema URL to your <code>appsettings.json</code> file as shown in the example above.</p>
</li>
<li>
<p><strong>Explore Settings</strong>: Start typing in your configuration file to experience the power of autocompletion, validation, and inline documentation.</p>
</li>
<li>
<p><strong>Contribute</strong>: Found an undocumented configuration or want to improve the schema? Feel free to submit issues or pull requests to the GitHub repository.</p>
</li>
</ol>
<hr />
<h3>Release Changes</h3>
<h4>12/12/2024: Initial Schema (Version 1.0)</h4>
<ul>
<li>
<p>Launched the first version of the JSON Schema.</p>
</li>
<li>
<p>Included all major configuration options for Optimizely CMS based on official documentation.</p>
</li>
<li>
<p>Added support for autocomplete, validation, and inline documentation in JSON editors.</p>
</li>
</ul>
<h4>01/10/2025: Refactor and Optimize Schema (Version 1.1)</h4>
<ul>
<li>
<p>Refactored the schema to improve performance and readability.</p>
</li>
<li>
<p>Optimized the structure for better autocomplete suggestions.</p>
</li>
<li>
<p>Enhanced validation rules to catch edge cases and unsupported values more effectively.</p>
</li>
</ul>
<hr />
<h3>Conclusion</h3>
<p>The Optimizely JSON Schema is here to make your life as an Optimizely developer easier. By integrating the schema into your IDE, you’ll spend less time searching through documentation and more time building great experiences with Optimizely CMS.</p>
<p>Feel free to share your feedback and suggestions in the comments below or on the project’s GitHub page. Let’s make working with Optimizely CMS configurations smoother than ever!</p>2024-12-19T07:54:40.0000000ZBlog post