Use the Adobe Analytics menu to setup Adobe Analytics metrics authentication, manage Adobe Analytics metrics of a Report Suite, or use SAINT to enhance Adobe Analytics reports through the acceptance of tabular data from outside sources.

Setting up Adobe Analytics metrics authentication

To incorporate Adobe Analytics metrics into your site search/merchandising rankings, you must first obtain a Adobe Analytics Web Services login. After you obtain the login information, you can use it to set up Adobe Analytics authentication in site search/merchandising.

To set up Adobe Analytics metrics authentication

On the product menu, click Settings > Adobe Analytics > Authentication.

On the Setup Adobe Analytics Metrics Authentication page, specify the information requested in each field.

Text field	Description
Adobe Analytics Company Name	The same Company Name setting that is used to log in to your Adobe Analytics account.
Web Services Username	The Web Services Username that is associated with your Adobe Analytics account. You can obtain this information in Adobe Analytics. On the Adobe Analytics menu bar, click Admin > Admin Console > Company > Web Services . The information is in the API Access Information table.
Web Services Shared Secret	The Web Services Shared Secret that is associated with your Adobe Analytics account. You can obtain this information in Adobe Analytics. On the Adobe Analytics menu bar, click Admin > Admin Console > Company > Web Services . The information is in the API Access Information table.

Text field

Description

Adobe Analytics Company Name

The same Company Name setting that is used to log in to your Adobe Analytics account.

Web Services Username

The Web Services Username that is associated with your Adobe Analytics account.

You can obtain this information in Adobe Analytics. On the Adobe Analytics menu bar, click Admin > Admin Console > Company > Web Services . The information is in the API Access Information table.

Web Services Shared Secret

The Web Services Shared Secret that is associated with your Adobe Analytics account.

You can obtain this information in Adobe Analytics. On the Adobe Analytics menu bar, click Admin > Admin Console > Company > Web Services . The information is in the API Access Information table.

Click Save Changes.
(Optional) Do one of the following:
- Click History to revert any changes that you have made.
  
  See Using the History option.
- Click Live.
  
  See Viewing live settings.
- Click Push Live.
  
  See Pushing stage settings live.

About Adobe Analytics Report Suites

To use Adobe Analytics Report Suite data within site search/merchandising, you must first create copies of the Adobe Analytics data in your site search/merchandising account.

You can create new Adobe Analytics Report Suite definitions, or you can view or modify your existing Adobe Analytics Report Suites and associated metrics.

The first time you access Adobe Analytics from within site search/merchandising, a list of your company’s available Report Suites are downloaded and cached. If new Report Suites have recently been added, or existing ones removed, you can refresh the report suite list to re-download the list of Report Suites.

Adding an Adobe Analytics Report Suite

You can select an Adobe Analytics Report Suite on which to base your site search/merchandising Ranking rules.

The list you can select from should correspond to the Report Suites that are available from within your Adobe Analytics account. The Report Suite you select determines the metrics that are available for use within your site search/merchandising Ranking Rules.

See About Ranking Rules.

After you add a Adobe Analytics Report Suite, you can edit its metrics.

See Editing the Adobe Analytics metrics of a Report Suite.

To add an Adobe Analytics Report Suite

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Adobe Analytics Report Suites page, click Add Report Suite.
In the drop-down list of the newly added table row, select the Report Suite that you want.
Edit the Adobe Analytics metrics of a Report Suite.

Editing the Adobe Analytics metrics of a Report Suite

To incorporate Adobe Analytics metrics into your Ranking Rules in site search/merchandising, you select one or more of the metrics that are associated with the chosen Report Suite. Then you configure the options that are used to fetch metric data by way of the Adobe Analytics Web Service.

See Adding an Adobe Analytics Report Suite.

See Configuring advanced Adobe Analytics options.

To edit the Adobe Analytics metrics of a Report Suite

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Adobe Analytics Report Suites page, under the Actions column, click Edit for the Report Suite whose metrics you want to configure.

On the Edit Adobe Analytics Metrics page, set the metrics that are required. Metrics that do not have an asterisk (*) next to the metric name, are optional.

