Migration and Assessment of Global Auto Numbers, Enable OmniGlobalAutoNumberPref (#333)

Author: rajender-kumar-salesforce

README.md

@@ -41,11 +41,12 @@ sfdx omnistudio:migration:assess -u [email protected]
 sfdx omnistudio:migration:migrate -u [email protected]
 
 
-// To migrate/assess specific components: FlexCards, DataMappers, Integration Procedures, or OmniScripts, add the following parameters:
---only=dr
---only=ip
---only=os
---only=fc
+// To migrate/assess specific components: FlexCards, DataMappers, Integration Procedures, OmniScripts, or Global Auto Numbers, add the following parameters:
+--only=dr    // DataMappers (DataRaptors)
+--only=ip    // Integration Procedures
+--only=os    // OmniScripts
+--only=fc    // FlexCards
+--only=autonumber   // Global Auto Numbers
 
 // To migrate all versions of the components and not just the active ones:
 --allversions
@@ -59,6 +60,47 @@ sfdx omnistudio:migration:migrate -u [email protected]
 
 5. An HTML page will be open in your default browser with the results of your migration/assessment reports.
 
+## Global Auto Number Migration
+
+Global Auto Numbers are components that generate sequential numbers across your Omnistudio org. The migration tool supports both assessment and migration of these components.
+
+### Prerequisites for Global Auto Number Migration
+
+Before migrating Global Auto Numbers, ensure that:
+
+1. **Org Preference is Disabled**: The `OmniGlobalAutoNumberPref` org preference must be disabled before migration
+2. **Rollback Flags are Disabled**: Both `RollbackIPChanges` and `RollbackDRChanges` flags must be disabled
+3. **Namespace is Specified**: Provide the correct namespace for your OmniStudio package
+
+### Global Auto Number Migration Process
+
+The migration process for Global Auto Numbers includes:
+
+1. **Pre-migration Checks**: Validates that org preferences and rollback flags are properly configured
+2. **Data Migration**: Transforms Global Auto Number settings from custom objects to standard Business Process Objects (BPO)
+3. **Post-migration Cleanup**: Removes source objects and enables the `OmniGlobalAutoNumberPref` org preference
+4. **Validation**: Ensures all records are successfully migrated before cleanup
+
+### Global Auto Number Assessment
+
+Assessment provides detailed information about:
+
+- **Name Changes**: Identifies any naming modifications required to comply with API naming standards
+- **Migration Readiness**: Determines if components can be automatically migrated or require manual intervention
+- **Warnings**: Highlights potential issues that may affect migration success
+
+### Usage Examples for Global Auto Numbers
+
+```bash
+# Assess Global Auto Numbers only
+sfdx omnistudio:migration:assess -u [email protected] --only=autonumber
+
+# Migrate Global Auto Numbers only
+sfdx omnistudio:migration:migrate -u [email protected] --only=autonumber
+```
+
+5. An HTML page will be open in your default browser with the results of your migration/assessment job.
+
 ### Assess Usage & parameters
 
 ```
@@ -88,7 +130,7 @@ OPTIONS
 
   --only=only                                                                       specify components to assess:
                                                                                     dr (DataRaptors), ip (Integration Procedures),
-                                                                                    os (OmniScripts), fc (FlexCards)
+                                                                                    os (OmniScripts), fc (FlexCards), autonumber (Global Auto Numbers)
 
   --relatedobjects=relatedobjects                                                   specify related objects to assess:
                                                                                     'apex' for Apex classes

messages/assess.json

@@ -1,17 +1,18 @@
 {
   "examples": [
-    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE",
-    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=dr",
-    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=ip",
-    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=os",
-    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=fc"
+    "omnistudio:migration:assess -u [email protected] ",
+    "omnistudio:migration:assess -u [email protected]  --only=dr",
+    "omnistudio:migration:assess -u [email protected]  --only=ip",
+    "omnistudio:migration:assess -u [email protected]  --only=os",
+    "omnistudio:migration:assess -u [email protected]  --only=fc",
+    "omnistudio:migration:assess -u [email protected]  --only=autonumber"
   ],
   "commandDescription": "Assess migration of omnistudio components from custom objects to standard objects",
   "namespaceFlagDescription": "The namespaced of the package",
   "apiVersionFlagDescription": "The Salesforce API version to use",
   "errorNoOrgResults": "No results found for the org '%s'.",
-  "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr",
-  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr",
+  "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr | autonumber",
+  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr | autonumber",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
   "couldNotTruncate": "Could not truncate {0}",
   "couldNotTruncateOmnniProcess": "Could not truncate OmniProcess. Please make sure your OS/IP is not referenced in an OmniScrirpt or Flex Card.",
@@ -39,13 +40,17 @@
   "formulaSyntaxError": "There was some problem while updating the formula syntax, please check the all the formula's syntax once : %s",
   "errorDuringFlexCardAssessment": "Error during FlexCard assessment",
   "errorDuringOmniScriptAssessment": "Error during OmniScript assessment",
+  "errorDuringGlobalAutoNumberAssessment": "Error during GlobalAutoNumber assessment",
   "processingFlexCard": "Processing FlexCard: %s",
   "processingDataRaptor": "Processing DataRaptor: %s",
   "processingOmniScript": "Processing OmniScript: %s",
+  "processingGlobalAutoNumber": "Processing GlobalAutoNumber: %s",
   "foundDataRaptorsToAssess": "Found %s DataRaptors to assess",
   "foundOmniScriptsToAssess": "Found %s OmniScripts and Integration Procedures to assess",
+  "foundGlobalAutoNumbersToAssess": "Found %s GlobalAutoNumbers to assess",
   "startingDataRaptorAssessment": "Starting DataRaptor assessment",
   "startingOmniScriptAssessment": "Starting OmniScript assessment",
+  "startingGlobalAutoNumberAssessment": "Starting GlobalAutoNumber assessment",
   "allVersionsInfo": "allVersions : %s",
   "assessmentInitialization": "Assessment Initialization: Using namespace: %s",
   "apiVersionInfo": "API Version: %s",
@@ -57,6 +62,9 @@
   "flexCardAssessment": "FlexCard Assessment",
   "assessedFlexCardsCount": "Assessed %s FlexCards",
   "flexCardAssessmentCompleted": "FlexCard assessment completed",
+  "globalAutoNumberAssessment": "GlobalAutoNumber Assessment",
+  "assessedGlobalAutoNumbersCount": "Assessed %s GlobalAutoNumbers",
+  "globalAutoNumberAssessmentCompleted": "GlobalAutoNumber assessment completed",
   "omniScriptAssessment": "OmniScript and Integration Procedure Assessment",
   "assessedOmniScriptsCount": "Assessed %s OmniScripts",
   "assessedIntegrationProceduresCount": "Assessed %s Integration Procedures",
@@ -89,6 +97,8 @@
   "methodCallBundleNameUpdated": "Method call bundle name will be updated in %s for class %s method %s",
   "cardNameChangeMessage": "Card name will be changed from {0} to {1} to follow API naming standards",
   "authordNameChangeMessage": "Author name will be changed from {0} to {1} to follow API naming standards",
+  "globalAutoNumberNameChangeMessage": "GlobalAutoNumber name will be changed from %s to %s to follow API naming standards",
+  "duplicateGlobalAutoNumberNameMessage": "Potential duplicate: Another Global Auto Number has the same name %s after name cleaning. This may cause conflicts during migration",
   "omniScriptNameChangeMessage": "OmniScript reference part {0} will be changed to {1} during migration.",
   "dataRaptorNameChangeMessage": "DataRaptor reference {0} will be changed to {1} during migration.",
   "integrationProcedureNameChangeMessage": "Integration Procedure reference {0} will be changed to {1} during migration.",

messages/migrate.json

@@ -1,20 +1,21 @@
 {
   "examples": [
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=dr",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=ip",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=os",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=fc",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r apex,lwc",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r apex",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r lwc"
+    "omnistudio:migration:migrate -u [email protected] ",
+    "omnistudio:migration:migrate -u [email protected]  --only=dr",
+    "omnistudio:migration:migrate -u [email protected]  --only=ip",
+    "omnistudio:migration:migrate -u [email protected]  --only=os",
+    "omnistudio:migration:migrate -u [email protected]  --only=fc",
+    "omnistudio:migration:migrate -u [email protected]  --only=autonumber",
+    "omnistudio:migration:migrate -u [email protected]  -r apex,lwc",
+    "omnistudio:migration:migrate -u [email protected]  -r apex",
+    "omnistudio:migration:migrate -u [email protected]  -r lwc"
   ],
   "commandDescription": "Migrate omnistudio components from custom objects to standard objects",
   "namespaceFlagDescription": "The namespace of the package",
   "apiVersionFlagDescription": "The Salesforce API version to use",
   "errorNoOrgResults": "No results found for the org '%s'.",
-  "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr",
-  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr",
+  "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr | autonumber",
+  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr | autonumber",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
   "couldNotTruncate": "Could not truncate {0}",
   "couldNotTruncateOmnniProcess": "Could not truncate OmniProcess. Please make sure your OS/IP is not referenced in an OmniScrirpt or Flex Card.",
@@ -63,11 +64,13 @@
   "cleaningComponent": "Cleaning: %s",
   "cleaningDone": "Cleaning Done: %s",
   "migratingComponent": "Migrating: %s",
+  "cleaningFailed": "Cleaning Failed: %s",
   "migrationCompleted": "Migration completed: %s",
   "formulaSyntaxError": "There was some problem while updating the formula syntax, please check the all the formula's syntax once : %s",
   "foundDataRaptorsToMigrate": "Found %s DataRaptors to migrate",
   "foundFlexCardsToMigrate": "Found %s FlexCards to migrate",
   "foundOmniScriptsToMigrate": "Found %s OmniScripts and Integration Procedures to migrate",
+  "foundGlobalAutoNumbersToMigrate": "Found %s GlobalAutoNumbers to migrate",
   "allVersionsInfo": "allVersions : %s",
   "migrationInitialization": "Migration Initialization: Using namespace: %s",
   "apiVersionInfo": "API Version: %s",
@@ -109,5 +112,26 @@
   "errorParsingData": "Error while parsing data for template",
   "errorGeneratingHTML": "Error while generating HTML from template for {} with properties {}",
   "errorEvaluatingExpression": "Error evaluating expression: {0}, {1}",
-  "manuallySwitchDesignerToStandardDataModel": "To complete the setup, please manually run the required Apex code to configure OmniStudio Designers to use the Standard Data Model <br> https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_change_the_sobject_data_model_after_migration.htm&type=5"
+  "manuallySwitchDesignerToStandardDataModel": "To complete the setup, please manually run the required Apex code to configure OmniStudio Designers to use the Standard Data Model <br> https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_change_the_sobject_data_model_after_migration.htm&type=5",
+  "omniGlobalAutoNumberPrefEnabled": "Successfully enabled OmniGlobalAutoNumberPref org preference",
+  "errorEnablingOmniGlobalAutoNumberPref": "Error enabling OmniGlobalAutoNumberPref org preference",
+  "performingPreMigrationChecks": "Performing pre-migration checks for Global Auto Number...",
+  "preMigrationChecksPassed": "Pre-migration checks passed. Proceeding with Global Auto Number migration.",
+  "preMigrationChecksFailed": "Pre-migration checks failed. Migration cannot proceed.",
+  "globalAutoNumberPrefEnabledError": "Global Auto Number preference (OmniGlobalAutoNumberPref) is enabled. Please disable it before proceeding with migration.",
+  "bothRollbackFlagsEnabledError": "Both RollbackIPChanges and RollbackDRChanges flags are enabled. Please disable both flags before proceeding with Global Auto Number migration.",
+  "rollbackIPFlagEnabledError": "RollbackIPChanges flag is enabled. Please disable this flag before proceeding with Global Auto Number migration.",
+  "rollbackDRFlagEnabledError": "RollbackDRChanges flag is enabled. Please disable this flag before proceeding with Global Auto Number migration.",
+  "errorCheckingRollbackFlags": "Error checking rollback flags status.",
+  "startingPostMigrationCleanup": "Starting post-migration cleanup for Global Auto Number...",
+  "postMigrationCleanupCompleted": "Post-migration cleanup completed successfully.",
+  "errorDuringPostMigrationCleanup": "Error during post-migration cleanup.",
+  "globalAutoNumberNameChangeMessage": "Global Auto Number name has been modified to fit naming rules: %s",
+  "duplicatedGlobalAutoNumberName": "Duplicated Global Auto Number name",
+  "errorWhileUploadingGlobalAutoNumber": "An error occurred while uploading Global Auto Number: ",
+  "startingGlobalAutoNumberAssessment": "Starting Global Auto Number assessment...",
+  "foundGlobalAutoNumbersToAssess": "Found %s Global Auto Numbers to assess",
+  "unexpectedError": "An unexpected error occurred during processing",
+  "migrationValidationFailed": "Post Migration validation failed.",
+  "incompleteMigrationDetected": "Incomplete migration detected. Source objects: %s, Target objects: %s."
 }

src/commands/omnistudio/migration/assess.ts

@@ -7,6 +7,7 @@ import { AssessmentReporter } from '../../../utils/resultsbuilder/assessmentRepo
 import { OmniScriptExportType, OmniScriptMigrationTool } from '../../../migration/omniscript';
 import { CardMigrationTool } from '../../../migration/flexcard';
 import { DataRaptorMigrationTool } from '../../../migration/dataraptor';
+import { GlobalAutoNumberMigrationTool } from '../../../migration/globalautonumber';
 import { DebugTimer } from '../../../utils';
 import { Logger } from '../../../utils/logger';
 import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
@@ -102,6 +103,7 @@ export default class Assess extends OmniStudioBaseCommand {
       apexAssessmentInfos: [],
       dataRaptorAssessmentInfos: [],
       flexCardAssessmentInfos: [],
+      globalAutoNumberAssessmentInfos: [],
       omniAssessmentInfo: {
         osAssessmentInfos: [],
         ipAssessmentInfos: [],
@@ -164,6 +166,7 @@ export default class Assess extends OmniStudioBaseCommand {
       await this.assessDataRaptors(assesmentInfo, namespace, conn);
       await this.assessFlexCards(assesmentInfo, namespace, conn, allVersions);
       await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.All);
+      await this.assessGlobalAutoNumbers(assesmentInfo, namespace, conn);
       return;
     }
 
@@ -180,6 +183,9 @@ export default class Assess extends OmniStudioBaseCommand {
       case Constants.IntegrationProcedure:
         await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.IP);
         break;
+      case Constants.GlobalAutoNumber:
+        await this.assessGlobalAutoNumbers(assesmentInfo, namespace, conn);
+        break;
       default:
         throw new Error(messages.getMessage('invalidOnlyFlag'));
     }
@@ -230,4 +236,18 @@ export default class Assess extends OmniStudioBaseCommand {
     );
     Logger.log(messages.getMessage('omniScriptAssessmentCompleted'));
   }
+
+  private async assessGlobalAutoNumbers(
+    assesmentInfo: AssessmentInfo,
+    namespace: string,
+    conn: Connection
+  ): Promise<void> {
+    Logger.logVerbose(messages.getMessage('startingGlobalAutoNumberAssessment'));
+    const globalAutoNumberMigrationTool = new GlobalAutoNumberMigrationTool(namespace, conn, Logger, messages, this.ux);
+    assesmentInfo.globalAutoNumberAssessmentInfos = await globalAutoNumberMigrationTool.assess();
+    Logger.logVerbose(
+      messages.getMessage('assessedGlobalAutoNumbersCount', [assesmentInfo.globalAutoNumberAssessmentInfos.length])
+    );
+    Logger.log(messages.getMessage('globalAutoNumberAssessmentCompleted'));
+  }
 }