API (Simple) Publication Type - Field Mappings
Overview
The API (Simple) publication type maintains data in the main language only, without translation sublines. This page documents the specific fields that are populated in the Publication Line entity for each source data type.
Entity: Publication Line
The main entity is the PIMX Publication Line table. All fields are populated with main language data only.
Item Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Item No. | Item.No. | Item number (validated) |
Vorlagencode |
Template Code | Allocation Line."Template Code" > Item."PIMX Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Item.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Item."Description 2" | Secondary description - resolved per priority order below |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Item Group.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Item Group."Description 2" | Secondary description - resolved per priority order below |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Product Group.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Product Group."Description 2" | Secondary description - resolved per priority order below |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 | Allocation Line."Template Code" > Chapter."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Chapter.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Chapter."Description 2" | Secondary description - resolved per priority order below |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 | Allocation Line."Template Code" > Catalog Group."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Catalog Group.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Catalog Group."Description 2" | Secondary description - resolved per priority order below |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 Line (no fallback - Line takes precedence) |
Bezeichnung |
Description | Channel Allocation.Description > Catalog Item.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Catalog Item."Description 2" | Secondary description - resolved per priority order below |
Description Source Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - 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 | Allocation Line."Template Code" > Document."Template Code" | Template code - see priority order below |
Bezeichnung |
Description | Channel Allocation.Description > Document.Description | Description field - resolved per priority order below |
Bezeichnung 2 |
Description 2 | Channel Allocation."Description 2" > Document."Description 2" | Secondary description - resolved per priority order below |
Link |
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 |
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 Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.DescriptionandChannel Allocation."Description 2" - Channel Allocation."Manual Descriptions" = FALSE → Use
Document.DescriptionandDocument."Description 2"
Document Line Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Document Code | Document identifier |
Bezeichnung |
Description | Channel Allocation.Description > Document.Description | Description field - resolved per priority order below |
Link |
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 |
Description Source Priority Order:
- Channel Allocation."Manual Descriptions" = TRUE → Use
Channel Allocation.Description - Channel Allocation."Manual Descriptions" = FALSE → Use
Document.Description|Nummer| Document Code | Document identifier | |Bezeichnung| Channel Allocation OR Document.Description | Description field - resolved per priority order | |Link| Document."Public Link" | Public URL | |MIME Type| Document."Mime Type" | MIME type | |Source File Name| Document."Source File Name" | Original file name | |Document Usage| Document."Document Usage" | Usage classification | |Repository Type| Document."Repository Type" | Repository type | |External Container Id| Document."External Container Id" | External container ID | |External Id| Document."External Id" | External document ID |
Keyword Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
ID | Keyword."Keyword ID" or Classification | Keyword identifier based on ID source setting |
Priority |
Sequence No. | Keyword.Order | Keyword priority/order |
Bezeichnung |
Text | Keyword.Description | Keyword text - main language only |
Nummer |
Keyword."Keyword ID" or Classification | Keyword identifier based on ID source setting | |
Priority |
Keyword.Order | Keyword priority/order | |
Bezeichnung |
Keyword.Description | Keyword text - main language only |
Feature Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Feature Number or Reference/Classification | Feature identifier based on ID source |
Bezeichnung |
Name | Product Feature.Description | Feature name - main language only |
Type Enum |
Type | Product Feature."Field Type" | Feature data type |
Feature Value Type |
Value Type | Derived from Product Feature."Field Type" | Value type (Text, Number, Range, Boolean, etc.) |
Display Text Value |
Value (Text) | Product Feature.Value | Text representation |
Display Number Value |
Value (Number) | Product Feature."Value Numeric" | Numeric value |
Display Number To Value |
Value To (Number) | Product Feature."Value Numeric To" | Range end value |
Value Logical |
Value (Boolean) | Product Feature."Value Logical" | Boolean value |
Value Date |
Value (Date) | Product Feature."Value Date" | Date value |
Importance |
Importance | Product Feature.Importance | Feature importance |
Relevance |
Relevance | Product Feature.Relevance | Feature relevance |
Usage Type Code |
Usage Type | Product Feature."Usage Type Code" | Usage type |
Variant Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
Code | Item Variant Code | Variant identifier |
Bezeichnung |
Name | Item Variant.Description | Variant text - main language only |
Description Text Data
| Field | Caption | Source | Description |
|---|---|---|---|
Nummer |
No. | Description Text.Number | Text identifier |
Langtext |
Long Text | Description Text.Description or "Plain Text Description" | Main language 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 |
Cross-Reference Data
| Field | Source | Description |
|---|---|---|
Vorlagencode |
Allocation."Template Code" | Template code |
Priority |
Allocation.Order | Sort order |
| Cross Reference Field | Cross-Reference Type Description | Type description in main language |
Important Characteristics
No Sublines Created
PIMX Publication Subline MLtable is NOT used- All data remains in the main
PIMX Publication Linetable
Single Language Only
- All descriptions and text are in the main/default language
- Language code filtering not applied to translations
- Much smaller data footprint compared to Multilanguage types
Channel Allocation Impact on Descriptions
The InitFromChannel() method applies channel-specific configuration:
Description Resolution Priority:
- If Channel Allocation has "Manual Descriptions" = true:
- Use
Channel Allocation.DescriptionandChannel Allocation."Description 2"
- Use
- If Channel Allocation has "Manual Descriptions" = false:
- Get descriptions from source entity (Item.Description, ItemGroup.Description, etc.)
Once descriptions are obtained:
Bezeichnungfield is populated
Data Processing Flow
- Load Base Data: Load entity (Item, Document, etc.)
- Populate Fields: Set publication line fields from entity
- Template Code Resolution: Attempt to use allocation template code, fall back to entity template code
- Channel Allocation: Apply channel-specific defaults via
InitFromChannel()- Check if Manual Descriptions are enabled
- Get descriptions (either from allocation or source entity)
- Populate Bezeichnung and Bezeichnung 2 fields
- No Translation Step: Unlike Multilanguage types, no translation lookup or subline creation
- Finalize: Line ready for export/API
Field Mapping Summary
Core Fields (All Entities)
| Field | Always Set | Source |
|---|---|---|
Code |
Yes | Publication Header |
Nummer |
Yes | Entity ID/Code |
Vorlagencode |
Conditional | Allocation or Entity |
Priority |
Conditional | Allocation or Entity |
Translation-Related Fields
| Field | Single Language | Source |
|---|---|---|
Langtext |
Main Language | Entity Description |
| Translation Sublines | None Created | N/A |
Use Cases
- REST APIs with single-language consumers
- Lightweight exports with minimal data volume
- Performance-optimized integrations
- Default language data exposure
- Simple integrations requiring single language