redSHOP:Importing and Exporting XML Files

From redWIKI
Jump to: navigation, search

Contents

Purpose of XML section

(shopping comp sites, custom systems)

Types of data available

Products
Orders


How to import (download / "pull" from feed)

XML Import Listing screen

RedSHOP - XML Import Listing.png

Fields:
Display Filename – the name that identifies this XML import profile
Filename – the name of the XML file that contains the content to upload
Section Type – the section in the redSHOP database to where the contents of the XML import file will be uploaded; you can upload data for “products” and “orders”
Autosynchronization - sets whether the contents of the XML file are synced with the records in the database, meaning if the XML file gets updated you can automate the updating of redSHOP’s records
Published – sets whether this XML import profile is active and used to import data; unpublish to disable


Actions:
New - takes you to the XML Import Details screen where you can create a new XML Import profile
Edit - takes you to the edit product screen where you can modify an existing XML Import profile's details. The screen can be reached either by clicking on the profile name or clicking on the checkbox next to the name followed by the edit button
Delete - removes the Import profile record from the database, this is a permanent delete
Publish - lets you set import profiles in batch to be active and used to import data, with either single or multiple profile records selected for publishing
Unpublish - lets you set import products to be disabled and inactive in batch, with either single or multiple profile records selected for unpublishing



XML Import Details screen

Fields:
Display Filename – sets the name that identifies this XML import profile
XML Import file URL – sets the URL of the XML file located remotely which the contents of the import data will come from; http://www.route.to/the.xml for example
XML File – sets the path to the XML file stored locally from where the contents of the import data will come; click on the browse button and select the appropriately formatted XML file to be used

Section Type - (Select: Product, Order)

Product selected:
Product detail Element Name – the name or label for the tag in the XML file that refers to the product ID
Stock detail Element Name – the name or label for the tag in the XML file that refers to the stockroom ID
Extra Field Element Name – (notes soon)

Order selected:
Orderdetail Element Name – the name or label for the tag in the XML file that refers to the order record ID
Billing Element Name - the name or label for the tag in the XML file that refers to the billing address record ID
Shipping Element Name - the name or label for the tag in the XML file that refers to the shipping address record ID
Orderitem Element Name – the name or label for the tag in the XML file that refers to the record IDs for each product ordered



Autosynchronization: - sets whether the contents of the XML file are synced with the records in the database, meaning if the XML file gets updated you can automate the updating of redSHOP’s records (Available options: Yes, No)
Synchronize On Request: – sets whether the contents of the XML will be uploaded / imported when the time interval that has been set has been reached with a “request” to update (Available options: Yes, No)
Synchronize Interval – sets the time interval for each synchronization request and update; the automated update of the database at each time interval depends on whether the above “On Request” setting is enabled (Select: 24hrs, 12hrs, 6hrs)
Published: - sets whether this XML import profile is active and used to import data; unpublish to disable (Available options: Yes, No)
Override existing number if number matches: – when the database already has existing product and order records, each has their own unique record ID; this sets whether a record in the XML file with a matching ID will overwrite the contents of the record that exists in the store database, or ignore records with similar IDs when importing (Available options: Yes, No)
Add prefix for existing – sets the prefix that may have been used within the XML file … (notes soon)
"Read XML File" button – reads the contents of the XML file selected and displays all the fields listed within; the contents will be displayed in the “Import Filename Detail” space below


"XML Import Filename Detail" – this section populates with the fields listed in the XML file that has been selected above and after the “Read XML File” button has been clicked to refresh the listing


Actions:
XML Import – manually start an import of the XML file contents to the database, based on the details stored for the import profile
Save – saves the details of the profile and returns to the XML Import Listing screen
Cancel – returns to the XML Import Listing screen without saving any changes



How to export (upload / "push" from feed)

XML Export Listing screen

RedSHOP - XML Export Listing.png

Fields:
Display Filename – the name that identifies this XML export profile
Filename – the name of the XML file that contains the exported content
Section Type – the section in the redSHOP database from which the contents of the XML export file will be stored; you can export data for “products” and “orders”
Autosynchronization - sets whether the contents of the XML file are synced with the records in the database, meaning if there are updates made to the database you can automate the exporting to and updating of the XML file
XML file use to all users – (notes soon)
Published – sets whether this XML export profile is active and used to export data; unpublish to disable

Actions:
New - takes you to the XML Export Details screen where you can create a new XML Export profile
Edit - takes you to the edit XML Export Details screen where you can modify an existing XML Export profile's details. The screen can be reached either by clicking on the profile name or clicking on the checkbox next to the name followed by the edit button
Delete - removes the export profile record from the database, this is a permanent delete
Publish - lets you set export profiles in batch to be active and used to import data, with either single or multiple profile records selected for publishing
Unpublish - lets you set export products to be disabled and inactive in batch, with either single or multiple profile records selected for unpublishing


XML Export Details screen

"Details"
Display Filename - sets the name that identifies this XML export profile
XML Export Parent Name – (notes soon)
Section Type – sets the section of the redSHOP database from which data records will be exported, either product or order details; the spaces to map the individual XML tag references for each file are listed in the “XML Export Filename Detail” space at the bottom of the page, and will automatically update to list tag mapping options based on the section type (Select: Products, Orders)


Autosynchronization: - sets whether the contents of the XML file are synced with the records in the database, meaning if redSHOP’s records get updated you can automate the updating of the exported XML file (Available options: Yes, No)
Synchronize On Request: – sets whether the XML file will be updated / exported to when the time interval that has been set has been reached with a “request” to update (Available options: Yes, No)
Synchronize Interval – sets the time interval for each synchronization request and update; the automated update of the database at each time interval depends on whether the above “On Request” setting is enabled (Select: 24hrs, 12hrs, 6hrs)
Published: - sets whether this XML import profile is active and used to import data; unpublish to disable (Available options: Yes, No)
XML File - (notes soon)
XML File – the path and link to the XML File that is automatically generated based on the profile details; you can copy and paste this path into the shopping comparison site account that you may be subscribed to


"XML Export Access"
XML file use to all users – (notes) (Available options: Yes, No)
IP or URL to access export file – the IP address or the URL of the account or site is allowed access to the XML export file; you can add and remove multiple addresses, and connect to shopping comparison sites this way


"XML Export Filename Detail"

Section type = Product
’’’’’Filter’’’’’ – sets the categories from where product records should be exported; select one or more holding down the Control key on the keyboard when clicking on the category names
Add Product Detail - click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to specific product details when generating the exported file
Add Product Stock Detail – click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to specific stockroom details when generating the exported file
Product Extra Field Added – (notes soon)

Section type = Orders
Add Order Detail - click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to specific order details when generating the exported file
Add Order User Billing Information - click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to specific billing address details when generating the exported file
Add Order User Shipping Information - click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to shipping address details when generating the exported file
Add Order Item Detail - click on the plus icon to open a lightbox where you can identify and map the XML tags that are used to refer to the details of products in each order when generating the exported file


Actions:
XML Export – manually start an export of the database contents to the XML export file, based on the details stored for the export profile
Save – saves the details of the profile and returns to the XML Export Listing screen
Cancel – returns to the XML Export Listing screen without saving any changes

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox