How to migrate your mobile application from SDK v4 to Adobe Experience Platform SDK sdkv4-migration
Support for the Adobe Experience Platform Mobile version 4 SDKs has ended as of August 31, 2021. If you are still using this legacy version of the SDK, you must update your implementation with Adobe Experience Platform SDK before end of June 2024. Learn how to migrate to Adobe Experience Plaform SDK in this article.
About the SDK V4 migration
Adobe Campaign Standard processes mobile applications using SDK V4 as separate applications from those using Adobe Experience Platform SDK.
After upgrading the Adobe SDK version from v4 to Adobe Experience Platform, mobile applications need to continue using existing application subscriber data and campaigns: a migration is therefore needed.
Migrate your mobile application from SDK v4 to Adobe Experience Platform SDK how-to-migrate
Before migrating, you should take into account the following recommendations:
- The migration process is irreversible.
- You should not run migration of multiple application at the same time. You should also make sure the migration of a same application is not triggered by multiple windows at the same time.
- Before migration make sure that you are assigned the Organizational unit of the mobile application you want to migrate and of the Adobe Experience Platform application you are using for migration.
- After migration, the application will become an Adobe Experience Platform SDK application. Its changes will be linked to its corresponding tag Mobile Property.
-
Create a new Mobile property in the Data Collection UI. For more information on this, refer to the documentation.
-
In Adobe Campaign Standard, from the advanced menu, select Administration > Application Settings > Workflows and open the syncWithLaunch workflow. Check if the workflow has ended without error.
-
After workflow completion, from the Administration > Channels > Mobile app (Adobe Experience Platform SDK) menu, check if the mobile application is available in Adobe Campaign Standard and is in Ready to Configure state.
-
In Administration > Channels > Mobile app (SDK V4), select the SDK V4 application you want to migrate.
-
Select the Mobile application migration to AEP SDK tab.
-
From the Select AEP SDK mobile application to merge current application with drop-down, select the Adobe Experience Platform SDK mobile application previously created.
-
Click Migrate.
-
From the Migration application window, click Ok.
-
The successful completion window appears, click Go to Adobe Experience Platform SDK Channel list.
-
From the Adobe Experience Platform SDK channel list page, check that your previous V4 mobile application is set to Ready To Configure.
-
Select your mobile application and click Save to complete the migration.
After this migration, subscribers collected by the V4 version of the mobile application and new subscribers collected by the AEP version of the mobile application will be available in the migrated application.
To distinguish the two different types of subscribers, you can add a new custom field of Text type when extending the custom resource Subscriptions to an application (appSubscriptionRcp) as sdkversion or appVersion for example. For more information on how to extend a custom resource, refer to this page.
You will then need to configure the associated tag Mobile property to send this custom field value in the Collect PII call and change your mobile application configuration accordingly.
FAQ faq
Q: In the SDK v4 mobile application, the Mobile application migration to Adobe Experience Platform SDK tab is not visible. tab-not-visible
A: From the advanced menu Administration > Application Settings > Options, check the value of the Enable migration of mobile app from SDK v4 to Adobe Experience Platform SDK option option. It should be set to 1 and enabled by default. Administrator may have disabled it manually.
Q: From the Mobile application migration to Adobe Experience Platform SDK tab, the message No data appears. no-data
A: Only eligible application of your Organizational unit is shown in the list. Please make sure you have the correct Adobe Experience Platform application for the migration. The Property Status of your Adobe Experience Platform application should be set to Ready to Configure and the Mobile app migration status set to Not Migrated.
Q: Why can’t the Adobe Experience Platform SDK application with the Configured Property Status be used for migration? property-status
A: Migration process retains the SDK v4 subscribers and attributes. It only keeps the tag related information from Adobe Experience Platform SDK application. Subscribers and other data from the Adobe Experience Platform SDK application will be lost. To avoid any data loss, only Adobe Experience Platform SDK applications with the Ready to Configure Property Status are eligible for migration.
Q: After the migration, where can I found my previous SDK v4 mobile application? v4-app-not-visible
A: The mobile application after migration will be visible from the advanced menu Administration > Channels > Mobile app (Adobe Experience Platform SDK).
Q: After the migration, where can I found my newly created Adobe Experience Platform SDK application? aep-not-visible
A: The newly created Adobe Experience Platform SDK application used for the migration will not exist as a separate application. Only the migrated SDK v4 application will be available.
Q: If the SDK v4 mobile application Organizational unit is set to A (a child of the Organizational unit ALL) and the Adobe Experience Platform SDK is set to ALL. How can I migrate my mobile application? v4-org-unit
A: Administrators of the Organizational unit ALL will have the rights to manage both mobile applications and will be in charge of the migration.
Q: If the SDK v4 mobile application Organizational unit is set to A and the Adobe Experience Platform SDK application is set to B (a sibling of the Organizational unit A). How can I migrate my mobile application? aep-org-unit
A: Adobe Experience Platform SDK application being the asset of a sibling Organizational unit, the mobile application will not be visible to users of the Organizational unit A. The mobile application will be available to the Administrators of the Organizational unit ALL but we do not recommend these administrators to migrate the mobile application.
In this case, you should move your mobile applications in the same Organizational unit or in an Organizational unit with a parent link.
For more information on Organizational unit, please refer to this section.
Q: From your Adobe Experience Platform SDK mobile application (migrated from your v4 mobile application) page, under the Push channel settings drop-down, no information such as uploaded date/name is displayed for the Android key or iOS certificate no-information-v5
A: The system does not store this information when the SDK V4 mobile application is created. When migrating your SDK V4 mobile application to an Adobe Experience Platform SDK mobile application, your migrated mobile application will not have this kind of information either. As soon as a user will upload a new iOS certificate or Android key, the different details of the key or certificate will be stored and displayed correctly under the Push channel settings drop-down.