Originally written by John Hardwick, last updated Oct 24, 2023, on the Swan Retail knowledge base (FRS).
Based on SwanFRS Version 1207
Overview
SwanFRS is designed to show product and stock images to screen and on selected prints. This guide describes how to link images with products and stock items.Configuration
Application Parameters
Menu Location: System Admin > Admin > Set Up Application Parameters
Prior to loading images, it is important to ensure the following settings are correctly defined.
Images obtained dynamically from https sites cannot be displayed on printed documents, such as the sales invoice. It is therefore recommended that images are held locally in the image folder set within the IMAGE_FOLDER_PATH application parameter.
SwanFRS offers the ability to ‘screen scrape’ - i.e. download the https (web image) and hold it locally on the server, this improves response times when displaying thumbnail images and allows prints to show these pictures.
Image Types
SwanFRS offers a choice of settings for the image file dependent, upon how the image name is defined. This is controlled via the CATALOGUE_PICTURES application parameter. Choices are
|
Choices |
Description |
|
Feature 1 |
This option is only of use when linked to the X-Margin product creation program. |
|
Feature 2 |
This option is only of use when linked to the X-Margin product creation program. |
|
Feature 3 |
This option is only of use when linked to the X-Margin product creation program. |
|
ImageURL |
Use this setting when loading data directly into SwanFRS, using the Swan issued Excel spreadsheet or any other third-party product generation program. A URL requires SwanFRS to download the image from the external server whenever the ‘thumbnail’ image is to be displayed. This can slow down the screen rendering time and create a banding effect during the download. SwanFRS offers an image capture whereby web images are saved locally when the catalogue is imported from the XML file. This allows the full URL to be collected in the product creator, with a local image being held within the SwanFRS server. If this feature is required, the CATALOGUE_PICTURES_PATH needs setting by Swan. |
|
None |
Catalogue thumbnails are not in use – omit the column when displaying the catalogue search results. |
It is recommended that this control parameter be set to ImageURL to maximise the possibilities of SKU / Stock Images.
Where using thumbnails, the CATALOGUE_THUMB_SIZE should be defined. This controls the size of the thumbnails when presented in the search grid. It is suggested this is set to 50 and adjusted as necessary.
Increasing the number increase the image size, however this may reduce response times. Lowering the number makes the image smaller but speeds up loading.
Image Folders
The image path is defined via the IMAGE_FOLDER_PATH application parameter.
Local Servers
When running with a local version of SwanFRS the image folder can be located in any folder on the server which is accessible to both SwanFRS and users. It may be necessary to share this folder to ensure full operation.
C:\Inetpub\wwwroot\FRSTest\pictures\
It is important that the path end with a backslash, as the path is appended by the filename to generate a full data path to the image file.
Hosted Servers
When operating on a hosted platform (such as the Swan hosting solution) this image path will be pre-set by your implementation consultant and will be similar to
\\fs-01\importexport\<AccessName>\<AccessNameLive\Pictures\
This will correspond to the folder on your SwanSync share.
Folder structure
It is possible (and recommended) that subfolders are created within this folder.
It is suggested that a folder for each supplier / vendor is created and images for that vendor are stored within this sub folder. If desired, create further sub folders for each range / collection.
It is also suggested that the image filename itself be named either as per the SKU or model number of the item to further assist with image identification.
SwanFRS resizes the image file, therefore there are no restrictions or recommendation, however it is wise to keep image file sizes as small as possible (whilst retaining clarity) as larger file sizes take longer to render on the browser which can slow down response times thus reducing the viewer experience.
Stock Specific Images
If stock specific images are required, the StockImages folder must be created. This folder will contain stock specific images.
It is possible to hold a maximum of 3 stock images per item – each image must be named as indicated below
<Stock ID>-<Image Number>.jpg
For example: 7101-1.jpg, where 7101 is the stock ID and 1 relates to image 1.
Image Numbers > 3 are ignored (only 1,2 or 3 are linked to the stock item).
The image may be held in an alternate format – JPG, PNG, BMP or TIF
The process of linking the stock specific image to the stock item is identified in the operational section of this document.
Operation
Defining the Product Image
Dependent upon the chosen setting, advising SwanFRS where the images are to be held (Application parameters - CATALOGUE_PICTURES). Images are held in the following locations.
|
Choices |
Description |
|
Feature 1, Feature 2 or Feature 3 |
Set in the appropriate field within X-Margin and import into SwanFRS via the Import Catalogue program. |
|
ImageURL |
Set the image path in the load spreadsheet (Image 1 through to Image 20) and import via the Import Catalogue program or set via the Set Up Product Pricing program. This is the Swan recommended setting. |
SwanFRS can hold a single image via the Feature1, 2 or 3 option or several via the ImageURL.
When importing, the process overwrites any previously defined image paths – this will change all histories, i.e. if the image is changed and the operator views an item processed using the old image, they will now see the new image not the old one.
Image filenames may be the full URL, which should link to a freely accessible web image or point to a local image on a share image folder.
URLs pointing to https websites will display within the software, but will NOT display when producing reports.
When viewing the data from within SwanFRS the Set Up Product Pricing program will show the image filename.
Features 1,2 and 3 will display the image filename as shown below in the Image Filename field.
ImageURL displays the image filename(s) in the Default Image and ImageURLx fields. (where x is 1 to 5)
When showing thumbnails and pop-up images, SwanFRS uses the Default Image URL.
Although this screen only shows 5 image URL, it is possible to hold many more images per SKU.
The Default Image URL is used as the thumbnail image when showing data grids.
SwanFRS will show the image URLs 1 to 10 in the scroll window.
Option Answer Images
In addition to product images, it is possible to set up a series of option choice images, for example swatch images. It is only possible to set up a single image per option answer and these images
Product Creator Spreadsheet
Product and option answer images can be set and maintained within the Product Creator Spreadsheet.
This Excel (with macros) replicates the product pricing program allowing a more expedient way of creating and maintaining not only product but also prices.
Catalogue Searching
When using product images, an image thumbnail is displayed (per row) when listing matching SKUs within the Catalogue Search, Insert Catalogue Search and Add Products processes.
The thumbnail image will be the first product or stock image associated to the item.
When viewing SKUs this will always be the product image, when viewing stock, if a stock specific image has been assigned, this will be the first of the three possible images - Stock images are shown in preference to SKUs images, where set.
Clicking the thumbnail displays a maximum of 10 images associated with the SKU.
Where multiple images are displayed pressing the < or > indicators on screen moves to the next or previous image.
When defining the options, and where option answer images are present the pick list will display the option answer thumbnail.
Hovering the cursor over the image thumbnail displays a larger version of the image to screen.
Selecting the option moves the image to its own column, and therefore acts as a reminder to the customer and salesperson of the choice.
Clicking the selected choice image produces a larger image window as shown blow.
Option Choice images only display when defining the product on either the back office or tablet version.
Defining the Stock Image
The process of linking a stock image begins with obtaining the image. Once the digital image is available, save this in the StockImages folder as located within the IMAGE_FOLDER_PATH application parameter.
Image filename must adhere to the <Stock ID>-<Image Number> structure where <Stock ID> is the SwanFRS stock tracking number and <Image Number> is 1,2 or 3
Filename can be jpg, png, bmp or tif
Images can be saved on mass prior to associating them within SwanFRS.
To associate the images, visit the Warehouse > Search Stock program.
Find the stock items to be updated using the search criteria and select them via the checkbox in the first column, or click the A of the A/N column header.
Once selected, click the Refresh Stock Images option on the side panel.
The screen will refresh, however images will not begin to be displayed until the Find button is selected.
Once associated images will be available to be displayed whenever the stock item is visible on the catalogue search, stock search or, if associated with a sales order, when viewing the sales order.
Images can be refreshed at any time.
Once associated, the image name will be visible when viewing the stock detail.
These images can be manually changed, subject to permission, via the AMEND option.
Imperfect Images
Where configured and if used, SwanFRS will show an image assigned to a Imperfect Message on the sales order acknowledgement print.
SwanFRS does not show this image in catalogue searches or when showing the sales order on screen. Imperfect images are only shown when the imperfect message is viewed.
Sales Order Acknowledgement
When using the ‘Banner’ series of external facing documents, if configured, the image thumbnail will display on the acknowledgement.
For more details about this print option and other reports within the Banner series, refer to Process Related Reports
Warehouse Search
When presenting search results, if the item has an image associated with it, the grid will display the a thumbnail of the item for viewing.
SwanFRS will display the image as a window showing the first 10 images assigned to the SKU (3 for stock).
Image window
Clicking a thumbnail image displays the image to screen as shown below
When viewing multiple stock images, the window auto scrolls, or the operator may choose the < or > image to force the display to move to the next image
Files from the Confluence page
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