Lifecycle for Edge Network
The Adobe Experience Platform Mobile SDK Lifecycle extension enables application lifecycle data collection from your mobile app when using the Adobe Experience Platform Mobile SDK and the Edge Network extension. Use the following steps to set up an application to forward Lifecycle extension data to the Adobe Experience Platform.
Migrating from Analytics to Lifecycle for Edge Network
If you are an existing Mobile Analytics customer and are migrating to the Edge Network or would like more information on how Lifecycle for Edge Network works, please read the Lifecycle for Edge Network migration reference. Here you will find important information about the differences of how Lifecycle works when using Edge Network versus Analytics.
After migrating to Lifecycle for Edge Network from Analytics, the number of events (hits) sent to Adobe Experience Platform may increase and could impact billable events. It is important to understand the changes to Lifecycle for Edge Network by reading the migration reference.
Configure and install Lifecycle for Edge Network
Add AEP Mobile Lifecycle Details field group to your XDM Schema in Adobe Experience Platform
Include the "AEP Mobile Lifecycle Details" field group to the schema defined in your Edge configuration datastream. This field group defines all the data auto-collected by the Lifecycle for Edge Network extension.
Creating an XDM schema is optional if your workflow does not require one. An XDM schema is required for some services, such as Adobe Experience Platform and Data Prep for mapping XDM fields on the server. However, if the datastream only enables the Analytics service, for example, then an XDM schema is not strictly required.
- In Adobe Experience Platform, log in to your organization.
- Under Schemas section, select the Browse tab and search for the schema used in the application's Edge configuration.
- In the Field groups section, select Add.
- Search for AEP Mobile Lifecycle Details. Select it, then select Add field groups.
- Select Save.
Configure the Adobe Experience Platform Lifecycle extension in Data Collection UI
The Lifecycle for Edge Network extension is part of the Mobile Core extension. There is no separate card for the Lifecycle for Edge Network extension in the Extensions Catalog.
The configuration setting "Session Timeout" in the Mobile Core extension configuration is used when collecting Lifecycle session data for Analytics and is not used for the Lifecycle for Edge Network extension.
- In the Data Collection UI, from your mobile property, select the Extensions tab.
- On the Catalog tab, locate or search for the Mobile Core extension, and select Install.
- There are no configuration settings for Lifecycle for Edge Network.
- Select Save.
- Follow the publishing process to update SDK configuration.
In addition, use the following steps to Configure the Edge Network extension.
Configure a Rule to forward Lifecycle data to Platform
The Lifecycle for Edge Network extension dispatches application launch (foreground) and application close (background) events to the Mobile SDK. Create a rule to forward these events to the Adobe Experience Platform Edge Network.
Create a rule
On the Rules tab, select Create New Rule.
Give your rule an easily recognizable name in your list of rules.
In this example, the rule is named "Forward Lifecycle XDM events to Edge Network".
If you do not have existing rules for this property, the Create New Rule button will be in the middle of the screen. If your property has rules, the button will be in the top right of the screen.
Select an event
- Under the Events section, select Add.
- From the Extension dropdown list, select Mobile Core.
- From the Event Type dropdown list, select Foreground.
- Select Keep Changes.
- Under the Events section again, select the plus icon to add another Event.
- From the Extension dropdown list, select Mobile Core.
- From the Event Type dropdown list, select Background.
- Select Keep Changes.
Define the action
- Under the Actions section, select Add.
- From the Extension dropdown list, select Adobe Experience Platform Edge Network.
- From the Action Type dropdown list, select Forward event to Edge Network.
- Select Keep Changes.
Save the rule and rebuild your property
After you complete your configuration, verify that your rule looks like the following:
- Select Save.
- Rebuild your mobile property and deploy it to the correct environment.
Add the Lifecycle extension to your app
Installing Lifecycle for Edge Network is the same as installing Lifecycle for Analytics as there is only a single mobile SDK Lifecycle extension. The Lifecycle APIs for lifecycleStart and lifecyclePause are the same for both Lifecycle workflows. If your application already includes the Lifecycle extension then you are already setup for Lifecycle for Edge Network.
For implementation details, please reference the implementation guide for Lifecycle.
Add Edge Network extension to your app
Use the following steps to add the Edge Network extension to your app.
Optionally, if you are using configuration overrides with your Edge implementation, follow the tutorial Sending configuration overrides using Rules to override the destination for the Lifecycle events.
