Configure datastream overrides

Last update: November 5, 2024

CREATED FOR:

  • Developer

The edgeConfigOverrides object allows you to override configuration settings for commands run on the current page. This override object is not a command, but rather an object that you can include in most Web SDK commands.

This object is useful when you have different websites or subdomains for different countries, or if you have multiple Experience Platform sandboxes to store data specific to different business units.

IMPORTANT
For detailed, end-to-end configuration instructions for datastream overrides, see the datastream configuration overrides documentation.

Datastream configuration override is a two-step process:

  1. First, you must define your datastream configuration override in the datastream configuration page, within the Datastreams UI. See the datastream configuration overrides documentation for instructions on how to configure overrides.

  2. After you have configured the datastream override in the UI, you must send the overrides to the Edge Network in one of the following ways:

If you set overrides both in the Web SDK configuration and in a specific command (such as sendEvent), the overrides in the specific command take priority.

NOTE
If you want a configuration override to disable an Experience Cloud service, you must make sure that the service is first enabled in the datastream configuration. See the documentation on how to configure datastreams for details on how to add services to a datastream.

Send datastream overrides to the Edge Network through the Web SDK tag extension

See the documentation on configuring datastream overrides from the Web SDK tag extension for detailed configuration instructions.

If you want to configure datastream overrides from the Web SDK tag extension, set each desired field under Datastream configuration overrides when configuring the tag extension.

  1. Log in to experience.adobe.com using your Adobe ID credentials.
  2. Navigate to Data Collection > Tags.
  3. Select the desired tag property.
  4. Navigate to Extensions, then click Configure on the Adobe Experience Platform Web SDK card.
  5. Scroll down to the Datastream configuration overrides section. Set each desired override value.
  6. Click Save, then publish your changes.

If you want to set overrides just for a specific command, set each desired field within the actions of a tag rule.

  1. Log in to experience.adobe.com using your Adobe ID credentials.
  2. Navigate to Data Collection > Tags.
  3. Select the desired tag property.
  4. Navigate to Rules, then select the desired rule.
  5. Under Actions, select an existing action or create an action.
  6. Set the Extension dropdown field to Adobe Experience Platform Web SDK, and set the Action Type to Send event.
  7. Scroll down to the section labeled Datastream configuration overrides.
  8. Set each field in this section to the desired override value.
  9. Click Keep Changes, then run your publishing workflow.

Separate fields are provided for Development, Staging, and Production environments. Make sure that you fill in each desired field for each environment.