Xperience by Kentico: Kentico Migration Tool

Description

This repository is part of the Xperience by Kentico Migration Toolkit.

The Kentico Migration Tool transfers content and other data from Kentico Xperience 13, Kentico 12 or Kentico 11 to Xperience by Kentico.

This tool supports migrating a project to Xperience by Kentico over multiple migration runs with built-in and custom data transformations.

Our documentation (Learn portal) includes guides covering the whole upgrade process from Kentico Xperience 13 to Xperience by Kentico, using the Kentico Migration Tool for data migration.

Tip

Refer to our FAQ page for frequently asked questions about the upgrade process, migration tool, and deployment of an upgraded project.

Library Version Matrix

View all project releases.

Xperience Version	Library Version
30.8.0	3.12.0
30.6.0	3.8.0
30.5.1	3.6.0
30.4.0	3.4.0
30.3.1	3.3.0
30.2.0	3.0.0
30.1.1	2.3.0
30.0.0	2.0.0
29.7.0	1.6.0
29.6.0	1.4.0
29.5.2	1.3.0
29.3.3	1.2.0
29.2.0	1.1.0
29.1.0	1.0.0

Dependencies

• ASP.NET Core 8.0
• Xperience by Kentico

Quick Start

Follow the steps below to run the Kentico Migration Tool:

1. Clone or download the source code from this repository.

2. Open the .\Migration.Tool.sln solution in your IDE.

3. Configure the options in the .\Migration.Tool.CLI\appsettings.json configuration file.

   • See Migration.Tool.CLI/README.md - Configuration for details.

4. Build the solution.

5. Open the repository folder in a terminal.

6. Navigate to the output directory of the Migration.Tool.CLI project.

   • .\Migration.Tool.CLI\bin\Debug\net8.0

7. Run the Migration.Tool.CLI.exe migrate command.

   • The following example shows the command with all parameters for complete migration:

     .\Migration.Tool.CLI.exe  migrate --sites --custom-modules --users --settings-keys --page-types --pages --attachments --contact-management --forms --media-libraries --data-protection --countries --custom-tables --members --categories

8. Review the command line output of the tool.

   • The output is also logged to a file logs\log-<date>.txt under the output directory by default.

9. Review the migration protocol output, which provides information about the result of the migration, lists required manual steps, etc.

   • The output file path is found in the Migration.Tool.CLI/appsettings.json configuration file under the MigrationProtocolPath setting.

The data is now migrated to the target Xperience by Kentico instance according to your configuration.

Tip

Follow our step-by-step, code-along walkthrough to practice upgrading the Dancing Goat sample site from Xperience 13 to Xperience by Kentico. It includes video instructions and sample configs, showing environment setup, migration tool use, iterative data migration, and subsequent code changes to render a page in XbyK the same as in KX13.

Full Requirements

This repository contains several README documents containing information necessary for the correct usage of the Kentico Migration Tool.

• Migration CLI - detailed information about the migration CLI, configuration options, instructions related to individual object types, and manual migration steps.
• Usage Guide - information about what kind of projects the Kentico Migration Tool supports.
• Supported Data - lists all available data for migration
• Migration Protocol - provides information about the results of the migration and required manual steps, etc.

When planning an upgrade, note the special considerations for deploying an upgraded project into production for the first time and deploying an upgraded project to SaaS.

Contributing

If you are creating an issue, please provide all available information about the problem or error. If possible, include the command line output log file and migration protocol generated for your Migration.Tool.CLI.exe migrate command.

To see the guidelines for contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Full support by 7-day bug-fix policy.

See SUPPORT.md for more information.

Important

Before submitting a support ticket, please read about the best practices on reporting Kentico Migration Tool and upgrade issues.

Security

For any security issues, see Kentico's SECURITY.md.