knennigtri / venia-tag-property

Venia/WKND proof of concept for a Tag property

Check out the story behind this project.

Venia Tag Property Project

This is an example web property definition on how to setup a Adobe Expierence Platform Tag (previously Adobe Launch) for an AEM website using WCM core components, CIF core components, and Magento events SDK. This tutorial is valid for the following reference websites:

• Venia with WCM and CIF core components
• WKND with WCM core components

A few general points for this Tag property project:

• When building a launch property, Data Elements should contain any logic to pull values out of the websites's Data Layer. This allows Rule Actions to be freely built without deep knowledge of the data layer.
• Rules can be quickly stubbed out by using data layer events from the ACDL. This allows product experts to quickly build Actions based on these defined events.
• Venia uses several projects to build it's data layer:
  • WCM core components: https://github.com/adobe/aem-core-wcm-components
  • CIF core components: https://github.com/adobe/aem-core-cif-components
  • Magento Events SDK: https://github.com/adobe/magento-storefront-events-sdk
• WKND uses a single project to build it's data layer:
  • WCM core components: https://github.com/adobe/aem-core-wcm-components
• Web Property Extensions used:
  • Core
  • ECID
  • Adobe Client Data Layer
  • Adobe Analytics
  • Adobe Target v2
  • AEP Web SDK
  • Analytics product string

In this documentation:

• Data Elements exposed from the ACDL
• Starter Rules
• Example XDM mappings

Installing the Venia web property

1. Create and Adobe IO project
   1. Add the Experiance Platform Launch API
      1. Generate a public/private key pair
      2. Download the public/private key
   2. Go to Service Account (JWT)
      1. In the top right click Download JSON
      2. Update downloaded file to config.json
   3. Update config.json to include the path to the private.key you downloaded earlier.

   {
     "CLIENT_SECRET": "xxxxxxxxxxxxxxxxxxxxx",
     "ORG_ID": "xxxxxxxxxxxxxxxxxxxxx@AdobeOrg",
     "API_KEY": "xxxxxxxxxxxxxxxxxxxxx",
     "TECHNICAL_ACCOUNT_ID": "[e-mail]",
     "TECHNICAL_ACCOUNT_EMAIL": "[e-mail]",
     "PRIVATE_Key": "path/to/private.key",
     "PUBLIC_KEYS_WITH_EXPIRY": {}
   }

2. Create a new AEP Tag property.
   1. Take note of the PID from the URL: P12341234123123123123
   2. Install these plugins:
      1. Experience Cloud ID
      2. Adobe Client Data Layer
      3. Adobe Experience Platform Web SDK
      4. Adobe Target v2
      5. Adobe Analytics
      6. Adobe Analytics Product String
3. Download venia-property.json
4. Install npm if not already installed
5. Install the AEP tag tool

 npm install -g @knennigtri/aep-tag-tool

1. Import the venia data elements and starter rules into your property:

 aep-tag-tool -c config.json --import venia-property.json -p <yourPID> -DR