Health Check Error: Extends From Removed Sidecar Class

Overview

The Health Check wizard must be run when upgrading to evaluate whether your instance is suitable for upgrade. During the health check, various types of issues may be detected which can affect your ability to upgrade. This article will cover the "Extends From Removed Sidecar Class" error reported by the health check.

Symptoms

This error generates an output similar to the following in health check:
extendsFromRemovedSidecarClass

Resolution

The generated error message will help determine the contents of the file causing the health check error. To address this issue, the code-level customization will need to be edited from Sugar before proceeding with the upgrade.

The example error shown above was caused by a problem in the named file, ./custom/clients/base/views/news/news.js. This example custom code extends from a class, NewsViews, which was removed in Sugar 7.8.0.0. We can see this on line 12 of the problematic file:

  extendsFrom: 'NewsView',

The following classes have been removed in version 7.8 and above. Any custom code extending these classes will trigger a Health Check failure:

NewsView
SubpanelsCreateLayout
HistorySummaryPreviewHeaderView
PasswordmodalView
PortalPasswordmodalView
ACLRolesRecordsLayout
AdministrationRecordsLayout
CalendarRecordsLayout
CampaignsRecordsLayout
ContractsRecordsLayout
ContractTypesRecordsLayout
KBContentsPrefilteredlistView
QuotesPanelTopForAccountsView
RevenueLineItemsSubpanelListWithMassupdateView

In order to proceed with the upgrade, either update or remove the offending line of code or disable the specified file so that it no longer references the removed Sidecar class.

Once the necessary change has been made, please navigate to Admin > Repair and perform a "Quick Repair and Rebuild". Then, perform the health check again to confirm that the error is no longer reported.