Rules & XDM events

Prerequisites for this tutorial

Before starting this tutorial, please read and follow the steps in the sample XDM implementation tutorial, including downloading the sample application and setting up the required fields.

Attach data to XDM events

Update the Product reviews schema

  1. In the browser, navigate to Adobe Experience Platform and login with your credentials.

  2. Update the previously created Product reviews schema created by adding two new fields.

    • From the left panel, select Schemas and then select the Product reviews schema you have created for the previous assignment.

    • Select the Product review field group.

    • Select the plus icon + next to the schema name and add the following fields. Click Apply after each field added.

      Field name

      Display name

      Type

      Required

      ratingSource

      Rating Source

      String

      No

      ratingDate

      Rating Date

      DateTime

      No

    • Click Save to update the schema.

Create a mobile rule in Adobe Experience Platform Launch

  1. Navigate to Adobe Experience Platform Launch and select the mobile property you created in the previous assignments.

  2. Click on Extensions from the left panel and update the Adobe Experience Platform Edge extension to latest version.

  3. Click on Data elements from the left panel and the following data elements:

    1. Create App ID data element:

      • Click on the Create New Data Element button.

      • Select the Mobile Core Extension and App ID Data Element Type.

      • Set the name for this data element to App ID and click Save.

    2. Create Operating system version data element:

      • Click on the Add Data Element button.

      • Select the Mobile Core Extension and OS Version Data Element Type.

      • Set the name for this data element to Operating system version and click Save.

    3. Create Event timestamp data element:

      • Click on the Add Data Element button.

      • Select the Mobile Core Extension and Adobe Experience Platform Timestamp Data Element Type.

      • Set the name for this data element to Event timestamp and click Save.

  4. Click on Rules from the left pannel and create the following rule:

    • Click Create New Rule.

  5. Click on the + Add button in the Events section.

    • Select Adobe Experience Platform Edge for Extension.

      • Select AEP Request Event.

      • Click on the + button to Add XDM Event Type.

      • Select XDM Event Type equals product.review.

      • Click Keep Changes.

  • Click on the + Add button in the Actions section.

    • Select Mobile Core from the Extensions drop-down and Attach Data as Action type.

    • In the JSON Payload box, add the following content and modify _tenantId to the org identifier found in the Product reviews schema:

      {
      "xdm": {
      "_tenantId": {
      "ratingDate": "{%%Event timestamp%%}",
      "ratingSource": "MobileApp {%%App ID%%} OS {%%Operating system version%%}"
      }
      }
      }
    • Note that the previously created three data elements are used here to populate the ratingDate and ratingSource XDM fields.

      • Click Keep Changes.

      • Set a name and click Save to keep the rule.

  • Publish the new data elements and rule created:

    • Click on Publishing Flow from the left panel.

    • Select the development library and click + Add All Changed Resources.

    • Click Save & Build for Development.

The rules configured in Adobe Experience Platform Launch for mobile properties are executed on the client-side mobile application by the AEP Rules Engine extension.

Test with the sample application

Run the Sample app in a simulator or a device and generate product review XDM events:

  • In the sample app, navigate to the Edge tab.

  • Select a product, add the review information and click Submit Review.

  • In the console log search for this log message - Attaching event data (iOS) / New EventData for Event (Android) and check that ratingDate and ratingSource were attached correctly.

  • Verify if the logging messages are intuitive and descriptive for the use-case you are testing.

Validate the event data with AEP Assurance

Connect to an Assurance Session to inspect that the Adobe Experience Platform Request Event has the correct data. To set up an Assurance session with the Sample app, follow the steps in the using Adobe Experience Platform Assurance guide.

  • Once connected to Project Griffon, search for the Adobe Experience Platform Request Event in your session.

  • Check that the XDM data for the product.review event is correctly updated with the two new fields ratingDate and ratingSource.

Extra credit: Update rule/add new rule of your choice

Add a new rule in Adobe Experience Platform Launch or update the one created in the previous steps. Then validate that the rule was correctly executed for your use case using Adobe Experience Platform Assurance and/or Mobile SDK logging.

Next steps

Find more details about the Adobe Experience Platform Mobile SDK Rules Engine and the supported rule types, please read the Rules Engine documentation and the Rules Engine GitHub.

For more rules examples in Adobe Experience Platform Launch, see the following links: