The Omnistudio Migration Assistant is a command-line interface (CLI) plugin that you install via Salesforce CLI. It creates records for your omnistudio components on the Salesforce standard objects.
-
Review the migration phases in Migration Process from Omnistudio for Managed Packages to Omnistudio
-
Install Salesforce CLI on your computer. See : Install Salesforce CLI.
- Install SF cli using the official documentation located here.
- Authenticate Salesforce CLI in your migration sandbox (the org you are going to use for development) using the
sf org login webcommand and then enter your username and password in the new browser tab that appears. See Salesforce CLI Command Reference org login Commands.
sf org login web --instance-url=<Org URL>
When prompted, enter your username and password, and connect. The command-line interface shows the message "Authentication Successful"
For example:
username@userdomain ~ % sf org login web --instance-url=https://usa794org-5b.my.salesforce.com
You then see the authorization message. Successfully authorized username@salesforce.com with org ID 00DHp000004ArLWMA0
You can also authenticate using a consumer key (client ID) and secret key through connected apps. See Authorization Through Connected Apps and OAuth 2.0.
- In a new terminal session, Install the Omnistudio Migration Assistant by running the
sf plugins installcommand. For example
sf plugins install @salesforce/plugin-omnistudio-migration-tool@2.0.0-beta.25
- Run the Omnistudio Migration Assistant from the Salesforce CLI:
// To assess everything without migrating
sfdx omnistudio:migration:assess -u YOUR_ORG_USERNAME@DOMAIN.COM
// To migrate everything
sfdx omnistudio:migration:migrate -u YOUR_ORG_USERNAME@DOMAIN.COM
// To migrate/assess specific components: FlexCards, DataMappers, Integration Procedures, or OmniScripts, add the following parameters:
--only=dm
--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
- An HTML page will be open in your default browser with the results of your migration/assessment reports.
USAGE
$ sf omnistudio:migration:assess [-f] [-v <string>] [-u <string>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-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
--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 assess:
dr (DataRaptors), ip (Integration Procedures),
os (OmniScripts), fc (FlexCards)
--relatedobjects=relatedobjects specify related objects to assess:
'apex' for Apex classes
USAGE
$ sf omnistudio:migration:migrate [-f] [-v <string>] [-u <string>] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-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
--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:
dm (DataMappers), ip (Integration Procedures),
os (OmniScripts), fc (FlexCards)
--relatedobjects=relatedobjects specify related objects to assess:
'apex' for Apex classes
Note: LWC (Lightning Web Components) assessment/migration functionality is temporarily disabled in the current version. LWC features will be re-enabled in a future releases.
Apex migration functionality remains fully available. The
--relatedobjectsflag only accepts values ('apex')
Terms: Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Assistant (‘Assistant’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Assistant you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Assistant 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 Assistant or any willful misconduct, fraud or grossly negligent acts or omissions by the Customer.