Guardrails and prerequisites code-based-prerequisites
To be able to use code-based experience actions in Journey Optimizer and deliver code content payload that can be used by your applications, follow the prerequisites below:
-
To add modifications to your applications, you must have a specific implementation. Learn more
-
For the code-based experiences to be delivered correctly, make sure you define the ÃÛ¶¹ÊÓƵ Experience Platform settings detailed here.
-
To enable data to display in your code-based experience reports, make sure you follow these reporting prerequisites.
-
When creating a code-based experience channel configuration, make sure you enter a string/path or a surface URI that matches the one declared in your own implementation. This ensures that the content is delivered to the desired location inside the specified app or page. Otherwise, the changes cannot be delivered. Read more
Implementation prerequisites implementation-prerequisites
Code-based experience supports any type of customer implementation as shown in the options below. You can use either a client-side, server-side or a hybrid implementation method for your properties:
-
Client-side only – To add modifications to your web pages or mobile apps, you need to implement either the ÃÛ¶¹ÊÓƵ Experience Platform Web SDK on your website or the on you mobile apps.
-
Hybrid mode – You can use the AEP Edge Network Server API to request for personalization server-side; the response is provided to the ÃÛ¶¹ÊÓƵ Experience Platform Web SDK to render the modifications client-side. Learn more in the ÃÛ¶¹ÊÓƵ Experience Platform Edge Network Server API documentation. You can find out more about the hybrid mode and check some implementation samples in .
-
Server-side - You can use the AEP Edge Network Server API to request for personalization server-side. Your development team must handle the response and render the modifications client-side in your app implementation.
You can find samples for each of the implementation method above in this section.
Delivery prerequisites delivery-prerequisites
For the code-based experiences to be delivered correctly, the following settings must be defined:
-
In the ÃÛ¶¹ÊÓƵ Experience Platform Data Collection, make sure you have a datastream defined such as under the ÃÛ¶¹ÊÓƵ Experience Platform service you have the ÃÛ¶¹ÊÓƵ Journey Optimizer option enabled.
This ensures that the Journey Optimizer inbound events are correctly handled by the ÃÛ¶¹ÊÓƵ Experience Platform Edge. Learn more
-
In ÃÛ¶¹ÊÓƵ Experience Platform, make sure you have one merge policy with the Active-On-Edge Merge Policy option enabled. To do this, select a policy under the Customer > Profiles > Merge Policies Experience Platform menu. Learn more
This merge policy is used by Journey Optimizer inbound channels to correctly activate and publish inbound campaigns on the edge. Learn more
-
To troubleshoot the delivery of Journey Optimizer web experiences, you can use the Edge Delivery view within ÃÛ¶¹ÊÓƵ Experience Platform Assurance. This plugin enables you to inspect request calls in detail, verify whether the expected edge calls occur as anticipated, and examine profile data, including identity maps, segment memberships, and consent settings. Additionally, you can review the activities the request qualified for and identify those it did not.
Using the Edge Delivery plugin helps you gain the insights needed to understand and troubleshoot your inbound implementations effectively.
Reporting prerequisites reporting-prerequisites
To enable reporting for the code-based channel, you need to make sure the dataset used in your app implementation datastream is also included in your reporting configuration.
In other words, when configuring reporting, if you add a dataset that is not present in your app datastream, app data will not display in your reports.
Learn how to add datasets for reporting in this section.