fix: updated error messages based on CX

Author: shaurabh-tiwari-git

messages/migrate.json

@@ -249,7 +249,7 @@
   "migrationSuccessfulMessage": "Migration process for org %s is complete and reports are ready for review in the folder %s",
   "metadataTablesAlreadyClean": "OmniStudio metadata tables are empty",
   "startingMetadataCleanup": "Initiated cleanup process for Omnistudio metadata tables.",
-  "failedToCleanTables": "Table cleanup failed: %s",
+  "failedToCleanTables": "Table cleanup failed: %s, Please contact Salesforce Support.",
   "errorCheckingMetadataTables": "Error checking Omnistudio metadata tables: %s",
   "metadataCleanupCompleted": "The Omnistudio metadata table cleanup process is complete. Total records cleaned: %s",
   "metadataCleanupConsentMessage": "By proceeding further, you hereby consent to clean up the Omnistudio metadata tables. Proceeding with the cleanup process will permanently delete all records from OmniUiCardConfig, OmniScriptConfig, OmniIntegrationProcConfig, and OmniDataTransformConfig tables. Do you want to proceed? [y/n]",
@@ -260,7 +260,7 @@
   "omniStudioSettingsMetadataEnabled": "The Omnistudio Metadata setting is enabled with standard data model.",
   "timeoutEnablingOmniStudioSettingsMetadata": "Timeout while checking the metadata enablement status. Tried for %s seconds.",
   "errorEnablingOmniStudioSettingsMetadata": "Error while enabling the Omnistudio Metadata setting: %s. Enable it manually.",
-  "fieldIntegrityException": "Field integrity Exception while deleting metadata records from %s: %s",
+  "fieldIntegrityExceptions": "Metadata cleanup failed for %s due to a field integrity exception. Deactivate Active %s and try again.",
   "manuallyEnableOmniStudioSettingsMetadata": "Manually enable the Omnistudio Metadata setting in your org’s Omnistudio Settings page.",
   "omniStudioMetadataEnableConsentNotGiven": "You’ve not consented to proceed with enabling the Omnistudio Metadata setting. We’ll not be able to proceed with the migration.",
   "enablingOmniStudioSettingsMetadataStatus": "Enabling Omnistudio Metadata setting…",

src/utils/config/OmniStudioMetadataCleanupService.ts

@@ -21,6 +21,13 @@ export class OmniStudioMetadataCleanupService {
     'OmniDataTransformConfig',
   ];
 
+  private static readonly FIELD_MAP = {
+    OmniUiCardConfig: 'Flexcard',
+    OmniScriptConfig: 'OmniScript',
+    OmniIntegrationProcConfig: 'Integration Procedure',
+    OmniDataTransformConfig: 'Data Mapper',
+  };
+
   private readonly connection: Connection;
   private readonly messages: Messages;
 
@@ -60,17 +67,33 @@ export class OmniStudioMetadataCleanupService {
 
       let totalCleanedRecords = 0;
       const failedTables: string[] = [];
+      const tablesWithFieldIntegrityExceptions: string[] = [];
+      const toDeactivate: string[] = [];
 
       for (const tableName of OmniStudioMetadataCleanupService.CONFIG_TABLES) {
-        const recordCount = await this.cleanupOmniStudioMetadataTable(tableName);
+        const result = await this.cleanupOmniStudioMetadataTable(tableName);
 
-        if (recordCount >= 0) {
-          totalCleanedRecords += recordCount;
+        if (result.recordCount >= 0) {
+          totalCleanedRecords += result.recordCount;
         } else {
           failedTables.push(tableName);
+          if (result.statusCode === 'FIELD_INTEGRITY_EXCEPTION') {
+            tablesWithFieldIntegrityExceptions.push(tableName);
+            toDeactivate.push(OmniStudioMetadataCleanupService.FIELD_MAP[tableName]);
+          }
         }
       }
 
+      if (tablesWithFieldIntegrityExceptions.length > 0) {
+        Logger.error(
+          this.messages.getMessage('fieldIntegrityExceptions', [
+            tablesWithFieldIntegrityExceptions.join(', '),
+            toDeactivate.join(', '),
+          ])
+        );
+        return false;
+      }
+
       if (failedTables.length > 0) {
         Logger.error(this.messages.getMessage('failedToCleanTables', [failedTables.join(', ')]));
         return false;
@@ -88,20 +111,21 @@ export class OmniStudioMetadataCleanupService {
    * Checks a specific table for records and cleans them if found
    *
    * @param tableName - Name of the table to check and clean
-   * @returns Promise<number> - number of cleaned records, or -1 if failed
+   * @returns Promise<{recordCount: number, statusCode?: string}> - recordCount: number of cleaned records (or -1 if failed), statusCode: optional error status code
    */
-  private async cleanupOmniStudioMetadataTable(tableName: string): Promise<number> {
+  private async cleanupOmniStudioMetadataTable(
+    tableName: string
+  ): Promise<{ recordCount: number; statusCode?: string }> {
     const recordIds = await QueryTools.queryIds(this.connection, tableName);
 
     if (recordIds.length === 0) {
-      return 0;
+      return { recordCount: 0 };
     }
 
     const deleteResult = await NetUtils.deleteWithFieldIntegrityException(this.connection, recordIds);
-    if (!deleteResult.success && deleteResult.statusCode === 'FIELD_INTEGRITY_EXCEPTION') {
-      Logger.error(this.messages.getMessage('fieldIntegrityException', [tableName, deleteResult.message || '']));
-      return -1;
+    if (!deleteResult.success) {
+      return { recordCount: -1, statusCode: deleteResult.statusCode };
     }
-    return deleteResult.success ? recordIds.length : -1;
+    return { recordCount: recordIds.length };
   }
 }