Rate this page:
This page lists all the mandatory steps you must perform as part of your migration path implementation to allow customers to successfully migrate their server app data to your cloud app.
We strongly recommend that Marketplace Partners use the checklist of steps on this page to assess the readiness of their migration path.
This section lists the types of migration paths that Marketplace Partners can build for their apps. Identify your migration path type from the following options:
Fully automated app migration path
This type of path:
Partially automated app migration path
This type of path:
An app migration path that's included with the core migration of the Cloud Migration Assistant
This type of path:
Use the Status API to implement the progress reporting feature in your cloud app. The CMA user interface displays the progress of your app migration. This is the only way your customers can check if your server app data has successfully migrated to their cloud site and is ready to use.
Implementing progress reporting allows your cloud app to:
IN_PROGRESS
status at regular intervals of every 10 - 15 minutes to inform the customer that the app migration is running and report on its progress.SUCCESS
status when the app migration is complete.FAILED
status if the app migration has encountered an error and cannot be completed.The status messages sent using the Status API displays in the CMA user interface, on the Migration details screen.
Test the progress reporting in the CMA. If you have not yet published your migration path, you will first need to enable dev mode to test the progress reporting implementation.
After you have tested your migration path, build your app and publish it to Marketplace. At this stage, your migration path availability will still not be displayed to customers.
Use the Marketplace Migrations API to inform customers about the availability of your migration path in the Assess your apps screen of the CMA.
Provide the cloudMigrationAssistantCompatibility
field value to the Marketplace Migrations API.
This field value should indicate the first version of your server app with the automated migration path implementation, published in the previous step.
This is the only value you'll need to provide to the Marketplace Migrations API as your app is fully automated.
The CMA will ask the customers to upgrade their server app to this version before running the migration. Our docs provide more information about how customers interpret the Assess your apps screen .
Use the Status API to implement the progress reporting feature in your cloud app. The CMA user interface displays the progress of your app migration. This is the only way your customers can check if your server app data has successfully migrated to their cloud site and is ready to use.
Implementing progress reporting allows your cloud app to:
IN_PROGRESS
status message at regular interval of every 10 - 15 minutes to inform the customer that the app migration is running and report on its progress.INCOMPLETE
status message when the automated part of the app migration is complete.FAILED
if app migration encountered an error and cannot be completed.The status messages sent using the Status API displays in the CMA user interface, on the Migration details screen.
Test the progress reporting in the CMA. If you have not yet published your migration path, you will first need to enable dev mode first to test the progress reporting implementation.
After you have tested your migration path, build your app and publish it to Marketplace. At this stage, your migration path availability will still not be displayed to customers.
Use the Marketplace Migrations API to inform customers about the availability of your migration path in the Assess your apps screen of the CMA.
As your app is partially automated, you'll need to provide the following field values to the Marketplace Migrations API:
cloudMigrationAssistantCompatibility
: This value should indicate the first version of your server app with the automated migration path implementation, published in the previous step.migrationDocumentation
: This value should link to a page that indicates the manual actions a customer needs to perform after the INCOMPLETE
app migration status message displays in the CMA.Use the Marketplace Migrations API to inform customers about the availability of your migration path in the Assess your apps screen of the CMA.
Provide the cloudMigrationAssistantCompatibility
field value to the Marketplace Migrations API.
This field value should indicate the first version of your server app that can be migrated with the CMA. In some cases, it can be the first version of your app.
As your app is fully automated, this is the only value you'll need to provide to the Marketplace Migrations API.
The CMA will ask the customers to upgrade their server app to this version before running the migration. Our docs provide more information about how customers interpret the Assess your apps screen .
Rate this page: