How to get ready to migrate from the Batch MEP to the CEP?

Follow these steps to prepare your upgrade from the Batch Mobile Engagement Platform (MEP) to the Batch Customer Engagement Platform (CEP).

The Customer Engagement Platform (CEP) provides enhanced capabilities, improved performance, and a more powerful approach to managing your customer engagement strategies. Ensuring these prerequisites are met will facilitate a smooth transition and enable you to leverage the full potential of the Batch CEP.

Learn more about how to differentiate the Batch CEP and MEP on this page.

• Please carefully review all sections relevant to your Batch usage and complete the necessary actions before requesting the CEP activation from our teams.

• This guide provides an extensive overview, but it might not be exhaustive. Please make sure that everything important to you will be available on the CEP. If you’re unsure, don’t hesitate to contact us!

1. SDK version

The Batch CEP relies on newer versions of the Mobile and Web SDKs to support its advanced features and ensure optimal performance.

• Upgrade your mobile apps with the Batch Android and iOS SDKs latest version. Refer to our SDK changelog: iOS / Android / Flutter / React Native / Cordova

Version 2 of the Batch mobile SDK is compatible with the CEP, apart from the new Mobile Landing and In-App v2 features. Upgrade to version 3 to be able to use the new In-App and Mobile Landings features.

• Upgrade your websites with the Batch SDK version 4.0.0 or higher, following the dedicated update guide: Migrating from v3

2. Tagging plan: cross-platform matching

When migrating to the CEP, your apps and websites will be grouped into omnichannel projects. Data must be consistent across the different apps and websites to ensure omnichannel features work smoothly.

An omnichannel project can contain a maximum of 1 Android app, 1 iOS app, and 1 website.

• Use the same Custom User ID across all platforms (Android, iOS, Web) of the same project to consistently identify users.

• Ensure consistency of the tagging plan tracked via the Batch SDKs and APIs across all platforms (Android, iOS, Web) of the same project. This means that custom attributes and events need to be sent:

  • With the exact same name

  • With the same additional data for events (consistent keys and value structures)

  • With the same data type (String, Integer, Boolean, etc.).

Ensure you test the data collection carefully using the Debug feature on the Batch dashboard.

3. APIs

To ensure full compatibility with the CEP, apply the adjustments detailed below to the MEP APIs you are currently using.

Remember to keep the MEP APIs running as long as you still need them during the migration phase.

Transactional & Partner APIs

If you are using the Transactional API (or its variant, the Partner API), we recommend switching from the Transactional API to the Profile API. This will especially allow your marketing teams to edit the content of these transactional messages without relying on your back-end teams.

This option is not applicable yet if you are targeting Installation IDs with the Transactional API. It will be available soon.

In any case, the Transactional API is fully compatible with the CEP. Simply note that it relies on the Batch v1 Data Model, so exporting Events (push_sent, push_open, etc.) related to sendings done with this API will still be done using the MEP Export API.

Campaigns API

• If you are using the MEP Campaigns API, you need to upgrade to the CEP Campaigns API to send push notifications on the CEP data model.

In-app Campaigns API

• The migration to the CEP of your use cases relying on the In-app Campaigns API will depend on your specific usage. Contact us so that we can review your needs and define the best approach together.

Custom Audience API

• If you are using the MEP Custom Audience API, you need to upgrade to the CEP Audiences API so that the resulting audiences are usable on the CEP.

This option is not applicable if you are sending Installation IDs with the MEP Custom Audience API. In this case, contact us so that we can review your needs and define the best approach together.

Custom Data API

The Custom Data API is fully compatible with the CEP, except in one specific case: if you are using the overwrite: true parameter, API calls are skipped for the data integration into the CEP.

• To ensure proper data ingestion, we recommend setting the overwrite parameter to false. For more details, refer to the Custom Data API documentation.

• You should also consider moving to the Profile API to send data to all platforms (iOS, Android, Web) of your omnichannel project within a single API call.

Once the CEP is activated for your account, you will need to do a one-shot API call to send all attributes again for all users so that they are available for the CEP usage.

App Data API

• The migration to the CEP of your use cases relying on the App Data API will depend on your specific usage. Contact us so that we can review your needs and define the best approach together.

GDPR API

The GDPR API is fully compatible with the CEP, without any additional action on your side.

Export API

• If you are using the MEP Export API, you need to upgrade to the CEP Exports API to export data from the CEP data model (profiles data).

Webhooks

• The migration to the CEP of your use cases relying on the Webhooks will depend on your specific usage. Contact us so that we can review your needs and define the best approach together.

Trigger Events API

The Trigger Events API is fully compatible with the CEP, without any additional action on your side.

4. Additional features

Custom Exports

You may have set up custom exports to receive files from Batch on external storage that you manage (such as SFTP, S3, AWS, etc.).

There are two types of exports:

• Userbase exports: These are fully compatible with the CEP.

• Events exports: These must be updated to ensure compatibility with the CEP. We recommend switching from these flat file exchanges to the CEP Exports API so that you are fully autonomous for the setup and maintenance of these data flows. If that's not an option on your end, please contact us to schedule the update of these flat file exchanges.

CSV audience importer

You may have requested from Batch to set up a custom script to import audiences from files that you drop on external storage that you manage (such as SFTP, S3, AWS, etc.).

• This feature must be updated to ensure compatibility with the CEP. We recommend switching from this custom script to the CEP Audiences API so that you are fully autonomous for the setup and maintenance of these data flows. If that's not an option on your end, please contact us to schedule the update of the script.

Editorial Dashboard

• The migration to the CEP of your use cases relying on the Editorial dashboard will depend on your specific usage. Contact us so that we can review your needs and define the best approach together.

5. Third-party integrations

You may have configured connections between Batch and our partners' solutions (Analytics, CDP, etc.).

• Establish the list of connectors you are willing to upgrade, and contact us to get the upgrade steps.

Event dispatchers (used to connect the Batch mobile SDK with external Analytics tools) are compatible with the CEP, without any additional action on your side.

Next Steps

Once you have performed the necessary checks and updates:

1. Test: After making changes, especially SDK updates and data format adjustments, test your app extensively. Pay close attention to data collection across all relevant platforms (iOS, Android, Web).

   • How to test the integration on Android?

   • How to test the integration on iOS?

2. Inform us: Reach out to us to confirm that you have completed the prerequisite actions, and we will work with you to schedule the migration of your account to the CEP.

If you have any questions about any of the steps outlined above, feel free to reach out to us via your dedicated Customer Success Manager or [e-mail].