Skip to content

Commit

Permalink
Add guid to add datastream config overrides to edge requests using Ta…
Browse files Browse the repository at this point in the history
…gs for edge based extensions.
  • Loading branch information
addb committed Oct 12, 2023
1 parent e9fe866 commit 707b67a
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 0 deletions.
4 changes: 4 additions & 0 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,10 @@ module.exports = {
title: "Validation",
path: "/documentation/edge-network/validation"
},
{
title: "Datastream Config Override for Edge Based Extensions using Tags",
path: "/documentation/edge-network/datastram-config-override-using-tags"
},
{
title: "Release notes",
path: "/documentation/edge-network/release-notes"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Datastream config override for Edge events using Tags.
description: This guide provides instructions on overriding datastream ID and datastream configuration for Edge Network Requests that are not initiated by the sendEvent API, all accomplished through Tags Rules.
keywords:
- Edge Network
- Datastream config overrides
- Datastream ID override
- Guide
---

# Overriding Datastream ID and Configuration for Edge Network Requests Using Tags Rules

<InlineAlert variant="info" slots="test"/>

Starting with version **2.4.0** of the `Edge` Android extension and version **4.3.0** of the `AEPEdge` iOS extension, the `sendEvent` API now supports optional Datastream overrides. For detailed information, please refer to the [sendEvent API reference](./api-reference.md#sendEvent).

## Utilizing Tags Rules for Datastream Configuration Overrides in Edge-based Extensions

Suppose you are working with an Edge-based extension like "Streaming Media for Edge" and you need to override datastream ID and datastream configuration for Media requests passing through the Edge Network. Follow these steps to achieve that:

1. Navigate to the DataCollection UI and select your mobile property.

2. Add a new rule for your mobile property:

a. Provide a descriptive name for your Rule.

b. Under the "If" section in the "Events" category, add a new Event.

c. In the Event configuration view, set the **Extension** to "Adobe Experience Platform Edge Network" and the **Event Type** to "AEP Request Event." Then, click the plus button to "Add XDM Event Type." For all media requests, set the condition to contain "media" since all media events have types prefixed with "media."

![Sample Event configuration for Rule](./assets/configOverrides/rule-eventConfiguration-edge-typeMedia.png)

d. Save the event configuration and return to the Rule Editor UI.

e. In the "Then" section under "Actions," add a new Action.

f. In the Action configuration view, set the **Extension** to "Mobile Core" and the **Action Type** to "Attach Data."

g. Now, add the JSON payload for your datastream ID override and datastream config override in the following format:

**Payload Format:**

```json
{
"config" : {
"datastreamIdOverride" : "<Your_Datastream_ID>",
"datastreamConfigOverride" : {
"<Your_Config_Key>" : "<Your_Config_Value>"
}
}
}
```

**Sample Payload:**

```json
{
"config": {
"datastreamIdOverride": "SampleDatastreamID",
"datastreamConfigOverride": {
"com_adobe_experience_platform": {
"datasets": {
"event": {
"datasetId": "SampleEventDatasetIdOverride"
}
}
}
}
}
}
```

![Rules Action configuration](./assets/configOverrides/rule-action-attach-configOverride-payload.png)

h. Save the Action configuration and return to the Rule Editor UI. Your rule should look like this:

![File Rules configuration](./assets/configOverrides/final-rule-datastreamConfigOverride.png)

i. Save this Rule, publish the new Tags library with all the changes, and your rule will be set and ready. Now, all Media Edge Requests will be sent with the overridden datastream ID and Datastream Config Overrides.

0 comments on commit 707b67a

Please sign in to comment.