Option	Description
Report Suite	Displays the name of the currently Report Suite that you added.
Report Suite View Name	Provides an "alias" name for the Adobe Analytics Report Suite name. This alternate name is useful if the same Report Suite is used in more than one definition.
Select Report Type	Specifies the Report Type value to use with the selected Report Suite. The value identifies the key for each returned row of results. The Report Type is also known as the Adobe Analytics Element. This metric is required.
Cross-reference Field Name	Specifies a metadata field whose values are used as look-up "keys" into the Report Suite's data. If no value is selected ("-- None --"), this Report Suite's data is not available for use in Ranking calculations ( Rules > Ranking Rules > Edit Rules ). When you select a value, this field's values are used to cross-reference site search/merchandising documents with this Report Suite's Adobe Analytics data, using the selected Report Type value that you set earlier.
Search Terms Report	Gives you access to create business rules and simulate search terms from the Stage Adobe Analytics Data Preview page. See Previewing Adobe Analytics Data. A pull-down menu appears on every row that includes two options: Simulate Search Term and Create New Business Rule. Both options use data from the Report Type as the search terms. Therefore, this feature only makes sense if the Report Type represents search terms.
Metrics	Identifies the metric values that you want to download and use within your site search/merchandising Ranking Rules. The metrics that you configure here appear as choices on the Rules > Ranking Rules > Edit Rules member center pages, when the rule's Data Type is set to Adobe Analytics Metric (Number) . The choices show a combination of the Report Suite names or Report Suite View Names, if specified, and the individual metric names. This metric is required.
Minimum Metric Value	Lets you enter a nonzero value to specify a minimum value for the metric. If blank, or zero, all values for the metric are downloaded; otherwise, the download for this metric stops when the minimum metric value is passed. Adobe Analytics metrics are retrieved in descending order. Click + to add additional metric definitions; click - to remove metric definitions that you no longer need or want.
Adobe Analytics Metric Aggregation Period (Days)	Controls the number of days worth of Adobe Analytics metrics to fetch, counting back from yesterday's date. No attempt is made to fetch data from the current day. The default is 7. This metric is required.
Adobe Analytics Download Refresh Frequency (Days)	Sets the minimum interval between downloads of Adobe Analytics data that is used in ranking calculations. Index-triggered downloads that occur within the download refresh frequency interval are ignored. However, manual downloads ignore this value. When you set this value to the default of 1, Adobe Analytics data does not download more than once within a 24 hour period. All Search indexes that occur within the download refresh frequency interval use the last data set that was downloaded. This metric is required.

Deleting an Adobe Analytics Report Suite

You can use Delete to remove a Report Suite from the Adobe Analytics Report Suites page. Deleting a Report Suite only removes the copy of the data from the site search/merchandising servers; it does not impact the data on Adobe Analytics systems.

To delete an Adobe Analytics Report Suite

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Adobe Analytics Report Suites page, under the Actions column, click Delete for the Report Suite you want to remove.
On the Adobe Analytics Delete Report Suite page, click Delete.

Previewing Adobe Analytics Data

You can use Preview to view your most recently loaded Adobe Analytics metrics.

The Row column in the table shows the number for each row of metric data, indicating the original order that the Adobe Analytics metrics were loaded.

The Product column shows the Adobe Analytics Element that is associated with each row of metric data. The values in this column are used to associate your site search/merchandising pages with their corresponding metric values, as configured in your ranking definitions.

See About Ranking Rules.

See Configuring ranking.

The remaining columns show the metric values that are associated with each entry.

If the table is empty, it means that you have not loaded any Adobe Analytics data yet. You can close the Adobe Analytics Data Preview page, and then load Adobe Analytics data.

See Loading Adobe Analytics data.
If the table was designated as a search term report, a small triangle appears in every row. You can click the drop-down list and select Simulate Search Term or Create New Business Rule. The action you select is applied to that row’s search term, the data residing in the second column

To preview Adobe Analytics Data

On the product menu, do one of the following:
- Click Settings > Adobe Analytics > Metrics. On the Adobe Analytics Report Suites page, under the Actions column, click Preview for the Report Suite whose downloaded data you want to view.
- Click Reports > Adobe Analytics Terms Reports. On the Adobe Analytics Terms Report page, under the Actions column, click Preview for the Report Suite whose downloaded data you want to view.
On the Adobe Analytics Data Preview page, use the navigation and viewing options at the top and bottom of the page to view the data.

Click any column heading in the table to sort the data in ascending or descending order.
Do any of the following:
- Click Download to Desktop to download and save the table as a .xlt file.
- Close the page when you are finish previewing the Adobe Analytics data and return to the previously viewed page.

Viewing the log from the most recent Adobe Analytics data load

You can use View Log to examine the Adobe Analytics data log file of the most recent download process. You can also use the log view to monitor a running download.

See Loading Adobe Analytics data.

To view the log from the most recent Adobe Analytics data load

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Adobe Analytics Report Suites page, click View Log. Log page,
On the Adobe Analytics Data Log page, use the navigation and viewing options at the top and bottom of the page to view the log information.
When you are finished, close the page to return to the Adobe Analytics Report Suites page.

Loading Adobe Analytics data

You can download the configured Adobe Analytics Report Suite data into site search/merchandising.

The Data Load page shows the status of your last Adobe Analytics Data Load operation with the following information:

