PIM to CMS
This Document will cover all the necessary steps and comprehensive information for Implementation of new client PIM to our Vin Lister-CMS.
1. CMS Panel Creation -Prerequisite for getting data from PIM to CMS is to create client’s CMS panel.
For each client unique CMS panel link is created
2. CMS environment specific end point setup and Request format provided to Client
Once CMS panel is created, CMS environment specific end point is to be shared for PIM data push to CMS
a) Product Create URL – To push data in CMS from PIM, we need to provide our CMS API’s product create url to client. This URL is sequence of Unique cms link and CMS API create path
Example: Our Client Bata Malaysia has its own PIM and pushes data through PIM to CMS.
Unique CMS Panel Link is as below:
API to submit product data to CMS for Creation is as below:
End Point created will be CMS Panel Link + CMS API, i.e., https://bata-my-cms.vineretail.com/ + cmsRestWS/api/v1/product/create
New endpoint will be: https://bata-my-cms.vineretail.com/cmsRestWS/api/v1/product/create
|
b) Required Keys to be provided for getting PIM data are:
- Content Type - The value of content type is always same –
application/json
- Authorization Key - For all new clients and new PIM configurations,
unique authorization key is generated by Integration Team.
c) Request format is provided to client- Once CMS panel is setup and required keys and end points are generated, we share the request format to client.
Sample request format:
Make sure below pointers are covered in our Request format:
Below are few required Static attributes:
|
Client might send us the customized request format. In those cases, we need to configure the same at our backend.
3. Ext attribute Mapping in CMS
After first push of product data from PIM to CMS, All the PIM attributes will be populated in CMS panel of client’s Admin >> EXT SKU Attribute Mapping.
Now, Mapping is done for PIM attributes and PIM values with our CMS attributes and CMS Values respectively.
We must ensure that:
|
Understanding of EXT Mapping headers:
- EXT Attribute Name- This column covers all the Attributes passed from PIM to CMS.
Here in below screenshot, Ankle_Height, Arch_Type, brand etc Attributes are coming from PIM to CMS
- CMS Attrib – This column denotes whether corresponding attribute is Static as S and Dynamic as D
- CMS Attribute – CMS attribute code is entered in this field.
- Attribute Label – CMS Attribute name of that corresponding PIM Attribute is added here.
For example, check below: Ankle_Height is EXT Attribute name, and its corresponding CMS attribute name is Ankle Height and Unique attribute code for ankle height is 25045
- Mapping Type –If any attribute is of dropdown and requires value mapping then this Mapping type column is used to enable value mapping box. We need to enter Mapping name to enable value box.
In above example, we can see that once “Brandmapping” name is given to Mapping type column, the box in left side will be enabled. Click on it to map the EXT values to CMS values.
To add new mapping, click on Add New and by using Pipe delimiter | add ext value and cms value and click on Add + button
EXT Value|CMS Value
- Conditional Field and Conditional Values – These columns are used when we have to do one to many relationships mapping based on different field conditions, which means one EXT attribute is mapped to many CMS attribute.
Here in above screenshot, one EXT attribute Material_Type is used for different CMS attribute which are different Category- Footwear, Bags and Luggage. So, if material data comes for MerchID- 211-Footwear, then CMS will read mapping of Seqno-26789 and will create that sku under footwear and will use Footwear Material accordingly in CMS.
- Priority – Priority is set for those attributes where more than one EXT Attribute is passed for one CMS attribute. So, whenever request will come Priority 2 will be picked first followed with priority 1
EXT setup will be done by CMS team for PIM sku push
4. SKU Push from PIM to CMS
Once PIM configuration is done, the data is hit from PIM to CMS.
Import tab will show the result of data push whether all the product created or not with Total data pushed and success count, if any error and data failed, it will come in Red highlighted number.
Error can be checked by clicking on errors:
We can also check for data logs in Importlogs table (It is a Global db. table, which contains all information of import of all orgid- Importtype, Orgid, UID,Filename, Successcount, error msg etc).
DB Table References
Table Name | Purpose |
APIKeys | Global DB table which contains all the information of all clients API Keys details |
ImportLogs | Global DB table which contains all information of import of all orgid- |
gorganization | Global DB table for to check assigned db of all orgids |
Extmapping | Global db table to check all the EXT value mapping to CMS values on basis of EXT System |
extskuattribmapping | Global DB table to check all the PIM Attribute mapping information to CMS attributes |