AML RevH StoreScan Server Software User Manual

StoreScan Server
User Manual

Introduction

StoreScan Server is an easy-to-use, price checking web service software designed for use with AML StoreScan price checking software running on an AML kiosk. When a barcode is scanned on an AML kiosk, StoreScan (client) will make a web request to the StoreScan Server web service to retrieve product and pricing information.
StoreScan Server features include:

• Data Manager application that updates price/product information from data file(s) every 10 minutes. (For more information, see the Data Manager section.)
• Email notifications for failed updates, overdue updates and an update status overview.
• User interface for configuring StoreScan Server, viewing update status and enabling/disabling included local system services.

Choosing a StoreScan Server Version
StoreScan Server comes in two variations. A simple StoreScan Server Self-Host version for less experienced users allows for a quick and easy setup. For more advanced users, StoreScan Server for IIS will work with an existing IIS website.

2.1 StoreScan Server Self-Host
The ‘Self-Host’ version installs everything users need to quickly get up and running with little or no experience.
This version does not support product images or remote updating of the StoreScan (client) slideshow.
2.2 StoreScan Server for IIS
The version for IIS is intended for advanced users. Because this version works with existing IIS web site/applications, users can set up HTTPS on their site/application within IIS. Users can also set up a separate site for hosting product images and remote slideshow updating of StoreScan (client) slideshow.

Data File Setup

After launching StoreScan Server, users will begin by selecting a data file setup type. The data files must be in CSV (Comma Separated Value) format or in a MS SQL database. StoreScan Server has two operational modes: Spreadsheet and SQL Database.

• Spreadsheet mode is for retailers who use .CSV format files to store their pricing information.
• SQL Database mode is for those who have their information hosted on an MS SQL Server serving multiple stores each with their own pricing information and/or promotions.

3.1 Setup Modes for Spreadsheet Type
StoreScan Server has two operational modes: Simple and Multi-Store

• Simple mode is for retailers who have one universal pricing structure for all stores or plan to put a server in every store.
• Multi-Store mode is for those who have one server serving multiple stores each with their own pricing information and/or promotions.
  Once the mode has been determined, the rest is pretty easy. Select a CSV file containing the product information, and set up what product information will be displayed. StoreScan Server will then periodically check the CSV file(s) in the selected directory to see if new data is available and automatically update pricing as needed. (For a detailed breakdown of the update procedure, see section “7.2 Data Manager”)

3.1.1 Simple Setup Example Diagram 3.1.2 Multi-Store Setup Example Diagram
This setup is designed to use one data file with no store or regional specific information.

3.1.3 Simple Begin the Simple setup by selecting a data file (CSV format) from the directory that will act as the data file depository. The directory that the selected file resides in will be the directory that the local system service will check for updates. Next, select ‘Yes’ or ‘No’ if the data file has a header. Then, select ‘Map Data File Columns’.

After the selected data file has been imported into the ‘Data File Preview’, select each column name from the imported data file in the dropdown options that correlates to the ‘Response Object Property’ beside it.
Example: If the column that contains the ‘Price’ data is titled “Price”, select that option from the dropdown menu next to the ‘Actual Price’ property. See red highlights below.

Select the column name beside each property that will be used.
IMPORTANT: Barcode, Name and Actual Price properties are required.
Once ‘Data Files’ setup is completed, proceed to the ‘Web Setup’ section.
3.1.4 Multi-Store
This setup is designed to use multiple data files each containing pricing, promotional or other data that is specific to a store or region. IMPORTANT: Each AML kiosk running StoreScan (client) software must have a ‘Store Number’ assigned in order to use this setup type. Begin the Multi-Store setup by selecting a data file (CSV format) from the directory that will act as the data file depository. This directory will be the location that the local system service will check for updates.
IMPORTANT: All data files in the selected directory must be the same format, structure and file naming convention. Next, select ‘Yes’ or ‘No’ if the data file has a header. Then, select ‘Map Data File Columns’. After the selected data file has been imported into the ‘Data File Preview’, select each column name from the imported data file in the dropdown options that correlates to the ‘Response Object Property’ beside it.
Example: If the column that contains the ‘Price’ data is titled ‘Price’, select that option from the dropdown menu next to the ‘Actual Price’ property. See red highlights below. Select the column name beside each property that will be used. IMPORTANT: Barcode, Name and Actual Price properties are required.
Another setting to determine is whether or not a ‘Store Table Name Prefix’ is required.
If a device’s ‘Store Number’ is set to ‘12’ and the data file is titled ‘AML12.csv’, then the ‘Store Table Name Prefix’ must be set to ‘AML’.
If a device’s ‘Store Number’ is set to ‘AML12’ and the data file is titled ‘AML12.csv’, then a ‘Store Table Name Prefix’ is not needed.

Once ‘Data Files’ setup is completed, proceed to the ‘Web Setup’ section.
3.2 SQL Database Type
This setup is designed to be used when there is already an MS SQL server hosting the database to be queried.

