Read and follow the directions in the Omnistudio migration documentation: https://help.salesforce.com/s/articleView?id=sf.os_migrate_omnistudio_custom_objects_to_standard_objects.htm&type=5
- Install SFDX cli using the official documentation located here.
- Authenticate your SFDX cli into the org you are going to use for development. You can follow authentication steps here.
- In a new terminal session, install the plugin using the following command
sfdx plugins:install @salesforce/plugin-omnistudio-migration-tool
- To run the migration tool, run the following command from your command line tool:
// To migrate everything
sfdx omnistudio:migration:migrate -u [email protected] --namespace=VLOCITY_PACKAGE_NAMESPACE
// 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:
--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
- An HTML page will be open in your default browser with the results of your migration/assessment job.
USAGE
$ sfdx omnistudio:migration:migrate [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-n, --namespace=namespace the namespace of the vertical package
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
org; overrides default dev hub org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
-a, --allversions migrate all versions and not
and not just the active ones.
--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
--relatedobjectsflag accepts all values ('apex', 'lwc', 'apex,lwc'), but LWC-related operations will not be executed.
Terms: Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Tool (‘Tool’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Tool you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Tool only as permitted to the Customer and shall not compromise, break or circumvent any technical processes or security measures associated with the services provided by SFDC. The Customer agrees to hold harmless, indemnify, and defend SFDC, and its officers, directors, agents, employees, licensees, successors and assigns (collectively, the “Indemnified Parties”) against any and all damages, penalties, losses, liabilities, judgments, settlements, awards, costs, and expenses (including reasonable attorneys’ fees and expenses) to the extent arising out of or in connection with any claims related to the Customers use of the Tool or any willful misconduct, fraud or grossly negligent acts or omissions by the Customer.