Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Edge] Update docs for Datastream config override feature #427

Merged
merged 23 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ module.exports = {
title: "Validation",
path: "/edge/edge-network/validation"
},
{
title: "Config Override for Edge Based Extensions using Tags",
path: "/edge/edge-network/datastream-config-override-using-tags"
addb marked this conversation as resolved.
Show resolved Hide resolved
},
{
title: "Release notes",
path: "/edge/edge-network/release-notes"
Expand Down Expand Up @@ -739,4 +743,4 @@ module.exports = {
},
plugins: [`@adobe/gatsby-theme-aio`],
pathPrefix: process.env.PATH_PREFIX || '/client-sdks/'
};
};
7 changes: 7 additions & 0 deletions src/pages/edge/edge-network/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ See [MobileCore.resetIdentities](../../home/base/mobile-core/api-reference.md#re

Sends an Experience event to Adobe Experience Platform Edge Network.

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

Starting with `Edge` Android extension version **2.4.0** and `AEPEdge` iOS extension version **4.3.0** onwards, the `sendEvent` API supports optional Datastream overrides. This allows you to adjust your datastreams without the need for new ones or modifications to existing settings. The process involves two steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting with Edge extension version 2.4.0 (Android) and 4.3.0 (iOS), the ...


1. Define your Datastream configuration overrides on the [datastream configuration page](https://experienceleague.adobe.com/docs/experience-platform/datastreams/configure.html).
2. Send these overrides to the Edge Network using the `sendEvent` API.

<TabsBlock orientation="horizontal" slots="heading, content" repeat="2"/>

Android
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="text"/>

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).
addb marked this conversation as resolved.
Show resolved Hide resolved

## Using Datacollection Tags Rules for datastream configuration overrides in Edge based extensions
addb marked this conversation as resolved.
Show resolved Hide resolved

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 go to **Tags** 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."
addb marked this conversation as resolved.
Show resolved Hide resolved

![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:
addb marked this conversation as resolved.
Show resolved Hide resolved

**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.
Loading