AEM: How to troubleshoot XTM Cloud in-context preview issues

Introduction

XTM Cloud provides an in-context translation preview, enabling you to view the translated content of the website layout as you are working on it. Additional content, such as graphics and style sheets, is sent to XTM Cloud to enable the page that is being translated to be opened in XTM Visual mode.

It is enabled in XTM Cloud by default, for the following file formats: “HTML”, “XML”, “InDesign”. However, a special configuration needs to be implemented for the content coming from AEM. To configure XTM Visual mode for AEM, see the Enable Visual mode in XTM Workbench using setting at the bottom of the Advanced section of the XTM Cloud Translation Connector Settings panel [Adobe Experience Manager → Tools → Cloud Services → Translation Cloud Services → conf → (select you configuration) → XTM Connector → xtm → Edit) and select the desirable method.

  • XTM Cloud Preview Generator → It does not require any additional configuration.

  • XTM Cloud Preview Generator (node path added) → Additional data-previewnodepath attributes are added to the preview. It might require an additional configuration, and a suitable content structure.

  • AEM Preview Generator → This is a built-in solution based on AEM Content Sync.

  • No preview → As the name suggests, there will be no in-context preview in XTM Cloud.


Guidelines

If there are any problems with previewing your content on the XTM Cloud side, and you have performed all the configuration steps mentioned in the Introduction section correctly, follow these guidelines:

  1. Ensure that your page renders without any issues in the “View as published" mode (for example, http://localhost:4502/content/wknd/language-masters/en/errors/404.html?wcmmode=disable). If there are any issues, the preview in XTM Cloud simply will not work as the page will not render at all. The configuration on the AEM side needs to be corrected.

  2. Check if you can create a manual preview archive by appending the following suffix to the page: “.xtmpreview.zip” (for example, http://localhost:4502/content/wknd/language-masters/en/errors/404.xtmpreview.zip). If there are any issues, contact the XTM International Support team, by creating a suitable ticket, and provide logs from the operation described above. To learn about AEM logs, make sure to read the following article: AEM: Where are logs located and what information do they contain?.

  3. Check if the preview in XTM Cloud produces the expected outcome by unpacking the archive and displaying it on a local web server. Running it directly without Apache will not work due to the use of absolute paths in the files.

  4. Run the translation project with a single page. Start it and wait for the preview file to be sent over to XTM Cloud. If there are any issues, contact the XTM International Support team, by creating a suitable ticket, and provide logs from the operation described above, as well as the generated ZIP package from item 2.