Skip to content

Working with Localized Metadata in EKTRON Web CMS

Content Management Systems

Working with Localized Metadata in EKTRON Web CMS

Ektron is one of the most popular CMS choices to drive scalable, multilingual websites that must be deployed on a global basis.

As previously discussed in Managing your Multilingual Website with Ektron 8.5 CMS, the latest version 8.5 release of the Ektron CMS introduced the following new localization features and concepts:


1. Translation Packages
2. Translation Status (i.e. Mark  for Translation Status)
3. Fallback Locale
4. Translation of Managed Assets
5. Web Localization Include and Exclude Feature
6. Custom Locales
7. Pseudo-localization
8. Localization Dashboard

Once your Ektron website is ready for translation, you can export its content with a single click of your mouse. The new Ektron translation features listed above, work together by going through each page on your website, creating an XLIFF file and compressing it with all the other pages into a single ZIP file (one per language).

Each ZIP file will have a complete copy of your website’s content ready for translation. The next step involves downloading these files and sending them to GPI’s Translation Portal to initiate your translation workflows. After the translation process is completed and the files are returned, you can import the translated content back into Ektron thereby completing the language export / import process.

Working with Localized Metadata

Out of the box the Ektron translation features affords users the ability of translate the following CMS item types:

  • Content
    1. Summaries
    3. Meta data
  • Forms
    1. Response message
    3. Meta data
  • All menus
  • File assets
  • Taxonomies

When these CMS item types are marked for translation, Ektron exports their content and the details into output XLIFF files. GPI, the translation agency uses these source files to translate your website content and returns them upon completion. Ektron then processes the updated XLIFF files and creates new or updates existing CMS entries in the target language for the associated items.

Although translated Metadata content exists in the XLIFF file, the Ektron import routine does not process them. As such the localized Metadata content is not associated with its localized content. Therefore CMS users would notice that the localized content’s metadata is missing.

Let’s illustrate what happens by way of an example:

ID Name Language
100 Content Number One en-US
101 Content Number Two en-US

Table 1: Metadata in source language (English) only

Table 1, illustrates a list of sample metadata definition entries. The metadata is only defined in the source language (i.e. English).

ID Name Language
100 Content Number One en-US
101 Content Number Two en-US
102 Contenido del número uno es-ES
103 内容一 zh-CN
104 内容第二 zh-CN

Table 2: Localized metadata in multiple (English, Spanish, Chinese) languages

Table 2, illustrates the result of localizing the Metadata into two target languages (i.e. Chinese and Spanish). It is clear from this illustration that metadata definition entries acquire different ID values across language types unlike content ID values which remain the same regardless of language. As such the system is unable to perform automatic mapping between metadata definitions from the source English language to the target Chinese and Spanish languages.

To solve this disconnect, an additional mapping process is required when Metadata items are included for translation.

ID Localized Version
100 102 (es-ES), 103 (zh-CN)
101 104 (zh-CN)

Table 3: Relationship between localized versions

Table 3, illustrates the relationships/mappings between the metadata definitions which we would like to achieve. The metadata ID values 100, 102, 103 are related, as well as Id values 101 and 104.

Ektron uses an XML-based mapping during the XLIFF importing process to accomplish this task. The mapping instructs the import routine about the association between the source language versions of the metadata entries and their corresponding target (localized) language versions.

The following outlines a step-by-step approach to setup metadata definition mappings:

1. Locate the file (<website-root>/workarea/xslt/metadataDefinitions.xml). If the file does not exist, you can download it from Ektron using the following URL:

2. Within the Ektron Workarea (Settings > Configuration > Metadata Definition), define your metadata definitions entries in the source language (e.g. English).

3. Switch the language view (e.g. Chinese, Spanish) to define your metadata definitions in all the required target languages.

Definitions in the target language should be assigned the same data type and properties of the associated source language metadata definition version.

4. Edit (<website-root>/workarea/xslt/metadataDefinitions.xml) using a text-editor. Each metadata definition is defined using a <dd> element within the root <dl> element. The <dd> element should be defined as follows:

<dd title=”Name of the metadata definition entry”>

<dfn id=”ID of Metadata entry” xml:lang=”language country code”/>

<dfn id=”ID of Metadata entry” xml:lang=”language country code”/>

<!– add as many dfn entries as required –>


For example,

<?xml version=”1.0″?>


<dd title=”Content Number One”>

<dfn id=”100″ xml:lang=”en-US”/>

<dfn id=”102″ xml:lang=”es-ES”/>

<dfn id=”103″ xml:lang=”zn-CH”/>


<dd title=”Content Number Two”>

<dfn id=”101″ xml:lang=”en-US”/>

<dfn id=”104″ xml:lang=”zh-CN”/>



Once this setup has been completed, the XLIFF import process uses the mappings defined in the metadataDefinitions.xml file to correctly associate definitions in a target language (e.g. Chinese, Spanish) correspond to the definitions in the source language (e.g. English).