Originally written by John Hardwick, last updated Nov 14, 2023, on the Swan Retail knowledge base (FRS).
Part of: Product Creator - v1207
The GenerateXML tab converts the data held in the various tabs into an XML load file which can then be used to update / Import into SwanFRS.
Generating the XML
To generate an output file, click the Generate XML button. This will present a series of output formats to choose from.
This button will only operate if there are no alert notices on the Product Group, Range, Options, Option Attributes, Choices, Choice Attributes, Items, Item Attributes and Matrix Tickets tabs or if the catalogue ID is not set within the Catalogue Tab. If one or more of these tabs has an alert, the following message will be displayed and the process aborted.
If there are no alerts, the operator will be allowed to choose the XML contents.
The green notice section highlights if features have been turned off / set that could affect the data held in SwanFRS.
To select, click on the data type required and click the GENERATE XML button (or double-click the choice).
Choose from
|
Ranges, Products, Options and Pricing |
It is essential to load SwanFRS with changes to the range, product, or options before loading any of the other choices. Attempting to load data without first importing the reference data will result in the load file being rejected. It is possible to send price changes only via this export, dependent on the ‘Mode’ setting within the spreadsheet. |
|
Alternative Retailer Codes |
When the ‘’legacy System Code’ is used, this XML should be used. Legacy data is not included in the products and pricing XML output. |
|
Blocked Option Choices |
Use this option to inform SwanFRS there are blocked options in-use. |
|
Default Option Choices |
Use this option to inform SwanFRS there are default options in-use. |
|
Product Sets |
Use this option to inform SwanFRS there are product sets available. |
|
Cancel request. |
Select this option to abort the output process. |
Ranges, Products, Options and Pricing
Selecting this option produces an additional confirmation prompt
The prompt window identifies the active cost and selling price to be used when importing to populate the promotion. (Or will indicate no costs are being included in the XML)
If creating new SKUs, you MUST specify a cost and selling price – the import process will reject the import if these fields are missing from the load file.
For data updates, it is possible to exclude cost and or selling prices.
Including the selling price will also include the MSRP / MRP (Retail price)
These options allow the retailer to decide whether to send prices into SwanFRS.
The macro within the spreadsheet will process, generating a series of rows. Wait for this process to finish before pressing any buttons.
Completing the XML Generation
Once completed, a notification will be presented to the screen.
If the process has discovered a data consistency issue, a warning message like that shown below will be presented.
Once acknowledged, the screen will redisplay, showing the first error generated.
Please note, there may be more errors in the XML
All lines containing an error are highlighted in yellow, the line will detail the problem.
It is not possible to export the XML if it contains an error.
More errors can be located by scrolling down the data or by using the Find & Select option as per the example below.
If the system reports a match, this indicates a data error not the line it relates to and find the corresponding items in the data file and adjust the data.
Re process the data file creation and test again.
Successful generation of data will produce the following message.
Save to File
To save the generated catalogue, click the save to file, Save To File button.
The button will produce a warning and block the output if there is an ‘error’ in the generated XML output. Generation of the XML is prohibited is there is an issue in the XML data set.
A series of prompts guides the operator thought this process.
The process will automatically sense the type of XML generated and suffix the file name with the XML data format. This will be visible in the header of the window.
Clicking allows the operator to select a folder/filename for the contents of the Preview tab to save to.
For Swan hosted companies, it is suggested that the operator uses the Dropbox folder (<company name>\XML) to save the data file – this enables it to be loaded into SwanFRS without having to move the saved XML data file across the network.
Please ask your implementation consultant for details.
If you pick a data filename containing the XML format name, the format name is automatically removed.
When naming your file, avoid using the full stop in the narrative. E.g., Supplier.Range.xml will cause a load issue.
Clicking produces an abort confirmation message.
Entering a filename / selecting a save folder path produces the following confirmation window
Note the type of file is automatically added in brackets to the specified filename.
Once saved, a successful save message is displayed.
The file saved will have a .xml suffix.
Once saved, this file can be used as an import file for the Import Catalogues program with SwanFRS
The type of XML file being saved will be appended to the chosen name immediately before the .xml suffix – this is to make selection easier when importing into SwanFRS. If you choose to overwrite a file with a file type in brackets already in the filename, the process will automatically strip this out and replace it with the file type corresponding to the data set saved.
Save to Clipboard
To save the generated catalogue to your clipboard, click the Copy to Clipboard button.
File Locations
This is an alternative to the save to file, Save To File button.
Once the data in the Preview tab has been refreshed (via the Generate XML button) and has been checked f or errors, the next step is to create the import file.
Ensue, the Correct load path has been defined within Set Up Application Parameters. The CATALOGUE_PATH should be set the folder on your server where XML load files are the processed. Typical paths are listed below.
-
Hosted systems: \\fs-01\importexport\<Retailername>\<Retailername><Live>\XML\
Please ask your implementation consultant for your <Retailername>
-
On Prem system: c:\inetpub\wwwroot\FRS<LIVE>\XML
If using your test system, replace <Live> with TEST
The < > should be omitted and are used to indicate names (words) which will vary on your system.
Open the folder using File Explorer.
Right click in an area of white space, selected New, then Text Document.
This will create a file called New Text Document.txt – select (highlight) this file, right click, and select Rename.
Change the name to <Name>.xml where <Name> is your filename – it is suggested this is the supplier / vendor’s name.
If you do not see the .txt suffix, tick the File Name Extension box in the View Tab. If this does not resolve the problem, please consult your system administrator to have your PC’s settings changed
If you do not see the .txt suffix, tick the File Name Extension box in the View Tab. If this does not resolve the problem, please consult your system administrator to have your PC’s settings changed
Changing the filename and suffix will produce a warning like that shown below – click YES when prompted.
Having changed the filename, right click again, and select Open With, then click Notepad.
Having opened the file with Notepad, return to the Excel® document.
Within the Excel – click on any cell in the Preview Tab, then press and hold the Control Key followed by the A key (all cells should be highlighted). This is the control for selecting All cells.
Then press and hold the Control key and then the C buttons – this is the instruction to copy all cells the clipboard - nothing changes on screen.
Now return to your Notepad window, clicking anywhere in the white space within the window.
Now hold the Control key and press the V button.
This will paste the contents of the Preview tab into the notepad. The contents will be like that shown below.
Finally, Close (and save) the window.
The product load file in now ready for processing within SwanFRS.
Apple / IOS directions
How to get the XML data from the Preview sheet in the product creator spreadsheet in to SwanFRS on a Mac -
-
Open the Mac app called
“TextEdit” (it is a standard OS app, like notepad on Windows) - this app can be found in the “Applications” folder or hit CMD + SPACE on the keyboard and type “TextEdit"
-
Create a
"New Document", then from the top menu go “Format > Make Plain Text”
-
Next copy the XML data from the preview sheet and paste it into the text document.
-
From the Text Edit menu again, click
"File > Save” then name the file and change the file extension from .TXT to .XML and save it.
-
This file can then be copied in to the shared SwanFRS Syncthing folder ready for import.
Importing XML Data into SwanFRS
To Import the file within SwanFRS, use the Import Catalogue routine.
For more details of this routine, please refer to the XML Product Import Guide
Check the bracketed element of the load file name to ensure you’ve chosen the correct ‘upload type’ from the pick list. Mismatched data sets will cause the import to reject the data.
-
When importing products choose the Collections, Products, Options and Prices option.
-
When importing Alternative SKUs, select the Alternative Retailer Codes option
-
When importing sets, choose the Product Sets.
-
When import Blocked items selected Blocked Option Choices.
-
When importing Default options, select Default Option Choices.
I
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article