Index Converter

Index Converter is a utility developed to migrate a customer’s Index Definitions in preparation for the move to AEM as a Cloud Service.

Introduction

The Index Converter allows AEM developers to migrate existing Custom Oak Index Definitions to AEM as a Cloud Service compatible Custom Oak Index Definitions.

There are two ways to create Custom Oak Index Definitions:

• under /apps (through any custom content package)
• directly under /oak:index path

If Ensure Oak Index was used, Ensure Definitions are not supported on AEM as a Cloud Service. As such, they must be converted to Oak Index Definitions first, and then migrated to Custom Oak Index Definitions that are compatible with AEM as a Cloud Service, as per below guidelines:

• If property ignore is set to true, ignore or skip the Ensure Definition
• Update the jcr:primaryType to oak:QueryIndexDefinition
• Remove any properties that are to be ignored as mentioned in OSGi configurations
• Remove subtree /facets/jcr:content from Ensure Definition

Using the Index Converter

• By way of Adobe I/O CLI : It is recommended to use the Index Converter by way of aio-cli-plugin-aem-cloud-service-migration (AEM as a Cloud Service code refactoring plugin for the Adobe I/O CLI).

  See Git Resource: aio-cli-plugin-aem-cloud-service-migration to learn how to install and use the plugin.

• As a standalone utility : The Index Converter can also be executed as a standalone utility.

  See Git Resource: aem-cs-source-migration-index-converter to learn how to use this tool.

Business.Adobe.com resources