Analytics Database Manager (ADM)

  0 rating
1/14/2013 6:29:19 AM
4/3/2020 2:32:47 PM
Source: GitHub
Provider: Sitecore

About

If you have any issues with the module or have any suggestion, please contact us via Sitecore.ADM@sitecore.com. We do not get notifications when comments are added on the marketplace page, so response on such feedback may be delayed.

 

ADM 4.0.2 and 4.1.2 work with 9.0 and 9.1 correspondingly. ADM 4.2.1 works with 9.2 and 9.3.

 

The current versions of ADM has the following new features:

  • View xDB statistics.
  • Find collection database outliers (contacts with abnormal number of contacts).
  • Remove multiple contacts by id.

 

ADM 4.2.0 works with 9.2 version.

 

The current versions of ADM have the following functional:

  • Remove all data for contacts that do not have interactions after the specified date.
  • Remove all data for a specific contact defined by the contact id or source and identifier.
  • Rebuild calculated facets for all contacts.

 

ADM 4.0.1 and 4.1.1 work with 9.0 and 9.1 correspondingly.

 

The current versions of ADM has the following functional:

  • Remove all data for contacts that do not have interactions after the specified date.
  • Remove all data for a specific contact defined by the contact id or source and identifier.
  • Rebuild calculated facets for all contacts.

 

ADM 4.0.0 and 4.0.1 work with 9.0 and 9.1 correspondingly.

 

The current versions of ADM has the following functional:

  • Remove all data for contacts that do not have interactions after the specified date.
  • Remove all data for a specific contact defined by the contact id or source and identifier.

 

 

 

ADM 3.0 works with Sitecore 8.0 or higher.


The tool allows to perform the following actions:


  • Remove historical data older than specified date using various filters (including custom ones).
  • Remove contacts without interactions.
  • Re-index contact data.

 

ADM3

 

ADM 2.1 works with Sitecore 7.2. It helps you to:


  • Clean up the unnecessary data from the Analytics database by various criteria.
  • Remove BOTs visits/sessions.
  • Perform the indexes rebuilding of the Analytics database.
  • Quickly create a backup of the analytics data.
  • Synchronize the Analytics Definitions to use the clean Analytics database on the existing solution.
  • Diagnose mismatches of the Analytics database configuration with the recommendations in the DMS Performance tuning Guide

 

Documentation

