From d25430407328f4f42e8284f7b43465e93f5e45a3 Mon Sep 17 00:00:00 2001 From: Yang Cheung <83841766+yanghcheung@users.noreply.github.com> Date: Mon, 12 Aug 2024 17:29:42 -0400 Subject: [PATCH 1/7] add One Creation documentation add One Creation documentation --- .../index.md | 4 -- .../catalog/cloud-apps/onecreation/index.md | 58 +++++++++++++++++++ 2 files changed, 58 insertions(+), 4 deletions(-) delete mode 100644 src/connections/sources/catalog/cloud-apps/one-creation-zero-party-data-engagement/index.md create mode 100644 src/connections/sources/catalog/cloud-apps/onecreation/index.md diff --git a/src/connections/sources/catalog/cloud-apps/one-creation-zero-party-data-engagement/index.md b/src/connections/sources/catalog/cloud-apps/one-creation-zero-party-data-engagement/index.md deleted file mode 100644 index 751daeec2b..0000000000 --- a/src/connections/sources/catalog/cloud-apps/one-creation-zero-party-data-engagement/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'One Creation Zero Party Data Engagement Source' -hidden: true ---- \ No newline at end of file diff --git a/src/connections/sources/catalog/cloud-apps/onecreation/index.md b/src/connections/sources/catalog/cloud-apps/onecreation/index.md new file mode 100644 index 0000000000..c3c1398746 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/onecreation/index.md @@ -0,0 +1,58 @@ +--- +title: 'One Creation Source' +--- + +[One Creation](https://www.one-creation.com/){:target="_blank”} provides brands with a Digital Preference Wallet to confirm, collect, and digitize consumer preference data. By seamlessly integrating into every customer touchpoint, the platform enhances services while enforcing consent (including Time-Based Consent) and data sharing rules. + +This is an Event Cloud Source which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. + +This source is maintained by One Creation. For any issues with the source, [contact their Support team](mailto:support@one-creation.com). + +## Getting started + +1. From your workspace's Sources catalog page{:target="_blank”} click **Add Source**. +2. Search for "One Creation" in the Sources Catalog, select One Creation, and click Add Source. +3. On the next screen, give the Source a name configure any other settings. + + The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). + +4. Click Add Source to save your settings. +5. Copy the Write key from the Segment UI. +6. Log in to your [One Creation account](https://app.one-creation.com/admin/integrations?app=segment) - navigate to Settings > Integrations > Segment and paste the key to connect. + +## Stream + +One Creation uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. + +One Creation assigns a unique ID to each user. This ID is passed to Segment as theuserID. The user's email address is included as a trait. + +## Events + +The table below lists events that One Creation sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. One Creation always includes the userId. + +| Event Name | Description | +|------------------|---------------------------| +| Submitted preferences | User responded to a data request campaign | +| Expired data | Data associated with a campaign has expired | +| Extended preferences | User agrees to extending the data associated with a campaign | + +1. When a user responds to an One Creation data request campaign, One Creation sends the user's response to Segment. This is achieved by triggering an `identify` call to create the traits and a `track` call to record the **Submitted preferences** action. Each trait is suffixed with the associated One Creation campaign ID. +2. When a user agrees to extend data usage through an One Creation extension campaign, One Creation triggers an `identify` call to create extended traits suffixed with the associated One Creation campaign ID. Additionally, a `track` call is triggered to record the **Extended preferences** action. +3. When data associated with a campaign expires, One Creation triggers an `identify` call to update traits with the **Expired_** prefix and a `track` call to record the **Expired data** action. + +## Event Properties + +The table below list the properties included in the events listed above. + +| Property Name | Description | +|---------------|-------------| +| campaign.campaignId | ID of the campaign the user responded to | +| campaign.name | name of the campaign the user responded to | + +## Adding Destinations + +Now that your Source is set up, you can connect it with Destinations. + +Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the Destination docs for each tool for troubleshooting. + +If there are any issues with how the events are arriving to Segment, contact the [One Creation support team](mailto:support@one-creation.com). \ No newline at end of file From 1d343fa89eaee1fa47db4a8f258a966da14bc70f Mon Sep 17 00:00:00 2001 From: Yang Cheung <83841766+yanghcheung@users.noreply.github.com> Date: Wed, 14 Aug 2024 08:56:38 -0400 Subject: [PATCH 2/7] Update src/connections/sources/catalog/cloud-apps/onecreation/index.md Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- src/connections/sources/catalog/cloud-apps/onecreation/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/connections/sources/catalog/cloud-apps/onecreation/index.md b/src/connections/sources/catalog/cloud-apps/onecreation/index.md index c3c1398746..3cff91b9ab 100644 --- a/src/connections/sources/catalog/cloud-apps/onecreation/index.md +++ b/src/connections/sources/catalog/cloud-apps/onecreation/index.md @@ -1,5 +1,6 @@ --- title: 'One Creation Source' +id: IB9M67ZWaA --- [One Creation](https://www.one-creation.com/){:target="_blank”} provides brands with a Digital Preference Wallet to confirm, collect, and digitize consumer preference data. By seamlessly integrating into every customer touchpoint, the platform enhances services while enforcing consent (including Time-Based Consent) and data sharing rules. From 12cbca86a75233615802763fe818094822072b22 Mon Sep 17 00:00:00 2001 From: Yang Cheung <83841766+yanghcheung@users.noreply.github.com> Date: Wed, 14 Aug 2024 08:59:51 -0400 Subject: [PATCH 3/7] Update src/connections/sources/catalog/cloud-apps/onecreation/index.md Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- src/connections/sources/catalog/cloud-apps/onecreation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/onecreation/index.md b/src/connections/sources/catalog/cloud-apps/onecreation/index.md index 3cff91b9ab..7896f2894e 100644 --- a/src/connections/sources/catalog/cloud-apps/onecreation/index.md +++ b/src/connections/sources/catalog/cloud-apps/onecreation/index.md @@ -15,7 +15,7 @@ This source is maintained by One Creation. For any issues with the source, [cont 2. Search for "One Creation" in the Sources Catalog, select One Creation, and click Add Source. 3. On the next screen, give the Source a name configure any other settings. - The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev). +- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. OneCreation_Prod, OneCreation_Staging, OneCreation_Dev). 4. Click Add Source to save your settings. 5. Copy the Write key from the Segment UI. From bd9ab00748401dc2f3524315fe5619eccc6378d4 Mon Sep 17 00:00:00 2001 From: Yang Cheung <83841766+yanghcheung@users.noreply.github.com> Date: Wed, 14 Aug 2024 09:00:19 -0400 Subject: [PATCH 4/7] Update src/connections/sources/catalog/cloud-apps/onecreation/index.md Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- src/connections/sources/catalog/cloud-apps/onecreation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/onecreation/index.md b/src/connections/sources/catalog/cloud-apps/onecreation/index.md index 7896f2894e..b34a82aaac 100644 --- a/src/connections/sources/catalog/cloud-apps/onecreation/index.md +++ b/src/connections/sources/catalog/cloud-apps/onecreation/index.md @@ -25,7 +25,7 @@ This source is maintained by One Creation. For any issues with the source, [cont One Creation uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. -One Creation assigns a unique ID to each user. This ID is passed to Segment as theuserID. The user's email address is included as a trait. +One Creation assigns a unique ID to each user. This ID is passed to Segment as the `userId`. The user's email address is included as a trait. ## Events From cf92fe7de1adfc98108828c2ac3b2695d5f8d846 Mon Sep 17 00:00:00 2001 From: Yang Cheung <83841766+yanghcheung@users.noreply.github.com> Date: Wed, 14 Aug 2024 09:03:04 -0400 Subject: [PATCH 5/7] update folder name --- .../catalog/cloud-apps/{onecreation => one-creation}/index.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/connections/sources/catalog/cloud-apps/{onecreation => one-creation}/index.md (100%) diff --git a/src/connections/sources/catalog/cloud-apps/onecreation/index.md b/src/connections/sources/catalog/cloud-apps/one-creation/index.md similarity index 100% rename from src/connections/sources/catalog/cloud-apps/onecreation/index.md rename to src/connections/sources/catalog/cloud-apps/one-creation/index.md From 1b465558b3157b0447521ad8d3f199c57c28a12c Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Tue, 20 Aug 2024 11:49:48 -0400 Subject: [PATCH 6/7] cleanup --- .../catalog/cloud-apps/one-creation/index.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/one-creation/index.md b/src/connections/sources/catalog/cloud-apps/one-creation/index.md index b34a82aaac..46e77397f2 100644 --- a/src/connections/sources/catalog/cloud-apps/one-creation/index.md +++ b/src/connections/sources/catalog/cloud-apps/one-creation/index.md @@ -5,31 +5,31 @@ id: IB9M67ZWaA [One Creation](https://www.one-creation.com/){:target="_blank”} provides brands with a Digital Preference Wallet to confirm, collect, and digitize consumer preference data. By seamlessly integrating into every customer touchpoint, the platform enhances services while enforcing consent (including Time-Based Consent) and data sharing rules. -This is an Event Cloud Source which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations. +This is an Event Cloud Source that can not only export data into your Segment warehouse but also federate the exported data into your other enabled Segment Destinations. This source is maintained by One Creation. For any issues with the source, [contact their Support team](mailto:support@one-creation.com). ## Getting started -1. From your workspace's Sources catalog page{:target="_blank”} click **Add Source**. -2. Search for "One Creation" in the Sources Catalog, select One Creation, and click Add Source. -3. On the next screen, give the Source a name configure any other settings. +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**. +2. Search for "One Creation" in the Sources Catalog, select One Creation, and click **Add Source**. +3. On the next screen, give the source a name configure any other settings. -- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. OneCreation_Prod, OneCreation_Staging, OneCreation_Dev). +- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but Segment recommends using something that reflects the source itself and distinguishes amongst your environments (for example `OneCreation_Prod`, `OneCreation_Staging`, `OneCreation_Dev`). -4. Click Add Source to save your settings. +4. Click **Add Source** to save your settings. 5. Copy the Write key from the Segment UI. -6. Log in to your [One Creation account](https://app.one-creation.com/admin/integrations?app=segment) - navigate to Settings > Integrations > Segment and paste the key to connect. +6. Log in to your [One Creation account](https://app.one-creation.com/admin/integrations?app=segment){:target="_blank”} - navigate to **Settings > Integrations > Segment** and paste the key to connect. ## Stream -One Creation uses our stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. +One Creation uses the Stream Source component to send Segment event data. It uses a server-side (select from `track`, `identify`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. One Creation assigns a unique ID to each user. This ID is passed to Segment as the `userId`. The user's email address is included as a trait. ## Events -The table below lists events that One Creation sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. One Creation always includes the userId. +The following table lists events that One Creation sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. One Creation always includes the userId. | Event Name | Description | |------------------|---------------------------| @@ -37,23 +37,23 @@ The table below lists events that One Creation sends to Segment. These events ap | Expired data | Data associated with a campaign has expired | | Extended preferences | User agrees to extending the data associated with a campaign | -1. When a user responds to an One Creation data request campaign, One Creation sends the user's response to Segment. This is achieved by triggering an `identify` call to create the traits and a `track` call to record the **Submitted preferences** action. Each trait is suffixed with the associated One Creation campaign ID. -2. When a user agrees to extend data usage through an One Creation extension campaign, One Creation triggers an `identify` call to create extended traits suffixed with the associated One Creation campaign ID. Additionally, a `track` call is triggered to record the **Extended preferences** action. -3. When data associated with a campaign expires, One Creation triggers an `identify` call to update traits with the **Expired_** prefix and a `track` call to record the **Expired data** action. +1. When a user responds to an One Creation data request campaign, One Creation sends the user's response to Segment. This is achieved by triggering an Identify call to create the traits and a Track call to record the **Submitted preferences** action. Each trait is suffixed with the associated One Creation campaign ID. +2. When a user agrees to extend data usage through an One Creation extension campaign, One Creation triggers an Identify call to create extended traits suffixed with the associated One Creation campaign ID. Additionally, a Track call is triggered to record the **Extended preferences** action. +3. When data associated with a campaign expires, One Creation triggers an Identify call to update traits with the **Expired_** prefix and a Track call to record the **Expired data** action. -## Event Properties +## Event properties -The table below list the properties included in the events listed above. +The following table lists the properties included in the events listed above. | Property Name | Description | |---------------|-------------| -| campaign.campaignId | ID of the campaign the user responded to | -| campaign.name | name of the campaign the user responded to | +| `campaign.campaignId` | ID of the campaign the user responded to | +| `campaign.name` | name of the campaign the user responded to | -## Adding Destinations +## Adding destinations -Now that your Source is set up, you can connect it with Destinations. +Now that your source is set up, you can connect it with destinations. Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the Destination docs for each tool for troubleshooting. -If there are any issues with how the events are arriving to Segment, contact the [One Creation support team](mailto:support@one-creation.com). \ No newline at end of file +If there are any issues with how the events are arriving to Segment, contact the [One Creation support team](mailto:support@one-creation.com). From c71ecdbc86c33c127a5ad0e057c33a4896d25411 Mon Sep 17 00:00:00 2001 From: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> Date: Tue, 20 Aug 2024 12:00:06 -0400 Subject: [PATCH 7/7] add hidden frontmatter --- src/connections/sources/catalog/cloud-apps/one-creation/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/connections/sources/catalog/cloud-apps/one-creation/index.md b/src/connections/sources/catalog/cloud-apps/one-creation/index.md index 46e77397f2..5e7e157634 100644 --- a/src/connections/sources/catalog/cloud-apps/one-creation/index.md +++ b/src/connections/sources/catalog/cloud-apps/one-creation/index.md @@ -1,6 +1,7 @@ --- title: 'One Creation Source' id: IB9M67ZWaA +hidden: true --- [One Creation](https://www.one-creation.com/){:target="_blank”} provides brands with a Digital Preference Wallet to confirm, collect, and digitize consumer preference data. By seamlessly integrating into every customer touchpoint, the platform enhances services while enforcing consent (including Time-Based Consent) and data sharing rules.