sitecore analytics upgrade tool - welcome to the sitecore

Sitecore CMS 6.5 Sitecore Analytics Upgrade Tool Rev: August 30, 2012

Sitecore® is a registered trademark. All other brand and product names are the property of their respective holders. The contents of this document are the property of Sitecore. Copyright © 2001-2012 Sitecore. All rights reserved.

Sitecore CMS 6.5

Sitecore Analytics Upgrade Tool An administrator's and developer's guide to upgrading Sitecore Engagement Analytics

Sitecore CMS 6.5


of 13

Table of Contents

Introduction.................................................................................................................................................... 3

Prerequisites .............................................................................................................................................. 3

Pre-Upgrade Steps .................................................................................................................................... 3

Installation.................................................................................................................................................. 4

Upgrading the OMS Database ...................................................................................................................... 5

Step 1: Analyzing the Database ................................................................................................................ 5

Step 2: Transferring Meta-Data ................................................................................................................. 8

Step 3: Transferring the Data and Updating the History ......................................................................... 10

Progress Information ............................................................................................................................... 11

Sitecore Analytics Upgrade Tool


of 13

Introduction

The Sitecore Analytics Upgrade Tool lets you upgrade the Sitecore OMS 1 Analytics database to Sitecore 6.5 DMS 2.0.1 Engagement Analytics database.

Note The most recent version of the tool is only compatible with 6.5 Update-5 and later.

Prerequisites

To use this upgrade tool, you must be running on OMS database version 1.1.1.

The upgrade tool supports:

Windows XP

Windows Vista

Windows 7

Windows Server.

Pre-Upgrade Steps

Upgrade your Sitecore CMS 6.5 Solution First

Before transferring data to the new analytics database, you should upgrade your Sitecore 6.5 solution to the version that you require first. The analytics upgrade should be the last step in the upgrade process, because when you start to transfer meta-data, your old Sitecore solution will not be able to collect any further analytics information into the OMS database.

When you have finished transferring meta-data, your upgraded site can start to collect statistics and work normally. Your site must be ready to run when you finish transferring meta-data.

Install a Clean Sitecore 6.5 Analytics Database

You must have a clean Sitecore 6.5 Analytics database so that the upgrade tool can transfer data from your Sitecore OMS 1 Analytics database to this clean database. For more information about where to download an empty DMS database, read the following instructions on the SDN.

Plan the Upgrade Time

When planning the timeline for this upgrade, you must remember that after you start transferring meta-data, Sitecore is not able to collect analytics information into the OMS database.

For more information about transferring meta-data, see section Step 2: Transferring Meta-Data.

Please also note that MV Tests are not transferred during the conversion process. This means that no data related to MV tests are transferred using the Analytics Upgrade Tool.

http://sdn.sitecore.net/Products/Sitecore%20V5/Sitecore%20CMS%206/Update/6_5_0_rev_110602/Upgrade%20to%20This%20Release/from64oms_to_dms.aspx

Sitecore CMS 6.5


of 13

Ensure the tempdp Database Has Enough Space

Ensure that the tempdp database has enough space.

For more information, see the article Capacity Planning for tempdb.

Installation

You can download the upgrade tool from the SDN.

The upgrade tool comes in a zip file called: AnalyticsUpgrade.zip

When you extract the tool, place it in a new folder.

The zip-file contains 5 files:

AnalyticsUpgradeTool.exe

AnalyticsUpgradeTool.exe.config

Log4net.dll

Sitecore.AnalyticsUpgrade.dll

Sitecore.Kernel.dll

http://msdn.microsoft.com/en-us/library/ms345368.aspx



of 13

Upgrading the OMS Database

This section contains instructions for upgrading an existing Sitecore OMS 1 Analytics database to a Sitecore 6.5 Analytics database.

The upgrade process consists of three steps:

Step 1: Analyze.

Step 2: Transfer Meta-Data.

Step 3: Transfer and Update the History.

The following sections describe each of these steps in detail.

Step 1: Analyzing the Database

In this step, the Upgrade Tool analyzes the OMS 1 database schema and its content for potential issues.

When you start the Upgrade Tool, it opens the Analytics Upgrade dialog box:

Sitecore CMS 6.5


of 13

To perform this step:

1. In the Analytics Upgrade Steps section, select Step 1: Analyze.

2. In the Database Connections section, under OMS 1, fill in the fields that let the tool connect to your OMS 1 database.

Field Description

Server name The address of the server.

Database name The name of the OMS 1 database.

Authentication The type of authentication that the tool uses to connect to the database.

User name The user name that the tool uses to connect to the database.

Password The password that the tool uses to connect to the database.

3. Click Test Connection and the tool connects to the database.

In the Database Connections section, under DMS 2.0.1, fill in the fields that let the tool connect to your DMS 2.0.1 database.

Field Description

Server name The address of the server.

Database name The name of the clean Analytics database.

Authentication The type of authentication that the tool uses to connect to the database.

User name The user name that the tool uses to connect to the database.

Password The password that the tool uses to connect to the database.

4. Click Test Connection and the tool connects to the database.



of 13

5. In the Analytics Upgrade Steps section, click Start and the tool starts the analysis.

When the tool starts the analysis, it displays information in the Progress Information section:

For more information about the Progress Information section, see the section Progress Information.

6. When the Total Progress indicator reaches 100%, the analysis is finished.

7. Review the Tables field for any potential issues. For more information about how to resolve the Tables field issues, see section Resolving the Table field issues.

