From 527383dcdb906670caf5f1be90e0679ee1ed5a58 Mon Sep 17 00:00:00 2001 From: David Stover <56250584+davidmoltin@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:21:01 -0500 Subject: [PATCH 1/3] UTM Source handling --- docusaurus.config.js | 8 +++- static/js/utm-handler.js | 84 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 static/js/utm-handler.js diff --git a/docusaurus.config.js b/docusaurus.config.js index 50b0f77e..48847594 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1329,7 +1329,7 @@ const config = { { to: '/docs/studio/Settings/Domain-Management/Connecting-your-Namecheap-Domain', from: '/docs/cx-studio/Settings/Domain-Management/Connecting-your-Namecheap-Domain'}, { to: '/docs/api/pxm/catalog/get-catalog-by-id', from: '/docs/pxm/catalogs/catalog-configuration/get-all-catalogs'}, { to: '/docs/api/carts/transactions', from: '/docs/commerce-cloud/payments/transactions/get-all-transactions'}, - { to: '/docs/api/pxm/catalog/get-by-context-all-nodes', from: '/docs/pxm/catalogs/shopper-catalog/get-a-hierarchys-nodes'}, + { to: '/docs/api/pxm/catalog/get-by-context-all-hierarchies', from: '/docs/pxm/catalogs/shopper-catalog/get-a-hierarchys-nodes'}, { to: '/changelog/Studio-Release-Notes/Release-190-February-14-2024', from: '/docs/cx-studio/Release-Notes/Release-190-February-14-2024'}, { to: '/changelog/Studio-Release-Notes/Release-190-February-14-2024', from: '/docs/cx-studio/Release-Notes/Release-191-February-27-2024'}, { to: '/docs/api/pxm/products/build-child-products', from: '/docs/pxm/products/pxm-product-variations/child-products-api/build-child-products'}, @@ -1653,6 +1653,12 @@ const config = { }), ], ], + scripts: [ + { + src: '/js/utm-handler.js', + async: true, + }, + ], }; module.exports = config; diff --git a/static/js/utm-handler.js b/static/js/utm-handler.js new file mode 100644 index 00000000..1306820f --- /dev/null +++ b/static/js/utm-handler.js @@ -0,0 +1,84 @@ +// Default UTM parameters +const DEFAULT_UTM = { + utm_source: 'docs', + utm_medium: 'documentation', + utm_campaign: 'elasticpath_docs' +}; + +// Get UTM params from URL if they exist +function getUrlUtmParams() { + const urlParams = new URLSearchParams(window.location.search); + const utmParams = {}; + + ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content'].forEach(param => { + if (urlParams.has(param)) { + utmParams[param] = urlParams.get(param); + } + }); + + return utmParams; +} + +// Store UTM params in sessionStorage +function storeUtmParams(params) { + sessionStorage.setItem('utmParams', JSON.stringify(params)); +} + +// Get stored UTM params +function getStoredUtmParams() { + const stored = sessionStorage.getItem('utmParams'); + return stored ? JSON.parse(stored) : null; +} + +// Add UTM params to a URL +function addUtmToUrl(url) { + try { + const urlObj = new URL(url); + + // Don't modify external URLs + if (!urlObj.hostname.includes('elasticpath.dev')) { + return url; + } + + // Get stored or default UTM params + const utmParams = getStoredUtmParams() || DEFAULT_UTM; + + // Add UTM params to URL + Object.entries(utmParams).forEach(([key, value]) => { + urlObj.searchParams.set(key, value); + }); + + return urlObj.toString(); + } catch (e) { + // Return original URL if invalid + return url; + } +} + +// Initialize UTM handling +function initUtmHandler() { + // Store UTM params from URL if present + const urlUtmParams = getUrlUtmParams(); + if (Object.keys(urlUtmParams).length > 0) { + storeUtmParams(urlUtmParams); + } + + // Add click event listener to handle links + document.addEventListener('click', (e) => { + const link = e.target.closest('a'); + if (link && link.href) { + const modifiedUrl = addUtmToUrl(link.href); + if (modifiedUrl !== link.href) { + e.preventDefault(); + window.location.href = modifiedUrl; + } + } + }); +} + +// Run when DOM is loaded +if (document.readyState === 'loading') { + document.addEventListener('DOMContentLoaded', initUtmHandler); +} else { + initUtmHandler(); +} \ No newline at end of file From 9134a855a750eeeda5813831b4c10845db46d949 Mon Sep 17 00:00:00 2001 From: David Stover <56250584+davidmoltin@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:28:10 -0500 Subject: [PATCH 2/3] Add UTM campaign sources --- docusaurus.config.js | 6 ++++- src/snippets/resourceDOCS.html | 9 ++++++++ static/js/utm-handler.js | 42 +++++++++++++++++++++++++++++----- 3 files changed, 50 insertions(+), 7 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 48847594..877d24b7 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -252,10 +252,12 @@ const config = { { label: "Changelog", to: "/changelog-landing", + datautmcampaign: "changelog", }, { label: "Support", to: "https://support.elasticpath.com", + dataUtmCampaign: "support", }, { type: "search", @@ -266,12 +268,14 @@ const config = { href: "https://www.elasticpath.com/get-in-touch", position: "right", className: "navbar-book-demo", + dataUtmCampaign: "get-in-touch", }, { label: "Free Trial", href: "https://useast.cm.elasticpath.com/free-trial", position: "right", className: "dev-portal-signup dev-portal-link", + dataUtmCampaign: "free-trial", }, ], }, @@ -313,7 +317,7 @@ const config = { }, { label: "GitHub", - href: "https://github.com/facebook/docusaurus", + href: "https://github.com/elasticpath", }, ], }, diff --git a/src/snippets/resourceDOCS.html b/src/snippets/resourceDOCS.html index f89b2bdc..b2f69432 100644 --- a/src/snippets/resourceDOCS.html +++ b/src/snippets/resourceDOCS.html @@ -40,6 +40,7 @@ onmouseover="document.body.setAttribute('docs-menu', 'cm')" class="flex cursor-pointer !mt-2 items-start justify-start gap-2 border-none bg-transparent text-black dark:text-white" href="/ui" + datautmcampaign="commerce-manager" >
{ @@ -67,7 +95,9 @@ function initUtmHandler() { document.addEventListener('click', (e) => { const link = e.target.closest('a'); if (link && link.href) { - const modifiedUrl = addUtmToUrl(link.href); + // Get the campaign type from the data attribute + const campaignType = link.getAttribute('datautmcampaign'); + const modifiedUrl = addUtmToUrl(link.href, campaignType); if (modifiedUrl !== link.href) { e.preventDefault(); window.location.href = modifiedUrl; From 7d15b8ec47c8b18f60a80052f06d46494cae1c4f Mon Sep 17 00:00:00 2001 From: David Stover <56250584+davidmoltin@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:29:57 -0500 Subject: [PATCH 3/3] Updated observable events page --- docs/subscriptions/observable-events.mdx | 47 +++++++++++++++++------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/docs/subscriptions/observable-events.mdx b/docs/subscriptions/observable-events.mdx index d2791b51..8c8e1fb0 100644 --- a/docs/subscriptions/observable-events.mdx +++ b/docs/subscriptions/observable-events.mdx @@ -3,21 +3,40 @@ title: Observable Events nav_label: Observable Events sidebar_position: 100 --- -You can integrate Subscriptions with external systems like enterprise resource planning, fulfilment and other systems. For example, when a subscriber updates their address, the Customer Relationship Management system is updated with the change. -Events are actions that occur in Subscriptions, such as a subscriber changing their address or a subscription changing from active to inactive. You can create custom functions that perform additional processing outside of Subscriptions, and create integrations so that when an event occurs in your store, the custom function is run. +# Observable Events in Subscriptions -Events are processed concurrently. This means that events may not be delivered in the order they are created. For example, if a subscription is updated multiple times, the events may not be delivered in the same sequence they were updated. Events operate on an "at least once" delivery policy. We aim to deliver messages within 30 minutes or less. Ensure that you design your receiving code accordingly. +## Overview +Observable events allow you to integrate Subscriptions with external systems like ERP, fulfillment, and CRM platforms. When specific actions occur within Subscriptions (such as address updates or status changes), these events can trigger custom functions to perform additional processing or update external systems. -For more information about integrating Subscriptions, see [**Integration Types**](/docs/api/integrations/integrations-introduction#integration-types). +## Event Processing Behavior +- Events are processed concurrently and may not be delivered in chronological order +- Events follow an "at least once" delivery policy +- Target delivery time is within 30 minutes +- Integration code should be designed to handle out-of-order and duplicate events -| Resource | Action | Observable Key | Availability | -| --- | --- | --- | --- | -| Product |
  • Created
  • Updated
  • Deleted
|
  • `subscription-product.created`
  • `subscription-product.updated`
  • `subscription-product.deleted`
| Store | -| Plan |
  • Created
  • Updated
  • Deleted
|
  • `subscription-plan.created`
  • `subscription-plan.updated`
  • `subscription-plan.deleted`
| Store | -| Offering |
  • Created
  • Updated
  • Deleted
|
  • `subscription-offering.created`
  • `subscription-offering.updated`
  • `subscription-offering.deleted`
| Store | -| Subscription |
  • Created
  • Create-failed
  • Paused
  • Canceled
  • Pending-cancel
  • Pending-pause
  • Resumed
  • Closed
|
  • `subscription.created`
  • `subscription.create-failed`
  • `subscription.canceled`
  • `subscription.paused`
  • `subscription.pending_cancel`
  • `subscription.pending_pause`
  • `subscription.resumed`
  • `subscription.closed`
| Store | -| Job |
  • Created
  • Updated
  • Deleted
|
  • `subscription-job.created`
  • `subscription-job.updated`
  • `subscription-job.deleted`
| Store | -| Invoices |
  • Created
  • Deleted
|
  • `subscription-invoice.created`
  • `subscription-offering.deleted`
| Store | -| Schedule |
  • Created
  • Updated
  • Deleted
|
  • `subscription-schedule.created`
  • `subscription-schedule.updated`
  • `subscription-schedule.deleted`
| Store | -| Subscriber |
  • Created
  • Updated
  • Deleted
|
  • `subscription-subscriber.created`
  • `subscription-subscriber.updated`
  • `subscription-subscriber.deleted`
| Store | +For detailed information about integration options, see [**Integration Types**](/docs/api/integrations/integrations-introduction#integration-types). + +## Available Events + +### Subscription Management +| Resource | Actions | Observable Keys | +|----------|---------|-----------------| +| Subscription | • Created
• Create-failed
• Paused
• Canceled
• Pending-cancel
• Pending-pause
• Resumed
• Closed | `subscription.created`
`subscription.create-failed`
`subscription.paused`
`subscription.canceled`
`subscription.pending_cancel`
`subscription.pending_pause`
`subscription.resumed`
`subscription.closed` | +| Subscriber | • Created
• Updated
• Deleted | `subscription-subscriber.created`
`subscription-subscriber.updated`
`subscription-subscriber.deleted` | + +### Product Configuration +| Resource | Actions | Observable Keys | +|----------|---------|-----------------| +| Product | • Created
• Updated
• Deleted | `subscription-product.created`
`subscription-product.updated`
`subscription-product.deleted` | +| Plan | • Created
• Updated
• Deleted | `subscription-plan.created`
`subscription-plan.updated`
`subscription-plan.deleted` | +| Offering | • Created
• Updated
• Deleted | `subscription-offering.created`
`subscription-offering.updated`
`subscription-offering.deleted` | + +### Operations +| Resource | Actions | Observable Keys | +|----------|---------|-----------------| +| Job | • Created
• Updated
• Deleted | `subscription-job.created`
`subscription-job.updated`
`subscription-job.deleted` | +| Invoices | • Created
• Deleted | `subscription-invoice.created`
`subscription-invoice.deleted` | +| Schedule | • Created
• Updated
• Deleted | `subscription-schedule.created`
`subscription-schedule.updated`
`subscription-schedule.deleted` | + +> **Note**: All events are available at the Store level.