https://github.com/salesforcecli/plugin-omnistudio-migration-tool
https://github.com/salesforcecli/plugin-omnistudio-migration-tool
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/salesforcecli/plugin-omnistudio-migration-tool
- Owner: salesforcecli
- License: bsd-3-clause
- Created: 2022-05-09T17:31:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T06:31:15.000Z (5 months ago)
- Last Synced: 2026-01-17T11:55:27.036Z (5 months ago)
- Language: TypeScript
- Size: 3.88 MB
- Stars: 2
- Watchers: 6
- Forks: 11
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# OmniStudio Migration Tool
## 🚀 Before You Begin
⚠️ IMPORTANT: Before installing and using the Omnistudio Migration Tool, contact Salesforce support.
Follow the steps in [Migration Process from Omnistudio for Managed Packages to Omnistudio](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_omnistudio_custom_objects_to_standard_objects.htm&language=en_US&type=5)
## Running SFDX plugin
1. Install SFDX cli using the official documentation located [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
2. Authenticate your SFDX cli into the org you are going to use for development. You can follow authentication steps [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_auth_web.htm).
3. In a new terminal session, install the plugin using the following command
```
sfdx plugins:install @salesforce/plugin-omnistudio-migration-tool
```
4. To run the migration tool, run the following command from your command line tool:
```
// To migrate everything
sfdx omnistudio:migration:migrate -u YOUR_ORG_USERNAME@DOMAIN.COM --namespace=VLOCITY_PACKAGE_NAMESPACE
//to migrate specific components: FlexCards, DataRaptors, 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
```
5. An HTML page will be open in your default browser with the results of your migration job.
### Usage & parameters
```
USAGE
$ sfdx omnistudio:migration:migrate [-n ] [-f] [-v ] [-u ] [--apiversion ] [--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.
```