AEM: File-Naming Convention in XTM Cloud for AEM Projects

Owned by Damian Rozmiarkowski (Unlicensed)
Last updated: Jul 17, 2024 by Damian Rozmiarkowski
3 min read

Introduction

Generally, in AEM, there are two ways in which XTM Cloud project names are generated automatically, depending, among others, on such details as the page title or the URL path to that page. There are actually two ways which you can control a file-naming pattern.

Specifics

Configuration

  1. In Adobe Experience Manager, select Tools → Cloud Services → Translation Cloud Services → conf → (select your XTM Cloud configuration) → XTM Connector → (select xtm) → Edit.

Untitled1.png

  1. In the Advanced section, you will find the When creating translation jobs in XTM Cloud field. There are two options to choose from:

  • Use the title for XTM Cloud job name,

  • Use the path for XTM Cloud job name.

Untitled2.png

“Use the title for XTM Cloud job name” option

If you select the Use the title for XTM Cloud job name option, the name of each source file in XTM Cloud will consist of the:

  • actual page title in the CMS.

  • unique page ID, which is generated on the fly when the page is being sent off to XTM Cloud for translation.

  • the file extension, .xml.

So the name pattern will look like this: PAGE TITLE [UNIQUE PAGE ID].xml.

XTM Connect – AEM adds an auto-generated unique ID to the source file, to distinguish between files in case, for example, there are two pages with the title about_us but they come from different paths and differ from one another.

This is also necessary to to support the continuous localization process. Without a unique file name, XTM Connect – Adobe Experience Manager will not be able to find the appropriate file in XTM Cloud that needs to be updated when its source content is changed in AEM.

“Use the path for XTM Cloud job name” option

If you select the Use the path for XTM Cloud job name option, the name of each source file in XTM Cloud will consist of the:

  • URL path to the page in the CMS.

  • the file extension, .xml.

So the name pattern will look like this: URL/PATH/TO/THE/PAGE.xml.

IMPORTANT!

Some items will use the title-based approach even if the path-based approach has been selected.