AEM: Troubleshooting when a target file does not return to the AEM CMS after a specific job finishes in XTM Cloud

Owned by Damian Rozmiarkowski
Last updated: Dec 09, 2024
2 min read

Introduction

This article describes some possible reasons why translated content is not returned to the AEM CMS after a job or project is finished in XTM Cloud, and provides some troubleshooting guidelines.

Root cause of the issue

In the majority of cases, there are three potential reasons why target files fail to return to the CMS:

  1. Connection problems between the AEM CMS and XTM Cloud.

  2. Target file generation fails on the XTM Cloud side.

  3. Other obscure problems occurring in the AEM CMS at the time.

Troubleshooting guidelines

Troubleshooting should take all the root causes listed in the previous section into account. See below.

Connection problems between the AEM CMS and XTM Cloud

Ensure that the XTM Translation Cloud Configuration is properly configured for your site.

  1. On your AEM CMS instance, access the following path:/mnt/overlay/cq/translation/gui/content/cloudservices.html.

  2. Search for your XTM Cloud configuration and open it for editing.

  3. Check that all the required data is provided and that no errors are displayed.

  4. Go to /services/xtm/rest-connection-test?configurationPath=<PATH_TO_XTM_CLOUD_CONFIG
    URATION> and check if the REST connection is working (i.e. http://localhost:4502/services/xtm/rest-connection-test?configurationPath=/conf/wknd/settings/cloudconfigs/translation/xtm/xtm).

If you would like to know more about managing a REST API connection, read the following article: AEM: How to check the REST API connection.

Target file generation fails on the XTM Cloud side

The next step you should take is make sure that the relevant target file has been generated successfully for a related project in XTM Cloud. For this purpose, in XTM Cloud, enter the appropriate project, go to the Project Editor → Files section and check the status of your target file.

If you spot an actual file generation error, it might be due to quite a few reasons. Read the following article, to try to identify the actual root cause and find out how to resolve the problem: Target generation – most common issues & troubleshooting.

If, however, the target file has been generated correctly, the root cause might lie outside of the XTM Cloud environment.

Other obscure problems occurring in your AEM CMS at the time

Sometimes, the issue is likely to have occurred in your CMS.

In such cases, to assist you more effectively with the issues you are encountering with AEM, we always ask that you provide additional information whenever you report a problem.

Specifically, it would be extremely helpful if you could include the logs from the operation in question, in your JSM request. These logs are crucial for us to diagnose and resolve the issue promptly, as they provide detailed insights into what might be going wrong. Read the following article, to learn how to access and download logs from your CMS: AEM: Where are logs located and what information do they contain?.

IMPORTANT!

Note that logs sometimes disappear over time. Replicating the behavior will generate new logs that the XTM Support team can analyze. Without these logs, it becomes challenging for them to investigate the problem thoroughly.

Additionally, if possible, attach any relevant screenshots that illustrate the issue. This visual information can further aid the XTM Support team in understanding the problem context and specifics.