Personal Library

Guide - IOM Supplier Onboarding 2.0

https://support.intershop.com/kb/28004F

Product Version	1.1
Product To Version	2.2
Status	Final

1 Introduction

This guide describes the configuration steps to add a supplier to an existing IOM shop instance. It is addressed to IOM operators (e.g., an IOM administrator who has access to the whole system).

A questionnaire guides the target group to collect the necessary information in the run of the supplier configuration.

This guide does not cover any kind of supplier approval processes. So there is no documentation of the following configuration tables in this document:

oms."Supplier2ApprovalStateCodeDefDO"
oms."Supplier2ApprovalStateCodeReasonDefDO"
oms."Shop2Supplier2ApprovalTypeDefDO"

1.1 Glossary

Term	Description
COD	Cash on delivery
DO	Data Object - used as persistence entities to represent stored values in the database
DOSE	Dynamic Order Supplier Evaluation
EOL	End Of Life - the sale or support of goods and services is terminated
IOM	The abbreviation for Intershop Order Management
OMS	The abbreviation for Order Management System, the technical name of IOM
OMT	The abbreviation for Order Management Tool, the graphical management tool of the IOM
RMA	Return Merchandise Authorization / Return Material Authorization

1.2 1.2 References

1.3 Prerequisite

To follow this guide and to do the supplier on-boarding by yourself, you need good experience with SQL, XML, and CSV. A good understanding of the retailing model between the shop and the new supplier is helpful.

An essential parameter for the supplier configuration is the OMS internal ID of the OMS shop instance to which the new supplier should be connected. From now on this ID will be identified by $shopId.

2 Questionnaire

