DocumentationExperience PlatformTags

Getting started with event forwarding

Last update: Mon Nov 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
NOTE
Adobe Experience Platform Launch has been rebranded as a suite of data collection technologies in Adobe Experience Platform. Several terminology changes have rolled out across the product documentation as a result. Please refer to the following document for a consolidated reference of the terminology changes.

To use event forwarding in Adobe Experience Platform, data must be sent to Adobe Experience Platform Edge Network using one or more of the following three options:

NOTE
The Platform Web SDK and Platform Mobile SDK do not require deployment through tags in Adobe Experience Platform. However, using tags to deploy these SDKs is the recommended approach.

After you send data to Edge network, you can toggle on Adobe solutions to send data there. To send data to a non-Adobe solution, set that up in event forwarding.

Prerequisites

  • Adobe Real-Time CDP Connections, Prime, or Ultimate (Contact your Adobe account team for pricing)
  • Event forwarding in Adobe Experience Platform
  • Adobe Experience Platform Web SDK, Mobile SDK, or Edge Network Server API configured to send data to Edge Network
  • Map data to Experience Data Model (XDM) (This mapping can be done using tags)

Create an XDM schema

In Adobe Experience Platform, create your schema.

  1. Create a schema by selecting Schemas>Create Schema and choosing the XDM ExperienceEvent option.

  2. Give the schema a name and short description.

  3. You can add the “ExperienceEvent web details” field group by selecting Add next to Field Groups.

    note note
    NOTE
    Multiple field groups can be added, if desired.

  4. Save the schema and note the name that you gave it.

For more information about schemas, see Experience Data Model (XDM) System Help.

Create an event forwarding property

In the Tags workspace, create a property of type Edge.

  1. Select New Property.

  2. Name the property.

  3. Choose the “Edge” platform type.

  4. Select Save.

After you create the property, go to the Environments tab for the new property and make
note of the environment IDs. If the Adobe Org used in the datastream differs from the Adobe Org used in event forwarding, you can copy the Environment ID from the Environments tab and paste it when creating a datastream. Otherwise, you can select the environment from a drop-down menu.

Create a datastream

To create your datastream in Adobe Experience Platform, use the Environment ID generated when you created the event forwarding property.

  1. Select Datastreams in the left navigation.

  2. Name the configuration and provide an optional description.
    The description helps to identify configurations in a list of several configurations.

  3. Select Save.

Enable event forwarding

Next, configure Edge Network to send data to event forwarding, and to other Adobe products.

  1. In the Datastreams workspace, select the property you created.

  2. Select the Development, Production, or Staging environment.

    Or, to send data to an event forwarding environment outside the Adobe org, select Switch to Advanced Mode and paste in an ID. The ID is provided when you create a event forwarding property.

  3. Toggle on the necessary tools and configure as required.

    • Adobe Analytics requires a report suite ID.

    • Event forwarding in Adobe Experience Platform requires a property ID and environment ID. This is the publish path for the event forwarding property.

After configuring, make note of the Environment IDs for the new property.

Configure the Platform Web SDK extension to send data to the datastream created previously

Create your property in the Tags workspace, then navigate to Extensions and select the Experience Platform Web SDK extension from the catalog to configure and install it.

See the Web SDK extension documentation for details on configuration options.

Create a tag rule to send data to Platform Web SDK

After the above is in place, build data definitions, rules, and so on, that use event forwarding and tags, but that need only a single request from the page.

Create a page load rule using the Platform Web SDK extension and the “Send Event” action type:

  1. Open the Rules tab, then select Create New Rule.

  2. Name the rule.

  3. Select Events Add.

  4. Add an event by choosing an extension and one of the event types available for that extension, then configure the settings for the event. For example, select Core - Window Loaded.

  5. Add an action using the Platform Web SDK extension. Select Send Event from the Action Type list, select the desired Instance (Alloy instance configured earlier), and then select a data element to add to the XDM Data block within the Alloy hit.

  6. Leave the rest of the settings as default for this example, and select Save.

For another example, you might create a rule that sends the data layer to Edge if the user hovers over a specified button.

Summary

With the following in place, you can now create event forwarding rules to forward data to non-Adobe destinations.

  • Experience Data Model schema (Note the name that you gave it.)
  • An event forwarding property (Keep track of the property ID and environment IDs.)
  • A datastream (Note the environment ID, not to be confused with the environment ID from event forwarding.)
  • A tag property
recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743