Migration guideMigrate from Predictive Merchandiser to Commerce Studio

Download the provided precheck script to check for staged (unpublished) rules and rewrites: Click to download precheck.sh

Run the script, replacing the placeholder values with your values.

./precheck.sh FUSION_USERNAME FUSION_PASSWORD FUSION_BASE_URL FUSION_APP_ID

Check the output to see if any issues were detected. If there are no issues, the output returns All pre-checks passed. No issues found. Continue to retrieve list of objects in Predictive Merchandiser.

If there are issues, the output returns a list of issues like the following:

The following pre-checks failed:
  Found published rules with staged changes. Publish or revert the changes to fix this issue.
  - 2fRtM1GEsU
  - E1YkUTX9r6
  - Eb2A6WARag
  - FNS7Whciwx
  - LlIsMfK4kq
  - OidpIUrVv3
  - P39TDQ2X1K
  - RYbY2XPMOI
  - ZHvW2LiQpe
  - aCseNzc4Xc
  ... and 6 more.
See precheck_results.json for the full list of invalid content

Review precheck_results.json and inspect each reported rule. If you created the rules, sign into Predictive Merchandiser and publish or revert the staged changes.

After resolving issues, re-run the script. If there are no issues, continue to retrieve list of objects in Predictive Merchandiser.

Export a list of your rules and rewrites:

curl --request GET \
  --url  USER:PASSWORD \
  'https://FUSION_HOST/api/apps/APP_NAME/query-rewrite/instances' \
  --header 'accept: application/json' \
  > exported-rules.json

Create an inventory of your rules, noting how many of each type and tag appear in the list.

Export a list of your zones:

curl --request GET \
-u USER:PASSWORD \
  --url 'https://FUSION_HOST/api/templating/zones?context=app:APP_NAME' \
  --header 'Accept: application/json' \
  > zones.json

Export a list of your templates:

curl --request GET \
-u USER:PASSWORD \
  --url 'https://FUSION_HOST/api/templating/templates?context=app:APP_NAME' \
  --header 'Accept: application/json' \
  > templates.json

Copy the ID of the Fusion instance you’re migrating from and save in a secure location.

Copy the Lucidworks Platform workspace ID and save in a secure location. You can find this in the JWKS and Issuer URLs.

To start the migration, send a PUT request to set the instance state to MIGRATING:

curl --location --request PUT "https://EM_INSTANCE_ID.experiencemanager.lucidworks.com/pm-migration" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer BEARER_TOKEN" \
--data '{
    "state": "MIGRATING"
}'

Optional: Check the migration status:

curl --location "https://EM_INSTANCE_ID.experiencemanager.lucidworks.com/pm-migration" \
--header "Authorization: Bearer BEARER_TOKEN"

When the migration completes, the state value changes to COMPLETED or FAILED. Check if the skippedContents array is populated. This array contains a list of all contents that were skipped during migration due to unsupported or invalid content. For example, see the following:

{
    "skippedContents": [
        {
            "contentType": "rules",
            "fusionId": "8otY20teB5",
            "reason": "Published rule with staged changes will be skipped. To fix, revert or publish the changes. Or, manually re-create this content in the destination instance."
        },
        {
            "contentType": "rules",
            "fusionId": "eWvjz3B2UX",
            "reason": "Unsupported or invalid content will be skipped. Attempted to import content .... EM rejected this content with status 400 BAD_REQUEST and error message: {\"statusCode\":500,\"message\":\"conditions.queries[0].<list element>: size must be between 0 and 8192\",\"fusionErrorMessage\":null,\"violations\":{\"conditions.queries[0].<list element>\":\"size must be between 0 and 8192\"}} ."
        },
        {
            "contentType": "rules",
            "fusionId": "yIOvDet9JY",
            "reason": "Published rule with staged changes will be skipped. To fix, revert or publish the changes. Or, manually re-create this content in the destination instance."
        }
    ],
    "migratedContentCounts": {
        "rules": 6,
        "zones": 0,
        "templates": 0,
        "rewrites": 0
    }
}

Review the completion status of the migration to determine how to proceed.

Sign in to Lucidworks Platform as a workspace owner and navigate to Commerce Studio.

Navigate to Rules, then compare your rule count in Commerce Studio against the JSON you exported from Predictive Merchandiser.

Navigate to Rewrite, then validate that your query rewrites in Commerce Studio match the exported JSON.

Navigate to Pages, then validate your templates have become pages in Commerce Studio, and that the count matches the exported JSON.

Open each page, then validate your Predictive Merchandiser zones have become sections in Commerce Studio, and they are associated with the correct page.

Navigate to the Editor and check that rules and rewrites are applied as expected. Some rules and rewrites only fire under specific conditions:

Perform additional rules and rewrites validations as needed, using the exported rules JSON as a reference. For example, check that the direction of synonym rewrites matches the expected direction.

Open your browser’s developer tools and go to the Network tab.

Verify that the query pipeline behaves as expected in Fusion Query Workbench.

Confirm that rules and rewrites are saved to the correct Solr collections.

Ensure the staging collection has only one replica.

Verify that the pipeline supports the fl parameter.

Text Tagger stage. Leave Tagger Collection blank.

Apply Rules stage. Leave Collection blank.

Solr Query stage.

Modify Response with Rules stage.

Response Diagnostics stage.