Add Lifecycle for Edge migration reference page. #736
Conversation
kevinlind
requested review from
addb,
praveek,
emdobrin,
stcheng-adobe,
calebk1 and
timkimadobe
|
|
||
| ### 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. |
There was a problem hiding this comment.
Should we add link for the XDM schema here?
|
|
||
| <InlineAlert variant="info" slots="text"/> | ||
|
|
||
| If your workflow does not require the creation of an XDM schema, such as when only using the Adobe Analytics service, then this step is optional. |
There was a problem hiding this comment.
Should we add more context to make it more evident, something on these lines:
... such as when only using the Adobe Analytics service and no AEP services ...
Or a note saying schema is required when sending data to AEP or any AEP services/Apps
There was a problem hiding this comment.
I don't want to get into a situation where we list all the services which require a schema as that can change in the future. It looks like, however, that only AEP and Data Prep require a schema. How about I rewrite the info block as
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.
|
|
||
| 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 Lifecycle documentation to learn how to [add Lifecycle to your app](../../home/base/mobile-core/lifecycle/index.md#add-lifecycle-to-your-app) and [register Lifecycle with Mobile Core and add appropriate the Start/Pause calls](../../home/base/mobile-core/lifecycle/index.md#register-lifecycle-with-mobile-core-and-add-appropriate-start-pause-calls). |
There was a problem hiding this comment.
As a note - we're probably moving towards using absolute links instead, since there was some issues with relative links, since it leads to pages breaking (see the Slack thread here: https://adobemobileservices.slack.com/archives/C029J6S76NB/p1734486288166699). I don't think it's of vital importance to update, but just keep this in mind going forwards.
src/pages/edge/lifecycle-for-edge-network/migration-reference.md
Outdated
Show resolved
Hide resolved
src/pages/edge/lifecycle-for-edge-network/migration-reference.md
Outdated
Show resolved
Hide resolved
src/pages/edge/lifecycle-for-edge-network/migration-reference.md
Outdated
Show resolved
Hide resolved
Thanks. I fixed most of the cases but there are two places where I still use "lifecycle" because I'm referring to the "application lifecycle data" (i.e. the data from the Application) and not the Lifecycle extension. |
src/pages/edge/lifecycle-for-edge-network/migration-reference.md
Outdated
Show resolved
Hide resolved
| @@ -9,7 +9,7 @@ keywords: | |||
|
|
|||
| # Lifecycle for Edge Network data | |||
|
|
|||
| When used with the [Edge Network extension](../edge-network/index.md), the following data is collected and sent to Platform on every application launch. An additional [rule in the mobile property](./index.md#configure-a-rule-to-forward-lifecycle-data-to-platform) is required to send Lifecycle data to the Edge Network extension. | |||
| When used with the [Edge Network extension](../edge-network/index.md), the following data is collected and sent to Platform on every application launch. An additional [rule in the mobile property](../lifecycle-for-edge-network/index.md#configure-a-rule-to-forward-lifecycle-data-to-platform) is required to send Lifecycle data to the Edge Network extension. | |||
There was a problem hiding this comment.
For the link here, we don't need to go back up to the ../lifecycle-for-edge-network level, since we're linking to the index within there.
There was a problem hiding this comment.
That link is currently broken the way it is written. I'm finding that linking to an anchor in the "index.md" page isn't working correctly for some reason. When the link is something like ./index.md#anchor it seems to ignore the ./index.md and apply the anchor to the current page. As a workaround, I'm going up a directory level to get it to work. That works when running under yarn dev, and I hope it will work in production too.
In the live docs for Lifecycle for Edge Network data, check the link "rule in the mobile property" in the first paragraph to see the broken link. https://developer.adobe.com/client-sdks/edge/lifecycle-for-edge-network/metrics/
|
|
||
| ## Installing Lifecycle for Edge Network | ||
|
|
||
| The Mobile SDK Lifecycle for Edge Network extension is used together with the Mobile SDK Edge Network extension, and both must be included and registered in an application. A rule is required, however, to forward the Lifecycle events to the Edge Network extension. To configure and install Lifecycle for Edge Network, follow the instructions from the [overview page](../lifecycle-for-edge-network/index.md#configure-and-install-lifecycle-for-edge-network) to set up your XDM schema, add a rule to forward the Lifecycle Application Launch and Application Close events to the Edge Network, add the Edge Network extension to your application, and add Lifecycle and the required API calls to your application if not already done. The Lifecycle for Edge Network does not add any new APIs so application changes to migrate to the Edge Network from Analytics are minimal. To disable Lifecycle for Analytics, simply remove the Analytics extension from your application. |
There was a problem hiding this comment.
This link can also just be ./index.md#configure-and-install-lifecycle-for-edge-network.
Adds a Lifecycle for Edge Network migration from Analytics reference page.
Description
Adds a new page under Lifecycle for Edge Network which attempts to outline the differences between the Lifecycle for Edge Network and Lifecycle for Analytics extensions. Some of the information in this page may be redundant with bits and pieces in other Lifecycle pages, but the idea is to bring all those pieces into a single page and expand on the topics.
The page is linked from the Lifecycle for Edge Network index.md where I added a brief intro to the topic so that it is very clear to readers that this page exists. I've added a link from the Analytics "migrate-to-edge-network.md" page as well.
Please read for content and format. I found I wrote a lot of paragraphs but if the content would be better understood with bullet points or numbered lists let me know. Also let me know if the content is detailed enough as I chose not to do a field by field comparison of the Lifecycle data but instead gave an overview of what types of data are no longer included.
Motivation and Context
We received feedback from some customers stating the changes made to Lifecycle for Edge Network were not clearly documented. This PR attempts for fix that by outlining all the changes between Lifecycle for Edge Network and Lifecycle for Analytics.
What is not covered
There is a separate task to update the Lifecycle install instructions. Those change will be submitted in a separate PR.