Last updated Jul 17, 2023

Rate this page:

Migration Path

App Migration Platform allows Marketplace Partner to manage the migration path for their app displayed inside Assess your apps screen with the introduction of following Marketplace Migration API Fields Marketplace API documentation.

Assess your apps screen

Marketplace Migration API Fields

migrationPath

The migration path shown to the customer is derived from a set of internal calculations performed by the CMAs. The presence of an app migration listener implementation and the version of the app are two such factors that are considered. This field will allow the Marketplace Partners to define the current Migration Path state for the app. Setting a value for this field will directly change the status for the app on the Assess your apps screen.

Possible values:

ValueDescription
MANUALDeclares the App has a Manual process to migrate the data to cloud.
AUTOMATEDDeclares the App has a Automatic process to migrate the data to cloud.
INSTALL_ONLYDeclares the App has no migration process needed, it will work with the core data migrated by CMAs.
DISCARDEDDeclares the App has no Migration Path implemented, and it will never have one.
UNKNOWNDeclares the App has no Migration Path implemented at the moment.

Marketplace Partners will be able to use this new field to provide a link inside the App Assessment screen that will point the user to a public ticket with the current state of the App Migration Path.

For this link to show up, the app must have a specific value for the following fields:

  • migrationPath as UNKNOWN
  • cloudMigrationAssistantCompatibilityRanges as null
  • cloudMigrationAssistantCompatibility as null

cloudMigrationAssistantCompatibilityRanges

Currently, the field cloudMigrationAssistantCompatibility declares the version of the App which has Migration Path implemented. The field cloudMigrationAssistantCompatibilityRanges can be used to describe a set of versions where the App has Migration Path implemented. If no value is provided for this field, CMAs will use the value provided in cloudMigrationAssistantCompatibility to define if the app needs an upgrade or not.

To keep compatibility with previous versions of CMAs, Marketplace Partners should keep updating the value for cloudMigrationAssistantCompatibility, the cloudMigrationAssistantCompatibilityRanges field will only be used if present by CMAs after the versions:

Jira Cloud Migration Assistant: 1.9.7

Confluence Cloud Migration Assistant: 3.4.8

See an example

App can be migrated in any version after 1.0.0

1
2
[
  {
    "start": "1.0.0",
    "end": null
  }
]

App can be migrated in any version between 1.0.0 and 2.0.0

1
2
[
  {
    "start": "1.0.0",
    "end": "2.0.0"
  }
]

App can be migrated in any version before 2.0.0

1
2
[
  {
    "start": null,
    "end": "2.0.0"
  }
]

App can be migrated in any version between the ranges defined

1
2
[
  {
    "start": "1.0.0",
    "end": "2.0.0"
  },
  {
    "start": "4.2.0",
    "end": "5.0.9"
  },
  {
    "start": "8.3.0",
    "end": "9.2.1"
  }
]

Rate this page: