Reserved Key and Duplicate Element name

Author: mdmehran-qureshi

messages/assess.json

@@ -184,5 +184,6 @@
   "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
   "nameMappingUndefined": "Name Mapping is undefined",
-  "experienceSiteException": "Exception occurred while processing experience sites"
+  "experienceSiteException": "Exception occurred while processing experience sites",
+  "reservedKeysFoundInPropertySet": "Reserved keys found in any of output response transformation fields: %s."
 }

messages/migrate.json

@@ -197,6 +197,7 @@
   "missingInfo": "Info is missing",
   "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
-  "nameMappingUndefined": "Name Mapping is undefined",
-  "experienceSiteException": "Exception occurred while processing experience sites"
-}
+  "experienceSiteException": "Exception occurred while processing experience sites",
+  "reservedKeysFoundInPropertySet": "Reserved keys found in any of output response transformation fields: %s.",
+  "nameMappingUndefined": "Name Mapping is undefined"
+}

src/migration/omniscript.ts

@@ -43,6 +43,12 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
   private readonly exportType: OmniScriptExportType;
   private readonly allVersions: boolean;
 
+  // Reserved keys that should not be used for storing output
+  private readonly reservedKeys = new Set<string>(['Request', 'Response', 'Condition']);
+
+  // Tags to validate in PropertySet for reserved key usage
+  private readonly tagsToValidate = new Set<string>(['additionalOutput']);
+
   // constants
   private readonly OMNISCRIPT = 'OmniScript';
 
@@ -358,11 +364,31 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     const dependenciesLWC: nameLocation[] = [];
 
     //const missingRA: string[] = [];
