Opting Into Adobe Analytics and Adobe Target
- Topics:
- Administering
CREATED FOR:
- Admin
AEM has an opt-in procedure to help you integrate with Adobe Analytics and Adobe Target. This is available out-of-the-box, as a pre-loaded task assigned to the administrator user group.
When you log in as an administrator this task (Configuring Analytics & Targeting) is available from the Inbox. Based on the credentials you supply, it helps you configure and integrate these services.
You have the following options for configuring the integration:
-
Configure the integration via the task.
This can be done either immediately or later, the task will remain in the Inbox until some action is taken. In either case the configuration can be done directly in the UI, or with the use of a pre-defined
.properties
file. -
Opt out of the integration.
Consider this option if you prefer to manually configure the integration. See also Integrating AEM with Adobe Target and Adobe Analytics using DTM.
-
Configure the set up and provisioning by using a script.
Configuring the Integration
Opt into the integration with:
- Analytics to enable the use of their page tracking and analysis capabilities.
- Target to enable the use of their personalization capabilities.
For either option you need to provide the user account information and specify the pages that are tracked.
When you opt into the integration, AEM performs the following tasks:
- Creates the cloud configurations that enable the connection to Analytics and Target.
- Creates the frameworks that determine the data that is tracked.
- Configures the web pages to use these services.
To opt-in from the pre-loaded, out-of-the-box task:
-
From your Inbox, select and Open the Configure Analytics & Targeting task.
-
For Analytics:
- Enter the user account information for Analytics, then click the corresponding Add button.
- The appropriate credentials are authenticated.
- When the Analytics account is authenticated, select the Analytics report suite to use. AEM retrieves those Analytics report suites. The status is updated to Added.
-
For Target:
- Enter the user account information for Target then click the corresponding Add button.
- The appropriate credentials are authenticated. The status is updated to Added.
-
Select Next.
-
Select the sites for which Analytics and/or Target should be used.
-
Select Done to complete.
CAUTION
After you opt into the configuration, you need to publish the affected site/pages to replicate these changes to your publish instance.
Opting Out of the Integration
Opt out of the integration with Analytics and Target when you either:
-
Do not want to integrate with these products.
-
Prefer to configure the integrations manually.
For information about configuring the integrations manually, see Integrating with Adobe Analytics and Integrating with Adobe Target.
To opt out you need to complete the pre-loaded task:
- From your Inbox, select and Complete the Configure Analytics & Targeting task.
Providing Account Information Using a Properties File
Install a properties file that AEM reads on server startup to configure the account properties for the integration with Analytics and Target. When you use the properties file, the opt-in wizard automatically uses the properties from the file and the cloud configuration is created accordingly.
The properties file is a text file named marketingcloud.properties that you save in the working directory that the AEM process is using (typically the same directory as the JAR file). The file includes the following properties:
- analytics.server: The URL of the Analytics data center that you use.
- analytics.company: The company that is associated with your Analytics user account.
- analytics.username: Your Analytics user name.
- analytics.secret: The secret that is associated with your Analytics user name.
- analytics.reportsuite: The name of the Analytics report suite to use.
- target.clientcode: The client code that is associated with your Target account.
- target.email: The email address that you use to authenticate your Target account.
- target.password: The password that is associated with your email address.
Properties and values are separated with equal signs (=). The Analytics properties are prefixed with analytics
, and the Target properties are prefixed with target
. To configure a service, provide values for all of the properties for that service. If you do not want to configure a service, provide no values for that service.
The following example .properties
file includes the property values for creating a cloud configuration for Analytics:
analytics.server=https://test.omniture.com/login/
analytics.company=MyCompany
analytics.username=sbroders
analytics.secret=12345678
analytics.reportsuite=myreportsuite
target.clientcode=
target.email=
target.password=
The following procedure describes how to opt into the integration using the properties file.
-
Create the
marketingcloud.properties
file in the working directory that the AEM process is using (author instance).NOTE
The working directory is usually the directory that holds the jar orlicense.properties
file.However, it can also be defined as an absolute path by the system property:mac.provisioning.file.container
-
Add the property values according to your Analytics and/or Target accounts.
-
Start or restart the server, and then log in using an administrator account.
-
Open the Configure Analytics & Targeting task as described in Configuring the Integration. Instead of requesting your account information, the wizard uses the values from the
.properties
file.Select Add for the appropriate service, then continue with the wizard.
About the Cloud Configurations
When you configure the integration with Analytics and Target, AEM automatically creates the required cloud configurations and frameworks. For example, the Analytics cloud configuration is called Provisioned Analytics Account.
You do not need to alter the cloud configurations. However, you can configure the frameworks as needed. (See Mapping Component Data with Adobe Analytics Properties and Add a Target Framework.)
reportsuite
is selected, then the framework is restricted to the publish run mode. This means that tracking only works on the publish instance.all
.Configuring the Setup and Provisioning via Script
As an administrator, you may want to trigger setup and provisioning with a script rather than manually stepping through the wizard. You can do so by:
- Sending a POST request to /libs/cq/cloudservicesprovisioning/content/autoprovisioning.json with the required parameters.
Which parameters you send depends on the following:
-
If you want to use the marketingcloud.properties file filled in with all the required credentials, then you must send the following parameters:
automaticProvisioning
=true
servicename
=analytics|target
path
=path to an AEM page to attach the created cloud services configs
For example, a curl request that creates both Analytics and Target configurations and attachs them to the we.retail page would be:
curl -v -u admin:admin -X POST -d"automaticProvisioning=true&servicename=target&servicename=analytics&path=/content/we-retail" http://localhost:4502/libs/cq/cloudservicesprovisioning/content/autoprovisioning.json
-
If you do not want to use the marketingcloud.properties file then you will have to send the credentials as well as parameters; for example:
- automaticProvisioning=
true
- servicename=
analytics|target
- path=path to an AEM page to attach the created cloud services configs; multiple paths can be defined
- analytics.server=
https://servername
- analytics.company=
Name of company
- analytics.username=
me
- analytics.secret=
secret
- analytics.reportsuite=
we-retail
- target.clientcode=
mycompany
- target.email=
me@adobe.com
- target.password=
password
In this case, the curl request that creates both Analytics and Target configurations and attachs them to the we-retail page would be:
curl -v -u admin:admin -X POST -d"automaticProvisioning=false&servicename=target&servicename=analytics&path=/content/we-retail&analytics.server=https://servername/&analytics.company=Name of company&analytics.username=me&analytics.secret=secret&analytics.reportsuite=weretail&target.clientcode=mycompany&target.email=me@adobe.com&target.password=password" http://localhost:4502/libs/cq/cloudservicesprovisioning/content/autoprovisioning.json
- automaticProvisioning=
Experience Manager
- Administering User Guide overview
- Sites Features
- Website Administration
- Reusing Content: Multi Site Manager and Live Copy
- Live Copy Overview Console
- Configuring Live Copy Synchronization
- Creating and Synchronizing Live Copies
- MSM Rollout Conflicts
- MSM Best Practices
- Translating Content for Multilingual Sites
- Managing Translation Projects
- Identifying Content to Translate
- Preparing Content for Translation
- Creating a Language Root Using the Classic UI
- Connecting to Microsoft Translator
- Configuring the Translation Integration Framework
- Language Copy Wizard
- Translation Enhancements
- Translation Best Practices
- Configurations and the Configuration Browser
- AEM FAQs
- Operations
- Dashboards
- Operations Dashboard
- Backup and Restore
- Data Store Garbage Collection
- Monitoring Server Resources Using the JMX Console
- Working with Logs
- Configure the Rich Text Editor
- Configure the Video component
- The Bulk Editor
- Configuring Email Notification
- Configuring RTE for Producing Accessible Sites
- The Link Checker
- Troubleshooting AEM
- Audit Log Maintenance in AEM 6
- Editor
- Managing Access to Workflows
- Using cURL with AEM
- Configuring Undo for Page Editing
- Proxy Server Tool (proxy.jar)
- Configuring for AEM Apps
- Administering Workflows
- Configuring Search Forms
- Tools Consoles
- Reporting
- Administering Workflow Instances
- Configuring Layout Container and Layout Mode
- Enabling Access to Classic UI
- Starting Workflows
- Configure the Rich Text Editor plug-ins
- Admin Consoles
- Security
- User Administration and Security
- User, Group and Access Rights Administration
- Security Checklist
- OWASP Top 10
- Running AEM in Production Ready Mode
- Identity Management
- Adobe IMS Authentication and Admin Console Support for AEM Managed Services
- Creating a Closed User Group
- Mitigating serialization issues in AEM
- User Synchronization
- Encapsulated Token Support
- Single Sign On
- How to Audit User Management Operations in AEM
- SSL By Default
- SAML 2.0 Authentication Handler
- Closed User Groups in AEM
- Granite Operations - User and Group Administration
- Enabling CRXDE Lite in AEM
- Configuring LDAP with AEM 6
- Configure the Admin Password on Installation
- Service Users in AEM
- Encryption Support for Configuration Properties
- Handling GDPR Requests for the AEM Foundation
- Content Disposition Filter
- Personalization
- eCommerce
- Integration
- Integrating with Third-Party Services
- Integrating with Salesforce
- Integrating with Adobe Target
- Integrating with Adobe Analytics
- Connecting to Adobe Analytics and Creating Frameworks
- Configuring Link Tracking for Adobe Analytics
- Mapping Component Data with Adobe Analytics Properties
- Configuring Video Tracking for Adobe Analytics
- HTTP2 Delivery of Content FAQ
- Troubleshooting your Adobe Campaign Integration
- SharePoint Connector Licenses, Copyright Notices, and Disclaimers
- SharePoint Connector
- DHTML Viewer End-of-Life FAQs
- Integrating with Adobe Campaign Classic
- Related Community Articles
- Integrating with Adobe Campaign Standard
- Flash Viewers End-of-Life Notice
- Integrating with Adobe Creative Cloud
- Integrating with Adobe Dynamic Tag Management
- Opting Into Adobe Analytics and Adobe Target
- AEM Portals and Portlets
- Integrating with Dynamic Media Classic
- Troubleshooting Integration Issues
- Integrating with BrightEdge Content Optimizer
- Best Practices for Email Templates
- Catalog Producer
- Integrating with Silverpop Engage
- Integrating with Adobe Campaign
- Integrating with ExactTarget
- Analytics with External Providers
- Integrating with the Adobe Marketing Cloud
- Manually Configuring the Integration with Adobe Target
- Prerequisites for Integrating with Adobe Target
- Adobe Classifications
- Solutions Integration
- Target Integration with Experience Fragments
- Best Practices
- Content Management