Question	Relates to
Does the supplier support order responses? Does the supplier use the OMS ShopService to submit response messages?	Guide - IOM Supplier Onboarding 2.0#Response transmission SupplierDO property "Guide - IOM Supplier Onboarding 2.0#supportsResponse"
Does the supplier use the OMS ShopService to submit dispatch messages (delivery notifications)?	Guide - IOM Supplier Onboarding 2.0#Dispatch transmission
Does the supplier use the OMS ReturnService to submit return messages?	Guide - IOM Supplier Onboarding 2.0#Return transmission
Does the retailer / shop use the supplier for drop shipment?	SupplierDO property "Guide - IOM Supplier Onboarding 2.0#supplierTypeDefRef" Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#isDropShipment"
Does the retailer / shop allow the splitting of an order into multiple shipments?	Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#splitShipmentAllowed"
Does the supplier support the payment method COD in relation to the retailer / shop?	Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#supplierSupportsCOD"
Does the shop system use the OMS feature to select a supplier with the order submission (shop system to OMS)? If TRUE, the configuration value (Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#shopSupplierName") has to be agreed with the shop system.	Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#shopSupplierName"
Which return reasons does the supplier use? Does the supplier use own identifiers / names for return reasons in the communicating with the OMS?	Guide - IOM Supplier Onboarding 2.0#Supplier2ReturnReasonDefDO
Does the shop / retailer support an RMA process? If TRUE should the OMS create RMA numbers for the supplier? is the RMA number a fix value for the supplier?	Guide - IOM Supplier Onboarding 2.0#Supplier2ReturnTypeDefDO
Which reduction reasons (name / identifier) does the retailer / shop use? Which reduction reasons (name / identifier) does the supplier use? What is the mapping of the reduction reasons between retailer / shop and supplier?	Guide - IOM Supplier Onboarding 2.0#Shop2Supplier2ReduceReasonDO
Should the inventory of a product set to 0, if a product is not longer included in the import data files? Note Requires that the property "checkMissingInLastDatapack" at the product import configuration is set to TRUE.	Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#resetStockOnImport"
If the order includes coupons, should these be transmitted to the supplier?	Shop2SupplierDO property "Guide - IOM Supplier Onboarding 2.0#sendOrderCoupon"

3 Configuration

This chapter describes the configuration at the OMS database to add a new supplier to an existing and already configured OMS shop instance. The sections in this chapter are corresponding to the configuration tables.

3.1 SupplierDO

The main entity of the supplier configuration is the database table oms.“SupplierDO”. All other supplier related configurations refer to this table.

3.1.1 Table structure

Property	Description	Example
id	ID / primary key - from now on this ID will be identified by `$supplierId`	5000
active	Indicates enabled / disabled suppliers	TRUE
contentSupplier	Indicates if the supplier is a content provider for product data - should be FALSE	FALSE
countryCodeDefRef	Country code used in the IOM interfaces - should be 1 (ISO 3166-1 alpha-2) - reference to oms."CountryCodeDefDO"	1
countryDefRef	Country of the supplier - reference to oms."CountryCodeDefDO"	29
cutOffTime	Specifies the time by which an order must be submitted to the supplier to guarantee the minimum delivery time. If the cutoff time already passed when the DOSE process for an order takes place, the planned delivery date is increased by one day. syntax: hh:mm (24-hour time format)	14:30
deliveringSupplier	States whether a supplier delivers goods. If FALSE, this supplier is not considered in the order assignment for a shop (DOSE process).	TRUE
legal	Indicates if the Supplier is a concrete supplier, or is used only for configuration purposes - should be TRUE	TRUE
modificationDate	Time stamp of the last modification - should be updated with each change	now()
name	Name of supplier	SIM Flagship store - North
supplierName	Name of supplier, as used by the supplier itself Used by: IOM SOAP Web service ShopService (Guide - IOM Supplier Onboarding 2.0#Response transmission and Guide - IOM Supplier Onboarding 2.0#Dispatch transmission)	SIM - North
supportsReservation	Indicates whether the supplier supports reservations - should be FALSE Note Reservations are currently not supported by the IOM	FALSE
supportsResponse	Indicates whether the supplier supports order responses (IOM ShopService method storeResponse) - If FALSE, the data determined by the DOSE process (INITIAL-response) are immediately assumed. Otherwise the OMS waits for a response message of the supplier.	FALSE
singlePositionArticle	Indicates whether the supplier can handle only one position per product. - If TRUE, the OMS combines positions with the same product to one position and sums up their quantities (for the order placement message to the supplier). Used by: Guide - IOM Supplier Onboarding 2.0#Order placement - OMS to supplier	TRUE
internalSupplierName	Name of the supplier for OMS internal technical purpose syntax: spaces are not allowed and lowercase is recommended	simwarehouse_north
parentSupplierRef	Reference to a parent supplier (oms."Guide - IOM Supplier Onboarding 2.0#SupplierDO".id). Contrarily to shop inheritances that affect many features, supplier inheritance is only used for users and roles assignments: roles granted in a parent supplier are also available in all descendant suppliers.	null
cleanParentOnImport	If TRUE, any existing values of EAN and manufacturerArticleNo are set to null at master products (variation masters) after an IOM product import.	TRUE
ignoreAdditionalPositions	Specifies the handling of additional order positions in messages from the supplier. If TRUE, the OMS should ignore additional positions. If FALSE, the OMS throws an InvalidReferenceException in case of an additional order position.	TRUE
configurationUseCaseDefRef	Note Removed with IOM 2.2	5
businessObjectProcessingDelay	Delay of message processing. Such a delay enables the cancellation of business messages like dispatches etc. before the processing has begun. Note Currently this functionality is only used for messages from the OMT. Duration in minutes = m (e.g., 30m) Duration in hours = h (e.g., 1h)	15m
supplierTypeDefRef	Type of supplier - possible values are: 1 = Retailer 2 = Warehouse 3 = Drop shipment	2

3.1.2 Example OMS Version Until 2.1

until OMS 2.1

INSERT INTO oms."SupplierDO"(
            "id", "active", "contentSupplier", "countryCodeDefRef", "countryDefRef", 
            "cutOffTime", "deliveringSupplier", "legal", "modificationDate", 
            "name", "supplierName", "supportsReservation", "supportsResponse", 
            "singlePositionArticle", "internalSupplierName", "parentSupplierRef", 
            "cleanParentOnImport", "ignoreAdditionalPositions", "configurationUseCaseDefRef", 
            "businessObjectProcessingDelay", "supplierTypeDefRef")
    VALUES (5000, TRUE, FALSE, 1, 29, 
            '14:30', TRUE, TRUE, now(), 
            'SIM Flagship store - North', 'SIM - North', FALSE, FALSE, 
            TRUE, 'simwarehouse_north', 5, 
            TRUE, TRUE, null, 
            '15m', 2);

3.1.3 Example OMS Version 2.2 or Higher

OMS 2.2 or higher

INSERT INTO oms."SupplierDO"(
            "id", "active", "contentSupplier", "countryCodeDefRef", "countryDefRef", 
            "cutOffTime", "deliveringSupplier", "legal", "modificationDate", 
            "name", "supplierName", "supportsReservation", "supportsResponse", 
            "singlePositionArticle", "internalSupplierName", "parentSupplierRef", 
            "cleanParentOnImport", "ignoreAdditionalPositions",
            "businessObjectProcessingDelay", "supplierTypeDefRef")
    VALUES (5000, TRUE, FALSE, 1, 29, 
            '14:30', TRUE, TRUE, now(), 
            'SIM Flagship store - North', 'SIM - North', FALSE, FALSE, 
            TRUE, 'simwarehouse_north', null, 
            TRUE, TRUE, 
            '15m', 2);

3.2 Shop2SupplierDO

The database table oms."Shop2SupplierDO" includes the relationship between an OMS shop instance and an OMS supplier entity. It is the glue for the shop supplier relationship.

3.2.1 Table structure

Property	Description	Example
id	ID / primary key	15000
active	Indicates enabled / disabled shop to supplier relationships	TRUE
modificationDate	Time stamp of the last modification - should be updated with each change	now()
reservationTimeInDays	The supplier holds a reservation for the shop for this number of days - should be 0 Note Reservations are currently not supported by the IOM.	0
sendOffTimeInHours	Note Deprecated The column is deprecated - 0 should be used.	0
shopAccount	User account of the shop system for the placement of supplier response, dispatch, and return messages from the OMS to the shop system - set only if required. Used by: XML element User at storeResponse XML element User at storeDispatch XML element User at storeReturn	null
shopPassword	Password of the above mentioned user account at the shop system - set only if required. Used by: XML element Password at storeResponse XML element Password at storeDispatch XML element Password at storeReturn	null
shopSupplierName	Name (identifier) of the supplier as called by the the shop system - mandatory but no constraint at the DB Used by: Order placement shop system to OMS (selectedSupplier) OrderStateService method getOrderStateReport (OrderStateReportMapperOutBean) - XML attribut name at element Supplier ReverseService method returnSlipRequest (ReturnRequestResponseMapperOutBean) - XML attribut name at element Supplier Outbound XML messages like response, dispatch, and return from the OMS Document creation (OrderDocumentsMapperBean) - see OrderDocuments.xsd element SupplierData at OrderDocuments attribute shopSupplierName	SIM supplier - North
splitShipmentAllowed	Indicates the allowance of the retailer / shop to split an order into multiple shipments. Used by: Guide - IOM Supplier Onboarding 2.0#Order placement - OMS to supplier (this configuration property is used when no corresponding value at the order is present )	TRUE
supplierAccount	User account of the supplier system for the placement of order messages from the OMS to the supplier system - set only if required. Used by: Order placement - OMS to supplier (Shop2SupplierTransmissionWrapper) XML element User at storeOrder	null
supplierPassword	Password of the above mentioned user account at the supplier system - set only if required. Used by: Order placement - OMS to supplier (Shop2SupplierTransmissionWrapper) XML element Password at storeOrder	null
supplierShopName	Name (identifier) of the retailer / shop as called by the the supplier. Used by: IOM SOAP Web service ShopService (Guide - IOM Supplier Onboarding 2.0#Response transmission and Guide - IOM Supplier Onboarding 2.0#Dispatch transmission) Document creation (OrderDocumentsMapperBean) - see OrderDocuments.xsd element ShopData at OrderDocuments attribute supplierShopName Guide - IOM Supplier Onboarding 2.0#Order placement (FileSenderBean) - OMS to supplier for the wildcard SHOP at the filename	SIM
shopRef	Reference to the OMS shop instance - references oms."ShopDO" - $shopId	10000
supplierRef	Reference to the OMS supplier instance - references oms."SupplierDO" - $supplierId	5000
supplierShopKey	Note Deprecated The column is deprecated - 'null' should be used.	null
sendOrderCoupon	Indicates whether existing order coupons (oms.”OrderCouponDO”) are sent to the supplier alongside with the order. Used by: Guide - IOM Supplier Onboarding 2.0#Order placement - OMS to supplier	FALSE
supplierSupportsCOD	Indicates whether the supplier supports payment method COD in relation to the retailer / shop. If FALSE the supplier is not considered in the DOSE process for orders with payment method COD. Used by: Dynamic Order Supplier Evaluation	FALSE
eolDetectionTimeInterval	Specifies the time in minutes to determine when a product that was not available at the last successfully imported dynamic data file (see Guide - IOM Supplier Onboarding 2.0#Product import) is set to EOL by the OMS. null = The OMS default EOL detection time interval of seven days 0 = The next EOL detection run (triggered by a quartz job) sets the concerned products immediately to EOL Used by: OMS article management - function / stored procedure "product.article_eol_detection"	null
resetStockOnImport	Specifies whether to set the inventory of a product to 0 if the product is no longer included in the product data files from the supplier. This determination is made only when the property "checkMissingInLastDatapack" at the import configuration (see product."ImportConfigurationDO") for the related supplier is set to TRUE. Used by: Product Import	FALSE
flatRateShipping	Specifies the delivery charge, which has been agreed between the retailer / shop and the supplier. This delivery charge is used in the optional OMS sales price calculation. This charge is added to the purchase price to determine the selling price. If this property is NULL, 0 is added. Used by: DB function / stored procedure "product.process_salesprice_calculation"	null
isDropShipment	Indicates if the supplier provides drop shipment for the retailer / shop. This property has an impact on business processes. If the property Guide - IOM Supplier Onboarding 2.0#supplierTypeDefRef = 3 of the related supplier, then this property should be TRUE. Used by: This property has an impact on business processes - DropshipperExecutionDeciderBean	FALSE
immaterialArticleUrlValidityDuration	Note Deprecated The column is deprecated - 'null' should be used.	null
returnCarrierRef	Specifies the carrier, which is used in the return processes between this shop and this supplier.- references oms."CarrierDO" Used by: Creation of return label according to the configured carrier	null
leadCode	Lead code of the supplier at the carrier for the return label Used by: creation of return label (complexType "ReturnLabel", element "LeadCode")	null
useSupplierArticleNoAsShopArticleNo	Indicates whether the product number of the supplier (see Product Import) should be used as the shop product number. If TRUE no further mapping of supplier product numbers to shop SKU is necessary. The OMS creates the necessary import file (so-called N-File) during product import processing. Used by: Product Import	FALSE
shopArticleNoPrefix	Only useful if property Guide - IOM Supplier Onboarding 2.0#useSupplierArticleNoAsShopArticleNo is TRUE. The shop product numbers can be created by the OMS using the supplier product numbers enriched with this prefix value. Used by: Product Import	null

Note

A unique constraint ensures that the relationship of a specific shop (property shopRef) to a specific supplier (property supplierRef) only occurs once.
Another unique constraint ensures that for a specific shop

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.