From daafbba03bc83618504c509edf33acc6511cfdf1 Mon Sep 17 00:00:00 2001 From: peterikladious Date: Thu, 10 Aug 2023 12:50:20 +1000 Subject: [PATCH 1/5] First release of Unlocking Simulation source documentation --- .../cloud-apps/unlocking-simulation/index.md | 123 ++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md new file mode 100644 index 0000000000..c5657dfed6 --- /dev/null +++ b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md @@ -0,0 +1,123 @@ +# 💥 Segment Partner Source Documentation Template + +--- +title: Unlocking Simulation Source +--- + + +Unlocking Simulation(https://unlockingproducts.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides a way to create realistic simulated Segment events that mirror customer interactions with your application. This can help you analyze user behavior, test various scenarios, and optimize your tracking and analytics setup. + + +This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. + + +This source is maintained by [Unlocking Growth](https://unlockinggrowth.co). For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). + +_**NOTE:** The Unlocking Simulation Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on August 10, 2023. If you are interested in joining their beta program or have any feedback to help improve the Unlocking Simulation Source and its documentation, [let their team know](mailto:support@unlockinggrowth.co)!_ + +## Getting Started + + +1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. +2. Search for "Unlocking Simulation" in the Sources Catalog, select Unlocking Simulation, and click **Add Source**. +3. On the next screen, give the Source a nickname configure any other settings. + + - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname 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 and log in to your Unlocking Simulation account - navigate to Settings > Integrations > Segment Integration and paste the key to connect. + +## Stream + +Unlocking Simulation uses our stream Source component to send Segment event data. It uses server-side (`track`, `identify`, `page`, `group`) 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. + +As part of the simulated events, Unlocking Simulation generates fake userIds and emails and includes them in the relevant traits and track events. + + +## Events + +The events generated into Segment are based on what you configure within Unlocking Simulation. If, for example, you have set up Unlocking Simulation to generate a "Login" event for each new user on a daily basis, then that event will be generated into Segment. + + +> (delete the below sentence and table) +The table below lists events that Unlocking Simulation sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Unlocking Simulation includes the `userId` if available. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Event NameDescription
Email SentEmail was sent successfully
Email OpenedProspect opened the email
Link ClickedProspect clicked the tracking link
Email RepliedProspect replied to the email sent
Email BouncedEmail servers rejected the email
Email UnsubscribedProspect clicked the unsubscribe link
+ +## Event Properties + +Similarly to Events, the Event Properties generated by Unlocking Simulation are entirely based on what you configure within the simulator. All property types are supported. + +> (delete the below sentence and table) +The table below list the properties included in the events listed above. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property NameDescription
`event`Email event type
`userId`Prospect email ID
`email_id`ID of the email
`fromId`Sender email ID
`email_subject`Subject line of the email
`link`URL of the link clicked
+ +## 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](https://segment.com/docs/connections/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 Unlocking Simulation support team](mailto:support@Unlocking Simulation.com). + + +--- \ No newline at end of file From 7623eacae7b0af915aeaca3183b0b36f4c00df5b Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Fri, 11 Aug 2023 15:35:13 +1000 Subject: [PATCH 2/5] Update index.md --- .../cloud-apps/unlocking-simulation/index.md | 69 +------------------ 1 file changed, 1 insertion(+), 68 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md index c5657dfed6..fb874b9371 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md @@ -39,77 +39,10 @@ As part of the simulated events, Unlocking Simulation generates fake userIds and The events generated into Segment are based on what you configure within Unlocking Simulation. If, for example, you have set up Unlocking Simulation to generate a "Login" event for each new user on a daily basis, then that event will be generated into Segment. -> (delete the below sentence and table) -The table below lists events that Unlocking Simulation sends to Segment. These events appear as tables in your warehouse, and as regular events in other Destinations. Unlocking Simulation includes the `userId` if available. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event NameDescription
Email SentEmail was sent successfully
Email OpenedProspect opened the email
Link ClickedProspect clicked the tracking link
Email RepliedProspect replied to the email sent
Email BouncedEmail servers rejected the email
Email UnsubscribedProspect clicked the unsubscribe link
- ## Event Properties Similarly to Events, the Event Properties generated by Unlocking Simulation are entirely based on what you configure within the simulator. All property types are supported. -> (delete the below sentence and table) -The table below list the properties included in the events listed above. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property NameDescription
`event`Email event type
`userId`Prospect email ID
`email_id`ID of the email
`fromId`Sender email ID
`email_subject`Subject line of the email
`link`URL of the link clicked
## Adding Destinations @@ -120,4 +53,4 @@ Log into your downstream tools and check to see that your events appear as expec If there are any issues with how the events are arriving to Segment, [contact the Unlocking Simulation support team](mailto:support@Unlocking Simulation.com). ---- \ No newline at end of file +--- From 0320f9d7b864f851f0bf4fec1ac64abe5fbfa1d3 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Fri, 18 Aug 2023 16:38:16 +1000 Subject: [PATCH 3/5] Update src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-simulation/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md index fb874b9371..9201108595 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md @@ -1,7 +1,7 @@ -# 💥 Segment Partner Source Documentation Template - --- title: Unlocking Simulation Source +id: l5eaZFs2Mj +hidden: true --- From 88fe27889ab2003ed0a6adf0e60753cbe45e2df1 Mon Sep 17 00:00:00 2001 From: ugpeter <89007350+ugpeter@users.noreply.github.com> Date: Fri, 18 Aug 2023 16:39:50 +1000 Subject: [PATCH 4/5] Update src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md Co-authored-by: Thomas Gilbert <64277654+tcgilbert@users.noreply.github.com> --- .../sources/catalog/cloud-apps/unlocking-simulation/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md index 9201108595..87e35e4317 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md @@ -53,4 +53,3 @@ Log into your downstream tools and check to see that your events appear as expec If there are any issues with how the events are arriving to Segment, [contact the Unlocking Simulation support team](mailto:support@Unlocking Simulation.com). ---- From 0352357d0154252c31cfbb495e93fe926c15df48 Mon Sep 17 00:00:00 2001 From: pwseg Date: Thu, 24 Aug 2023 11:13:46 -0500 Subject: [PATCH 5/5] Add Unlocking Simulation Doc --- .../cloud-apps/unlocking-simulation/index.md | 37 ++++++++----------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md index 87e35e4317..3e132f249e 100644 --- a/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md +++ b/src/connections/sources/catalog/cloud-apps/unlocking-simulation/index.md @@ -1,55 +1,50 @@ --- title: Unlocking Simulation Source id: l5eaZFs2Mj +private: true hidden: true --- -Unlocking Simulation(https://unlockingproducts.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) provides a way to create realistic simulated Segment events that mirror customer interactions with your application. This can help you analyze user behavior, test various scenarios, and optimize your tracking and analytics setup. +Unlocking Simulation(https://unlockingproducts.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} lets you create realistic simulated Segment events that mirror customer interactions with your application. This can help you analyze user behavior, test various scenarios, and optimize your tracking and analytics setup. -This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. +This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) 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 [Unlocking Growth](https://unlockinggrowth.co). For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). +[Unlocking Growth](https://unlockinggrowth.co){:target="_blank"} maintains this destination. For any issues with the source, [contact their Support team](mailto:support@unlockinggrowth.co). -_**NOTE:** The Unlocking Simulation Source is currently in beta, which means that they are still actively developing the source. This doc was last updated on August 10, 2023. If you are interested in joining their beta program or have any feedback to help improve the Unlocking Simulation Source and its documentation, [let their team know](mailto:support@unlockinggrowth.co)!_ +> info "Beta source" +> The Unlocking Simulation Source is currently in beta, which means that they are still actively developing the source. If you're interested in joining their beta program or have any feedback to help improve the Unlocking Simulation Source and its documentation, [let their team know](mailto:support@unlockinggrowth.co). ## Getting Started - -1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog) click **Add Source**. -2. Search for "Unlocking Simulation" in the Sources Catalog, select Unlocking Simulation, and click **Add Source**. -3. On the next screen, give the Source a nickname configure any other settings. - - - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname 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). - +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 **Unlocking Simulation** in the Sources Catalog, select Unlocking Simulation, and click **Add Source**. +3. On the next screen, give the source a nickname name and configure any other settings. + - The nickname is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The nickname can be anything, but Segment recommend using something that reflects the source itself and distinguishes amongst your environments (for example, `SourceName_Prod`, `SourceName_Staging`, `SourceName_Dev`). 4. Click **Add Source** to save your settings. -5. Copy the Write key from the Segment UI and log in to your Unlocking Simulation account - navigate to Settings > Integrations > Segment Integration and paste the key to connect. +5. Copy the Write key from the Segment UI and log in to your Unlocking Simulation account. +6. Navigate to **Settings > Integrations > Segment Integration** and paste the key to connect. ## Stream -Unlocking Simulation uses our stream Source component to send Segment event data. It uses server-side (`track`, `identify`, `page`, `group`) 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. +Unlocking Simulation uses the stream source component to send Segment event data. The source uses server-side (`track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts server-side events, as well as in a data warehouse schema that you can query against using SQL. As part of the simulated events, Unlocking Simulation generates fake userIds and emails and includes them in the relevant traits and track events. - ## Events The events generated into Segment are based on what you configure within Unlocking Simulation. If, for example, you have set up Unlocking Simulation to generate a "Login" event for each new user on a daily basis, then that event will be generated into Segment. - ## Event Properties -Similarly to Events, the Event Properties generated by Unlocking Simulation are entirely based on what you configure within the simulator. All property types are supported. - +Similarly to Events, the Event Properties that Unlocking Simulation generates are entirely based on what you configure within the simulator. All property types are supported. ## 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](https://segment.com/docs/connections/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 Unlocking Simulation support team](mailto:support@Unlocking Simulation.com). - +Log into your downstream tools to verify 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](/docs/connections/event-delivery/) tool, and refer to the destination docs for each tool for troubleshooting. +If you experience issues with how events arrive to Segment, [contact the Unlocking Simulation support team](mailto:support@Unlocking Simulation.com). \ No newline at end of file