When uploading data to Pepperi via FTP or using the upload option in the Pepperi Web Admin there are 3 files types that exist for various data types: regular, overwrite, and selective overwrite.
This article will explain by example what the result of uploading each file type is.
The table at the end of the article details the file types that each data type supports, including the file naming convention required. Some data types allow for overwrite and selective overwrite, while others overwrite only.
The only difference between these three file types is their file name. The data contained in them follows the same format as the template for the regular file.
- Regular file name
When loading files with their regular file name (example: API_Accounts-Catalogs_2016-04-15_114327_Distributor_12345.csv):
- All new lines will be appended to your Pepperi data
- All lines which already exist in your Pepperi data will be updated with any new values.
- Lines that exist in your Pepperi data and do not exist in the file will remain untouched.
-
Overwrite file name
When loading files with their overwrite file name (example: API_Accounts-Catalogs_Overwrite_2016-04-15_114327_Distributor_12345.csv):
- All new lines will be appended to your Pepperi data
- All lines which already exist in your Pepperi data will be updated.
- Lines that exist in your Pepperi data and do not exist in the file will be hidden.
Essentially, the overwrite process hides all the existing Pepperi data of this type and then loads the overwrite file data.
- Selective overwrite file name
When loading files with their selective overwrite file name (example: API_Accounts-Catalogs_SelectiveOverwrite_2016-04-15_114327_Distributor_12345.csv),
- All new lines will be appended to your Pepperi data.
- Lines which already exist in your Pepperi data will be selectively overwritten - meaning any associations with a certain object (Account, Price, etc) will be updated with the values that exist in the file, while values that are not associated in the selective overwrite file will be hidden.
This is best explained by example.
If existing data in Pepperi is as follows:
AccountExternalID | CatalogExternalID |
xxx | CatA |
xxx | CatB |
xxx | CatC |
xxx | CatD |
yyy | CatA |
yyy | CatB |
yyy | CatC |
You load the following selective overwrite file
API_Accounts-Catalogs_SelectiveOverwrite_2016-04-15_114327_Distributor_12345.csv
AccountExternalID | CatalogExternalID |
xxx | CatA |
xxx | CatB |
xxx | CatD |
In this file, Account xxx's association with CatC is not present, and neither are any of Account yyy's associations.
The resulting data in Pepperi:
AccountExternalID | CatalogExternalID |
xxx | CatA |
xxx | CatB |
xxx | CatD |
yyy | CatA |
yyy | CatB |
yyy | CatC |
xxx's asociation to CatC has been removed from your Pepperi data
yyy's association to CatC has not been modified, because Account yyy was not referenced in the uploaded selective overwrite file.
The following table details which file types are supported by Pepperi data type.
Data types not listed in the table support regular file only (no overwrite or selective overwrite).
For details on all data types, templates and sample files see: Upload data to Pepperi via FTP using csv files.
Data type | Regular | Overwrite | Selective overwrite |
|
API_Account_Distributor_xxxxx.csv | API_Account_Overwrite-Distributor_xxxxx.csv | |
|
API_Accounts-Users_Distributor_xxxx.csv | API_Accounts-Users_Overwrite-Distributor_xxxx.csv | |
|
API_AccountItemStock_2011-03-24_114327_Distributor_xxxx.csv | API_AccountItemStock__Overwrite_2011-03-24_114327_Distributor_xxxx.csv | API_AccountItemStock__SelectiveOverwrite_2011-03-24_114327_Distributor_xxxx.csv |
|
API_Accounts-Catalogs_2013-08-24_114327_Distributor_xxxx.csv | API_Accounts-Catalogs_Overwrite_2013-08-24_114327_Distributor_xxxx.csv | API_Accounts-Catalogs_SelectiveOverwrite_2013-08-24_114327_Distributor_xxxx.csv |
|
API_Accounts-Users_Distributor_xxxx.csv | API_Accounts-Users_Overwrite-Distributor_xxxx.csv | |
API_Activity_<your_activity_name>_2015-02-04_130415_Distributor_xxxxx .csv | API_Activity_<your_activity_name>_Overwrite_Distributor_xxxxx .csv | ||
API_Inventory_2011-03-24_114327_Distributor_xxxx.csv | API_Inventory_Overwrite_2011-03-24_114327_Distributor_xxxx.csv | ||
API_MapData_2011-03-24_114327_Distributor_45.csv | API_MapData_Overwrite_2011-03-24_114327_Distributor_45.csv | API_MapData_SelectiveOverwrite_2011-03-24_114327_Distributor_45.csv | |
API_PriceLevel_2011-03-24_114327_Distributor_xxxx.csv | API_PriceLevel_Overwrite_2011-03-24_114327_Distributor_xxxx.csv | ||
API_PriceLevelItem_2011-03-24_114327_Distributor_xxxx.csv | API_PriceLevelItem_Overwrite_2011-03-24_114327_Distributor_xxxx.csv | API_PriceLevelItem_SelectiveOverwrite_2011-03-24_114327_Distributor_xxxx.csv | |
API_SpecialPriceLevel_2011-03-24_114327_Distributor_xxxx.csv | API_SpecialPriceLevel_Overwrite_2011-03-24_114327_Distributor_xxxx.csv | ||
API_Transaction_<your transaction Name>2015-02-04_130415_Distributor_xxxxx .csv | API_Transaction_<your transaction Name>_Overwrite_2015-02-04_130415_Distributor_xxxxx .csv | ||
API_TransactionLine_<your transaction name>_2015-02-04_130415_Distributor_xxxxx.csv | API_TransactionLine_<your transaction name>_Overwrite_2015-02-04_130415_Distributor_xxxxx.csv |
Please note that the API_TransactionLine_Overwrite file actually overwrites per OrderID. i.e. it’s selective by default, and will not hide lines that are not in the file (from other orderID's). |
0 comments
Please sign in to leave a comment.