Skip to content

Commit

Permalink
Merge pull request #5556 from psin32/cx-studio/source
Browse files Browse the repository at this point in the history 
Cx studio/source
  • Loading branch information
@pwseg
pwseg authored Oct 19, 2023
2 parents c7071ce + 333a6ce commit 4698169
Showing 1 changed file with 182 additions and 0 deletions.
182 changes: 182 additions & 0 deletions src/connections/sources/catalog/cloud-apps/cx-studio/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
---
title: Elastic Path CX Studio Source
id: NC2jsEkA8Y
beta: true
hidden: true
---

[Elastic Path CX Studio](https://www.elasticpath.com/products/cx-studio?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} enables brands to build and deploy hosted storefronts and shoppable landing pages with dynamic personalization powered by your Segment data, all in a no-code visual editor.

This is an [Event Cloud Source](/docs/sources/#event-cloud-sources){:target="_blank"} that can not only export data into your Segment warehouse but also federate the exported data into your other enabled Segment Destinations.

Elastic Path maintains this source. For any issues with the source, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.

> info ""
> The Elastic Path CX Studio Source is currently in beta, which means that they are still actively developing the source. If you are interested in joining their beta program or have any feedback to help improve the Elastic Path CX Studio Source and its documentation, [let the Elastic Path team know](https://support.elasticpath.com/hc/en-us){:target="_blank"}.
## Getting started

1. Navigate to **Connections > Catalog** and make sure you're on the **Sources** tab of the catalog.
2. Search for **Elastic Path CX Studio** in the Sources Catalog, select **Elastic Path CX Studio**, and click **Add Source**.
3. Give the Source a name and configure any other settings.
- The name identifies this source within your workspace, and typically reflects the name of the application. The name can be anything, but Segment recommends that you use something that reflects the source itself and distinguishes amongst your environments (for example, `ElasticPath_Prod`, `ElasticPath_Staging`, or `ElasticPath_Dev`).
4. Click **Add Source** to save your settings.
5. Copy the Write key from the Segment UI and [log in to the Elastic Path CX Studio](https://app.unstack.com/login){:target="_blank"}.
6. Navigate to **Settings > Integrations > Select Segment integration**, and input the Segment write key.

## Stream

Elastic Path CX Studio uses the stream Source component to send Segment event data. It uses a client-side (select from `track`, `identify`, `page`, `group`) method(s) to send data to Segment. These events are then available in any destination that accepts client-side events, and available in a schema in your data warehouse, so you can query using SQL.

The default behavior is for Elastic Path CX Studio to pass the `anonymousId` if user is not logged in or pass `userId` if user is logged in, where `anonymousId` is a session ID generated by Elastic Path CX Studio.

## Events

The following table lists events that Elastic Path CX Studio sends to Segment. These events appear as tables in your warehouse and as regular events in other destinations.

| Event Name | Description |
| ------------------------- | ------------------------------------------------------------ |
| `Products Searched` | User searched for products. |
| `Product List Viewed` | User viewed a product list or category |
| `Product List Filtered` | User filtered a product list or category. |
| `Product Viewed` | User viewed a product details page. |
| `Product Added` | User added a product to their shopping cart. |
| `Product Removed` | User removed a product from their shopping cart. |
| `Checkout Started` | User initiated the order process (a transaction is created). |
| `Checkout Step Viewed` | User viewed a checkout step. |
| `Checkout Step Completed` | User completed a checkout step. |

## Event properties

The property name tables below of the different events list the properties included in the events listed above.

### Browsing events

#### Products searched

| Property Name | Description |
| ------------- | --------------------------------------------------- |
| `query` | Query the user searched with, for example, shirt, jeans, and so on. |

#### Product list viewed

| Property Name | Description |
| ----------------------- | ----------------------------------------------------- |
| `category` | Product category being viewed. |
| `list_id` | Product list being viewed, like search. |
| `products` | Products displayed in the product list. |
| `products.$.brand` | Brand associated with the product. |
| `products.$.currency` | Currency in which product price is shown to customer. |
| `products.$.image_url` | Image url of the product. |
| `products.$.name` | Name of the product being viewed. |
| `products.$.price` | Price of the product being viewed. |
| `products.$.product_id` | Product ID. |
| `products.$.quantity` | Quantity of a product. |

#### Product list filtered

| Property Name | Description |
| ----------------------- | ----------------------------------------------------- |
| `category` | Product category being viewed. |
| `list_id` | Product list being viewed, like search. |
| `products` | Products displayed in the product list. |
| `products.$.brand` | Brand associated with the product. |
| `products.$.currency` | Currency in which product price is shown to customer. |
| `products.$.image_url` | Image url of the product. |
| `products.$.name` | Name of the product being viewed. |
| `products.$.price` | Price of the product being viewed. |
| `products.$.product_id` | Product ID. |
| `products.$.quantity` | Quantity of a product. |

### Core ordering events

#### Product viewed

| Property Name | Description |
| ------------- | ----------------------------------------------------- |
| `brand` | Brand associated with the product. |
| `currency` | Currency in which product price is shown to customer. |
| `image_url` | Image URL of the product. |
| `name` | Name of the product being viewed. |
| `price` | Price of the product being viewed. |
| `product_id` | Product ID. |
| `quantity` | Quantity of a product. |

#### Product added

| Property Name | Description |
| ------------- | ----------------------------------------------------- |
| `brand` | Brand associated with the product. |
| `currency` | Currency in which product price is shown to customer. |
| `image_url` | Image url of the product. |
| `name` | Name of the product being viewed. |
| `price` | Price of the product being viewed. |
| `product_id` | Product ID. |
| `quantity` | Quantity of a product. |

#### Product removed

| Property Name | Description |
| ------------- | ----------------------------------------------------- |
| `brand` | Brand associated with the product. |
| `currency` | Currency in which product price is shown to customer. |
| `image_url` | Image url of the product. |
| `name` | Name of the product being viewed. |
| `price` | Price of the product being viewed. |
| `product_id` | Product ID. |
| `quantity` | Quantity of a product. |

#### Checkout started

| Property Name | Description |
| ----------------------- | ----------------------------------------------------- |
| `currency` | Currency code associated with the transaction |
| `discount` | Total discount associated with the transaction |
| `order_id` | Currency in which product price is shown to customer. |
| `shipping` | Shipping cost associated with the transaction. |
| `tax` | Total tax associated with the transaction. |
| `value` | Revenue ($) with discounts and coupons added in. |
| `products` | Products displayed in the product list. |
| `products.$.name` | Name of the product being viewed. |
| `products.$.price` | Price of the product being viewed. |
| `products.$.product_id` | Product ID. |
| `products.$.quantity` | Quantity of a product. |
| `products.$.sku` | Sku of the product being viewed |

#### Checkout step viewed

| Property Name | Description |
| --------------- | -------------------------------------------------- |
| `checkout_id` | Checkout transaction ID |
| `checkout_step` | Number representing a step in the checkout process |

#### Checkout step completed

| Property Name | Description |
| --------------- | -------------------------------------------------- |
| `checkout_id` | Checkout transaction ID |
| `checkout_step` | Number representing a step in the checkout process |

Note: CX Studio uses properties of these events from the [eCommerce Spec](/docs/connections/spec/ecommerce/v2){:target="_blank"} defined by the Segment doc.

## Identification

Elastic Path CX Studio automatically identifies users in Segment at certain points in their Elastic Path CX Studio session, to optimally connect your data across sessions and connections to other platforms (for example, Commerce Cloud).

### Session initialization

Elastic Path CX Studio initializes your Segment unify stream with an anonymous ID that corresponds to the Elastic Path CX Studio session id. This enables simple continuity of event streams. This session ID is further passed to Commerce Cloud and used to identify backend events with the same anonymous ID, for simple unification of all events in Segment.

### User identification

When a user has filled a form with an email address, that email is used to identify the user in a more permanent way. Specifically, forms with an email address may include any contact form or a checkout form. Checkout forms will identify the user even if abandoned after successfully completing the email field. This allows later retargeting of abandoned sessions.

When a user has registered an account in Elastic Path CX Studio and Commerce Cloud, the user is further identified in Segment with their Commerce Cloud user ID. This provides an additional connection point.

### The role of identification in personalization

Elastic Path CX Studio's Segment-unify personalization tooling is dependent on identity persistence. When a user revisits a session that has previously been identified, profile data can be retrieved from Segment including any augmented audience and trait data, which are referenceable within Elastic Path CX Studio for personalization. Refer to the Elastic Path CX Studio Personalization recipe for more information.

## Add destinations

After you configure your source, you can connect it with destinations. Log in to 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 arrive to Segment, contact the [Elastic Path Support team](https://support.elasticpath.com/hc/en-us){:target="_blank"}.

0 comments on commit 4698169

Please sign in to comment.