Otherwise, proceed to Step 2.

Note

During the upgrading process, the Bot values (with VisitorIdentification and

OverridenVisitorIdent > 925) are not transferred from the GlobalSession table in OMS1 to

the Visitors table in DMS 2.0.1

Sitecore CMS 6.5


of 13

Resolving the Table field issues

Cropped Data in Target Table Columns

If during the analysis it appears that the source table data are likely to be cropped in the target table later, a warning icon is displayed in the Tables field.

All the cropped fields are then written into the log file.

PageEvents: Schema warning: '[PageEvent].DataKey' column value with length 131 will be

truncated to 100 symbols in '[PageEvents].DataKey'. Source value = 'Multivariate Test Strategy

with id {4CFCFC60-F4BA-4876-8824-A2659DD4030D} is invalid (returns null). Using Random

strategy instead.'

You can either ignore the cropped fields or go the target table and change the corresponding field size so that the data fit into the field.

For example, let us assume, the IndexableUrl source table column is unlimited in size, and the

URL target table column is limited to 450 characters. If the IndexableUrl source table column

contains 511 characters in one of its fields, these data appear as cropped in the target table. To make the data appear in the target table in full, change the URL target table column size to 550 characters.

Step 2: Transferring Meta-Data

In this step, the tool transfers meta-data from the OMS 1 database to Sitecore 6.5 Analytics database.

The old Sitecore OMS 1 solution cannot collect analytics after you start transferring meta-data. It is necessary to disable analytics in the OMS database before transferring the meta-data. Otherwise the upgrade tool will fail during Step 3.

When this step is finished, your upgraded site can start to collect statistics and work normally. Your site must be ready to run when you finish transferring meta-data.

To transfer the meta-data:

1. Make sure that analytics is disabled in the old Sitecore OMS 1 solution so that it no longer collects analytics data into the OMS database. Analytics can be disabled by renaming the /App_Config/Include/Sitecore.Analytics.config file to Sitecore.Analytics.config.disabled.



of 13

2. In the Analytics Upgrade Steps section, select Step 2: Transfer Meta-Data.

3. In the Analytics Upgrade Steps section, click Start and the tool starts transferring the meta-data.

Important You cannot pause and resume the tool during this step. This process is relatively fast and usually lasts for less than half an hour. If the tool crashes, you must restart at Step 1.

4. Once the tool starts transferring the data, it displays information in the Progress Information section:


5. When the Total Progress indicator reaches 100%, the transfer is finished.

Now you have an Analytics database that works on a Sitecore 6.5 solution and which contains all your meta-data, such as Visitors, Visitor Classifications, Keywords, and Operating Systems.

You can now put your new 6.5 solution into production and begin collecting new analytics data into the new analytics database. At the same time, you can start transferring the historical analytics data from the old installation to the new analytics database.

Sitecore CMS 6.5


of 13

Step 3: Transferring the Data and Updating the History

In this step, the tool transfers and updates the historical analytics data from the Sitecore OMS 1 database to Sitecore 6.5 Analytics database.

Important This step may take several days, depending on the database size. You can pause and resume it if required. If the tool crashes during this step, you can resume it.

During this step, analytics must continue to be disabled in the old OMS 1 installation. If any additional analytics data has been collected after Step 2 was started, the upgrade tool will fail during Step 3.

The new Sitecore Analytics installation can collect data during this step or alternatively you can wait and turn it on and start collecting data when step 3 is finished.

To transfer the data:

1. In the Analytics Upgrade Steps section, select Step 3: Transfer and Update History and then click Start.

2. To stop the process, click Stop.

3. To resume the process, click Resume.



of 13

4. Once the tool starts to transfer data, it displays information in the Progress Information section:


5. When the Total Progress indicator reaches 100%, the transfer is finished.

6. After step 3 of the Analytics Upgrade Tool has been completed, run the Analytics post upgrading actions.aspx page to convert the structure of campaign items from OMS to DMS 2.0.1 and updates analytics database with required DMS 2.0.1 data. For more information, read the following instructions on the SDN.

Now you have an Engagement Analytics database that contains all of the historical data and runs on a Sitecore 6.5 solution.

Progress Information

The Progress Information section in the Analytics Upgrade window contains several fields.

http://sdn.sitecore.net/Products/Sitecore%20V5/Sitecore%20CMS%206/Update/6_5_0_rev_110602/Upgrade%20to%20This%20Release/from64oms_to_dms.aspx

Sitecore CMS 6.5


of 13

Tables

This field lists the tables in the target Sitecore 6.5 Analytics database. The tool checks the size or length of the data fields in the tables in the source database.

If the size of the data fields is not an issue, the tool displays a green checkmark next to the table.

If there is an issue, the tool displays a yellow warning sign next to the table. This means that the content of this table will be truncated in the target database during the upgrade process.

Time and Progress

On the right side of the Progress Information section there are some fields that display time estimates related to the process.

Field Description

Start time The time when the current process started.

Elapsed time The time that has elapsed since the process started.

Est. Time Remaining An estimate of the remaining time to complete this process.

Current state The current state of the process (running, stopped or finished).

Progress for this table A progress indicator for the current table — as a percentage of the current table.

Total progress A progress indicator for the whole process — as a percentage



of 13

To view the log file, which contains detailed information about the current process, click Link to Log File and the tool opens a log file:

Output Messages

This field displays status messages about specific tables:

To copy this output to the clipboard, click Copy to Clipboard.

sitecore analytics upgrade tool - welcome to the sitecore

Documents