Skip to main content

Sitecore Analytics Database Manager (ADM) Module Customization

Sitecore Analytics Database Manager (ADM) Module Customization

Sitecore Analytics Database Manager (ADM) Module Customization


Recently I got the situation where I want to remove multiple contacts from xDB. I do not want to write my custom code.

Then I found Analytics Database Manager (ADM) 4.0.1 module in Marketplace, but it was not fulfilling my requirement because this module has only below options:
  • Remove Historical Data:  Removing all contacts and all related data without interactions after the specific date
  • Rebuild Calculated Facet: Historcial rebuild of calculated facets
  • Remove Single Contact Data: Removing single contact by ID or identifier

Sitecore Analytics Database Manager (ADM) Module Customization


To fulfill my requirement, instead of creating a new tab for multiple contact removal, I did some minor change in Remove Single Contact Data. 
  • Open “AdmTaskPage.js” from this location “sitecore\shell\client\Your Apps\ADM\AdmTaskPage“
  • Replace “removeContact” function from below code, to remove multiple contacts from xDB
  •  removeContactByID: function (id) {  
                    jQuery.ajax({  
               type: "POST",  
               url: "/sitecore/adm/client/StartContactDataRemovingById?contactId=" + id,  
               success: function (result) {  
                 app.MessageBar2.addMessage("warning", result.replace(/^"(.+(?="$))"$/, '$1'));  
               },  
               error: function (xhr, error, thrownError) {  
                 app.MessageBar1.addMessage("error", "The error occured with the following message '" + thrownError + "' Please check logs for details");  
                 err = "yes";  
               }  
             });  
               },  
         removeContact: function () {  
           app.MessageBar2.removeMessages();  
           app.MessageBar2.set("expanded", "true");  
           app.ContactExpander.viewModel.show();  
           var running = app.checkIsRunning();  
           var enc = running.toString().replace(/[^a-zA-Z]+/g, '');  
           if (enc != "NotRunning") {  
             app.MessageBar2.addMessage("warning", "The remove task can't be started while another one is running.");  
             app.trigger("disable:ContactStatus");  
             return;  
           }  
           var err = "no";  
           if (app.IdentCheckBox.get("isChecked")) {  
                          app.MessageBar2.addMessage("warning", "Contact removing has been requested.");  
                         var ids=app.IdTextBox.get("text");  
                         var list=ids.split('|');  
                         for(var i=0;i<list.length;i++){  
                              app.removeContactByID(list[i]);  
                         }  
           } else {  
             app.MessageBar2.addMessage("warning", "Contact removing has been requested.");  
             jQuery.ajax({  
               type: "POST",  
               contentType: 'application/json',  
               data: JSON.stringify({  
                 "source": app.SourceTextBox.get("text"),  
                 "identifier": app.IdentTextBox.get("text")  
               }),  
               url: "/sitecore/adm/client/StartContactDataRemoving",  
               success: function (result) {  
                 app.MessageBar2.addMessage("warning", result.replace(/^"(.+(?="$))"$/, '$1'));  
                 if (result.indexOf("was not found") !== -1) {  
                   app.trigger("disable:ContactStatus");  
                   app.trigger("enable:RemoveContact");  
                   err = "yes";  
                 }  
               },  
               error: function (xhr, error, thrownError) {  
                 app.MessageBar1.addMessage("error", "The error occured with the following message '" + thrownError + "' Please check logs for details");  
                 err = "yes";  
               }  
             });  
           }  
           if (err == "yes") {  
             return;  
           }  
           app.trigger("disable:RemoveContact");  
           app.trigger("enable:ContactStatus");  
         },  
    
  • Move into this function “removeDataDialogue” and comment below lines:
  •  var valid = app.validateGuid(id);  
               if (!valid) {  
                  app.Label1.set("text", "entered contact ID is not a valid GUID");  
                 return;  
               }  
    
  • Switch into Core DB and go to this location “/sitecore/client/Your Apps/ADM/AdmTaskPage/PageSettings/Tabs/Remove  Single Contact Data”
  • Click on Presentation->Details and select “TextBox” rendering
Sitecore Analytics Database Manager (ADM) Module Customization
  • Do blank in “MaxLength: field
Sitecore Analytics Database Manager (ADM) Module Customization
  • Now I can add multiple contacts with pipeline separated like “F9F1F37A-6BCA-0000-0000-05AA3D2C0176|F9F1F37A-6BCA-0000-0000-05AA3D26BAF1|F9F1F37A-6BCA-0000-0000-05AA3D219161”
Sitecore Analytics Database Manager (ADM) Module Customization
  • Click “Yes” button, it will remove multiple contacts








Comments

Popular posts from this blog

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine’” on Windows 11

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine' ” on Windows 11 Today I started to install Sitecore 10.2 using Sitecore Instance Manager on Windows 11 and I got this issue “Failed to start service ‘Sitecore Marketing Automation Engine' ” . Error : On event viewer it was showing the below error: I also tried to run ‘ Sitecore.MAEngine.exe ’ like this C:\Windows\system32>C:\inetpub\wwwroot\sclocal102xconnect.dev.local\App_Data\jobs\continuous\AutomationEngine\Sitecore.MAEngine.exe Which was throwing below error: Starting Marketing Automation Engine... 2022-01-29 22:21:11 ERR Error initializing XConnect client. System.AggregateException: One or more errors occurred. ---> Sitecore.XConnect.XdbCollectionUnavailableException: An error occurred while sending the request. ---> System.Net.Http.HttpRequestException: An error occurred while sending the request. ---> System.Net.WebException: The underlying connection was closed: An unexpected err

Azure AD Integration with Sitecore 10.2

 Azure AD Integration with Sitecore 10.2 Sitecore identity server that comes with Sitecore 9.1 allows you to log in through an external identity provider like Azure Active Directory, Facebook, Apple, or Google. It is built on Federation Authentication. What is Federation Authentication? Federation authentication is a technology to allows users to access multiples application, tools, and domains using one credential. Using one set of credential user can access multiple applications, and resources after authentication.  Federation authentication consists of two systems, the Identity provider and the Service provider. Identity providers that maintain/create/manage identity information like name, email address, device, and location. Some examples of identity providers are Azure AD, Google, Facebook, and Apple. Service providers basically refer to a website, software, or app that the user is trying to access and SP basically relies on the identity provider to authenticate the user and provi

Sitecore Custom API Issue with Federation Authentication

Sitecore Custom API Issue with Federation Authentication In earlier segments, detailed in Part 1 and Part 2 of the blogs on Keycloak Integration with Sitecore, I introduced Keycloak functionality for CM login. Concurrently, I addressed a necessity to develop custom APIs for retrieving Sitecore users and roles. Following the development of custom APIs, during authentication failures, the API erroneously returned a status code of 200 instead of 401. The problem arose because API requests were being routed through the "owin.identityProviders" pipeline, which was not intended for API usage. Solution: When OWIN identifies a 401 response and the AuthenticationMode is set to "Active," it fails to capture the URL hash included in the request. Another choice is to activate the "Passive" AuthenticationMode, wherein OWIN refrains from actively intercepting 401 responses. In passive mode, your application needs to explicitly issue a Challenge to trigger the OWIN aut