Dynamic Assessments Migration

General Considerations

• If you’re new to Salesforce Metadata APIs, review Understanding Metadata APIs.
• Make sure the manifest file includes the active version of all assessment questions from the omni assessment task associated with the omni process.
• See the considerations from the Usage Type section in Omniscript.
• To migrate updates to an action plan template that was migrated earlier, clone the action plan template, change it, and then migrate it.
• To migrate a read-only or published action plan template that was created in a Winter '25 or earlier org, you must re-create it first. If you don’t, the migrated template will not include the link to the associated omni assessment task, causing Dynamic Assessments to fail.

Prerequisites for Source and Target Orgs

• For an admin user to migrate Dynamic Assessments, assign the Dynamic Assessment Access permission set.
• For a standard user to migrate Dynamic Assessments, complete these tasks:
  • In the Dynamic Assessment Access permission set, enable the Migrate Dynamic Assessments Data system permission, and assign the permission set to the user.
    

    See View and Assign Permission Sets.

  • On the standard user profile, enable these permissions:

    • Modify Metadata Through Metadata API Functions

    • View Setup and Configuration

    • Customize Application

    See Set Up User Profiles.

• Enable Omnistudio Metadata API support.
  1. In Setup, find and select Omnistudio Settings.
  2. Turn on Omnistudio Metadata.
• Enable Discovery Framework metadata APIs to retrieve and deploy assessment questions, assessment question versions, and assessment question sets.
  1. From Setup, in the Quick Find box, enter Discovery Framework, and then under Discovery Framework, select General Settings.
  2. Turn on Import or Export.
• Install and configure the migration tool that you want to use: Salesforce CLI or Visual Studio Code. See the documentation links for these Migration Features in Replacement Tools for Workbench:
  • Migration > Deploy
  • Migration > Retrieve
• Log in and authenticate the source and target orgs. See Salesforce DX Developer Guide.

Prepare the Source Org

• Make sure that Dynamic Assessments is set up. Complete topics from Dynamic Assessments Prerequisites to Create an Action Plan Template for a Dynamic Assessment.
• Create a Salesforce DX project. Make sure that you save the manifest file in this DX project directory.

  Here's a sample SF CLI command to create a DX project called my-dx-project:

  sf project generate --name my-dx-project

Prepare the Target Org

See Dynamic Assessments Prerequisites.

Prepare the Manifest File

Create a package.xml manifest file on your local file system. Then, save the manifest file in the Salesforce DX project directory in your source org.

You can migrate all or specific records of Dynamic Assessments from the source org. For specific records, copy the Unique Name values of the specific records of these objects and add them to the manifest file:

• Action plan template
• Assessment question
• Omni process associated with the Omniscript

Note Make sure the manifest file includes the active version of all assessment questions from the omni assessment task associated with the omni process. Otherwise, migration fails.

Here are a couple of sample manifest files.

Sample manifest file 1: Retrieves all action plan templates, assessment questions, and Omniscripts

<?xml version="1.0" encoding="UTF-8"?>
<Package
xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>ActionPlanTemplate</name>
</types>
<types>
<members>*</members>
<name>AssessmentQuestion</name>
</types>
<types>
<members>*</members>
<name>OmniScript</name>
</types>
<version>63.0</version>
</Package>

Sample manifest file 2: Retrieves specified action plan template, assessment question, and Omniscript

<?xml version="1.0" encoding="UTF-8"?>
<Package 
xmlns="http://soap.sforce.com/2006/04/metadata">
<types>        
<members>FireSafetyAPT_04f26088_a293_11ef_a2f9_b342e7b5849f</members>
<name>ActionPlanTemplate</name>
</types>
<types>
<members>FireSafetyBasic</members>
<name>AssessmentQuestion</name>
</types>
<types>
<members>FireSafetyOSD_FireSafetyOSD_English_1</members>
<name>OmniScript</name>
</types>
<version>63.0</version>
</Package>

See Sample package.xml Manifest Files.

See Salesforce CLI Command Reference: sf Project commands.

In the target org, clone and publish the migrated action plan templates. Your users can now use these action plan templates to create action plans.