Begin SQL Database Setup by entering your service’s hostname, port, username and password if required.
Once the proper information has been entered, click on the “Connect” button to grab the table information from the database for StoreScan Server to read.

The Database and Table dropdowns will now become available and populate with information if there is any available from the server provided.
Optional: Store ID Column
For multi-store setups, the optional Store ID Column feature can be toggled, which adds an additional column assignment for Store ID in the product lookups. An additional Fallback Store ID field is also available, which will be referenced in the event the lookup does not find a result with the first store ID. Assign all the required columns via the dropdown and click SAVE when finished.

Web Setup

4.1 StoreScan Server Self-Host
This section is for assigning the IP Address and Port Number through which the StoreScan Server Self-Host web service will be accessible.
IMPORTANT: When saving, StoreScan Server will automatically add an inbound firewall rule on a Windows machine to allow connections to the configured port. This only applies to the built-in Windows Firewall. If another firewall is enabled, users must manually add the inbound firewall rule. Then, enter a Port Number in the ‘Enter a Port Number’ field. The default value is ‘8080’. The valid Port Number range is 1025-65535. Use the ‘Check Usage’ button beside the ‘Port Number’ field to ensure the Port Number is available for use. Once the IP Address/ Hostname and a Port Number are entered, click on the ‘Web Request URL’ preview to copy the URL for use in the StoreScan Kiosk Configurator application.

4.2 StoreScan Server for IIS
Prior to this, users must set up a web application in IIS. Start this setup by selecting an existing IIS website from the list of web applications in the dropdown list titled, ‘Select the Web Application’.
IMPORTANT: An inbound firewall rule to allow connections to the configured port may be required.

ADVANCED
After selecting the desired web application, information about the application will appear below the dropdown field. Users must select ‘Update Web Service Files’ in order to copy the web service files to the selected web application’s physical path. Users can also click the ‘Web Request URL’ preview to copy the URL for use in the ‘Web Request URL’ field under the ‘Price Check’ section of the StoreScan Kiosk Configurator application. However, websites in IIS can be bound to multiple IP Addresses and Ports. Therefore, the ‘Web Request URL’ preview contains placeholders for the IP/Hostname and Port. The website’s ‘Status’ is also displayed.

Mail Setup (optional)

This section is for configuring settings to forward email notifications for update failures, overdue updates and an update status overview. In order for any of the notifications to be sent, the SMTP Host, SMTP Port, SMTP Username, SMTP Password, From Address and To Address must all be set. The ‘SMTP Socket Security’ setting will depend on the SMTP server’s connection settings. For more details about each setting in the dropdown list, select the ‘Help’ icon beside this field. To test the current SMTP settings, users can select the ‘Send Test Email’ button. A popup will appear describing if the test email was successful or if it failed and why the test email may have failed.

Admin Setup

This section is for setting the data file ‘Update Overdue Interval’ and enabling/disabling email notifications.
The ‘Data File Update – Overdue Interval’ represents the length of time, in days, that a data file can go without an update before being flagged as ‘Overdue’. Users can disable this functionality by selecting ‘Never’ from the dropdown menu options. The default value is ’NEVER’.
Enable/Disable “Real-Time Notifications” for Failed and Overdue data file updates. An ‘Update Failed’ notification will be sent when a data file update was attempted but failed. An ‘Update Overdue’ notification will be sent when a data file has not been updated in the time span set in the ‘Data File Update – Overdue Interval’ field. The name and last update time of the failed or overdue update will be displayed in the email. To enable the ‘Update Status Overview’ email under “Scheduled Notifications”, select the day(s) and set a time of day, in 24-hour format, that the ‘Update Status Overview’ email will be sent. Example ‘Update Overdue’ Email Example ‘Update Status Overview’ Email

Appendix

7.1 Example JSON Web Response Object
The JSON object shown below is an example of a web response that StoreScan Server will return.
Example JSON Web Response:
{
“Barcode”:”026388010011″,
“Name”:”Tennis Balls”,
“DetailedDescription”:”Head to the court with these Championship Tennis Balls. They are
designed for excellent performance on both indoor and clay courts. Constructed from Dura-weave felt, they are extremely durable and made to endure even the most rigorous games. Included are three tennis balls.\r\n\r\nChampionship Extra Duty Tennis Balls – 1 Can of 3 Balls:\r\n –
The traditional performance standard\r\n – Exclusive Dura-weave felt\r\n – Excellent performance and durability on clay/indoor courts\r\n – Tennis balls are available in regular duty, heavy duty and high altitude\r\n – Includes 3 balls”,
“ActualPrice”:”4.39″,
“ActualPriceQuantity”:”2″,
“RetailPrice”:”6.99″,
“RetailPriceQuantity”:”2″,
“ProductImageUrl”:”https://www.amltd.com/images/tennis_balls.png“,
“PromoDescription”:null
}
7.2 Data Manager (Local System Service)
7.2.1 How it Works
The ‘Data Manager’ is an application running as a local system service. It handles the updating of data file(s) and sending email notifications, if configured. The process shown below will run every 10 minutes.

