Deploy Your Migrated Components to the Testing Sandbox (Vlocity Industries Managed Package and Standard Data Model)

Deploy Your Migrated Components to the Testing Sandbox (Vlocity Industries Managed Package and Standard Data Model)

Manually complete these steps to switch to the Omnistudio standard runtime and deploy your migrated components to the testing sandbox using your standard deployment process..

Key deployment considerations include:

  • Deployment sequencing: Deployment order must be managed based on implementation dependencies. Parent–child relationships (for example, Omniscripts depending on Data Mappers or Integration Procedures) require dependent components to be deployed first. Failure to follow the correct sequence can result in dependency errors and may require manual intervention.
  • Separation of deployments: Always deploy Setup components (for example, custom objects, fields, and record types) separately from Omnistudio components. Deploying both together can result in failures, especially when dependencies exist between Setup and Omnistudio components.

Orgs with Metadata Enabled

  1. Retrieve all components from the source org: Record the cleaned components and updated references as Metadata API–compatible artifacts. See Deploy Migrated Omnistudio Components to Another Environment.
  2. Configure target org settings: Prepare the target org to support the standard runtime environment.
    1. In Setup, find and select Omnistudio Settings.
    2. Turn off the Managed Package Runtime and Managed Package Designer settings.
    3. Turn on the Deploy Custom Lightning Web Components in Standard Runtime setting.
  3. Deploy the package to the target org by using SF CLI. See Deploy Migrated Omnistudio Components to Another Environment.

Orgs with Metadata Disabled

  1. Retrieve all components from the source org: Record the cleaned components and updated references as Metadata API–compatible artifacts.
    sf project retrieve start --manifest OmnistudioDeployment.xml --target-org sourceorguser@domain.com
  2. Configure target org settings: Prepare the target org to support the standard runtime environment.
    1. In Setup, find and select Omnistudio Settings.
    2. Turn off the Managed Package Runtime and Managed Package Designer settings.
    3. Turn on the Deploy Custom Lightning Web Components in Standard Runtime setting.
  3. Deploy the package to the target org by using SF CLI. See Deploy Migrated Omnistudio Components to Another Environment.
  4. Preview records targeted for cleanup: Before deleting records, run the cleanup command with the --assess flag. This identifies records with special characters or missing unique names (orphans) that block Metadata API enablement.
    sf omnistudio:migration:clean -u targetorguser@domain.com --assess
    Review the JSON reports generated in the clean_assessment folder.
  5. Run the cleanup command in the target org: Run the clean command to remove incompatible records identified in the previous step. The tool deactivates and deletes records with special characters and older records without a unique name that now have valid deployed counterparts.
    sf omnistudio:migration:clean -u targetorguser@domain.com
  6. Enable the Omnistudio Metadata API in the target org: After the cleanup is complete and the org is free of incompatible records, enable the Omnistudio Metadata setting.
    1. In Setup, find and select Omnistudio Settings.
    2. Turn on the Omnistudio Metadata setting.