add analytics configuration details to documentation #327

sirugh · 2025-06-12T18:33:57Z

Purpose of this pull request

This pull request (PR) adds reference details for configuring analytics properties in the config.json file.

Associated JIRA ticket

USF-2416

Staging preview

not staged

Affected pages

https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/commerce-configuration/

Links to source code

hlxsites/aem-boilerplate-commerce#523

Signed-off-by: Stephen Rugh <rugh@adobe.com>

src/content/docs/setup/configuration/commerce-configuration.mdx

Co-authored-by: Carlos A. Cabrera <316104+fnhipster@users.noreply.github.com>

jeff-matthews

These may be noob questions, but I wasn't clear on how some of the linked docs relate to the analytics config props.

jeff-matthews · 2025-06-12T20:15:49Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+For type definitions of the analytics configuration properties, see the [storefrontInstance.ts](https://github.com/adobe/commerce-events/blob/main/packages/storefront-events-sdk/src/types/schemas/storefrontInstance.ts) file in the commerce-events repository.
+
+<Callouts>
+1. **analytics.base-currency-code:** The base currency code for the store. See [Currency Setup](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/currency/currency-setup) for details.


This page doesn't appear to exist. Do you mean https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/currency/currency-configuration?

Or https://experienceleague.adobe.com/en/docs/commerce-admin/config/general/currency-setup

Yep - we should fix these broken links. Cursor tried it's best :P

jeff-matthews · 2025-06-12T20:16:55Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+
+1. **analytics.environment:** The environment type (e.g., "Production", "Testing"). See [Cloud Environment overview](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/project/overview#environment-overview) for details.
+
+1. **analytics.environment-id:** The unique identifier for your Commerce Cloud environment. See [Cloud Environment overview](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/project/overview#environment-overview) for details.


What about ACCS? Is tenant ID the same thing?

https://experienceleague.adobe.com/en/docs/commerce/cloud-service/getting-started#access-an-instance

Yes I think so.

jeff-matthews · 2025-06-12T20:19:11Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+<Callouts>
+1. **analytics.base-currency-code:** The base currency code for the store. See [Currency Setup](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/currency/currency-setup) for details.
+
+1. **analytics.environment:** The environment type (e.g., "Production", "Testing"). See [Cloud Environment overview](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/project/overview#environment-overview) for details.


What about ACCS (e.g., sandbox vs production)? Not much in the wayof docs to reference, but here are a couple:

https://experienceleague.adobe.com/en/docs/commerce/cloud-service/overview#simplified-onboarding

https://experienceleague.adobe.com/en/docs/commerce/cloud-service/getting-started#create-an-instance:~:text=Choose%20the-,Environment%20Type,-for%20your%20instance

@shiftedreality maybe you know the difference here between Production and Testing value being provided to this arg.

jeff-matthews · 2025-06-12T20:22:26Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+
+1. **analytics.store-name:** The display name of your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.
+
+1. **analytics.store-url:** The base URL for your store. See [Store URLs](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/store-urls) for details.


What about ACCS? The link goes to a page that has a PaaS only badge.

TBH I thought that maybe we should remove all the links here. We are allowing users a way to dynamically define values used in storefront instance context. That context, hopefully, has documentation about what should be set in a frontend for headless commerce.

We should probably replace links to the Admin Guides with a link to GraphQL query (or queries if we need a different one for ACO).

Right - it's crazy to make someone have to make this themselves. Best thing we could do is automate it for them.

jeff-matthews · 2025-06-12T20:27:50Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+
+1. **analytics.store-code:** The code that identifies your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.
+
+1. **analytics.store-id:** The unique identifier for your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.


On the linked page, I only see info about web site, name, code, and root category. Which one does analytics.store-id map to?

I don't know. It's in the schema. Not sure what it's meant to be :)

I had a chance to dig into the questions around where to find the *-id values for the store, store view and web site entities. Shout out to Russell Albin for clarifying.

These IDs aren't exposed in the Admin UI the same way that other properties are, for example code and name. Apparently, the easiest way to find the ID is to click through an entity in the Admin UI and look at the URL.

Alternatively, you can find the value in the app/etc/config.php file or by running a DB query. However, those alternative methods are not available for ACCS customers.

@sirugh, I saw your internal Slack message this morning asking if we really need the IDs or if we can just rely on code. I think it would be best to get that clarification before proceeding with this PR.

Ideally we don't make non-technical users even aware of any of this :D

Partially why I made the tool to automate config generation (as best it could).

The real question we need to resolve is what exact information is necessary to send in analytics, and how do we (or a merchant) get that info?

jeff-matthews · 2025-06-12T20:31:41Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+
+1. **analytics.store-view-code:** The code that identifies your store view. See [Step 4: Create store views](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-4-create-store-views) for details.
+
+1. **analytics.store-view-id:** The unique identifier for your store view. See [Step 4: Create store views](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-4-create-store-views) for details.


On the linked page, I only see info about store, name, code, and status. Which one does analytics.store-view-id map to?

I don't know. It's in the schema. Not sure what it's meant to be :)

jeff-matthews · 2025-06-12T20:32:39Z

src/content/docs/setup/configuration/commerce-configuration.mdx

+
+1. **analytics.website-code:** The code that identifies your website. See [Step 2: Create websites](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-2-create-websites) for details.
+
+1. **analytics.website-id:** The unique identifier for your website. See [Step 2: Create websites](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-2-create-websites) for details.


On the linked page, I only see info about name, code, and sort order. Which one does analytics.website-id map to?

I don't know. It's in the schema. Not sure what it's meant to be :)

sirugh · 2025-06-13T02:52:22Z

src/content/docs/setup/configuration/commerce-configuration.mdx

-        "base-currency-code": "USD",
-        "environment": "Production",
-        "store-id": 1,
+        "base-currency-code": "{{YOUR_BASE_CURRENCY_CODE}}",


I actually think we should maybe rethink how the data is displayed. I don't like all these placeholders, it feels repetitive. Perhaps we provide an example, then describe them in detail below.

We also have an opportunity here to make a tool that takes an API url, makes a query for these values, and returns the config object exactly as should be saved in config.json, or uploaded to public config.

Something like this? Ignore the keys/values in the screenshot - just a quick poc.

https://da.live/app/adobe-commerce/storefront-tools/tools/config-generator/config-generator

add analytics configuration details to documentation

cedd4d8

Signed-off-by: Stephen Rugh <rugh@adobe.com>

fnhipster approved these changes Jun 12, 2025

View reviewed changes

src/content/docs/setup/configuration/commerce-configuration.mdx Outdated Show resolved Hide resolved

Update src/content/docs/setup/configuration/commerce-configuration.mdx

69410cc

Co-authored-by: Carlos A. Cabrera <316104+fnhipster@users.noreply.github.com>

jeff-matthews added the documentation Improvements or additions to documentation label Jun 12, 2025

jeff-matthews self-assigned this Jun 12, 2025

jeff-matthews reviewed Jun 12, 2025

View reviewed changes

sirugh commented Jun 13, 2025

View reviewed changes

Merge branch 'develop' into analytics-config

4d3d566


		1. analytics.environment: The environment type (e.g., "Production", "Testing"). See [Cloud Environment overview](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/project/overview#environment-overview) for details.

		1. analytics.environment-id: The unique identifier for your Commerce Cloud environment. See [Cloud Environment overview](https://experienceleague.adobe.com/en/docs/commerce-cloud-service/user-guide/project/overview#environment-overview) for details.


		1. analytics.store-name: The display name of your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.

		1. analytics.store-url: The base URL for your store. See [Store URLs](https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/site-store/store-urls) for details.


		1. analytics.store-code: The code that identifies your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.

		1. analytics.store-id: The unique identifier for your store. See [Step 3: Create stores](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-3-create-stores) for details.


		1. analytics.store-view-code: The code that identifies your store view. See [Step 4: Create store views](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-4-create-store-views) for details.

		1. analytics.store-view-id: The unique identifier for your store view. See [Step 4: Create store views](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-4-create-store-views) for details.


		1. analytics.website-code: The code that identifies your website. See [Step 2: Create websites](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-2-create-websites) for details.

		1. analytics.website-id: The unique identifier for your website. See [Step 2: Create websites](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/multi-sites/ms-admin#step-2-create-websites) for details.

add analytics configuration details to documentation #327

Are you sure you want to change the base?

add analytics configuration details to documentation #327

Uh oh!

Conversation

sirugh commented Jun 12, 2025 • edited by jeff-matthews Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request

Associated JIRA ticket

Staging preview

Affected pages

Links to source code

Uh oh!

Uh oh!

jeff-matthews left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sirugh Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sirugh commented Jun 12, 2025 •

edited by jeff-matthews

Loading

sirugh Jun 13, 2025 •

edited

Loading