End User License Agreement

The copy of the StoreScan Kiosk Configurator, StoreScan Server, StoreScan and accompanying files (“the Software Product”), are licensed and not sold. The Software Product is protected by copyright laws and treaties, as well as laws and treaties related to other forms of intellectual property. American Microsystems Ltd. or its subsidiaries, affiliates, and suppliers (collectively “AML”) own intellectual property rights in the Software Product. The Licensee’s (“you” or “your”) license to use, copy, or change the Software Product is subject to these rights and to all the terms and conditions of this End User License Agreement (“Agreement”).
Acceptance
YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT BY SELECTING THE “I AGREE” OPTION AND INSTALLING, USING, OR COPYING THE SOFTWARE PRODUCT. YOU MUST AGREE TO ALL OF THE TERMS OF THIS AGREEMENT BEFORE YOU WILL BE ALLOWED TO INSTALL THE SOFTWARE PRODUCT. IF YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT,  YOU MUST NOT INSTALL, USE, OR COPY THE SOFTWARE PRODUCT.
License Grant
This Agreement entitles you to install and use the Software Product for AML devices only. Without first obtaining the express written consent of AML, this Agreement does not permit the installation or use of the Software Product for any other device not made by AML.
Restrictions on Transfer
Without first obtaining the express written consent of AML, you may not assign your rights and obligations under this Agreement, or redistribute, encumber, sell, rent, lease, sublicense, or otherwise transfer your rightsto the Software Product.
Restrictions on Use
You may not decompile, “reverse-engineer”, disassemble, or otherwise attempt to derive the source code for the Software Product.
Restrictions on Alteration
You may not modify the Software Product or create any derivative work of the Software Product or its accompanying documentation. Derivative works include but are not limited to translations. You may not alter any files or libraries in any portion of the Software Product.
Disclaimer of Warranties and Limitation of Liability
UNLESS OTHERWISE EXPLICITLY AGREED TO IN WRITING BY AML, AML MAKES NO OTHER WARRANTIES, EXPRESS OR IMPLIED, IN FACT OR IN LAW, INCLUDING, BUT NOT LIMITED TO, ANYIMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OTHER THAN AS SET FORTH IN THIS AGREEMENT.
AML makes no warranty that the Software Product will meet your requirements or operate under your specific conditions of use. AML makes no warranty that operation of the Software Product will be secure, error free, or free from interruption. YOU MUST DETERMINE WHETHER THE SOFTWARE PRODUCT SUFFICIENTLY MEETS YOUR REQUIREMENTS FOR SECURITY AND UNINTERRUPTABILITY. YOU BEAR SOLE RESPONSIBILITY AND ALL LIABILITY FOR ANY LOSS INCURRED DUE TO FAILURE OF THE SOFTWARE PRODUCT TO MEET YOUR REQUIREMENTS. AML WILL NOT, UNDER ANY CIRCUMSTANCES, BE RESPONSIBLE OR LIABLE FOR THE LOSS OF DATA ON ANY COMPUTER OR INFORMATION STORAGE DEVICE.
UNDER NO CIRCUMSTANCES SHALL AML, ITS DIRECTORS, OFFICERS, EMPLOYEES OR AGENTS BE LIABLE TO YOU OR ANY OTHER PARTY FOR INDIRECT, CONSEQUENTIAL, SPECIAL, INCIDENTAL, PUNITIVE, OR EXEMPLARY DAMAGES OF ANY KIND (INCLUDING LOST REVENUES OR PROFITS OR LOSS OF BUSINESS) RESULTING FROM THIS AGREEMENT, OR FROM THE FURNISHING, PERFORMANCE, INSTALLATION, OR USE OF THE SOFTWARE PRODUCT, WHETHER DUE TO A BREACH OF CONTRACT, BREACH OF WARRANTY, OR THE NEGLIGENCE OF AML OR ANY OTHER PARTY, EVEN IF AML IS ADVISED BEFOREHAND OF THE POSSIBILITY OF SUCH DAMAGES. TO THE EXTENT THAT THE APPLICABLE JURISDICTION LIMITS AML’S ABILITY TO DISCLAIM ANY IMPLIED WARRANTIES, THIS DISCLAIMER SHALL BE EFFECTIVE TO THE MAXIMUM EXTENT PERMITTED.
Limitation of Remedies and Damages
Your remedy for a breach of this Agreement or of any warranty included in this Agreement is the removal of the Software Product. You agree to indemnify and hold AML harmless from all claims, judgments, liabilities, expenses, or costs arising from your breach of this Agreement and/or acts or omissions.
Severability
If any provision of this Agreement shall be held to be invalid or unenforceable, the remainder of this Agreement shall remain in full force and effect. To the extent any express or implied restrictions are not permitted by applicable laws, these express or implied restrictions shall remain in force and effect to the maximum extent permitted by such applicable laws.
©AML 2023. All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from AML.

AML
7361 Airport Freeway
Richland Hills, TX 76118
800.648.4452
www.amltd.com

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>