Sitecore: Manual for uninstalling the connector

Owned by Testers (Deactivated)
Last updated: Apr 08, 2024 by Duncan Bell
4 min read

Introduction

It is not possible to uninstall XTM Connect – Sitecore automatically. This must be done manually, both on the Sitecore Content Management website (marked below with green) and directly on the server that hosts this website (marked with blue).

IMPORTANT!
Make sure that you always create a backup before removing items and files.

Since every Sitecore instance is different, there is no way of predicting all the possible issues that can arise from performing this process. This article should give you a solid understanding of the best sequence in which you should delete items and files related to the XTM connector.

Uninstallation instructions

While removing items from Sitecore, always use the Remove links option (although it is sometimes necessary to use Scan for broken Links between the steps). All item paths are preceded by a database name (master or core). File paths are relative to the main Sitecore installation path on the server.

  1. Verify that none of your items inherits from XtmConnectorBaseTemplate.

  • In the Content Editor, select XtmConnectorBaseTemplate (under sitecore → Templates → XTM), and, in the upper menu, choose the Navigate tab and expand the Links dropdown.

  • Click every Items that refer to the selected item, change tab to Content, remove XtmConnectorBaseTemplate from the base templates that have been selected and then save the item:

  1. Verify that none of your items is in XTMWorkflowState.

  • Open the Content Editor, choose Workbox (from the “lower tabs” menu), select the XTM Translation workflow and verify that no items are using any of its workflow steps.

  • If any items are using the XTM Translation workflow steps, select Open link to edit the workflow and clear it or change to another workflow.

  • This will open the Content Editor popup. Select Edit fields in the Workflow section:

IMPORTANT!

The Workflow section is only displayed when the Standard fields option is selected in the View tab.

  1. Delete the XtmUser, XtmAdmin and XtmProjectViewRestriction roles (using the Role Manager).

  2. Delete the master/sitecore/content/XTM Translation item and all of its sub-items.

  3. Delete the /master/sitecore/templates/XTM/XtmSettings item.

  4. Delete the /master/sitecore/templates/XTM item and all of its sub-items.

  5. Delete the /master/sitecore/System/Workflows/XTM Translations item.

  6. Delete the /master/sitecore/system/Dictionary/XtmAddToQueueSimpleFilter item and all of its sub-items (only applicable to the connector version between 2.5 and 3.2).

  7. Delete the /master/sitecore/system/Dictionary/ImportTypeOptions item and all of its sub-items (only applicable to the connector version between 2.5 and 3.2).

  8. Delete all ribbon chunks (you need to switch to the core DB to do this – more details below):

  • /core/sitecore/content/Applications/Content Editor/Ribbons/Chunks/XTM Translation/TranslationReport,

  • /core/sitecore/content/Applications/Content Editor/Ribbons/Chunks/XTM Translation,

  • /core/sitecore/content/Applications/Content Editor/Ribbons/Ribbons/Default/XTM,

  • /core/sitecore/content/Applications/Content Editor/Ribbons/Strips/XTM/XTM Translation,

  • /core/sitecore/content/Applications/Content Editor/Ribbons/Strips/XTM,

  1. Empty the Recycle Bin for the master DB and core DB (you need to switch between the master and core DB to do so).

  2. Delete these files: /sitecore/shell/Themes/Standard/Xtm.zip and /sitecore/shell/Themes/Standard/XtmNewIcons.zip (if the connector version is 2.7 or higher).

  3. Delete this folder: /XtmFiles/.

  4. Delete this folder: /XtmData/.

  5. Delete this folder: /App_Config/Include/Xtm/ (or /App_Config/Include/LjungbergIt/ – if the connector version is below 2.0).

  6. Delete this file: /App_Data/packages/<XTM connector installation package>.zip – this is optional since these are the packages that are uploaded to the server when the connector is installed/upgraded.

  7. Delete files whose names start with XTM (dlls, configs, pdbs, etc.) from the /bin/ folder.

  • The XtmAssemblies FOLDER which contains all dlls used by the connector: HtmlAgilityPack.dll, RestSharp.dll, DotNetZip.dll, RestSharp.dll, FluentValidation.dll, Sentry.dll, Sentry.Platform.Abstraction.dll, Sentry.Protocol.dll, Swashbuckle.Core.dll, AutoMapper.dll. The folder was added in v.3.1. Before, it was called HtmlAgilityPack. Do not delete the dlls in the bin folder itself. Depending on the version of the connector, not all dlls will be present in your case (make sure that you do not use the dlls listed below in other plugins).

  1. In the Breaking Links window, choose Remove Links.

Other actions

How to switch to the CORE database

While logged in to Sitecore, go to Sitecore Experience Manager → Desktop, click on master from the bottom-right list, and select core.

  1. While logged in to Sitecore, go to Sitecore Experience Manager → Desktop → Reporting tools → Scan for broken Links.

  1. Select the master checkbox and click Rebuild link database.