+
+    // Check for duplicate element names within the same OmniScript
+    const elementNames = new Set<string>();
+    const duplicateElementNames = new Set<string>();
+
+    // Track reserved keys found in PropertySet
+    const foundReservedKeys = new Set<string>();
+
+    for (const elem of elements) {
+      const elemName = elem['Name'];
+      if (elementNames.has(elemName)) {
+        duplicateElementNames.add(elemName);
+      } else {
+        elementNames.add(elemName);
+      }
+    }
+
     for (const elem of elements) {
       const type = elem[this.namespacePrefix + 'Type__c'];
       const elemName = `${elem['Name']}`;
       const propertySet = JSON.parse(elem[this.namespacePrefix + 'PropertySet__c'] || '{}');
 
+      // Collect reserved keys from PropertySet
+      this.collectReservedKeys(propertySet, foundReservedKeys);
+
       // Check for OmniScript dependencies
       if (type === 'OmniScript') {
         const nameVal = `${elemName}`;
@@ -493,6 +519,20 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
       existingOmniscriptNames.add(recordName);
     }
 
+    // Add warning for duplicate element names within the same OmniScript
+    if (duplicateElementNames.size > 0) {
+      const duplicateNamesList = Array.from(duplicateElementNames).join(', ');
+      warnings.unshift(this.messages.getMessage('invalidOrRepeatingOmniscriptElementNames', [duplicateNamesList]));
+      assessmentStatus = 'Needs Manual Intervention';
+    }
+
+    // Add warning for reserved keys found in PropertySet
+    if (foundReservedKeys.size > 0) {
+      const reservedKeysList = Array.from(foundReservedKeys).join(', ');
+      warnings.unshift(this.messages.getMessage('reservedKeysFoundInPropertySet', [reservedKeysList]));
+      assessmentStatus = 'Needs Manual Intervention';
+    }
+
     if (omniProcessType === this.OMNISCRIPT) {
       const type = omniscript[this.namespacePrefix + 'IsLwcEnabled__c'] ? 'LWC' : 'Angular';
       if (type === 'Angular') {
@@ -648,10 +688,17 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
       // Get All elements for each OmniScript__c record(i.e IP/OS)
       const elements = await this.getAllElementsForOmniScript(recordId);
       if (omniscript[`${this.namespacePrefix}IsProcedure__c`] === true) {
+        // Check for reserved keys in PropertySet for Integration Procedures
+        const foundReservedKeys = new Set<string>();
+
         // do the formula replacement from custom to standard notation
         if (functionDefinitionMetadata.length > 0 && elements.length > 0) {
           for (let ipElement of elements) {
             if (ipElement[`${this.namespacePrefix}PropertySet__c`] != null) {
+              // Check for reserved keys while processing the PropertySet
+              const propertySet = JSON.parse(ipElement[`${this.namespacePrefix}PropertySet__c`] || '{}');
+              this.collectReservedKeys(propertySet, foundReservedKeys);
+
               var originalString = ipElement[`${this.namespacePrefix}PropertySet__c`];
               try {
                 originalString = getReplacedString(
@@ -669,6 +716,24 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
             }
           }
         }
+
+        // If reserved keys found, skip this IP
+        if (foundReservedKeys.size > 0) {
+          const reservedKeysList = Array.from(foundReservedKeys).join(', ');
+          const skippedResponse: UploadRecordResult = {
+            referenceId: recordId,
+            id: '',
+            success: false,
+            hasErrors: false,
+            errors: [],
+            warnings: [this.messages.getMessage('reservedKeysFoundInPropertySet', [reservedKeysList])],
+            newName: '',
+            skipped: true,
+          };
+          osUploadInfo.set(recordId, skippedResponse);
+          originalOsRecords.set(recordId, omniscript);
+          continue;
+        }
       }
 
       // Perform the transformation for OS/IP Parent Record from OmniScript__c
@@ -918,9 +983,8 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
             }
           }
 
-          let finalKey = `${oldrecord[this.namespacePrefix + 'Type__c']}${
-            oldrecord[this.namespacePrefix + 'SubType__c']
-          }${oldrecord[this.namespacePrefix + 'Language__c']}`;
+          let finalKey = `${oldrecord[this.namespacePrefix + 'Type__c']}${oldrecord[this.namespacePrefix + 'SubType__c']
+            }${oldrecord[this.namespacePrefix + 'Language__c']}`;
 
           finalKey = finalKey.toLowerCase();
           if (storage.osStorage.has(finalKey)) {
@@ -1306,6 +1370,37 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     return Object.keys(OmniScriptDefinitionMappings);
   }
 
+  /**
+   * Collects reserved keys found in PropertySet tagsToValidate
+   * @param propertySet - The PropertySet JSON object to validate
+   * @param foundReservedKeys - Set to collect found reserved keys
+   */
+  private collectReservedKeys(propertySet: any, foundReservedKeys: Set<string>): void {
+    // Iterate through each tag that needs validation
+    for (const tagToValidate of this.tagsToValidate) {
+      const tagValue = propertySet[tagToValidate];
+
+      if (tagValue) {
+        if (typeof tagValue === 'object' && tagValue !== null) {
+          // If it's an object, check all its keys
+          const keys = Object.keys(tagValue);
+          for (const key of keys) {
+            if (this.reservedKeys.has(key)) {
+              foundReservedKeys.add(key);
+            }
+          }
+        } else if (typeof tagValue === 'string') {
+          // If it's a string, check if the value itself is a reserved key
+          if (this.reservedKeys.has(tagValue)) {
+            foundReservedKeys.add(tagValue);
+          }
+        }
+      }
+    }
+  }
+
+
+
   private sleep() {
     return new Promise((resolve) => {
       setTimeout(resolve, 5000);

src/utils/constants/documentRegistry.ts

@@ -58,4 +58,6 @@ export const documentRegistry = {
   duplicateCardNameMessage: 'https://help.salesforce.com/s/articleView?id=xcloud.os_clone_a_flexcard.htm&type=5',
   duplicateGlobalAutoNumberNameMessage:
     'https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_naming_conventions.htm&type=5',
+  reservedKeysFoundInPropertySet:
+    'https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_naming_conventions.htm&type=5',
 };