| submitted | available | document details (if available) | source link |
|---|---|---|---|
| September 08 2019 | September 08 2019 | My Document rit madbuild |
| various | User manual | Users Manual | 3.09 MiB | September 08 2019 |
Core Service Quick Start Guide Last change: 27.06.2019 Core Service Quick Start Guide 1 Electronic Shelf Labeling A brief introduction 2 Label Family Introduction 2.1 General Key Features 2.2 The G1 label family 2.3 The VUSION label family 3 Get the latest software and documentation 3.1 Install software 3.2 System requirements 3.3 Installation process 3.4 SES-imagotag Customer and Partner Portal 4 Core Appliance 4.1 Why is it needed in the Store?
4.2 Key Features 5 Core Appliance initial setup 5.1 USB device configuration 5.2 Front side LEDdescription 5.3 Additional documentation 6 Start SES-imagotag Core Service and SES-imagotag Control Center 6.1 Starting SES-imagotag Core Service 6.1.1Example articles 6.2 Starting SES-imagotag Control Center 6.2.1SES-imagotag Control Center Login 6.3 Activating your license 7 ESL Access Point Configuration 7.1 Connect and configure AP-2010 7.1.1Connect and configure 7.1.2Discover the Access Point 7.1.3Necessary configuration on the AP-2010 web UI 7.1.4The Status LED 7.2 Adding AP-2010 to ESL system 7.2.1SES-imagotag Core Service 8 Selecting channels 9 Setup Security 9.1 General encryption features and how does it work 9.2 Set the encryption key 10 Register labels 10.1General procedure 10.2What's on the label?
10.2.1Registration page vs. Reset page 10.3Handheld terminals, USB barcode scanner and SES-imagotag Core Service iOS-App 10.4Encryption status 10.5Unlocking labels 11 Start tagging 11.1What can I do now?
4 5 5 5 6 7 7 7 7 8 9 9 9 10 10 11 11 12 12 12 13 13 14 16 16 16 16 17 18 19 19 21 22 22 22 23 23 23 24 25 25 26 27 27 Page 2 of 42 Core Service Quick Start Guide 11.2Sending pictures to labels 11.3Article management 11.4Matchings/Multi-Facing 11.5Set (extended) filters for enums 11.5.1Extended filter operators 12 Templates 12.1General information about templates 12.2SES-imagotag Template Editor 12.2.1Starting SES-imagotag Template Editor 12.2.2Open default template file and load records from server:
12.2.3Design Mode 12.2.4Enable and show color red 12.2.5Help Content 13 Integration 13.1Webservice integration 13.2Plugins 13.3Custom integration 14 Troubleshooting 14.1SES-imagotag Core Service Dashboard 14.2Running the SES-imagotag Core Service as a background service 14.3Where can get a demo/development license key?
14.4Deleting the demo articles 14.5Establish a network configuration when no DHCP is available Step by step 14.6Access point discovering with Bonjour Services 14.7What can I do if the Status LED of the AP-2010 access point doesnt turn blue?
14.8Labels dont come online 14.9The encryption does not work 14.10Unlocking labels 14.11Starting Java applications 14.12Encoding problems 14.13Reserve RAM for Java heap space 14.14Further documentation 15 Declaration 27 27 28 29 29 31 31 31 31 32 33 34 34 35 35 35 35 36 36 37 37 37 38 38 38 39 39 39 39 40 40 41 42 Page 3 of 42 Core Service Quick Start Guide 1 Electronic Shelf Labeling A brief introduction An electronic shelf label is a device that shows article data and price information on its display. In comparison to printed labels the information is automatically updated if price or article data changes. l Cost reduction through elim-
ination of manual price changes l Fully automatic price updates from the headquarters to the branch stores within seconds l Process security and price integrity 100% correlation between cash point and shelf l Increased flexibility in price design and immediate reaction to market situation Image gain due to use of highly modern technology l Simplified processes for store personnel l Enhanced sales & price prof-
itability maximize price per-
formance and profit opportunities Page 4 of 42 Core Service Quick Start Guide 2 Label Family Introduction The SES-imagotag electronic shelf label family offers high-quality display options, operating with a replaceable battery, thus working without any external power supply. The performance of the labels (updates per hour) depends on the mode of the access point. In the USA and Canada the AP-2010 usa/canada bundle incl. antenna with limited data efficiency is required (based on the FCC/ICregulation). 2.1 General Key Features l 2.4 GHz proprietary radio protocol l Radio coverage: up to 25 meters l Bi-directional communication l 11 available communication channels l Ultra-low power consumption l Customer-replaceable battery l Full graphical e-Ink display with paper-like readability l Different configurations available (theft protection, display protection, LED flash) l Label versions for deep-freezing environments l Super wide viewing angle (nearly 180 degrees) l Flexible mounting options available l May be used in landscape and portrait mode l Fast response time (less than 15/30 seconds, depends on wakeup time) l 128-bit AES encryption with secure key exchange l Multiple pages support with preloading and fast page switching l Integrated NFC l G1 - Passive NFC l VUSION - "Active" NFC 2.2 The G1 label family The SES-imagotag G1 BWR label family is capable of changing all pixels to black, white or red. The current line-up has display sizes from 1.6 inch to 12.2 inch. Caption Display Res-
olution Density
(dpi) Display Colors Useable Pages Active Dis-
play Area
(mm) Updates/hour/AP FCC&IC mode)
(standard /
time: 5 Battery life-
years with N updates per day 7500/4600 8500/5000 4500/2600 5000/2700 G1 1.6 BWR NFC 1 G1 2.2 BWR NFC 2 G1 2.6 BWR NFC 2 G1 2.7 BW NFC 4 G1 2.7 BWR NFC 2 G1 4.2 BW NFC 4 G1 4.2 BWR NFC 2 G1 4.5 BWR NFC 2 G1 6.0 BWR NFC 2 G1 7.4 BW NFC 8 G1 7.4 BWR NFC 2
*One useable page is shared with the registration code page. This page is initially shown when the label is shipped. After registration this page can be used as a custom page. To restore the original 27.5 x 27.5 48.6 x 23.8 60.1 x 30.7 57.3 x 38.2 57.3 x 38.2 84.8 x 63.6 84.8 x 63.6 104.2 x 38.2 114.9 x 85.8 97 x 161.6 97 x 161.6 152 x 152 212 x 104 296 x 152 264 x 176 264 x 176 400 x 300 400 x 300 480 x 176 600 x 448 480 x 800 480 x 800 3000/1600 2000/1300 2500/1500 900/500 1000/500 600/300 b/w/r b/w/r b/w/r b/w b/w/r b/w b/w/r b/w/r b/w/r b/w b/w/r 140 111 125 117 117 120 120 117 129 126 126 4*
4*
4*
8*
4*
4*
4*
4*
4*
12*
4*
4500 Page 5 of 42 Core Service Quick Start Guide content a service utility is required. To prevent accidentials overwrite this page is protected. To unlock this page contact the SES-imagotag support team. The content of all pages except page number 0 won't remain after a firmware update. 2.3 The VUSION label family The SES-imagotag VUSION (2.4GHz) electronic shelf label family is capable of changing all pixels to black, white or red. The current line-up has display sizes from 1.6 inch to 12.2 inch. They may be used in landscape and portrait mode and can be configured in terms of radio, theft protection, display protection and LED flash. Caption Model Display Res-
olution Density
(dpi) Display Colors Useable Pages Active Display Area (mm) Updates/hour/AP FCC&IC mode)
(standard /
Battery lifetime: 5 years with N updates per day VUSION 1.6 VUSION 2.2 VUSION 2.2 F VUSION 2.6 VUSION 2.6 F VUSION 2.7 VUSION 3.7 VUSION 4.2 VUSION 4.5 VUSION 5.9 VUSION 7.4 VUSION 9.7 VUSION 12.2
* Battery lifetime: 3 years with N updates per day EDG2-0160-A EDG2-0220-A EDG2-0220-A EDG2-0260-A EDG2-0260-A EDG2-0270-A EDG2-0370-A EDG2-0420-A EDG2-0450-A EDG2-0590-A EDG2-0740-A EDG2-0970-A EDG2-1220-A 152 x 152 212 x 104 212 x 104 296 x 152 296 x 152 264 176 416 x 240 400 x 300 480 x 176 720 x 256 480 x 800 960 x 672 768 x 960 140 111 111 125 125 117 130 120 117 134 126 121 103 b/w/r b/w/r b/w b/w/r b/w b/w/r b/w/r b/w/r b/w/r b/w/r b/w/r b/w/r b/w/r 4 4 4 4 4 4 4 4 4 4 4 4 6 27.5 x 27.5 48.6 x 23.8 48.6 x 23.8 60.1 x 30.7 60.1 x 30.7 57.3 x 38.2 81.54 x 47.04 84.8 x 63.6 104.2 x 38.2 138.96 x 49.40 97 x 161.6 201.60 x 141.12 190.08 x 237.6 7500/4600 8500/5000 10000/6500 4500/2600 6500/4500 4500/2600 2000/1300 2000/1300 2500/1500 1100/550 600/300 300/150 300/150 1 2 1*
2 1*
2 2 2 2 2 2 2 1 The content of all pages except page number 0 won't remain after a firmware update. Page 6 of 42 Core Service Quick Start Guide 3 3.1 Get the latest software and documentation Register at the SES-imagotag Customer and Partner Portal to get access to the latest software and documentation. https://portal.imagotag.com Install software Theres several software youll have to install in order to configure and setup your ESL system. Youll just have to extract the following 3 archives in a location of your choice:
1. SES-imagotag Core Service <server.zip>
2. SES-imagotag Control Center <client.zip>
3. SES-imagotag Template Editor <template.zip>
3.2 System requirements l Server hardware: Pentium 4 (2 GHz or higher), 2 GB RAM l Java Runtime Environment Version 6, Update 36 or higher l Windows 7, Windows 10, Windows Server 2008 (R2), Windows Server 2012, Windows Server 2016, Suse Enterprise Linux 11, Ubuntu 12 (all 32/64-bit versions), Mac OS X l SES-imagotag Core Service l SES-imagotag Access Point(s) l SES-imagotag Label(s) l License key 3.3 Installation process Please unpack the zip-archives <server.zip>, <client.zip> and <template.zip> on your machine - e.g. under C:\ses-imagotag-core-service\. Note: To unpack the zip-files you can either use the windows internal archive-unpacker (see screenshots) or an unpack tool of your choice (e.g. the free tool 7zip www.7zip.org). FIGURE 1-1:
FIGURE 1-2: Unpack/Install imagotag Software #1 After unpacking all 3 archives, your folder should look something like this:
Page 7 of 42 Core Service Quick Start Guide FIGURE 1-3: Unpacked imagotag software folder The SES-imagotag Core Service is now installed and you can step forward to point see Start SES-
imagotag Core Service and SES-imagotag Control Center on page 12. 3.4 SES-imagotag Customer and Partner Portal After user registration and activation you will have access to documentation. You can activate, manage and download your SES-imagotag software licenses see Start SES-
imagotag Core Service and SES-imagotag Control Center on page 12. Your user account will not be assigned to a customer account yet. Ask our sales backoffice team for user assignment (sales.at@ses-imagotag.com). Page 8 of 42 Core Service Quick Start Guide 4 Core Appliance The Core Appliance is a compact network device which can be used to run the SES-imagotag Core Service in the store, instead of using an additional dedicated server. The SES-imagotag Core Service is always needed in the store locally, also when cloud-based/centralized middleware systems like Jeegy S3 Centralized/Jeegy Cloud or Bison ESL Manager is used. 4.1 Why is it needed in the Store?
l Continuous communication with access points and labels is required (even without tasks) l Limited bandwidth between store and headquarters l Disconnected VPN connection will prevent proper operation l Load (image rendering) is distributed to stores 4.2 Key Features l Core Appliance is optimized to run up to 30 000 labels and 7 access points l Easier and faster shop installations (Plug and Play) l Is not recognized as an additional server l Low maintenance l Easy replace/restore when hardware crashes l Limited deployment variabilities l Lower development costs l Lower support costs l Better brand recognition l Easier to sell as a solution in a box l Less overall risk for system integrators Page 9 of 42 Core Service Quick Start Guide 5 Core Appliance initial setup To operate the Core Appliance there are only a few steps necessary:
1. Supply with power 2. Turn it on (button on the backside of the device) 3. Plug it into your network 4. 5. Update to the latest version Initial setup Per default, the Core Appliance comes with DHCPenabled. So if you have a DHCPservice running you can find it with the MAC address which is printed on the bottom side of the Core Appliance. If there's no way to get access to the DHCPserver we recommend to use an USBdevice with a configuration file to configure the appliance initially. FIGURE 1-4: Core Appliance rear view 5.1 USB device configuration You can find an example configuration file (example.config) at ourSES-imagotag Customer and Partner Portal. Core Appliance service reference mode | Core Appliance example.config file After downloading, editing and copying the configuration file onto any USBdevice, the configuration is automatically adopted after plugging in the USB flash drive into the Core Appliance. A triple beep indicates the successful configuration. A single beep signals that the configuration hasn't been set successful. Theweb user interface of the Core Appliance is now available under http://<ip-address>. The initial configuration of the Core Appliance can be compared with the installation and start of an SES-imagotag Core Service. After configuration, you can access the Core Appliance via the SES-
imagotag Control Center from every system connected to your network (see Start SES-imagotag Core Service and SES-imagotag Control Center on page 12). Example.config file To set up your Core Appliance for the first run you'll have to set at least the following network parameters:
l IPaddress l Subnet mask l Optional: Gateway, DNS To set the parameters mentioned above the contents of the configuration file might look like this:
# Set IP address of bridge interface set network br0 192.168.1.100 255.255.255.0
# Set a gateway set gateway 192.168.1.1 Page 10 of 42 Core Service Quick Start Guide
# Set a nameserver set dns 192.168.1.21 Note:This simple bridge configuration connects the network interfaces. No matter where the network cable is plugged in, the appliance is accessible via the configured bridge address. 5.2 Front side LEDdescription On the front side of the appliance you can see several status information:
Core Appliance front view LEDstatus information (Core Appliance version 1.8.0 or higher) Upper LED:Power on Lower LED: Core Appliance is active Upper LED: OFF=service not running | Flashing=restart or software update in progress | ON=service Lower LED: OFF=no internet connection | Slow flashing=no VPN configuration | Fast flashing=VPN not connected | ON=VPN connected running Upper LED: Port in use (color based on transfer rate) Lower LED: Port/Device is active 5.3 Additional documentation You can find additional documentation regarding the Core Appliance (e.g. a complete service mode reference) on our SES-imagotag Customer and Partner Portal. Page 11 of 42 Core Service Quick Start Guide 6 Start SES-imagotag Core Service and SES-imagotag Control Center 6.1 Starting SES-imagotag Core Service If you've recently configured yourCore Appliance the SES-imagotag Core Service software is already running and you can step forward to the next step. In order to start the SES-imagotag Core Service with the default configuration, just execute the jar file server.jar as described in Troubleshooting and wait for the small service GUI to show up (if the window doesnt show up after all, make sure your Java installation and configuration is correct). FIGURE 1-5: Core Service web UI The SES-imagotag Core Service will listen to TCP connections on Port 8000 and 8001 and UDP connections on Port 8000. Please make sure that there is no firewall issue and/or interference with other systems. After start of the SES-imagotag Core Service you can check the web user interface:
URL: http://<host|ip>:8000 Login: admin/admin During the first start the SES-imagotag Core Service will automatically create a Derby1 database. If another database connection is needed or preferred, the connection parameters should be validated by SES-imagotag GmbH. Note: As you can see there are several level numbers. You can find the description of the different levels in the Developer Reference (which is also part of the documentation available at the SES-
imagotag Customer and Partner Portal) under Integration Levels. 6.1.1 Example articles For easier usage some example articles can be preloaded at the time you start the SES-imagotag Core Service. You can find the corresponding XMLarticle data here: C:\ses-imagotag-core-
service\server\data\fixtures\. To enable and disable the preloading of these fixtures go to the system configuration and set the corresponding property "importFixtures"true or false. Note: The article records are based on the XML-standard. 1Apache Derby, an Apache DB subproject, is an open source relational database implemented entirely in Java Page 12 of 42 Core Service Quick Start Guide 6.2 Starting SES-imagotag Control Center Go to the extracted directory and execute the client.jar file. FIGURE 1-6: Starting SES-imagotag Control Center The SES-imagotag Control Centeris configured to connect to a server on the local machine per default. In order to change this to a remote machine in a network you have to start the SES-imagotag Control Center with an additional parameter:
Windows l Create a shortcut/Edit existing short cut l Right click to the shortcut and select "Properties"
l Append --host hostnameOrIPAddress at the end of the Target field. (Note: The text to append starts with an space and there are 2 hyphens to add!) Linux l Append --host hostnameOrIPAddress at the end of command (e.g. java -jar client.jar --host 192.168.1.100 Note: The text to append starts with an space and there are 2 hyphens to add!) FIGURE 1-7: Starting SES-imagotag Control Center with parameter 6.2.1 SES-imagotag Control Center Login l Username: admin l Password: admin Page 13 of 42 Core Service Quick Start Guide FIGURE 1-8: SES-imagotag Control Center Login 6.3 Activating your license After starting the SES-imagotag Core Service and SES-imagotag Control Center it's necessary to activate the license key which is included in the "Software License Document". To view your current license status there's a License status dialog. You can find it in the SES-imagotag Control Center under "Help - License status". Since no license is activated/imported yet the window should look similar to this:
FIGURE 1-9: License Status Dialog Copy the "System serial" to the clipboard (STRG+Cor right click "Copy to clipboard")and then click the "License activation". You'll be automatically redirected to the SES-imagotag Customer and Partner Portal https://portal.imagotag.com. Please log in (or register a new user). After log in, you can see a summary of already activated licenses and/or activate a new license. Click "activate new license". Fill in "License key", copy/paste the "System serial"(from the "License Status"dialog), add a Comment (optional) and click the "Activate"button. Page 14 of 42 Core Service Quick Start Guide FIGURE 1-10: Activate License (SES-imagotag Customer and Partner Portal) Download the generated license file and complete the licensing process by importing the license file to your ESLsystem. With the successful activation of your license you're now able to register labels and add ESL access points. FIGURE 1-11: Import of license file downloaded before Note: Press "F5"(after 15 seconds) to update the license status after license file import. Page 15 of 42 Core Service Quick Start Guide 7 ESL Access Point Configuration The ESL access points are the communication center in the store that transmits information to the labels. In order to ensure the communication between SES-imagotag Core Service, ESL access point(s) and the labels the access points have to be configured at the start of the SES-imagotag Core Service. In the Core Service Quick Start Guide you will find the procedure to connect and configure the SES-
imagotag AP-2010. For other ESL access point(s) and SES-imagotag Retail IoT Connectors, please find on the SES-imagotag Customer and Partner Portal the corresponding Configuration Guide. 7.1 Connect and configure AP-2010 7.1.1 Connect and configure Before labels are able to communication with the SES-imagotag Core Service at least one ESL access point needs to be configured. In standard configuration the AP-2010 gets an IP-address via DHCP (recommended) and is accessible via imagotag AP-2010 web UI:
URL: http://<host|ip>:8080 Login: admin/admin 7.1.2 Discover the Access Point Before you can configure the AP-2010 access point its necessary that it will be discovered. The following points have to be observed:
l Connect your machine to the same network as the AP l Plug in the power supply of the access point l During the boot process of the access point, start the SES-imagotag Core Service software on l When the access point is up (LEDturns orange), the SES-imagotag Core Service will discover it with an IP address (Note: The discovering process may take up to 2 minutes) l Use the SES-imagotag Control Center to connect to your SES-imagotag Core Service l Under System Access Point Status the AP should be listed as discovered (after successful the computer boot sequence) Page 16 of 42 Core Service Quick Start Guide FIGURE 1-12: List of discovered ESL access points Now youre able to configure the AP-2010 access point via AP-2010 web UI under http://<DHCP-IP-
address> or a right click on the discovered AP > Open in browser.... In the status overview you get some details about the AP-2010:
FIGURE 1-13: AP-2010 Status overview Its recommended for the demo installation not to use the Centralized Configuration feature and configure the AP manually. 7.1.3 Necessary configuration on the AP-2010 web UI The following actions need to be performed over the AP-2010 web UI Page 17 of 42 Core Service Quick Start Guide 1. Deactivate Centralized Configuration: Administration -> Configuration Mode 2. Set up network details (or keep DHCP mode): Administration -> Network 3. Set up an ESLchannel: Administration -> Wireless Channel The AP-2010 supports 11 ESL channels. Its recommended to choose one of the recommended channels: 3, 5, 8, 9 or 10. These channels do not interfere with standard Wi-Fi channels 1, 6, 11 and are scanned by the labels more often. 7.1.4 The Status LED There are several LED colors that indicates the status of the AP-2010. Page 18 of 42 Core Service Quick Start Guide Color Red Blue Description Boot process Operation mode Orange Ready for operation Note Can take up to 5 minutes, if it takes much longer, the device is defective and there is a need for service. AP-2010 is configured in any Core Service, has an ESL channel set and the has successfully received the roaming table from the Core Service Operational, but not connected to any ESL system, no ESL channel is set, a service on the AP-2010 failed to start, AP-2010 has not received the roaming table yet Red (blinking) Running Firmware Update During this time there is no connection to the electronic label 7.2 Adding AP-2010 to ESL system 7.2.1 SES-imagotag Core Service After the configuration in the AP-2010 web UI its necessary to add the AP-2010 via the SES-
imagotag Control Center: System Access Point Configuration New or right click on a discovered ESLaccess point - Create configuration. After saving the AP configuration you should see the AP under System Access Point Status as ONLINE. In addition the AP status LED should turn BLUE. FIGURE 1-14: SES-imagotag Control Center System - Access Point Status - Create configuration If the ESL access point is not discovered or if there is no DHCP server available you have to add the AP-2010 manually. When creating a new access point configuration under System - Access Point Configuratio, select Manual Configuration (if you dont use Centralized Configuration) and enter Access Point ID (AP ID), IP address and port (Host). Page 19 of 42 Core Service Quick Start Guide FIGURE 1-15: SES-imagotag Control Center System - Access Point Configuration - Create configuration Note: It is possible to configure the access point via host name. To get this working there has to be a corresponding entry in the DNS sever. Page 20 of 42 Core Service Quick Start Guide 8 Selecting channels For a working installation an ESL channel must be selected on each ESL access point in the network. There are 11 non overlapping ESL channels reserved for the communication with the labels. Five of these ESL channels do not interfere with typical Wi-Fi installations and should therefore be favored. These are the ESL channels 3, 5, 8, 9 and 10 and they should be selected if there is a Wi-Fi installation on the Wi-Fi channels 1, 6 and 11. FIGURE 1-16: Comparison between common used Wi-Fi and ESLchannels If there is a Wi-Fi installation operating at 2.4 GHz (IEEE 802.11 b/g/n) or any other radio frequency
(RF) technology that uses the 2.4 GHz ISM band make sure to select the ESL channels that are least overlapping with the existing installation. If there is no ESL channel without any overlapping both the ESL and existing installation should still work but there might be a reduced overall speed in both installations. Warning: Do not select the same ESL channel on two access points within one area. This will cause interferences and avoids labels from joining the network or being updated. The same ESL channel may only be selected on two access points if it can be guaranteed that every label is within the range of only one of these access points. Page 21 of 42 Core Service Quick Start Guide 9 Setup Security The security concept is based on individual registration codes for each label. Not only that the new concept simplifies installations, it also provides stronger encryption and a secure key exchange with individual communication key derived from a user defined network key. 9.1 General encryption features and how does it work l Solid improved safety l Encrypted data type AES128 (Advanced Encryption Standard) l User defined 128 bit network key for each installation l Key is distributed to labels automatically The system requires a user defined 128 bit network key for each installation. The key is derived from a passphrase that is defined by the customer and stored in the SES-imagotag Core Service and used by all ESL access points connected to that SES-imagotag Core Service to encrypt data communication to the labels. A per-label communication key is transmitted to the labels during the registration of them. Each label is assigned an individual registration code (it combines label ID and PIN code and its an alphanumeric case-sensitive code with 11 characters). The SES-imagotag Core Service will than automatically start the key exchange with the label secured by the PIN extracted from the registration code. 9.2 Set the encryption key First step is to set the parameter encryptionPassphraseunder System Configuration (you can choose the encryption passphrase on your own). FIGURE 1-17: Set encryption key Note: Do not change encryption passphrase if labels are already connected and encrypted (if you want to change the encryption passphrase youll first have to unlock all labels see Troubleshooting on page 36). Page 22 of 42 Core Service Quick Start Guide 10 Register labels In order that labels can join the network it is necessary to register them first. 10.1 General procedure Via the SES-imagotag Control Center under File Register Labels its possible to register your labels manually with the registration code shown on each single label or you could import a CSV file with your registration codes. Important Note: After the registration it could last a certain time until all registered labels are joined to the network (from 30 minutes up to two hours, depending on configured ESL channels). After this you can send images to each label (see Start tagging on page 27). FIGURE 1-18: Add/Delete Label and refresh entries 10.2 What's on the label?
All labels will arrive with its registration code (11-digit alphanumeric)shown on the display of the label. The code is printed as a 2D QR code, as a 1D Code128 barcode and as human readable text. The registration process for the customer is easy he has only to scan one of the barcodes. The SES-
imagotag Core Service will than automatically start the key exchange with the label secured by the PIN extracted from the registration code. The two relevant codes:
1. The label ID (8-digit hexadecimal) to identify the label (it's also the radio address which is similar to a MAC address). 2. The registration code (11-digit alphanumeric) is required to activate the encryption. This code also contains the label ID and a random PIN code. Page 23 of 42 Core Service Quick Start Guide 10.2.1 Registration page vs. Reset page Page Layouts G1 4.4 Layout when shipped Registration Page Layout Note:The label ID can only be read and will not be displayed as barcode in this layout. Layout after successful registration Reset Page Layout Note: After successful registration, the AES key is exchanged for encryption and the label switch to a page where only the label ID is displayed as 1D Code128 barcode. The sticker (on the bottom and on the back) always contain only the label ID and therefore should not be used for registration if the encryption will be used. They are only intended for the later article assignment (matching process). Here you can see the registration dialog in the SES-imagotag Control Center where one single label has been entered with the registration code (Pin =yes - security enabled)and the other one with the label ID (for old label versions < 3.0.0, Pin =no, no secured communication). FIGURE 1-19: Register labels dialog (registered with registration code and label ID) Page 24 of 42 Core Service Quick Start Guide Note: New versions of the SES-imagotag Core Service, SES-imagotag Control Center and AP-
2010 ( 1.3.0) will also support old labels that do not come with a pre-programmed PIN code. New labels ( 3.0.0) will also work in old installations together with old labels but the SES-imagotag Core Service will not accept registration codes during the registration process. To register the labels it is required to scan the barcode with the label ID from the backside or the bottom edge of the label. As the SES-imagotag Core Service will not start the key exchange all data is transmitted unencrypted to the labels. 10.3 Handheld terminals, USB barcode scanner and SES-imagotag Core Service iOS-App Its also possible to register labels with a commercial USB barcode scanner (2D/1D). You can also use the SES-imagotag Core Service iOS-App (for iPhone and iPod touch [only available on request]). Handheld terminals are mobile devices that are used to manage the ESL installation. If the handheld provides a barcode scanner, it may be used easily to link articles and labels by scanning the article barcode (usually EAN, UPC or GTIN) and the unique ID of the label. Here you can see some screenshots of our SES-imagotag Core Service iOS-App:
FIGURE 1-20: ESL-App Home-
Screen FIGURE 1-21: ESL-App Registration Page FIGURE 1-22: ESL-App Matching Page 10.4 Encryption status Here are the encryption status a label could have:
l AES: Communication with label is encrypted with 128 bit AES l No PIN: Could not set encryption key as no PIN (registration code) was provided o Solution: Re-register label with registration code l Key unset: Communication is NOT yet encrypted o Solution: Set encryption passphrase and ping the label to start the encryption process l Unsupported: Encryption is not supported by label firmware l Unknown: Security status is not determined yet Page 25 of 42 Core Service Quick Start Guide FIGURE 1-23: Encryption status 10.5 Unlocking labels If the label was registered and a communication key was set it will no longer work in other networks using a different network key passphrase. To unlock this labels for other networks an unlock code is required. The unlock code is similar to the registration code - it is a combination of the label ID and a 128 bit PUK code. Via SES-imagotag Control Center select File Unlock labels and enter the unlock key. FIGURE 1-24: Unlock Labels Dialog Page 26 of 42 Core Service Quick Start Guide 11 Start tagging 11.1 What can I do now?
As soon as labels are online you can do several things:
Send images to labels, assign tags, show the current images, ping labels, reset labels (reset display to show label ID and label ID barcode), refresh displays, switch to a preloaded page, create a new matching (or multi-matching/multi-facing), set (extended)filters, check update logs, ... 11.2 Sending pictures to labels 1. Right click on one or more labels -> Send image 2. Select a picture (Note: Display size must match the resolution of the image) A. B. In the right pane, a priority (currently not relevant) could be set for the task, as well as the page to which the image should be sent and whether the image is preloaded. If preloaded, the image is placed in the memory of the label, but not yet displayed. The image change will only be performed after the change to the relevant page. This allows for each label that images are cached on the various pages and be accessed quickly by switching to the relevant page. 3. By clicking on open the corresponding task(s) for the label(s) will be created and the transfer begins. 11.3 Article management For complete management of your articles select Articles All Articles in the SES-imagotag Control Center. Here youre able to create/delete and edit your articles. The Smart Box Package comes with some predefined articles which you can see here. You can add some more demo articles, edit the existing ones or just step further to the next point Matchings. FIGURE 1-25: Article management Page 27 of 42 Core Service Quick Start Guide 11.4 Matchings/Multi-Facing The logical link between articles and the label that shows the article information and price of this articles is called matching. With a matching the layout of the image rendered for the label is also defined by specifying the name of a template. In a more technical way a matching is the triple of:
l Label ID l Article number(s) or GTIN l Name of the template file Note: Only one matching per label is allowed but articles may be matched to more than one label. Select File New matchings to open the dialog where you can select the desired data records and create a number of matchings at the same time. To generate a multi-matching, multiple article numbers separated with a comma have to be specified. Keep in mind that your template has to be able to render a image for multiple articles. FIGURE 1-26: New matchings dialog Another way to create/edit matchings is under Matchings All Matchings:
l Select the desired data records (Label ID, Article Number) in the following window New Match-
ing Record(either manually or with the magnifying glass symbol). Select an appropriate tem-
plate via Template that should be used to generate the image. l Confirm your choice by clicking Save. After that, the generated image is sent to the selected label. FIGURE 1-27: Create a matching Page 28 of 42 Core Service Quick Start Guide Its also possible to create Matchings with SES-imagotag Control Center under Labels and Articles, for this just select the desired article or label, right-click on it and select New matching (the new matching dialog will be pre-filled with the article or label information). 11.5 Set (extended) filters for enums There are various filter options. Besides the known filter options you'll now have the possibility to set extended filters. Enable/disable the extended filter as shown in image below. FIGURE 1-28: Use and enable the extended filter mode With the extended filter options it's possible to set and combine several filters. Click on the drop down menu to see the different choices. FIGURE 1-29: SES-imagotag Control Center extended filter options 11.5.1 Extended filter operators The following operators are available:
Page 29 of 42 Core Service Quick Start Guide Operator
<
>
Description Less than Greater than
<=
>=
!
=
:
Less than and equal Greater than and equal Negation (Not) Equals Defines a range (e.g. RSSIfilter -65:-75 shows all labels with current RSSIvalue within -65 and -75) Doesn't apply to date and text. Page 30 of 42 Core Service Quick Start Guide 12 Templates The template is used to specify the fields, which should be rendered into the image. The SES-
imagotag Core Service can handle multiple templates. 12.1 General information about templates The image rendering process is based on XSL (EXtensible Stylesheet Language) templates. The individual image for the label is then generated by applying the template to a XML, which is based on the properties of the label and is expanded by a custom XML from the user. The following steps are executed when processing a template:
l Generating a record XML based on the label/task information and custom information provided by the user l Applying the template (XSL) on the generated record XML. This results in a document con-
taining the fields, specified in this reference and values referenced from the XML l Rendering the image (*.PNG) based on the previous output FIGURE 1-30: Input and result of the rendering process 12.2 SES-imagotag Template Editor In order to use our rendering engine you must know our template language which is basically XSL. We do also have a SES-imagotag Template Editor with live preview, but you need a little bit time to setup everything and get familiar with it. Therefore we suggest to send pre-rendered images to labels
(right-click on a label -> send image) which you can create with every image manipulation software you want (e.g. Gimp, Photoshop, Paint, ). You can even take some pre-rendered images from us for each label type with the correct resolution as a template youll find some in the SES-imagotag Control Centers directory under data/images. 12.2.1 Starting SES-imagotag Template Editor Navigate to the unpacked SES-imagotag Template Editor (see point Get the latest software and documentation on how to unpack the software package) and execute the template.jar file (see Troubleshooting on page 36). Page 31 of 42 Core Service Quick Start Guide FIGURE 1-31: Starting the SES-imagotag Template Editor 12.2.2 Open default template file and load records from server:
l Open the SES-imagotag Template Editor by clicking the template.jar file located in the tem-
plate-directory (In our example it should be C:\imagotag\teamplate\). l Next step is to create a new template file or to open an existing one (The default.xsl template file is located in the server-directory under C:\imagotag\server\data\template\). l To get a live preview youll have to load some records, in our case we load the demo article records from our running server, see the following figure. FIGURE 1-32: Load Records from Server Page 32 of 42 Core Service Quick Start Guide After these steps your SES-imagotag Template Editor window should look something like this:
FIGURE 1-33: SES-imagotag Template Editor with loaded records from server and default.xsl template file 12.2.3 Design Mode You can enable the graphical mode of the SES-imagotag Template Editor by selecting Settings Configuration tick Enable Design Mode and finally the Save-button. The Design Mode can be used for creating very simple templates. If you want to use for example conditions in your template, you cannot use the design mode and you should start from zero without the design mode of the SES-
imagotag Template Editor. FIGURE 1-34: Enable Design Mode in SES-imagotag Template Editor Page 33 of 42 Core Service Quick Start Guide After enabling the Design Mode a new tab will show up. FIGURE 1-35: SES-imagotag Template Editor Design Tab 12.2.4 Enable and show color red As there are label types which are capable of showing the color "red"there's a short description how to enable this inside the xsl template file. l Optional: Query whether it is a "red" label l <xsl:when test="Label/DisplayWidth = XXX and Label/DisplayHeight =
XXX and Label/DisplayColors = 'BLACK_WHITE_RED'">
l Add colors option to image tag:
l Show something in color red, e.g. text:
l <image width="XXX" height="XXX" colors="true" font-family="XXX">
l <text font-size="XXX" condense="XXX" font-weight="XXX" color=red>
12.2.5 Help Content Theres a link to the Help content for the SES-imagotag Template Editor, open it by clicking Help Help Content in the SES-imagotag Template Editor or open the file index.html located in C:\imagotag\template\help\. Also you can find further information on the USB Stick under Documentation - Image Rendering Reference. Page 34 of 42 Core Service Quick Start Guide Integration 13 13.1 Webservice integration The SES-imagotag Core Service provides access to its interfaces methods through a RESTful web service API. The web service is designed according to the Representational State Transfer (REST) architectural pattern. The SES-imagotag Core Service listens for incoming HTTP web service requests on the TCP port 8001 by default. You can find further information and documentation about the webservice integration online under https://portal.imagotag.com/get/documentation 13.2 Plugins We provide several plug ins which are used for importing article information into the SES-imagotag Core Service. You can find further information and documentation about our integration plugins online under https://portal.imagotag.com/get/documentation 13.3 Custom integration For custom integration we provide a Plugin-Interface. Software development service is available from SES-imagotag software development team or third-party integration partners. For pricing get in touch with our sales team (sales.at@ses-imagotag.com). Page 35 of 42 Core Service Quick Start Guide 14 Troubleshooting If you run into any errors during connecting or sending images to labels, please refer to the documentation included in the SES-imagotag Core Service. This documentation can be found in the AP-2010 web UI of the SES-imagotag Core Service under Documentation. l For problems updating the labels (error code column in labels window) refer to Update Error Codes or (task status column in labels window) refer to Task Status l For connection status problems refer to Connection Status l For label hardware errors (label error column in labels window) refer to Label Error Codes Code Problem 1 Label not licensed Label not registered Image does not match display size Error during image rendering Error during image conversion Invalid page Could not process task because there are unfinished tasks waiting for this label Template not found Error during template parsing Error during content document creation Could not send update because label has insufficient power to perform the update HTTP communication error with the access point Solution The label is not licensed. Import the proper license file for the label or check for typos in the label id. The label may have been deleted or has never been registered at all. Register label. The size of the image does not match the labels display size. Please check the width and height of your image and look up the display size in pixels for the label. These sizes have to be equal. Check template (wrong or faulty) Change format of the image to standard format (e.g. PNG or BMP) Page not supported by label type, choose a different page Abort task or wait until unfinished tasks are finished Check template directory for missing template file Correct template file (Invalid content found) Check server and article record configuration The power status of the label is Bad, which means it is very low on battery that in may not accomplish the display update. Replace the battery of the label. The server was not able to send the task to the Access Point. Please make sure that the Access Point is not offline (System -> Access Point Status) and there is an established network connection between Access Point and Server. Unlock the label Label authentication failed (wrong encryption key) Task was removed from pipeline because previous transmission was not finished in time Error while writing task to database Check database connection Task type not supported Resend the corresponding task(s) Upgrade AP software to process this kind of task 14.1 SES-imagotag Core Service Dashboard To get a better overview accross your complete ESLsystem you can use the dashboard of the SES-
imagotag Core Service. All kind of helpful information is shown here. You'll find the dashboard under Page 36 of 42 3 10 11 12 13 14 20 21 22 30 62 63 64 80 92 Core Service Quick Start Guide http://<core-service-ip>:<port>/service/dashboard.xml 14.2 Running the SES-imagotag Core Service as a background service The SES-imagotag Core Service may be started as a normal application, but on a productive system it is usually required to have it automatically started without a user logged in. To achieve this the SES-
imagotag Core Service can be registered as a Windows service. It is than started automatically without any graphics user interface. To install the SES-imagotag Core Service as a Windows service the batch file install_service.bat is provided. If this file is executed with administrator privileges (Right click Run as Administrator) it will install the SES-imagotag Core Service installation from the same directory as a Windows service with the name ESL_SERVICE. The file uninstall_service.bat will remove the Windows service if executed with administrator privileges. If you have any problems regarding the background service:
l Check if you have installed the correct JAVAversion corresponding to your system (x86/x64) l If the SES-imagotag Core Service is already installed as a Windows service you have to unin-
stall it first (uninstall_service.bat) and reinstall it again (install_service.bat). 14.3 Where can get a demo/development license key?
Ask the support.at@ses-imagotag.com or sales.at@ses-imagotag.com team for a demo/development license. 14.4 Deleting the demo articles In order to prevent the example articles from being re-added to the server, go to "System -
Configuration"and set the "importFixtures"variable to false. Note: Please do not use the "Smart Box Package" for productive installation. Page 37 of 42 Core Service Quick Start Guide 14.5 Establish a network configuration when no DHCP is available Step by step 1. Set a laptops Ethernet adapter to DHCP 2. Turn off all other network adapters (Wi-Fi) 3. Connect to the same network as the AP-2010 (use a common Ethernet cable to connect your device directly with the AP-2010) 4. Start local SES-imagotag Core Service on laptop 5. Use the SES-imagotag Control Center to connect to your local SES-imagotag Core Service 6. Under System Access Point Status the AP should be listed as discovered (after successful boot sequence may take up to 2 minutes) l Press F5 on your keyboard or the refresh button in the ESL client to refresh the access point status (the Client doesnt refresh the status automatically!) 7. One Column of the AP should now show the IP address 8. Open a browser, type in http://<discovered-ip>:8080 or l at the SES-imagotag Control Center perform a right click on the discovered access point Open in browser Maintenance Status Note: Restart your access point if discovering process takes more than 2 minutes. FIGURE 1-36: Restart and Factory Defaults button 14.6 Access point discovering with Bonjour Services You still got problems to find your ESL access point in your network? There's another workaround:
You can use Apple's "Bonjour Print Services". Download and install Bonjour Print Servicesfor Windows (pre-installed under OSX):
http://support.apple.com/kb/DL999 Note: After installation theres no reboot required. If the access point is connected directly to the system where the Bonjour Service is installed (or on a network with running Bonjour Service) you can find the access point by typing the following in the browser of your choice:
http://ap-<ID>.local:8080 (e.g. http://ap-12724.local:8080) Note: You can reach older versions of the AP with http://imagotag-ap.local:8080 (custom hostnames are only available on newer versions of the access point) 14.7 What can I do if the Status LED of the AP-2010 access point doesnt turn blue?
l Check the access point status l Check the access point configuration o No channel set l Check network reachability of the access point Page 38 of 42 Core Service Quick Start Guide l Is the access point registered to the SES-imagotag Core Service?
l Reboot the access point 14.8 Labels dont come online After the registration it could last a certain time until all registered labels are joined to the network (up to two hours, depending on number of access points and the channels used. l Up to 30 minutes with channels 3, 5, 8, 9 and 10 l Up to 2 hours with channels 0, 1, 2, 4, 6 and 7 Warning: A label must not be registered to multiple SES-imagotag Core Service installations at the same time. It will only connect to one of this installations. 14.9 The encryption does not work Check the encryption passphrase via the SES-imagotag Control Center - System Configuration. If label was already registered with a different passphrase youll have to unlock the label first in order to register it on the SES-imagotag Core Service. 14.10 Unlocking labels If the label was registered and a communication key was set it will no longer work in other networks using a different network key passphrase. To unlock this labels for other networks an unlock code is required. Select File Unlock labels and enter the unlock key. If you have any problems (the unlock code wasn't included or you can't find it) please contact the SES-imagotag Support Team (support.at@ses-imagotag.com). 14.11 Starting Java applications Before starting a Java application, make sure you have Java Runtime Environment Version 6 or higher installed and you have set the necessary environment variables. If the .jar file extension is known and associated with Java, just double-click the jar file to start the application. Otherwise if the extension is not recognized:
Windows:
Create a shortcut of the jar file, right-click on it and open properties. Prepend javaw.exe jarto the path in the Target field. Double-click the shortcut. Linux:
Navigate via command line to the directory where the jar file lies and execute java jar
<filename>.jar In case your environment variables are not set properly (e.g. javaw.exe/java command could not be found) do the following steps:
1. Locate your installation directory of your Java Runtime Environment 2. Set JAVA_HOME Variable Under Windows:
Page 39 of 42 Core Service Quick Start Guide l Right-click on My Computer and select Properties l Click the advanced tab l Click the EnvironmentVariables button l Under SystemVariables, click New. l Enter the variable name as JAVA_HOME l Enter the variable value as the installation directory of your Java Runtime Environment l Click OK l Look for the Path variable in SystemVariables and edit it l Append a semicolon (;) and %JAVA_HOME%\bin to it l Click OK l ApplyChanges Under Linux:
l Use the export command to set your variables l export JAVA_HOME=<pathToJRE>
l export PATH=$PATH:<pathToJRE>/bin l In order to make these changes persistent, write them into your .bash_profile file and use source ~/.bash_profile to apply the changes 14.12 Encoding problems Per default, UTF-8 encoding is used. If you have any problems regarding encoding you can force any java application to use UTF-8. By setting the (Windows) environment variable JAVA_TOOL_ OPTIONS to -Dfile.encoding=UTF8, the (Java) System property will be set automatically every time a JVM is started. 14.13 Reserve RAM for Java heap space As the generation of PDFs in the Site Survey Tool might need a lot of memory (depending on the amount of measurements, uploaded pictures, ) we recommend to use half of the available memory for the Site Survey Tool. In this case, please start the Site Survey Tool via Command Line (or create a corresponding shortcut respectively batch file) with corresponding parameters. If your notebook has 4 GB RAM, please reserve 2 GB for the Site Survey Tool with following command:
D:\Builds\sitesurvey>java -Xmx2g -jar sitesurvey.jar Example:
l m for megabyte
-Xmx512m Page 40 of 42 Core Service Quick Start Guide l g for gigabyte
-Xmx2g The same method can be used to reserve memory for the SES-imagotag Core Service. Detailed information regarding JAVA options: https://docs.oracle.com/cd/E13150_01/jrockit_ jvm/jrockit/jrdocs/refman/optionX.html 14.14 Further documentation Please visit https://portal.imagotag.com for further documentation. Page 41 of 42 Core Service Quick Start Guide 15 Declaration FCC This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Changes or modifications not expressly approved by the party responsible for compliance could void the authority to operate the equipment. IC This device contains licence-exempt transmitter(s)/receiver(s) that comply withInnovation, Science and Economic Development Canadas licence-exempt RSS(s).Operation is subject to the following two conditions: (1) This device may not cause interference. (2) This device must accept any interference, including interference that maycause undesired operation of the device. Lemetteur/recepteur exempt de licence contenu dans le present appareil estconforme aux CNR dInnovation, Sciences et Developpement economique Canadaapplicables aux appareils radio exempts de licence. Lexploitation est autoriseeaux deux conditions suivantes: 1) Lappareil ne doit pas produire de brouillage; 2) Lappareil doit accepter tout brouillage radioelectrique subi, meme si lebrouillage est susceptible den compromettre le fonctionnement. Page 42 of 42
This product uses the FCC Data API but is not endorsed or certified by the FCC