Documentation
  • Documentation > Getting Started with the Analytics Database Manager
    Analytics Database Manager 1.0 and 2.0 Documentation
    Installation and usage

    • Install the ADM package.
    • Go to 'Control Panel' -> 'Analytics' -> 'Analytics Database Manager'.
    • Select the certain task and run it.

    How to Upgrade

    In general, upgrade procedure for ADM is the following:

    • Rename Sitecore.AnalyticsDatabaseManager.config file to Sitecore.AnalyticsDatabaseManager.config.backup
    • Install new ADM package
    • When asking about conflicts, always choose 'Overwrite' option
    • Manually update settings in Sitecore.AnalyticsDatabaseManager.config from Sitecore.AnalyticsDatabaseManager.config.backup (if needed)


    Documentation

    To read more about the module you can find the documentation as a PDF document in the download section:


    Known issues (for ADM 2.0.0)


    1. [FIXED IN ADM 2.1 rev. 141001 (Update-1)] ADM requires consistent DMS database to clean it up. It could lead to ‘There was problem with setting/removing constraints. Please re-run the task’ error in ADM, when Analytics database with broken consistency is used.

    To check your DMS database integrity use the ‘DMS_integrity_check.sql' script from Download section, it will return all orphan entries in DMS database. To fix this violation by removing orphan entries, you can use ‘DMS_integrity_fix.sql’ script from Download section.


    2. After performing ‘Clean all Analytics Data’ task, it is recommended to restart all Sitecore instances connected to the cleaned Analytics database. Otherwise, it may lead to inconsistent Analytics database in future.

    100
  • Documentation > Analytics Database Manager 3.0 Documentation
    Analytics Database Manager 3.0 Documentation
    Installation and usage
    • For Sitecore 8.0 Update 4 or earlier, add the MongoDB assembly binding redirect as it is described in the 2nd solution in the following article: https://kb.sitecore.net/articles/920798
    • Install the ADM package.
    • Go to 'Dashboard’ -> 'Analytics Database Manager'.
    • Select the needed tab, specify the attributes and run the task.
    • Documentation You can read more about the module in the following document: Administrator Guide
    200
  • Documentation > Analytics Database Manager 400 410 Documentation
    Analytics Database Manager 4.0.0, 4.1.0 Documentation
    Installation:
    • Download "ADM.4.x.x.zip" file and unzip it.
    • Attach the Data\ADM.Tasks.mdf database to your SQL Server.
    • For the attached database add a connection string with adm.pool name in the xconnect\App_Config\ConnectionStrings.config file.
    • Extract the content of xConnect folder to your xConnect collection service root folder.
    • Run Scripts\CreateADMStoredProcedures.sql script against your ShardX databases.
    • Install Sitecore\Analytics Database Manager 4.x.x rev. xxxxxx.zip on your CM server using Installation Wizard.
    Documentation can be found in the "ADM.4.x.x.zip" file. Please read it before using the module.
    300
  • Documentation > Analytics Database Manager 401 411 Documentation
    Analytics Database Manager 4.0.1, 4.1.1 Documentation

    Installation:

    • 1. Download ADM 4.X.1.zip file and unzip it.
    • 2. Deploy the Data\ADM.Tasks.dacpac to your SQL server.
    • 3. Locate the xConnect instance defined in the xconnect.collection connection string on the CM instance. It will host the ADM on xConnect side.
      • 3.1. For the deployed database add a connection string with adm.pool name in the xconnect\App_Config\ConnectionStrings.config file.
      • 3.2. Extract the content of xConnect folder to this instance.
    • 4. Run Scripts\CreateADMStoredProcedures.sql script against your ShardX databases.
    • 5. Run Scripts\CreateMAStoredProcedures.sql script against your Marketing Automation database.
    • 6. Run Scripts\CreateProcessingPoolStoredProcedures.sql script against your Processing Pools database.
    • 7. Install Sitecore\Analytics Database Manager 4.X.1 rev. 190810.zip on your CM server using Installation Wizard.

     

    Upgrade from 4.X.0:

    • 1. Remove all the configuration files under App_Data\Config\Sitecore\ADM folder of the xConnect instance which has ADM installed.
    • 2. Drop the existing adm.pool database.
    • 3. Download ADM 4.X.1.zip file and unzip it.
    • 4. Deploy the Data\ADM.Tasks.dacpac to your SQL server with the same name as dropped one.
    • 5. Extract the content of xConnect folder to your xConnect collection service root folder defined in the xconnect.collection connection string on CM instance.
    • 6. Run Scripts\CreateMAStoredProcedures.sql script against your Marketing Automation database.
    • 7. Run Scripts\CreateProcessingPoolStoredProcedures.sql script against your Processing Pools* database.
    • 8. Install Sitecore\Analytics Database Manager 4.X.1 rev. 190810.zip on your CM server using Installation Wizard.

     

    Documentation can be found in the "ADM.4.X.1.zip" file. Please read it before using the module.

    350
  • Documentation > Analytics Database Manager 420 Documentation
    Analytics Database Manager 4.2.0 Documentation

    Installing the module

    To install the module, the following actions must be performed:

     

    • 1.Download ADM 4.2.0.zip file and unzip it.
    • 2. Deploy the Data\ADM.Tasks.dacpac to your SQL server.
    • 3. Locate the xConnect instance defined in the xconnect.collection connection string on the CM instance. It will host the ADM on xConnect side.
    • 4. For the deployed database add a connection string with adm.pool name in the xconnect\App_Config\ConnectionStrings.config file.
    • 5. Extract the content of xConnect folder to this instance.
    • 6. Install Sitecore\Analytics Database Manager 4.2.0 rev. 191122.zip on your CM server using Installation Wizard.

     

     

    Upgrading the module from 4.1.0

    To upgrade the module, the following actions must be performed:

     

    • 1. Remove all the configuration files under App_Data\Config\Sitecore\ADM folder of the xConnect instance which has ADM installed.
    • 2. Drop the existing adm.pool database.
    • 3. Download ADM 4.2.0.zip file and unzip it.
    • 4. Deploy the Data\ADM.Tasks.dacpac to your SQL server with the same name as dropped one.
    • 5. Extract the content of xConnect folder to your xConnect collection service root folder defined in the xconnect.collection connection string on CM instance.
    • 6. Install Sitecore\Analytics Database Manager 4.2.0 rev. 191122.zip on your CM server using Installation Wizard.
    350
Back
Release notes
March 27, 2020
Analytics Database Manager 4.0.2, 4.1.2 and 4.2.1 rev. 200327 have been released.

Highlights
      - It is possible to view the xDB statistics.
      - Outliers (contacts with abnormal amount of interactions) can be found now.
      - It is possible to remove multiple contacts by id now.
      - Small bug fixes.

