Skip to main content

Troubleshooting Installation Issues with the Bloomreach Sitemap XML Plugin

Updated

Overview

This article addresses the process of implementing Sitemap XML plugin with Bloomreach Content, key troubleshooting steps and common issues. It aims to guide users facing blockers during the installation and integration process, especially when the “Next” button is unresponsive with no validation errors displayed.

 

Problem Description

Customers may encounter an issue during the installation of the Sitemap XML plugin where, after entering the required details and clicking “Verify Settings”:

  • Nothing happens
  • The “Next” button remains inactive

  • No validation errors are shown

     

Troubleshooting Steps

  1. Environment Field Format

    • Ensure the “Environment” field is filled as follows: https://<environment>.bloomreach.io/

      For example: https://abc.bloomreach.io/

  2. Content Type Project Requirement

    • The environment must have a project with content type changes. If you don’t have such a project, create one before attempting the installation again.

  3. Content Type Validation

  4. Detecting Content Type Issues

    • Use your browser’s network tab when clicking “Verify Settings” to detect backend errors.

      Few examples of errors that users can come across: 

       

javax.jcr.ValueFormatException: property ... is a multi-valued property, so its values can only be retrieved as an array

 

Path not found; nested exception is javax.jcr.PathNotFoundException: cluster.options

 

  • If the error refers to a particular field, check if that field is still in use. If not, consider deleting it (note: deletion is permanent for that field name).

     

Note: Even after fixing one content type, another may cause the installation to fail. Use the aforementioned API endpoint to check all content types sequentially. 

 

Solution Example

In similar cases, installation issues were resolved after addressing structural problems within one or more content types in the relevant environment. Once the identified content type issues were corrected—typically by ensuring all fields were valid and supported—the installation was able to proceed successfully. This underscores the importance of validating all content types and correcting any configuration errors before attempting the installation again.

 

Post-Installation

After a successful installation:

  • Use the following endpoint to retrieve the generated sitemap: https://<environment>.bloomreach.io/delivery/site/v1/channels/<your-channel>/pages/sitemap.xml?preview-token=<preview-token>
  • The correct endpoint should not reference localhost or custom backend routes (e.g., localhost:5000/sitemaps_content.xml) since these do not exist in Bloomreach.
  • Access the API with a Preview Token for testing, or link your SPA with the project and use the Experience Manager for previewing your work.

 

Recommendations

  • Always verify content types prior to installation using the public API.
  • Keep a backup before deleting content type fields.
  • If installation errors persist and logs are unhelpful, contact support for deeper troubleshooting.

 

Additional Resources

If further issues occur, please contact Bloomreach Support. You may be required to provide screenshots and permission for environment access to expedite the resolution process.

Related articles