Loading
Salesforce now sends email only from verified domains. Read More
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Assess the Migration Readiness in Your Development Sandbox (Vlocity Industries Managed Package and Standard Data Model)

            You are here:

            1. Salesforce Help
            2. Docs
            3. Omnistudio for Managed Packages

            Assess the Migration Readiness in Your Development Sandbox (Vlocity Industries Managed Package and Standard Data Model)

            In the development sandbox, run the Omnistudio Migration Assistant in Assess mode to assess how the migration process impacts each Omnistudio component.

            Before You Begin

            To run the Omnistudio Migration Assistant, you must have the Omnistudio admin and Omnistudio user permission sets assigned. See Omnistudio Permission Sets.

            Important
            Important Always run the Assess mode before running the Migrate mode to understand the impact and avoid incomplete or incorrect migration. Review the assessment report for any failed statuses and resolve them before proceeding with migration.
            Important
            Important If your org is already on the standard data model with the Omnistudio Metadata API setting enabled, the Omnistudio Migration Assistant does not assess and generate assessment reports for the Omnistudio components such as Data Mappers, Omniscripts, Integration Procedures, Flexcards, and Omni Global Auto Number. In this scenario, the Omnistudio Migration Assistant assesses only Custom Labels, and related objects such as Apex classes, LWCs, FlexiPages, and Experience Cloud site pages to resolve namespace and reference dependencies.
            1. Authenticate to the migration sandbox org: 
              sf org login web --instance-url=<your_sandbox_URL>
            2. When prompted, enter your username and password. The authorization successful message appears.
              Note
              Note All prompts in the Omnistudio Migration Assistant have a timeout of five minutes. If no input is provided within this time, the command exits automatically.
            3. Open the Omnistudio Migration Assistant tool Versions page and install the Omnistudio Migration Assistant version 2.0.0-preview.27 by running this command in the terminal:

              sf plugins install @salesforce/plugin-omnistudio-migration-tool@2.0.0-preview.27

              See Install the Omnistudio Migration Assistant.

            4. Run the Omnistudio Migration Assistant in Assess mode.

              sf omnistudio:migration:assess [-u <string>] [-a] [--only=(dm|ip|os|fc|autonumber|cl)] [--relatedobjects=(apex|lwc|expsites|flexipage) [--verbose]

              • To assess all versions of the components, use -a or –allversions:
                sf omnistudio:migration:assess -u <YOUR_ORG_USERNAME@DOMAIN.COM> -a

                Where, YOUR_ORG_USERNAME@DOMAIN.COM is your username in the sandbox.

                Example: sf omnistudio:migration:assess -u asmith@sample.com -a

                If you don’t specify either -a or –allversions parameter in the command, the Omnistudio Migration Assistant requests for your consent to assess all versions of the Omnistudio components. Enter y to consent. If you don't consent to assess all versions of the Omnistudio components, you cannot proceed with the assessment.

              • To assess specific components, use the -o or --only=dm parameter:
                • --only=dm: Data Mappers
                • --only=ip: Integration Procedures
                • --only=os: Omniscripts
                • --only=fc: Flexcards
                • --only=autonumber: Omni Global Auto Numbers
                • --only=cl: Custom Labels

                Example: sf omnistudio:migration:assess -u asmith@sample.com –only=dm

              • To assess specific or all related objects, use the -r or --relatedobjects parameter:
                • --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:assess -u asmith@sample.com --relatedobjects=apex

              • To assess username or alias for the target org and to override the default target org:
                • -u <target_username> or --targetusername=<target_username>: Username of the target org or alias you’ve set up in Salesforce CLI for that org.

                Example: sf omnistudio:migration:assess -u asmith@sample.com

              • To control the amount of details shown in the command output, use the --verbose parameter with the command:

                Example: sf omnistudio:migration:assess -u asmith@sample.com --verbose

            5. If multiple Omnistudio packages are found, select one of the packages by entering its number.
            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 related objects such as Apex classes, FlexiPages, Experience Cloud site pages, and Lightning web components (LWCs).
                2. Enter y to proceed.
                3. Create an empty project folder where the tool can retrieve and store the related objects.
                4. When prompted, enter the path to the project folder. For example: /Users/<your_name>/Downloads/OMA
              • If you entered y:
                1. When prompted, enter the path to the project folder that contains the retrieved related objects. For example: /Users/<your_name>/Downloads/OMA
            7. Enter y to confirm that you consent to enable the ExperienceBundle metadata API and migrate Experience Cloud sites.
              The assessment process is initiated.

              After the assessment is complete, a confirmation message appears indicating that the reports are ready for review. For example:

              Migration assessment for org XYZ is complete and reports are ready for review in the folder <local_folder_path>/assessment_reports

              Where, <local_folder_path> is the location on your machine where the assessment reports are stored. The assessment reports also appear in a new browser window.

              The assessment 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
            8. Click the component for which you want to view the assessment report, and review it to identify potential migration issues and determine whether any updates are required before migration. See Review the Assessment Reports.
            9. To ensure a smooth migration, complete all the pending action items that are listed as Needs Manual Intervention in the assessment reports.
            10. To validate readiness, re-run the Omnistudio Migration Assistant in Assess mode.

              Each time you run the Omnistudio Migration Assistant, it reruns assessments on all components and generates new reports.

            11. Make sure that all records listed in the Assessment Status column in the Assessment Report are marked as either Ready for Migration or Warnings before proceeding with the migration.
             
            Loading
            Salesforce Help | Article