Capture is a tool that helps you configure and deploy Acoustic and certified partner integrations. It reduces the amount of work you need from your IT team.
With Capture, you can:
- Manage tags from Acoustic and certified partners.
- Organize tags into deployment groups and set rules for when the groups and their tags are applied.
- Set up individual tag rules within deployment groups to determine when and if the tags should be applied.
- Perform test deployments to troubleshoot or fine-tune the behavior of tags on pages before you deploy them to production.
- Disable or re-enable all tags from a particular partner.
- Configure deployment group rules to trigger third-party JavaScript and code snippets (optional).
Before you begin
You must have Exchange to access Capture. If you don't have an Exchange account, contact support.
In Exchange menu, go to Tools > Exchange Capture. A new browser tab opens. What happens next depends on who you are:
- If you are not already linked to an Exchange/DDX ID and you are not an existing Capture user, the Set up tag manager wizard automatically starts and guides you through your initial setup. For Instructions, check out Set up the Exchange Capture tag manager.
- If you are an existing DDX user with an Exchange / DDX ID and not an existing Capture user, the partner enablement window opens. Before moving to the next steps, we recommend you get to know the major concepts of Capture described in this article.
- If you are an existing Capture user and not an existing DDX user, nothing changes for you.
Set up Exchange Capture
- Go to Tools > Exchange Capture.
- Provide a client ID or generate a new one.
- If you have a client ID, select your client ID in the drop-down:
- If you are an existing user, click Connect existing user.
- Enter your user name and password and click Next.
- If your client ID, username, and password are valid, you get a confirmation message. Go to step 3.
- If you don't have a client ID, click Generate your ID. The wizard will automatically generate an ID for you and then you can click Next.
- If you have a client ID, select your client ID in the drop-down:
- Define global settings for partner applications.
- Set up a unique page identifier for your partner applications by configuring a method. For details, check out Unique page identifiers and Methods and their associated parameters.
- Select a deployment group tagging process. This setting is important when an individual page belongs to more than one deployment group.
- Execute tags in all tag deployment groups – If you have multiple deployment groups deployed, execute all tags in the deployment groups.
- Execute tags in only the first tag deployment group – Execute all tags in the first deployment group which meets the deployment group criteria. Tags in any other group are not executed.
If you deploy the same tag across multiple deployment groups that include the same page and you select Execute tags in all deployment groups, the tag is syndicated multiple times. Selecting Execute tags in only the first deployment group prevents this scenario.
- Choose tracking options to stop tracking tags from executing in specific browsers when the Do not track setting is enabled in the browser. By default, Capture always executes tracking tags. Available options include:
- Honor DNT settings in Internet Explorer 10 or later
- Honor DNT settings in browsers other than Internet Explorer
- Click Next.
- Copy the embed code by clicking the Copy icon and paste the code into the head section of your web pages. If you already have eluminate.js script embedded on your site from your Digital Analytics DDX account, skip this step.
- Click Done.
You can change your global settings or access the embed code at any time by going to the main navigation and selecting Global settings or Copy embed code.
Unique page identifiers
The unique page identifier is some specific value (for example, a JavaScript or HTML object that contains a string) included in the code of every page where you want Capture to manage tags. By default, unique page identifiers in Capture are JavaScript objects. They can also be values based on a number of other methods, including cookie, HTML object, URL, local or session storage, or HTML meta tag.
A unique page identifier needs to be on every page that you want to evaluate for deployment rules. If Capture cannot find the unique page identifier on a page, it will not evaluate deployment group rules and, as a result, will not syndicate tag data for that page.
The values for the unique page identifiers can be the same as your page ID parameter values, but you must explicitly specify what data object Capture uses for the unique page identifiers. If you already have an HTML object that is defined for Page IDs, you can use that same object as a unique page identifier method.
If you require a certain level of granularity in your development, you can use the unique page identifier to mark a page in a particular environment. A page that goes through various stages of development to production might have the same page ID, but the version of the page in production is not the same as the version of the page in development. If each of the page versions needs a unique set of tags and applied rules, you can distinguish them by using a different unique page identifier for each version.
Collect data with tags
To capture data from your site, you use tags. Understanding the various methods to make data available for tagging, tag standards, unique page identifiers, and tag placement on pages is key to making sure you get the data you need. You should have already received information from the partner regarding their enablement and tagging. For information about implementing tagging in Exchange Capture, see the Tagging implementation article.
Data identification methods
Capture gives you various methods to make data on your website available for tag syndication. Methods include JavaScript objects, HTML, URL, constants, cookies, session storage or local storage. For fields that are not required, Unassigned is displayed unless you specify a value.
Not every tag supports all methods. The methods that are supported for a particular tag type are reflected in the available choices when you configure a tag in Capture. See the following examples of some of the methods you can use to identify data for tagging. The examples use a Digital Analytics Page View tag, with the page ID parameter and Category ID, which are required parameters.
JavaScript Object example
The value that is entered for the JavaScript object name needs to exist on the page exactly as it is entered in the Object Name field in the tag configuration. This is the JavaScript variable name that contains the field value.
Tag Field | Method | Object Name |
---|---|---|
* Page ID | JavaScriptObject | digitalData.page.pageInfo.pageID |
* Category ID | JavaScriptObject | digitalData.page.pageInfo.primaryCategory |
Search Term | JavaScriptObject | mySearchTerm |
No. of Search Results | JavaScriptObject | mySearchTermsReturned |
Page Attributes 1-50 | unassigned | |
Page Extra Fields 1-15 | unassigned |
digitalData = { pageInstanceID'Standard Page', page { pageInfo { pageID:'SearchPage' }, category { primaryCategory:'Search' } } }; mySearchTerm 'books'; mySearchTermsReturned =;
HTML example
HTML supports two different formats for Capture to read in data from your website. In the first method, the HTML object name between the start and end tags is read.
A code example for page ID:
<p><div id ="pageID">phHome</div></p>
The pageID value is the HTML object name that is required to be set in the HTML attribute name field. This value must be unique for each tag field.
A code example for Category ID with attribute name:
<p><div id="categoryID" catValue="HOME PAGE"/></p>
The optional attribute name is catValue. This value is collected from the HTML tag. For example: catValue="HOME PAGE". If you don't specify an attribute name value in the code, no data is sent. For example: catValue="".
Tag Field | Method | Object Name |
---|---|---|
* Page ID | HTML | pageID |
* Category ID | HTML | categoryID [catValue] |
Search Term | JavaScriptObject | digitalData.page.pageInfo.onsiteSearchTerm |
No. of Search Results | JavaScriptObject | digitalData.page.pageInfo.onsiteSearchResults |
Page Attributes 1-50 | JavaScriptObject | digitalData.page.attributes.exploreAttributes |
Page Extra Fields 1-15 | JavaScriptObject | digitalData.page.attributes.extraFields |
URL example
With the URL method, the URL is parsed to find the parameters that are specified in the tag configuration. The tag parameters are then retrieved from the parameters found. For example, with the URL parameters pageId and categoryId, the URL would need:
http://www.mysite.com/?pageId=pgHome&categoryId=HOME%20PAGE
Constant example
This method specifies a constant value that is syndicated for every tag. In Digital Analytics, a constant value that is supported only for "Category ID".
Unassigned example
This method sets the tag parameter to JavaScript null, which is passed in as a tag parameter. The unassigned method cannot be used for required fields.
Tag standards
As a best practice, if your website uses JavaScript to collect data, you adopt the Digital Analytics (W3C Customer Experience Digital Data Layer) tag standards. Capture fully supports the W3C Customer Experience Digital Data Layer tag standards. By default, all Digital Analytics and certified partner tags are configured to use these Acoustic standards. If your website uses the Acoustic standards to surface data, all tags work without requiring extra tag configuration. It is recommended that you surface data in this way. When these standards are adhered to by a client website, Capture can automatically and accurately collect the named parameters (data fields) associated with the specific tag. For additional information about Digital Analytics tag standards, refer to the Customer Experience Digital Data Layer v1.0 Final Report (http://www.w3.org/2013/12/ceddl-201312.pdf).
Place tags on pages
The Capture tag is configured within Capture tool. Depending on the method you select for the Digital Analytics tag parameters, you may need to declare an object in the target web pages to process the data correctly.
The digital data layer is included in the head section on the web page.
Capture tags might also be called in response to visitor interaction with in-page/site elements.
For example, using the JavaScriptObject method for Digital Analytics tag parameters, it is necessary to declare the specified JavaScript Object in target web page HTML:
digitalData = { pageInstanceID:'Standard Page', page: { pageInfo: { pageID:'Shopping Cart', onsiteSearchTerm:", onsiteSearchResults:" }, category:{ primaryCategory:'Checkout' }, attributes: { exploreAttributes:", extraFields:" } } };
Capture service domains
For full Capture functionality, you must allow a number of domains to have inbound and outbound access to your corporate network. In addition, browsers that are used by development, QA and other internal network teams allow JavaScript execution and cookies set by the domains on this list.
To ensure that Capture tools, reporting and data collection function correctly within your internal corporate network, allow the following domains inbound and outbound access to your network.
- testdata.coremetrics.com
- test.coremetrics.com
- data.coremetrics.com
- welcome.coremetrics.com
- itt.coremetrics.com
- tmscdn.coremetrics.com
- Any Acoustic-managed data collection domains in use.
Europe data center service domains:
- data.de.coremetrics.com
- testdata.de.coremetrics.com
- welcome.de.coremetrics.com
- ftp.de.coremetrics.com
Capture might change the IP addresses associated with these domains without notice, so it is not possible to reliably allow access to these domains by IP.