Status field	Description
Status	Indicates the success or failure of the last data load attempt. Or, it displays the status of a data load operation that is already in progress.
Results	Displays the number of rows of metric data that was downloaded during the last data load attempt.
Start Time	Displays the date and time that the last data load operation started.
Stop Time	Displays the completion date and time of the last data load operation. Or, it indicates the current data load operation is still in progress.

To load Adobe Analytics data

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Stage Adobe Analytics Report Suites page, click Load Adobe Analytics Data.
On the Adobe Analytics Data Load page, do one of the following:
- Click Start Load to start the load operation.
  
  During a data load operation, the Progress row provides information on its progress.
- Click Stop Load to stop the load operation.
Click Close to return to the Stage Adobe Analytics Reports Suite page.

Refreshing the Report Suite list

The first time you access Adobe Analytics from the site search/merchandising user interface, a list of your company’s available Adobe Analytics Report Suites are downloaded and cached. If new Report Suites were recently added, or existing ones deleted, you can use Refresh Report Suite List to update the currently displayed list in site search/merchandising.

See Adding an Adobe Analytics Report Suite.

See Deleting an Adobe Analytics Report Suite.

To refresh the Report Suite list

On the product menu, click Settings > Adobe Analytics > Metrics.
On the Adobe Analytics Report Suites page, click Refresh Report Suite List.

Configuring advanced Adobe Analytics options

You can use Advanced Adobe Analytics Options to control settings that are intended to help you fine tune the behavior of the Adobe Analytics Report Suite download process.

See Editing the Adobe Analytics metrics of a Report Suite.

To configure advanced Adobe Analytics options

On the product menu, click Settings > Adobe Analytics > Advanced Options.

On the Advanced Adobe Analytics Options page, set the following options:

Option	Description
Maximum Rows, Any Metric	An optimization setting that prevents the download of too much Adobe Analytics data. If you set this option to a nonzero value, the Adobe Analytics data fetch is stopped when the total number of rows fetched for each metric exceeds the specified value. The default value is 0; no maximum value applied.
Metric Repeating Fetch Size (rows)	Controls the number of Adobe Analytics metric values to fetch at a time. The metric data rows are repeatedly fetched until all the data is retrieved or until the maximum rows limit is reached. Normally you do not need to change this setting. However, you may find it helpful to optimize the metric download phase of a full re-index of your site. The default value is 5000.

Option

Description

Maximum Rows, Any Metric

An optimization setting that prevents the download of too much Adobe Analytics data.

If you set this option to a nonzero value, the Adobe Analytics data fetch is stopped when the total number of rows fetched for each metric exceeds the specified value.

The default value is 0; no maximum value applied.

Metric Repeating Fetch Size (rows)

Controls the number of Adobe Analytics metric values to fetch at a time. The metric data rows are repeatedly fetched until all the data is retrieved or until the maximum rows limit is reached.

Normally you do not need to change this setting. However, you may find it helpful to optimize the metric download phase of a full re-index of your site.

The default value is 5000.

Click Save Changes.
(Optional) Do one of the following:
- Click History to revert any changes that you have made.
  
  See Using the History option.
- Click Live.
  
  See Viewing live settings.
- Click Push Live.
  
  See Pushing stage settings live.

About SAINT Classification Feeds

You can use Adobe Analytics SAINT to enhance your analytics reports through the acceptance of tabular data from outside sources. For example, you can use site search/merchandising to retrieve the data from its own indexes and export that data to Adobe Analytics.

To successfully use the Adobe Analytics SAINT feature in site search/merchandising be aware of the following requirements:

You must have a Adobe Analytics company and a Report Suite.

See About the Adobe Analytics menu.
The Adobe Analytics user account must have privileges to modify the Report Suite.

See Setting up Adobe Analytics metrics authentication.
The Adobe Analytics user must belong to the Web API group so that they can use the Adobe Analytics Web API.
The search index must have data that Adobe Analytics can use, such as having data in the correct format.

Before you create a feed, review the following questions and information so that you can complete the SAINT Feed wizard successfully:

Which Report Suite are you going to work with?
Which classification set, such as product, e-var, and so on, are you going to provide data for?
What classifications exist in the reports? The answer to this question is determined by the type of data that is readily available from site search/merchandising, and the type of reports that Adobe Analytics reports as desirable.
SAINT accepts the data from site search/merchandising as a text type. The format of that data impacts the presentation of the Adobe Analytics reports.

Creating an Adobe Analytics SAINT feed

You can use Adobe Analytics SAINT to enhance Adobe Analytics reports through the acceptance of tabular data from outside sources.

For example, you can use site search/merchandising to retrieve data from its own indexes and export that data to Adobe Analytics.

To create an Adobe Analytics SAINT feed

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the SAINT Classification Feeds page, click Create SAINT Feed.
In the Create Feed dialog box, in the Feed Name text field, enter the new feed name, and then click Next.

