Add Support for Only and RelatedObjects Flags in Assess Mode (#280)

Author: rajender-kumar-salesforce

README.md

@@ -20,17 +20,25 @@ sfdx plugins:install @salesforce/plugin-omnistudio-migration-tool
 // To migrate everything
 sfdx omnistudio:migration:migrate -u [email protected] --namespace=VLOCITY_PACKAGE_NAMESPACE
 
-//to migrate specific components: FlexCards, DataMappers, Integration Procedures, or OmniScripts, add the following parameters:
+// To assess everything without migrating
+sfdx omnistudio:migration:assess -u [email protected] --namespace=VLOCITY_PACKAGE_NAMESPACE
+
+// 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 all versions of the components and not just the active ones:
+// To migrate all versions of the components and not just the active ones:
 --allversions
+
+// To assess specific related objects:
+--relatedobjects=apex    // for Apex classes only
+--relatedobjects=lwc     // for Lightning Web Components only
+--relatedobjects=apex,lwc // for both Apex and LWC
 ```
 
-5. An HTML page will be open in your default browser with the results of your migration job.
+5. An HTML page will be open in your default browser with the results of your migration/assessment job.
 
 ### Usage & parameters
 
@@ -59,9 +67,13 @@ OPTIONS
   -a, --allversions                                                                 migrate all versions and not
                                                                                     and not just the active ones.
 
-  --relatedobjects=relatedobjects                                                   Please select the type of components to
-                                                                                    migrate: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types.
+  --only=only                                                                       specify components to migrate/assess:
+                                                                                    dr (DataRaptors), ip (Integration Procedures),
+                                                                                    os (OmniScripts), fc (FlexCards)
 
+  --relatedobjects=relatedobjects                                                   specify related objects to assess:
+                                                                                    'apex' for Apex classes, 'lwc' for Lightning
+                                                                                    Web Components, or 'apex,lwc' for both types
 ```
 
 > **Note:** LWC (Lightning Web Components) migration functionality is temporarily disabled in the current version. This includes LWC migration, assessment, and report generation features. These features will be re-enabled in a future release. Apex migration functionality remains fully available. The `--relatedobjects` flag accepts all values ('apex', 'lwc', 'apex,lwc'), but LWC-related operations will not be executed.

command-snapshot.json

@@ -2,25 +2,56 @@
   {
     "command": "basecommand",
     "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["apiversion", "json", "loglevel", "targetusername"],
+    "flags": [
+      "apiversion",
+      "json",
+      "loglevel",
+      "targetusername"
+    ],
     "alias": []
   },
   {
     "command": "omnistudio:migration:assess",
     "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["allversions", "apiversion", "json", "loglevel", "namespace", "only", "targetusername"],
+    "flags": [
+      "allversions",
+      "apiversion",
+      "json",
+      "loglevel",
+      "namespace",
+      "only",
+      "targetusername",
+      "relatedobjects"
+    ],
     "alias": []
   },
   {
     "command": "omnistudio:migration:info",
     "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["allversions", "apiversion", "json", "loglevel", "name", "targetdevhubusername", "targetusername"],
+    "flags": [
+      "allversions",
+      "apiversion",
+      "json",
+      "loglevel",
+      "name",
+      "targetdevhubusername",
+      "targetusername"
+    ],
     "alias": []
   },
   {
     "command": "omnistudio:migration:migrate",
     "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["allversions", "apiversion", "json", "loglevel", "namespace", "only", "relatedobjects", "targetusername"],
+    "flags": [
+      "allversions",
+      "apiversion",
+      "json",
+      "loglevel",
+      "namespace",
+      "only",
+      "relatedobjects",
+      "targetusername"
+    ],
     "alias": []
   }
-]
+]

messages/assess.json

@@ -29,5 +29,5 @@
   "allVersionsDescription": "Migrate all versions of a component",
   "changeMessage": " %s will be changed from %s to %s",
   "angularOSWarning": " Angular OmniScript will not be migrated, please convert this to LWC based Omniscript",
-  "apexLwc": "Please select the type of components to migrate: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types."
+  "apexLwc": "Please select the type of components to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types."
 }