--- schema_version: "1" id: de1e0d8908e6c5bb61c5373f6fa9a12072b2813065224ad4d10c15bc3edef087 title: Migrate Your Components in Your Development Sandbox (Vlocity Industries Managed Packages and Custom Data Model) collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_migrate_phase1_step3.md canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_phase1_step3.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 616f0bc8604a7e1022ea1b206a87325de37acfdca253b5fb57ab2f4c51d69d5a description: Migrate all your custom components from Omnistudio for Vlocity to Omnistudio Standard using the Omnistudio Migration Assistant. It overwrites any previously migrated components. products: - Omnistudio release: "264" --- # Migrate Your Components in Your Development Sandbox (Vlocity Industries Managed Packages and Custom Data Model) Migrate all your custom components from Omnistudio for Vlocity to Omnistudio Standard using the Omnistudio Migration Assistant. It overwrites any previously migrated components. ![Important](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_important.png) Important Run the Omnistudio Migration Assistant in Migrate mode only once. If you want to run the tool more than once, create a new development sandbox and run it. Before You Begin - Run the Omnistudio Migration Assistant in Assess mode to make sure that you understand the impact. Skipping the Assess mode can lead to incomplete or incorrect migration. - Check the Migration Assessment Reports for **Failed** or **Needs manual intervention** status, and resolve them. See [Review the Assessment Reports (Vlocity Industries Managed Packages and Custom Data Model)](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_review_assess_reports.htm&release=264.0.0&type=5 "When you run the Omnistudio Migration Assistant in Assess mode, it generates assessment reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These assessment reports highlight several key areas that require attention before migrating Omnistudio components.") - Make sure that no records in the **Assessment Status** column of the Assessment Report have a **Failed** or **Needs manual intervention** status before proceeding with the migration. See [Review the Assessment Reports (Vlocity Industries Managed Packages and Custom Data Model)](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_review_assess_reports.htm&release=264.0.0&type=5 "When you run the Omnistudio Migration Assistant in Assess mode, it generates assessment reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These assessment reports highlight several key areas that require attention before migrating Omnistudio components."). - For Lightning web component (LWC) deployment, set the required environment variable in your org: 1. Request an NPM repository access key from Salesforce Customer Support. 2. Set the required environment variable in your org: ``` export OMA_AUTH_KEY= ``` This environment variable provides the authentication key used to download the unmanaged component bundle from npm, bundle it, and deploy the components. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png) Note If you're using Windows OS, add the OMA\_AUTH\_KEY in the environment variables. To migrate all your custom components from Omnistudio for Vlocity to Omnistudio Standard: ![phase1\_step3\_migrate](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/omnistudio_for_managed_packages/images/os_oma_migrate_phase1_step3_migrate.png) ![Warning](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_warning.png) Warning Migrate all component types in a single migration run. Don't use the --only parameter to migrate a subset of components (for example, running --only=dm and then --only=ip as separate migrations). Component types depend on each other, Integration Procedures depend on Data Mappers, and migrating them separately causes the dependent components to fail activation with HTTP 400 errors. The --only parameter is intended for the assess command only. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png) Note If you already ran a scoped migration and your components fail to activate, back up any work built on the standard data model, rerun the migration for all component types together (without --only) on a fresh sandbox copy, and then redeploy your backup. Rerunning the migration deletes existing standard data model content, so complete the backup first. Test this in a separate org before you rerun the production migration. 1. Make sure you completed [Assess the Migration Readiness in Your Development Sandbox (Vlocity Industries Managed Packages and Custom Data Model)](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_phase1_step2.htm&release=264.0.0&type=5 "In the development sandbox, run the Omnistudio Migration Assistant in Assess mode to assess how the migration process impacts each Omnistudio component."). 2. Run the Omnistudio Migration Assistant tool in Migrate mode: `sf omnistudio:migration:migrate [-u ] [-a] [-v ] [--relatedobjects=(apex|lwc|expsites|flexipage) [--loglevel=(trace|debug|info|warn|error|fatal|trace)]` - To migrate all versions of the components, use `-a` or `–allversions`: ``` sf omnistudio:migration:migrate -u -a ``` Where, `YOUR_ORG_USERNAME@DOMAIN.COM` is your username in the sandbox. Example: `sf omnistudio:migration:migrate -u asmith@sample.com -a` - To migrate specific or all related objects: - `--relatedobjects=apex`: Apex classes - `--relatedobjects=lwc`: Lightning web components - `--relatedobjects=expsites`: Experience Sites - `--relatedobjects=flexipage`: FlexiPages - `--relatedobjects="apex,lwc,expsites,flexipage"`: all related objects Example: `sf omnistudio:migration:migrate -u asmith@sample.com --relatedobjects=apex` - To migrate username or alias for the target org and to override the default target org: - `-u ` or `--targetusername=`: Username of the target org or alias you’ve set up in Salesforce CLI for that org. Example: `sf omnistudio:migration:migrate -u asmith@sample.com` - To migrate username or alias for the Dev Hub org and to override the default Dev Hub org: - `-v ` or `--targetdevhubusername=`: Username of the target Dev Hub org or alias you’ve set up in Salesforce CLI for that org. Example: `sf omnistudio:migration:migrate -v asmith@sample.com` - To control the amount of detail shown in the command output: - `--loglevel=(trace|debug|info|warn|error|fatal`) : Sets the logging level for this command invocation. Default is warn. - `trace` or `debug`: Show very detailed logs, useful for troubleshooting. - `info`: Shows general informational messages. - `warn` (default): Shows warnings and errors only. - `error` or `fatal:` Shows only errors or critical failures. Example: `sf omnistudio:migration:migrate -u asmith@sample.com –loglevel=debug` 3. If multiple Omnistudio packages are found, select one of the packages by entering its number. 4. Enter y to confirm that all records listed in the **Assessment Status** column in the Assessment Report are marked as either **Ready for Migration** or **Warnings**. 5. Enter y to confirm that you accept changes to your custom code and the accompanying terms and conditions. 6. When prompted, enter y or n to specify whether you already have a Salesforce project with related objects. - If you entered n: 1. The tool connects to your org and retrieves the Apex classes. 2. Enter y to proceed. 3. Create an empty project folder where the tool can retrieve and store Apex classes. 4. When prompted, enter the path to the project folder. For example: /Users//Downloads/OMA - If you entered y: 1. When prompted, enter the path to the project folder that contains the retrieved Apex classes. For example: /Users//Downloads/OMA 7. Enter the target namespace (package name) for invoking the Apex classes in the Omnistudio managed package. For example: `vlocity_ins`, `vlocity_ps`, `vlocity_cmt`, and so on. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png) Note Do not enter `omnistudio` as the target namespace. 8. Enter y to confirm that you consent to enable the ExperienceBundle metadata API and migrate Experience Cloud sites. 9. Enter y or n to specify whether you want the tool to deploy the related objects automatically. - If you entered y, the migration process starts and deploys the metadata changes for Apex classes, Lightning web components (LWCs), Experience Cloud Site pages, and FlexiPages. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png) Note If the required environment variable is not set in your org, LWCs are not deployed. - If you entered n, you must manually deploy the metadata changes for Apex classes, Lightning web components, Experience Cloud Site pages, and FlexiPages. The migration process is initiated. After the migration completes, a confirmation message appears indicating that the reports are ready for review. For example: ``` Migration process for org is complete and reports are ready for review in the folder /migration_reports ``` Where, `` represents the location on your machine where the migration reports are stored. The migration reports also appear in a new browser window. The migration reports are generated for these components: - Omniscripts - Flexcards - Data Mappers - Integration Procedures - Apex Classes - Omni Global Auto Numbers - FlexiPages - Experience Cloud Site Pages - Lightning Web Components - Custom Labels 10. Click the component for which you want to view the migration report, and review the reports to make sure that all items listed are in **Successfully migrated** status. If there are any items that are marked as **Skipped**, review the items for any functional impacts. If there are items with the **Failed** status, contact Salesforce Customer Support. See [Review the Migration Reports](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_review_migrate_reports.htm&release=264.0.0&type=5 "When you run the Omnistudio Migration Assistant in Migrate mode, it generates migration reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These migration reports highlight several key areas that require attention after migrating Omnistudio components."). Post Migration Steps After you review the reports, go to **Omnistudio Settings**: - Make sure that the **Managed Package Runtime** setting is turned off. - Make sure that the **Omni Global Auto Number** setting is turned on. - Manually turn off the **Managed Package Designer** setting. - Manually turn on the **Deploy Custom Lightning Web Components in Standard Runtime** setting. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png) Note Depending on the number of Flexcards and Omniscripts, this deployment can take from a few minutes to an hour to complete. To monitor the deployment, go to Setup, find and select **Deployment Status**. If there are any deployment failures, turn off and turn on the setting, and monitor again. - **[Review the Migration Reports (Vlocity Industries Managed Packages and Custom Data Model)](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_review_migrate_reports.htm&release=264.0.0&type=5)** When you run the Omnistudio Migration Assistant in Migrate mode, it generates migration reports for Omniscripts, Flexcards, Data Mappers, Integration Procedures, Apex Classes, Omni Global Auto Numbers, FlexiPages, Experience Cloud Site Pages, Lightning Web Components, and Custom Labels. These migration reports highlight several key areas that require attention after migrating Omnistudio components. - **[Review the Automated Tasks (Vlocity Industries Managed Packages and Custom Data Model)](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_review_automated_tasks.htm&release=264.0.0&type=5)** The Omnistudio Migration Assistant automates these tasks to simplify and streamline your migration process: