Multilanguage API Publication Type - Field Mappings
Overview
The Multilanguage API publication type maintains data in the main language plus all configured translations. This page documents the specific fields that are populated in the Publication Line entity and its sublines for each source data type.
Entities Used
- PIMX Publication Line - Main line data (main language)
- PIMX Publication Subline ML - Additional language translations
Entity: Publication Line (Main Language)
The Publication Line table holds the base entity data in the main language.
Item Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Item No. | Item.No. | Item number (validated) |
Vorlagencode |
Template Code | Item."PIMX Template Code" or Allocation Line."Template Code" | Template code for the item |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Item) | All language translations beyond main language |
Source Data:
- Main language data comes from Item entity references
- Additional languages retrieved from
PIMX Catalog Translationtable - One subline created per additional language
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Item has "PIMX Template Code" → Use
Item."PIMX Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Item.DescriptionandItem."Description 2"
Item Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Item Group Code | Item group identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Item Group."Template Code" | Template code - Allocation Line takes priority |
Artikelgruppe |
Item Group | Item Group Code | Item group code reference |
ArtGrp Bezeichnung |
Item Group Description | Item Group.Description | Item group description |
Zusatzinfo 01-05 |
Additional Info 1-5 | Item Group."Additional Information 1-5" | Additional metadata fields |
| Translations | Translations | PIMX Catalog Translation (Type="Item Group") | Multilingual group descriptions |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Item Group has "Template Code" → Use
Item Group."Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Item Group.DescriptionandItem Group."Description 2"
Product Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Product Group Code | Product group identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Product Group."Template Code" | Template code - Allocation Line takes priority |
Warengruppe |
Product Group | Product Group Code | Product group code reference |
WarGrp Bezeichnung |
Product Group Description | Product Group.Description | Product group description |
Zusatzinfo 01-05 |
Additional Info 1-5 | Product Group."Additional Information 1-5" | Additional metadata fields |
| Translations | Translations | PIMX Catalog Translation (Type="Product Group") | Multilingual group descriptions |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Product Group has "Template Code" → Use
Product Group."Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Product Group.DescriptionandProduct Group."Description 2"
Chapter Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Chapter Code | Chapter identifier |
Vorlagencode |
Template Code | Chapter."Template Code" or Allocation Line."Template Code" | Template code |
Kapitel |
Chapter | Chapter Code | Chapter code reference |
Kap Bezeichnung |
Chapter Description | Chapter.Description | Chapter description (main language) |
Zusatzinfo 01-05 |
Additional Info 1-5 | Chapter."Additional Information 1-5" | Additional metadata fields |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Chapter) | Chapter descriptions in other languages |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Chapter has "Template Code" → Use
Chapter."Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Chapter.DescriptionandChapter."Description 2"
Catalog Group Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Catalog Group Code | Catalog group identifier |
Vorlagencode |
Template Code | Catalog Group."Template Code" or Allocation Line."Template Code" | Template code |
Zusatzinfo 01-05 |
Additional Info 1-5 | Catalog Group."Additional Information 1-5" | Additional metadata fields |
| Translation Sublines | Translations | PIMX Catalog Translation (Type="Catalogue Group") | Catalog group descriptions in other languages |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Catalog Group has "Template Code" → Use
Catalog Group."Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Catalog Group.DescriptionandCatalog Group."Description 2"
Catalog Item Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Catalog Item Code | Catalog item identifier |
Vorlagencode |
Template Code | Allocation Line."Template Code" | Template code from allocation |
| Translation Sublines | Translations | PIMX Catalog Translation (Type="Catalog Item") | Catalog item descriptions in all languages |
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Catalog Item.DescriptionandCatalog Item."Description 2"
Document Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Document Code | Document identifier |
Vorlagencode |
Template Code | Document."Template Code" or Allocation Line."Template Code" | Template code |
Link |
Public Link | Document."Public Link" | Public URL for the document |
MIME Type |
MIME Type | Document."Mime Type" | MIME type of the document |
Source File Name |
Source File Name | Document."Source File Name" | Original file name |
Document Usage |
Document Usage | Document."Document Usage" | Document usage classification |
Repository Type |
Repository Type | Document."Repository Type" | Type of file repository |
External Container Id |
External Container Id | Document."External Container Id" | External container reference |
External Id |
External Id | Document."External Id" | External document identifier |
Bezeichnung 2 |
Description 2 | Document."Description 2" | Secondary description (main language) |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Document) | Document metadata in all languages |
Template Code Priority Order:
- If Allocation Line has "Template Code" → Use
Allocation Line."Template Code" - Else if Document has "Template Code" → Use
Document."Template Code"
Description Source via Channel Allocation:
- If Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - If Channel Allocation."Manual Descriptions" = FALSE → Use
Document.DescriptionandDocument."Description 2"
Document Line Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Document Code | Document identifier |
Link |
Public Link | Document."Public Link" | Public URL |
MIME Type |
MIME Type | Document."Mime Type" | MIME type |
Source File Name |
Source File Name | Document."Source File Name" | Original file name |
Document Usage |
Document Usage | Document."Document Usage" | Usage classification |
Repository Type |
Repository Type | Document."Repository Type" | Repository type |
External Container Id |
External Container Id | Document."External Container Id" | External container ID |
External Id |
External Id | Document."External Id" | External document ID |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Document) | Document metadata in all languages |
Keyword Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Keyword ID | Keyword."Keyword ID" or Classification | Keyword identifier based on ID source |
Priority |
Order | Keyword.Order | Keyword priority/order |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Keyword) | Keyword text in all languages |
Feature Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Feature | Feature Number or Reference/Classification | Feature identifier based on ID source |
Type Enum |
Field Type | Product Feature."Field Type" | Feature data type (Text, Number, Range, Boolean, Date, Document, Graphic) |
Feature Value Type |
Value Type | Derived from Product Feature."Field Type" | Value type for storage |
Display Text Value |
Text Value | Product Feature.Value | Text representation of value |
Display Number Value |
Number Value | Product Feature."Value Numeric" | Numeric value |
Display Number To Value |
Number To Value | Product Feature."Value Numeric To" | Range end value (for ranges) |
Value Logical |
Logical Value | Product Feature."Value Logical" | Boolean value |
Value Date |
Date Value | Product Feature."Value Date" | Date value |
Importance |
Importance | Product Feature.Importance | Feature importance level |
Relevance |
Relevance | Product Feature.Relevance | Feature relevance level |
Usage Type Code |
Usage Type | Product Feature."Usage Type Code" | Usage type classification |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Feature) | Feature name/description in all languages |
Variant Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Item Variant Code | Variant identifier |
| Translation Sublines | Translations | PIMX Catalog Translation (Type=Variants) | Variant descriptions in all languages |
Description Text Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Number | Description Text.Number | Text identifier |
Langtext |
Description | Description Text.Description or "Plain Text Description" | Main language text content |
| Translation Sublines | Translations | PIMX Description Text Translation | Language-specific text versions |
| - Language Code | Language code | Language code | |
| - Description Title | Title | Translated title | |
| - Description Title 2 | Title 2 | Translated subtitle | |
| - Description | Translated text content |
Product Content Data
| Field | Source | Description |
|---|---|---|
Level |
Product Content.Level | Content hierarchy level |
Priority |
Product Content."Line No." | Content priority/order |
Vorlagencode |
Product Content."Template Code" | Template code |
Data (Blob) |
Product Content."Data Blob" | HTML or rich content data |
Content Header Data
| Field | Source | Description |
|---|---|---|
Level |
0 (Fixed) | Fixed at 0 for headers |
Priority |
0 (Fixed) | Fixed at 0 for headers |
Vorlagencode |
Content Header."Template Code" | Template code |
Data (Blob) |
Content Header."Data Blob" | HTML or rich content data |
Entity: Publication Subline ML (Additional Languages)
Sublines are created for each additional language beyond the main language.
| Field | Source | Description |
|---|---|---|
Publication Code |
Publication Header Code | Publication identifier |
Line Guid |
Publication Line."Line GUID c1" | Line reference |
Language |
PIMX Catalog Translation."Language Code" | Additional language code |
Beschreibung |
Translation record | Translated description |
Beschreibung 2 |
Translation record | Translated secondary description |
Value |
Translated value | Language-specific feature/keyword/value text |
Text |
PIMX Description Text Translation | Language-specific text content |
Cross-Reference Data
| Field | Caption | Source | Description |
|---|---|---|---|
Vorlagencode |
Template Code | Allocation Line."Template Code" | Template code |
Priority |
Priority | Allocation Line.Order | Sort order |
| Main Language | Description | Cross-Reference Type Description | Text in main language |
| Translation Sublines | Translations | Translation record | Description in additional languages |
Important Processing Rules
Multiple Languages Per Channel
- Main language data in Publication Line
- One subline per additional configured language
- Each subline contains complete translated data for that language
- Total sublines = Number of languages - 1
Translation Lookup Process
For each configured language:
PIMX Catalog Translation
Type = <Entity Type>
Code = <Entity Code>
Language Code = <Language>
Duplicate Handling
If translation source requires value IDs (like for Features):
- Each value ID translated within the language
- Multiple values combined with pipe separator (|) for polyvalent features
- Single value used for non-polyvalent features
Missing Translation Handling
Based on Publication Group "Replace Missing Translations" setting:
- DefaultValue: Creates subline using default/main language value
- False: Only creates subline if translation exists
- Skips missing translations when setting is False
Field Mapping Summary
Publication Line Fields (Main Language Only)
| Field | Source | Always Set |
|---|---|---|
Nummer |
Entity ID | Yes |
Vorlagencode |
Allocation/Entity | Conditional |
Priority |
Allocation/Entity | Conditional |
ArtGrp/WarGrp/Kap Bezeichnung |
Entity Description | Conditional |
| Descriptive Fields | Entity Fields | Conditional |
Subline Fields (Additional Languages)
| Field | Source | Per Language |
|---|---|---|
Language |
Translation Language Code | Yes |
Beschreibung |
Translated Description | Yes |
Value |
Translated Feature/Keyword Value | Yes |
Text |
Translated Text Content | Yes |
Data Flow
- Load Base Data: Load source entity
- Populate Publication Line: Set main language data
- Get All Languages: Query configured language codes
- For Each Language:
- Look up translations from PIMX Catalog Translation
- Look up text translations from PIMX Description Text Translation
- Create subline with translated data
- Storage:
- Main language in Publication Line
- Additional languages in Publication Subline ML
- Export: All languages available in single dataset
Use Cases
- Global APIs serving multiple language markets
- E-commerce platforms with multilingual product data
- International marketplaces (Amazon, Shopify, eBay)
- Multilingual mobile applications
- Content delivery networks requiring all languages
- Global SaaS applications with language selection
- Regional APIs needing multiple language support
Key Differences from Other Types
| Aspect | API Simple | API Translation | Multilanguage API | ML Print |
|---|---|---|---|---|
| Languages | 1 (main) | 1 (alt) | All configured | All configured |
| Main Language | Yes | No | Yes | Yes |
| Sublines | None | 1 per entity | N-1 per entity | N-1 per entity |
| Use Case | Single lang | Regional | Global | Print/Design |
| API Payload | Smallest | Medium | Largest | Largest |
Data Volume Considerations
- Publication Line Records: 1 per entity (same as API Simple)
- Subline Records: (Languages - 1) × Entities
- Total Size: Approximately N times larger than API Simple
- N = number of configured languages
- Example: 5 languages = ~5 times the data volume
Field Consistency
All instances of the same value are guaranteed consistency:
- Feature value translations retrieved from same source
- Description text translations for same entity
- Keyword/Unit translations synchronized
- Value ID references maintained across languages