Analytics Database Manager 3.0.1 rev. 200401 have been released for 8.2.5-8.2.7

Highlights:
      - In some cases, the "The GuidRepresentation for the reader is CSharpLegacy, which requires the binary sub type to be UuidLegacy, not UuidStandard." error appeared. This has been fixed.
      - Optional FilterInteractionsForKnownContacts processor was added.

October 22, 2019
Analytics Database Manager 4.2.0 rev. 191122 has been released.

Highlights
      - Remove process relies on 9.2 xConnect API now.
      - Data can be removed from the collection database which uses mongo provider now.
      - Cancelling the remove process reset the statistics before. This was changed. It is possible to see how many records were removed before the cancellation was triggered now.
      - Failed responses which come from xConnect are displayed in more user-friendly way now.
      - Configuration refactoring was performed.

August 10, 2019
Analytics Database Manager 4.0.1 rev. 190810 and 4.1.1 rev. 190810 have been released.

Highlights
      - Rebuild calculated facets functionality was added.
      - It is possible to define range for removing instead of just cut-off date.
      - Data for removed contacts is also removed from MA and Processing pools now.
      - Configurable retrying was added for SQL connections.
      - Interactions were not retrieved with contacts as defined in the IDataRemovingFacetsConfiguration. This was fixed.
      - It is possible to define if the contacts without interactions must be removed or not now.
      - UI shows correct messages now if there are no contacts in the databases.
      - UI shows errors in a more friendly way now.
      - Remove statistics shown in UI is updated when the process is paused now.
      - Interactions were not removed from database for edge dates. This was fixed.
      - Logging and exception handling improvements

December 24, 2018
Analytics Database Manager 4.0.0 rev. 181221 and 4.1.0 rev. 181224 have been released.

Highlights:
The module runs on Sitecore 9.0.x and 9.1.x correspondingly.
The module has the following features:
      - Remove all data for contacts that do not have interactions after the specified date.
      - Remove all data for a specific contact defined by the contact id or source and identifier.
December 21, 2018
Analytics Database Manager 3.0.1 rev. 180419 has been released.

Highlights:
      - Module works with Sitecore 8.2.5-8.2.7 now.
      - Indexes are built in background now.

December 26, 2016
Analytics Database Manager 3.0.0 rev. 161226 has been released.

Highlights:
The module runs on Sitecore 8.0 – 8.2.
The module has the following features:
      - Remove historical data older than specified date using various filters (including custom ones).
      - Remove contacts without interactions.
      - Re-index contact data.

October 01, 2014

Analytics Database Manager 2.1.0 rev. 141001 (Update-1) has been released.

Highlights:

- Logic of clean-up procedures was reworked and it does not require strongly consistent database anymore.
Now, the database schema is not updating during the operations, so clean-up procedures work much stable.
      - As a result, 'There was problem with setting/removing constraints' message will not be shown, as no constraints are changing;
      - Batch processing is used now to decrease load on the SQL Server during clean-up operation. The batch size and maximum iterations could be specified in *.config file.

- Added configuration for cleaning up helper tables (Browsers, OS...) in 'Clean All' command

- Improved statistics shown at the end of cleaning operation (now, number of visits/visitors removed is shown correctly)



April 08, 2014

Analytics Database Manager 2.1.0 rev. 140408 has been released.

Highlights:
- The range of diagnostic tasks have been added:
1. Auto Close Property
2. Auto Shrink Property
3. Check AutoDetectBots Setting
4. Compatibility Level property
5. File Growth
6. Maintenance Plan
7. Maximum File Size
8. Recovery Model
9. SQL Index Health
It allows you to check whether Analytics database is configured
according to the DMS Performance tuning Guide and update values
with the recommended ones.



March 01, 2013

Analytics Database Manager 2.0.0 rev. 130301 has been released.

Highlights:
- Support for Sitecore DMS, this version is compatible only with
Sitecore 6.5-6.6
- Cleaning up analytics data by custom Visits
attribute



November 10, 2011

Analytics Database Manager 1.0.0 rev. 111109 has been released.
Read more Back
Code examples

Solution screenshots(0)

Upload

Reviews (0)

Sort by: Date Most votes
  • Profile Avatar
    [fullName]

    Level: 0

    x0 x0 x0

    [date]

    [title]

    [text]

    Was this helpful?

    0

Comments (0)

Sort by: Date  Most votes

Leave a Comment

Comment must be field in
Post comment
loader

Write a review

Title can't be empty
Review can't be empty
Post review

Download

Title Description Download Action

Add File