Develop > Persistence layer > Data assets > Work with the Data load utility
Data load business object mediators
The data load business object mediator converts the business objects into physical objects. Two types of mediators provided with the data load utility are...
- component-based mediator
- table-based mediator
Several component-based mediators are available for catalog, inventory, and price components. You are also provided with a TableObjectMediator to support loading data directly into a table.
Table-based mediators
To use the TableObjectMediator, know the physical table to load data into. You also need to know the foreign key relationships, how the keys are generated, and how to resolve the generated keys based on the unique index. The column value which can be retrieved from the business contexts, also needs to be known.
Although table-based mediators have many advantages, it also has some disadvantages.
Advantages
- You know what physical tables and columns you are loading data to.
- You control the mapping and loading of data through the configuration, instead of using Java code as used by component-based mediators.
- You can load the data to any tables you want.
- The performance is better.
Disadvantages
- You need an in-depth knowledge on the database schema, and the physical tables to load the data into.
- If the data in the CSV files are not mapped to the database columns, you cannot use table-based mediators.
Catalog mediators
AttributeDictionaryAttributeMediator
Write attribute dictionary attributes. The mediator populates the following tables:
This mediator can load:
- attributes separately - one attribute per CSV line. Example:
Identifier Type Name Description Field1 Footnote UnitOfMeasure Color String Color Blue is the most popular Size String Size How large? We do not have XXXL
- attribute values separately - one attribute value per CSV line. This method is the only way to load the optional columns of ATTRVALDESC such as FIELD1, IMAGE1, and so on. Example:
Identifier ValueIdentifier ValueUsage Sequence Value Field1 Image1 Color Blue 1 1 Blue blue.gif Color Red 1 2 Red red.gif
- attributes and values together - one attribute with one or more allowed values per CSV line. Example:
Identifier Type Name Value1 Value2 Value3 Value4 Color String Color Red Green Blue Size String Size S M L XL
CatalogDescriptionMediator
Generate physical objects from catalog description in the Catalog noun.
CatalogEntryAssociationMediator
Generate physical objects for the catalog entry to catalog entry merchandising association relationships.
CatalogEntryAttributeDictionaryAttributeExtendedMediator
Write relationships between a SKU catalog and attribute dictionary attribute. This mediator populates the CATENTRYATTR table.
Multiple attribute and value pairs can be specified vertically per CSV line. Example:
PartNumber Color Size Shirt-white-small white S Shirt-white-medium white M Shirt-blue-medium blue M The CSV file must refer to a homogenous collection of existing SKU items that share the same set of attributes. This mediator can automatically create the missing parent table entries using default values.
CatalogEntryAttributeDictionaryAttributeMediator
Write relationships between a SKU catalog and attribute dictionary attribute. This mediator populates the CATENTRYATTR table.
One pair of attribute and value are specified horizontally per CSV line. Example:
PartNumber AttributeIdentifier ValueIdentifier Shirt-white-small Color white Shirt-white-small Size S Tire-CW15 Diameter 15 Tire-CW15 Type Winter Tire-CW15 Make Canada Tire Company The CSV file can refer to a heterogenous collection of existing SKU items that use diversified attributes. The parent tables ATTR and ATTRVAL are assumed to have been loaded already.
CatalogEntryAttributeExtendedMediator
Write classic attributes, populating the following tables:
- ATTRIBUTE
- ATTRVALUE
This mediator can load multiple attribute and value pairs vertically for a SKU item per CSV line. Example:
PartNumber Color Size Shirt-white-small white S Shirt-white-medium white M Shirt-blue-medium blue M The CSV file must contain a homogeneous collection of SKU items that share the same set of attributes.
CatalogEntryAttributeMediator
Write classic attributes. This mediator populates the following tables:
- ATTRIBUTE
- ATTRVALUE
This mediator can load:
- attributes for products separately - one attribute per CSV line. Example:
PartNumber Type Name Sequence Description Field1 Footnote UnitOfMeasure Shirt String Color 1 Blue is most popular Shirt String Size 2 How large? We do not have XXXL
- allowed attribute values for products separately - one attribute value per CSV line. This method is the only way to load optional columns of ATTRVALUE table such as FIELD1, IMAGE1, ATTACHMENT_ID, and so on. Example:
PartNumber Name ValueSequence Value ValueField1 Image1 AttachmentID Shirt Blue 1 Blue blue.gif Shirt Red 2 Red red.gif
- attributes and allowed values for products together - one attribute with one or more allowed values per CSV line. Example:
PartNumber Type Name Value1 Value2 Value3 Value4 Shirt String Color Red Green Blue Shirt String Size S M L XL
- attribute values for SKU items - one attribute value for a SKU item horizontally per CSV line. Example:
PartNumber Name Value Shirt-white-small Color white Shirt-white-small Size S Tire-CW15 Diameter 15 Tire-CW15 Type Winter Tire-CW15 Make Canada Tire Company
The CSV file can contain a heterogeneous collection of SKU items that use very diversified attributes.
CatalogEntryDescriptionMediator
Generate physical objects from catalog entry description in the catalog entry noun. It supports transforming descriptions in multiple languages.
CatalogEntryKitComponentMediator
Generate physical objects from parent catalog entry to child kit component relationships.
CatalogEntryMediator
Generate physical objects from CatalogEntry noun to create the catalog entry, descriptions, list price, and attributes. This mediator transforms the catalog entry noun to a list of physical objects.
The transformed data includes...
- catalog entry base properties
- store/catalog entry relationships
- descriptions
- parent catalog
- parent catalog group to child catalog entry relationship
- parent product to child SKU relationship
- descriptions
- list price
- attributes
- attribute value
Populate either the classic or attribute dictionary attribute tables depending on whether ATTRDICT is to be or has been initialized for the store that owns the catalog entries.
CatalogEntryParentCatalogGroupMediator
Generate physical objects from parent catalog group to child catalog entry relationships.
CatalogEntryParentProductMediator
Generate physical objects from parent product to child SKU relationships.
CatalogGroupAssociationMediator
Transform the association part of catalog group noun to merchandising association physical objects.
CatalogGroupDescriptionMediator
Transform the description part of catalog group noun into description physical objects. It supports transforming descriptions in multiple languages.
CatalogGroupMediator
Transform catalog group noun to a list of physical objects. The transformed data include catalog group base properties, store/catalog group relationships, descriptions, parent/child catalog group relationship, and catalog/catalog group relationship.
CatalogGroupRelationshipMediator
Parent catalog group identifier part of catalog group noun to catalog group relationship physical object.
CatalogMediator
Write catalog, populating the following tables:
FulfillmentPropertyMediator
Transform the fulfillment property part of catalog entry noun to ATP configuration-related physical objects only when the store (which owns the catalog entry) inventory system is ATP. Nothing is loaded if the inventory system is not ATP. This mediator is used for the delta load of ATP configuration data only.
Inventory mediators
NonATPInventoryMediator
Load the data into the INVENTORY table for stores which adopt non-ATP inventory system.
InventoryReceiptMediator
Populate the RECEIPT and RCPTAVAIL tables for stores which adopt ATP inventory system. However, no data is required in the CSV file to populate the RCPTAVAIL table.
ExpectedInventoryMediator
Populate the RA and RADETAIL tables for stores which adopt the ATP inventory system. It can also be used to populate the RA table only if no data for RADETAIL is specified in the CSV file. In other words, there are two options to initially load RA and RADETAIL:
- Load RA and RADETAIL together in a single CSV file
- Load RA and RADETAIL separately. Load RA first by calling the ExpectedInventoryMediator, then load RADETAIL by calling the ExpectedInventoryDetailMediator.
ExpectedInventoryDetailMediator
Populate the RADETAIL table for stores which adopt the ATP inventory system.
To use this mediator, the vendor name and RA creation time is required in the CSV file to resolve the RA ID.
Price mediators
DefaultOfferMediator
Transform price list noun to a list of physical objects for a store default price list. The transformed data includes offer, offer price, and offer description.
To use this mediator, either the part number or the unique ID of the catalog entry is required in the CSV file.
OfferMediator
Transform price list noun to a list of physical objects under the specified price list specified in the CSV file. The transformed data includes offer, offer price, and offer description.
To use this mediator, either the part number or the unique ID of the catalog entry is required in CSV file. If the price list name and the unique ID are not specified in the CSV file, the mediator loads the offer data into the default price list of the store.
PriceListMediator
Generate a physical object from the price list noun. The generated data includes the price list.
To use this mediator, either the name or the unique ID of price list is required in the CSV file.
Related concepts
Data load framework process and components
Related tasks
Examples: Mapping pricing data
Examples: Mapping inventory data
Configure the business object configuration file
Configure the CSV data reader
Related reference
Configure the BusinessObjectBuilder
Examples: Mapping catalog data