Getting started with the Web SDK tag extension

Use Adobe Experience Platform’s tags (formerly Launch) to send event data from your website to the Edge Network and downstream Adobe solutions.

Before following these steps, make sure that you can access the following property rights:

  • Develop
  • Manage extensions

In addition, ensure that you have all permissions under the following categories:

  • Data modeling
  • Identities

Create an XDM schema schema

The Experience Data Model (XDM) is an open-source specification that provides common structures and definitions for data in the form of schemas. Configuring a schema is highly recommended when sending data to the Edge Network.

  1. Log in to experience.adobe.com using your Adobe ID credentials.
  2. Navigate to Data Collection > Schemas.
  3. Select Create schema.
  4. Select Experience Event, then select Next.
  5. Give the schema a desired name, then select Finish.
  6. (Optional) You can add more fields or field groups for any additional data that you want to collect.

Schema canvas

NOTE
Once saved, schemas only allow additive changes. See schema evolution for more information.

Create a datastream datastream

A Datastream is a configuration that tells the Edge Network how to handle the data that you send it. When you configure a datastream to send data to a given product, the datastream automatically passes along relevant data to each respective product in a way that specific product understands.

  1. Navigate to Data Collection > Datastreams.
  2. Select New datastream.
  3. Give the datastream a desired name, and select the recently created schema under Mapping schema.
  4. Select Save.

Datastreams list

Create a tag property

Once you have created a schema and a datastream, you can create and configure a tag property.

  1. Navigate to Data Collection > Tags.
  2. Select New property.
  3. Give the tag property a desired name and domain, then select Save.

Install the tag extension

The Web SDK tag extension is installed on a given tag property.

  1. Navigate to Data Collection > Tags > Extensions.
  2. Select the Catalog tab.
  3. Use search to locate the Adobe Experience Platform Web SDK extension.
  4. Select the extension card, then select Install on the right.

Install SDK

Configure the tag extension

When you install the Web SDK tag extension, you are automatically taken to the Configuration page.

  1. Under the Datastreams section, select the desired datastream for each environment.

All other configuration settings are either filled out for you or optional. Set any desired configuration settings, then select Save.

Create a variable data element

Adobe recommends using Variable data elements to store the payload that you want to send to Adobe. XDM objects are also available data elements, but are older and more limited in applicable use cases.

  1. Navigate to Data Collection > Tags.

  2. Select the desired tag property.

  3. Select Data elements > Create new data element.

  4. Give the data element the following properties on the left:

    • Name: Any desired name
    • Extension: Adobe Experience Platform Web SDK
    • Data element type: Variable
  5. Set the following properties on the right:
    Variable type: XDM
    Sandbox: The sandbox that you created your schema in
    Schema: The desired schema

  6. Select Save.

Create a rule

Rules determine when you want to trigger something or set variables. Creating a rule that runs whenever the library is loaded allows you to easily populate variables that you want to contain a value on every page.

  1. Navigate to Data Collection > Tags.

  2. Select the desired tag property.

  3. Select Rules > Add rule.

  4. Give the rule a desired name.

  5. Select the ‘+’ icon next to Events.

  6. Give the event the following settings:

    • Extension: Core
    • Event type: Library loaded (page top)
  7. Select Keep changes.

The above steps establish the criteria part of the rule, which is to trigger once the library loads. The following steps establish the action to taken when that criteria is met.

  1. Select the ‘+’ icon next to Actions.

  2. Give the action the following settings on the left:

    • Extension: Adobe Experience Platform Web SDK
    • Action type: Send event
  3. Set the following fields on the right:

    • XDM: The XDM variable data element
  4. Select Keep changes.

Action config

Publish

The tag property contains all components necessary to send data to the Edge Network.

  1. Navigate to Data Collection > Publishing flow.
  2. Select Add library.
  3. Give the library a desired name. Consider this name similar to a commit name when working in version control software.
  4. Set the environment drop-down menu to Development.
  5. Select Add all changed resources.
  6. Select Save & build to Development.

Your changes are now deployed to your development environment.

  1. Navigate to Data Collection > Environments.
  2. Select the install icon next to the Development environment
  3. Install the embed code within a test web page on your site.

Once you validate that the tag works on your devlopment environment, you can use the Publishing flow interface to publish the library to staging, then eventually to production.

  1. Add the extension and rule to a Library, build it to an Environment, and install the embed code on your site.
  2. Validate with Adobe Experience Platform Debugger.

You now have a lean setup that captures events and sends them to the Edge Network. You can now further build up your implementation by adding fields to your schema, adding products to a datastream, or adding data elements to your tag property.

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743