At this point, the feed is saved and added to the SAINT Classification Feed page. If you choose, you can exit, and edit the feed later to complete the wizard.
On the Authentication page, specify the Adobe Analytics company name, user name, and web secret in the respective text fields, and then click Next.

Make sure that it is authorized to use the Web API with Adobe Analytics.
On the Report Suite page, choose a report suite and its classification data set, and then click Next.
On the Field Maps page, map Adobe Analytics classifications with site search/merchandising meta data fields, and then click Next.

To adjust Adobe Analytics classifications, click Edit Adobe Analytics Classifications to log in to Adobe Analytics. When you have finished making your changes, click Refresh Classifications to refresh the choices of classifications.
On the Search Criteria page, data from site search/merchandising can be filtered before it is submitted to Adobe Analytics SAINT. Construct filter rules here using the rule builder interface, and then click Next.
On the Configure FTP page, select the FTP server. Specify the frequency for how often you want to upload data, and then click Next.

As a best practice, each feed has its own FTP account to avoid accidental lost of data. You can create a new Adobe Analytics FTP account here.
On the Verification page, click Show Data View to review the data view representation of the output. If any actual feed files exist, they are listed here and are available for you to download.
Click Close.

Editing an Adobe Analytics SAINT feed

You can edit all aspects of an existing SAINT feed that you have created.

To edit an Adobe Analytics SAINT feed

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the Saint Classification Feeds page, under the Name column, in the drop-down list next to a feed, click Edit feed.
In the SAINT feed dialog box, in the Feed Name text field, enter the new feed name, and then click Next.

At this point, the feed is saved and added to the SAINT Classification Feed page. If you choose, you can exit, and edit the feed later to complete the wizard.
On the Authentication page, specify the Adobe Analytics company name, user name, and web secret in the respective text fields, and then click Next.

Make sure that it is authorized to use the Web API with Adobe Analytics.
On the Report Suite page, choose a report suite and its classification data set, and then click Next.
On the Field Maps page, map Adobe Analytics classifications with site search/merchandising meta data fields, and then click Next.

To adjust Adobe Analytics classifications, click Edit Adobe Analytics Classifications to log in to Adobe Analytics. When you have finished making your changes, click Refresh Classifications to refresh the choices of classifications.
On the Search Criteria page, data from site search/merchandising can be filtered before it is submitted to Adobe Analytics SAINT. Construct filter rules here using the rule builder interface, and then click Next.
On the Configure FTP page, select the FTP server. Specify the frequency for how often you want to upload data, and then click Next.

As a best practice, each feed has its own FTP account to avoid accidental lost of data. You can create a new Adobe Analytics FTP account here.
On the Verification page, click Show Data View to review the data view representation of the output. If any actual feed files exist, they are listed here and are available for you to download.
Click Close.

Deleting an Adobe Analytics SAINT feed

You can delete an existing Adobe Analytics SAINT feed that you no longer need or use.

To delete an Adobe Analytics SAINT feed

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the Saint Classification Feeds page, under the Name column, in the drop-down list next to a feed that you want to remove, click Delete feed.
In the Delete dialog box, click Yes to verify the feed deletion.

Viewing an Adobe Analytics SAINT feed file

You can open the Verification page of an existing SAINT feed to review the data view representation of the output.

If any actual feed files exist, they are listed here and are available for you to download as a text file.

To view an Adobe Analytics SAINT feed file

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the Saint Classification Feeds page, under the Name column, in the drop-down list next to a feed, click View Feed Files.
(Optional) Click Download File to save the feed file as a text file.
Click Close to return to the SAINT Classification Feeds page.

Testing an Adobe Analytics SAINT feed

You can test an existing Adobe Analytics SAINT feed with no file upload.

See Generating and uploading an Adobe Analytics SAINT feed.

See Viewing an Adobe Analytics SAINT feed file.

To test an Adobe Analytics SAINT feed file

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the Saint Classification Feeds page, under the Name column, in the drop-down list next to a feed, click Test Feed (No file upload).
When the feed finishes processing, from the feed name’s drop-down list, click View Feed Files.
On the Verification page, click Download File to download the feed file.
Click Close to return to the SAINT Classification Feeds page.

Generating and uploading an Adobe Analytics SAINT feed

You can generate and upload feed files for an existing Adobe Analytics feed that you have created.

See Testing an Adobe Analytics SAINT feed.

See Viewing an Adobe Analytics SAINT feed file.

To generate and upload a Adobe Analytics SAINT feed file

On the product menu, click Settings > Adobe Analytics > SAINT Classification Feeds.
On the Saint Classification Feeds page, under the Name column, in the drop-down list next to a feed, click Generate and Upload Feed.
When the feed finishes processing, from the feed name’s drop-down list, click View Feed Files.
On the Verification page, click Download File to download the feed file.
Click Close to return to the SAINT Classification Feeds page.