SES imagotag E00019 digital network transceiver User Manual My

SES-imagotag GmbH digital network transceiver My

Contents

Quick start guide

Quick StartGuideLast change: 31.05.2016Applies to software version 1.6.0 or higher
Quick Start GuidePage 2 of 50[Introduction] 41 Electronic Shelf Labeling – A brief introduction 42 What’s in your Smart Box? 53 The G1 label family 63.1 Key Features 74 Core appliance 84.1 Key Features 8[Getting Started] 91 Get the latest software and documentation 92 Install software 92.1 System requirements 92.2 Installation process 92.3 imagotag Customer and Partner Portal 103 Core appliance initial setup 113.1 USB device configuration 113.2 Configuration file creator 123.3 Front side LEDdescription 133.4 Additional documentation 134 Start Core Service and Control Center 144.1 Starting imagotag Core Service 144.2 Starting imagotag Control Center 154.3 Activating your license 175 Access Point Configuration 195.1 Connect and configure AP-2010 195.2 Connect and configure MAP-2014 T/Q & LANCOM L-151e/322e 225.3 Selecting channels 276 Setup Security 286.1 General encryption features and how does it work 286.2 Set the encryption key 287 Register labels 297.1 General procedure 297.2 What's on the label? 29
Quick Start GuidePage 3 of 507.3 Handheld terminals, USB barcode scanner and iOS-App 317.4 Encryption status 327.5 Unlocking labels 338 Start tagging 358.1 What can I do now? 358.2 Sending pictures to labels 358.3 Article management 358.4 Matchings/Multi-Facing 368.5 Set (extended) filters for enums 388.5 Templates 399 Integration 449.1 Webservice integration 449.2 Plugins 449.3 Custom integration 44[Troubleshooting] 451 FAQ 451.1 imagotag Core Service Dashboard 471.2 Running the imagotag Core Service as a background service 471.3 Where can I find the license file for my SmartBox? 481.4 Deleting the demo articles 481.5 Labels don’t come online 481.6 The encryption does not work 481.7 Unlocking labels 481.8 Starting Java applications 481.9 Encoding problems 501.10 Further documentation 50
Quick Start GuidePage 4 of 50[Introduction]1 Electronic Shelf Labeling – A brief introductionAn electronic shelf label is a device that shows article data and price information on itsdisplay. In comparison to printed labels the information is automatically updated if price orarticle data changes.FIGURE 1-1: Electronic Shelf LabelinglCost reduction through eliminationof manual price changeslFully automatic price updates fromthe headquarters to the branchstores within secondslProcess security and price integrity– 100% correlation between cashpoint and shelflIncreased flexibility in price designand immediate reaction to marketsituation Image gain due to use ofhighly modern technologylSimplified processes for store per-sonnellEnhanced sales & price profitabilitymaximize price performance andprofit opportunities
Quick Start GuidePage 5 of 502 What’s in your Smart Box?l2x G1 2.7 Labels / 1x G1 4.4 LabeloThe G1 electronic shelf label family offers high-quality display options, operatingwith a replaceable battery and thus working with any external power supply.Thanks to the perfect readability of the e-Ink displays and our outstanding wirelessdata transmission technology you can implement all your sales, marketing, andlogistic strategies.l1x Access Point AP-2010 incl. AntennaoThe AP-2010 by imagotag is the communication center in the store that transmitsprice information to the labels. Up to 10 000 labels can be managed per accesspoint and the self-organizing network allows automatic roaming of labels withoutmanual handling. It supports 11 selectable ESLchannels.l1x Mounting PlateoMetal Mounting Plate for Mounting the AP-2010 on Walls, Ceilings or other Mount-ing-Rails.l2x Caddy ClipsoWith our system you’re able to mount your labels almost wherever you want.l1x Power PlugoPower Plug to supply power for the AP-2010 (Power over Ethernet is also available).
Quick Start GuidePage 6 of 503 The G1 label familyThe imago G1 electronic shelf label family offers high-quality display options, operating with areplaceable battery and thus working without any external power supply. The G1 red family iscapable of changing all pixels to black, white or red.The current line-up has display sizes from 1.6 inch to 7.4 inch. They may be used in landscapeand portrait mode and can be customized with changeable front covers.The performance of the labels (updates per hour) depends on the mode of the access point. Inthe USA and Canada the AP-2010 usa/canada bundle incl. antenna with limited data efficiencyis required (based on the FCC/ICregulation).Caption Display Res-olutionDensity(dpi)DisplayColorsUseablePagesActive Dis-play Area(mm)Updates/hour/AP(standard /FCC&IC mode)Batterylifetime: 5years withN updatesper dayG1 retail 1.6 red NFC 152 x 152 140 b/w/r4* 27.5 x 27.5 7500/4600 1G1 retail 2.2 red NFC / Boss-ard 2.2 red NFC 212 x 104 111 b/w/r4* 48.6 x 23.8 8500/5000 2G1 retail 2.6 red NFC 296 x 152 125 b/w/r4* 60.1 x 30.7 4500/2600 2G1 retail 2.7 264 x 176 117 b/w 8* 57.3 x 38.2 5000/2700 4G1 retail 2.7 red NFC 264 x 176 117 b/w/r4* 57.3 x 38.2 4500 2G1 retail 4.2 400 x 300 120 b/w 4* 84.8 x 63.6 3000 4G1 retail 4.2 red NFC 400 x 300 120 b/w/r4* 84.8 x 63.6 2000/1300 2G1 retail 4.4 400 x 300 113 b/w 4* 90 x 67 3000/1600 4G1 retail 4.4 red NFC 400 x 300 113 b/w/r4* 90 x 67 2000 2G1 retail 4.5 480 x 176 117 b/w 4* 104.2 x 38.2 4300 4G1 retail 4.5 red NFC 400 x 300 113 b/w/r4* 90 x 67 2500 2G1 retail 7.4 800 x 480 126 b/w 12* 97 x 161.6 1000/500 8G1 retail 7.4 red NFC 800 x 480 126 b/w/r4* 97 x 161.6 600/300 2S-tag 6 HFNFC - - b/w 4 53 x 19.3 20000/20000 4*One useable page is shared with the registration code page. This page is initially shown whenthe label is shipped. After registration this page can be used as a custom page. To restore theoriginal content a service utility is required. To prevent accidentials overwrite this page isprotected. To unlock this page contact the imagotag support.The content of all pages except page number 0 won't remain after a firmware update.
Quick Start GuidePage 7 of 503.1 Key Featuresl2.4 GHz bi-directional MSK proprietary radiolRadio coverage: up to 25 meterslReturn Signal: yesl11 available communication channelslUltra-low power consumptionlCustomer-replaceable batterylFull graphical e-Ink display with paper-like readabilitylChangeable and customizable front coverslSuper wide viewing angle (nearly 180 degrees)lFlexible mounting options availablelMay be used in landscape and portrait modelFast response time (less than 15 seconds)lWater resistantl128-bit AES encryption with secure key exchangelMultiple pages support with preloading and fast page switchinglIntegrated NFCtag as an option
Quick Start GuidePage 8 of 504 Core applianceThe core appliance/core appliance mini is a compact network hardware which can be used torun the imagotag Core Service in the store, instead of using an additional dedicated server. Theimagotag Core Service is always needed in the store locally, also when cloud-based/centralizedmiddleware systems like Jeggy S or Bison ESL Suite is used.4.1 Key Featureslcore appliance is optimized to run up to 30 000 labels and 7 access pointslcore appliance mini is optimized to run up to 500 labels and 3 access pointslEasier and faster shop installations (“Plug and Play”)lIs not recognized as an additional serverlLow maintenancelEasy replace/restore when hardware crasheslLimited deployment variabilitieslLower development costslLower support costslBetter brand recognitionlEasier to sell as a “solution in a box”lLess overall risk for system integrators
Quick Start GuidePage 9 of 50[Getting Started]1 Get the latest software and documentationRegister at the imagotag Customer and Partner Portal to get access to the latest softwaresuite and documentation.https://portal.imagotag.comAfter registration your access is limited. Contact the imagotag Support Team(support@imagotag.com)to get further access and information.2 Install softwareThere’s several software you’ll have to install in order to configure and setup your ESL system.You’ll just have to extract the following 3 archives in a location of your choice:1. imagotag Core Service (previously known as imagotag ESL Server) <server.zip>2. imagotag Control Center (previously known as imagotag ESL Client)<client.zip>3. Template Editor <template.zip>2.1 System requirementslServer hardware: Pentium 4 (2 GHz or higher), 2 GB RAMlJava Runtime Environment Version 6, Update 36 or higherlWindows XP, Windows 7, Windows Server 2008 (R2), Windows 10, Suse Enterprise Linux11, Ubuntu 12 (all 32/64-bit versions), Mac OS Xlimagotag Core Software Suitelimagotag AP-2010limagotag LabelslLicense key2.2 Installation processPlease unpack the zip-archives <server.zip>, <client.zip> and <template.zip> on your machine -e.g. under C:\imagotag\.Note: To unpack the zip-files you can either use the windows internal archive-unpacker (seescreenshots) or an unpack tool of your choice (e.g. the free tool 7zip – www.7zip.org).
Quick Start GuidePage 10 of 50FIGURE 1-2: Unpack/Install imagotag Software #1 FIGURE 1-3: Unpack/Install imagotag Software #2After unpacking all 3 archives, your folder should look something like this:FIGURE 1-4: Unpacked imagotag software folderThe imagotag software is now installed and you can step forward to point Start Core Service andControl Center -Start Core Service and Control Center.2.3 imagotag Customer and Partner PortalAfter user registration and activation you will have access to documentation and you canactivate, manage and download your imagotag software licenses see Activating your license onpage 17. Your user account will not be assigned to a customer account yet. If assigned, youhave access to all shipments here including lists of label IDs, registration codes and unlockcodes. To get access there must be a completed order and your account needs to be verified(existing customer account required).
Quick Start GuidePage 11 of 503 Core appliance initial setupTo operate the appliance there are only a few steps necessary:1. Supply with power2. Turn it on (button on the backside of the device)3. Plug it into your networkPer default, the imagotag core appliance comes with DHCPenabled. So if you have aDHCPservice running you can find it with the MAC address which is printed on the bottom sideof the appliance.If there's no way to get access to the DHCPserver we recommend to use a USBdevice with aconfiguration file to configure the appliance initially.FIGURE 1-5: Core appliance rear view3.1 USB device configurationYou can find an example configuration file (example.config) at our customer portal.Core appliance service reference mode |Core appliance example.config fileAfter downloading, editing and copying the configuration file onto any USBdevice, theconfiguration is automatically adopted after plugging in the USB flash drive into the appliance.A triple beep indicates the successful configuration. A single beep signals that theconfiguration hasn't been set successful.The web UIinterface of the appliance is now available under http://<ip-address>.The initial configuration of the appliance can be compared with the installation and start of animagotag Core Service. After configuration, you can access the appliance via the imagotagControl Center from every system connected to your network (see Starting imagotag ControlCenter on page 15).
Quick Start GuidePage 12 of 503.1.1 Example.config fileTo set up your appliance for the first run you'll have to set at least the following networkparameters:lIPaddresslSubnet masklOptional: Gateway, DNSTo set the parameters mentioned above the contents of the configuration file might look likethis:# Set IP address of bridge interfaceset network br0 192.168.1.100 255.255.255.0# Set a gatewayset gateway 192.168.1.1# Set a nameserverset dns 192.168.1.21Note:This simple bridge configuration connects the network interfaces. No matter where thenetwork cable is plugged in, the appliance is accessible via the configured bridge address.3.2 Configuration file creatorYou'll also find a appliance configuration file creator wizard at our imagotag Customer andPartner Portal. The wizard will help to create the correct configuration file which is used to setthe following configuration parameters:Mandatory:lAppliance IDlIPaddresslSubnet maskOptional:lTitlelStore IDlCommentlHostnamelDefault GatewaylNameserver 1lNameserver 2
Quick Start GuidePage 13 of 50FIGURE 1-6: Appliance configuration file creator3.3 Front side LEDdescriptionOn the front side of the appliance you can see several status information:FIGURE 1-7: Core appliance front view LEDstatus informationPower onCore Appliance is activeCore service runningTask executedPort in usePort/Device is active3.4 Additional documentationYou can find additional documentation regarding the imagotag core appliance (e.g. a completeservice mode reference) on our imagotag Customer and Partner Portal
Quick Start GuidePage 14 of 504 Start Core Service and Control Center4.1 Starting imagotag Core ServiceIf you've recently configured your imagotag core appliance the ESLService is already runningand you can step forward to the next step 15In order to start the ESL 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 (ifthe window doesn’t show up after all, make sure your Java installation and configuration iscorrect).FIGURE 1-8: Core Service web UIThe service will listen to TCP connections on Port 8000 and 8001 and UDPconnections on Port 8000. Please make sure that there is no firewall issueand/or interference with other systems.After start of the service you can check the web-GUI of the server:URL: http://<host|ip>:8000Login: admin/adminDuring the first start the imagotag Core Service will automatically create a Derby1database. Ifanother database connection is needed or preferred, the connection parameters should bevalidated by imagotag.Note: As you can see there are several level numbers, by default the server instance will startin level 3. You can find the description of the different levels in the Developer Reference (whichis also part of the documentation available at the imagotag Customer and Partner Portal) under“Integration Levels”.1Apache Derby, an Apache DB subproject, is an open source relational database implementedentirely in Java
Quick Start GuidePage 15 of 504.1.1 Example articlesFor easier usage some example articles can be preloaded at the time you start the imagotagCore Service. You can find the corresponding XMLarticle data here:C:\imagotag\server\data\fixtures\.To enable and disable the preloading of these fixtures go to the system configuration and setthe corresponding property "importFixtures"true or false.Note: The article records are based on the XML-standard.4.2 Starting imagotag Control CenterGo to the extracted client directory and execute the “client.jar” file.FIGURE 1-9: Starting ESL ClientThe client is configured to connect to a server on the local machine per default. In order tochange this to a remote machine in a network you have to start the client with an additionalparameter:WindowslCreate a shortcut/Edit existing short cutlAppend “ --host hostnameOrIPAddress” at the end of the “Target” field. (Note: The text toappend starts with an space and there are 2 hyphens to add!)LinuxlAppend “ --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 2hyphens to add!)
Quick Start GuidePage 16 of 50FIGURE 1-10: Starting ESL Client with parameter
Quick Start GuidePage 17 of 504.2.1 imagotag Control Center LoginlUsername: adminlPassword: adminFIGURE 1-11: imagotag Control Center Login4.3 Activating your licenseAfter starting the imagotag Core Service and imagotag Control Center it's necessary to activatethe license key which is included in the "Software License Document". To view your currentlicense status there's a License status dialog. You can find it in the imagotag Control Centerunder "Help - License status". Since no license is activated/imported yet the window shouldlook similar to this:FIGURE 1-12: License Status DialogCopy the "System serial" to the clipboard (STRG+Cor right click "Copy to clipboard")and thenclick the "License activation". You'll be automatically redirected to the imagotag Customer andPartner Portal https://portal.imagotag.com.Please log in (or register a new user). After log in, you can see a summary of already activatedlicenses 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 aComment (optional) and click the "Activate"button.
Quick Start GuidePage 18 of 50FIGURE 1-13: Activate License (imagotag Customer and Partner Portal)Download the generated license file and complete the licensing process by importing thelicense file to your ESLsystem. With the successful activation of your SmartBox demo licenseyou're now able to register and use up to five labels and one access point.FIGURE 1-14: Import of license file downloaded beforeNote: Press "F5"(after 15 seconds) to update the license status after license file import.
Quick Start GuidePage 19 of 505 Access Point ConfigurationThe access points AP-2010, MAP-2014 T/Q and LANCOM L-131e/L-322e are the communicationcenter in the store that transmits information to the labels. In order to ensure thecommunication between imagotag Core Service, access point(s) and the labels the accesspoints have to be configured at the start of the imagotag Core Service.5.1 Connect and configure AP-20105.1.1 Connect and configureBefore labels are able to communication with the server at least one access point needs to beconfigured. In standard configuration the AP-2010 should get an IP-address via DHCP(recommended) and is accessible via imagotag AP-2010 web UI:URL: http://<host|ip>:8080Login: admin/adminImportant Note: In this part of the Quick Start Guide it is assumed that a DHCP server ispresent (you can find the steps to discover the access point without DHCP in theTroubleshooting section - see [Troubleshooting] on page 455.1.2 Discover the Access PointBefore you can configure the access point it’s necessary that the server will discover it.The following points have to be observed:lConnect your machine to the same network as the APlPlug in the power supply of the access pointlDuring the boot process of the access point, start the imagotag Core Service software onthe computerlWhen the access point is up (LEDturns orange), the server will discovery it with an IPaddress (Note: The discovering process may take up to 2 minutes)lUse the imagotag Control Center to connect to your imagotag Core ServicelUnder System – Access Point Status – the AP should be listed as discovered (after suc-cessful boot sequence)
Quick Start GuidePage 20 of 50FIGURE 1-15: List of discovered Access PointsNow you’re able to configure the 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-16: AP-2010 Status overview
Quick Start GuidePage 21 of 50It’s recommended for the demo installation not to use the “Auto-Config” feature and configurethe AP manually.5.1.3 Necessary configuration over the AP-2010 web UIThe following actions need to be performed over the web-GUI1. Deactivate Centralized Configuration: Administration -> Configuration Mode2. Set up network details (or leave DHCP): Administration -> Network3. Set up an ESLchannel: Administration -> Wireless ChannelThe AP-2010 supports 11 ESL channels. It’s recommended to choose one ofthe recommended channels: 3, 5, 8, 9 or 10. These channels do not interferewith standard Wi-Fi channels 1, 6, 11 and are scanned by the labels more often.For further information about selecting channels see point Connect andconfigure AP-2010.5.1.4 Necessary configuration at the imagotag Control CenterAfter the configuration in the AP-2010 web UI it’s necessary to add this AP via the imagotagControl Center: System – Access Point Configuration – New … or right click on a discoveredAP- Create configuration.FIGURE 1-17: ESL Client AP configuration - System -> Access Pont Status -> Create configurationChoose “Manual Configuration” if you don’t use Auto-Config and enter Access Point ID (AP ID)and IP address (Host).
Quick Start GuidePage 22 of 50Note: After the basic configuration in the AP-2010 web UI, it is also possible to fill in AP-ID andAP-IP-Address automatically. For this choose "Create Configuration..." under System – AccessPoint Status - Right click on the discovered and configured Access Point.After saving the AP configuration you should see the AP under System – Access Point Statusas ONLINE. In addition the AP status LED should turn BLUE.Note: It is possible to configure the access point via hostname. To get this working there hasto be a corresponding entry in the DNS.5.1.5 The Status LEDThere are several LED colors that indicates the main status of the access point.Color Description NoteRed Boot processCan take about 2 minutes, if it takes muchlonger, the device is defective and there is aneed for service.Blue Normal mode ---YellowOperational, but notconnected to any serveror no channel selected---Red (blinking) Running Firmware Update During this time there is no connection to theelectronic labelIf there are any problems regarding the access point please see chapter [Troubleshooting].5.2 Connect and configure MAP-2014 T/Q & LANCOM L-151e/322eThe LANCOM Access Point with Wireless-ePaper is the communication center in the store thattransmits price information to the labels. In order to ensure the communication between ESLserver, access point and the labels the LANCOM Access Point with Wireless-ePaper has to beconnected after the start of the ESL Server.One way to configure the access point is on the client.5.2.1 First configuration stepsAs described in the Installation Guide (printed version included in the package) you’ll have toconfigure the basic settings before setting up Wireless-ePaper using the imagotag imagotagCore Service.1. Installing the software or configuration using a web browser and setup wizards2. Deploying and connecting the device3. Searching for and configuring the deviceAfter setting up the basic settings the following points have to be fulfilled:
Quick Start GuidePage 23 of 50lKnowing the IP address of the AP-2010lWLAN activatedImportant Note: AP-2010 and the computer on which the imagotag Core Service runs should beconnected via Ethernet and not via WiFi, as this will result to regular failures.5.2.2 Access Point IPBefore labels are able to communication with the server at least one access point needs to beconfigured. After setting up the basics you should know the IP address of your AP-2010:URL: http://<LANCOM/MAP-IP-address>Login with the password set before.FIGURE 1-18: Figure - LANCOM Web GUI Login5.2.3 Configuration: Wireless ePaperUnder “Configuration – Wireless ePaper” you can check whether the module is activated or not.You can also select a channel or leave the “Automatic selection” (recommended).FIGURE 1-19: Figure - Configuration - Wireless ePaperThe AP-2010 supports 11 wireless channels. It’s recommended choose one ofthe recommended channels: 3, 5, 8, 9 or 10. These channels are scanned bythe labels more often.5.2.4 LCOS Menu TreeHere you’ll find the necessary information for the imagotag Core Service Access PointConfiguration settings.5.2.5 Setup – Wireless ePaperNavigation: “LCOS Menu Tree – Setup – Wireless ePaper”
Quick Start GuidePage 24 of 50It’s possible to change the ESL channels and do activate or deactivate the Wireless ePapersystem. Here you can also find the selected UDP port for the communication (port 7353 perdefault).FIGURE 1-20: Figure - LCOS Menu Tree - Setup - Wireless ePaperThe service will listen to TCP connections on Port 8000, 8001 and 8080 andalso UDP connections on Port 8000 and the port set in LCOS Menu Tree(default 7353). Please make sure that there is no firewall issue and/orinterference with other systems.5.2.6 Status – Wireless ePaperNavigation: “LCOS Menu Tree – Status – Wireless ePaper”After configuration you can see a summary of your Wireless ePaper settings underFIGURE 1-21: Figure - LCOS Menu Tree - Setup - Wireless ePaper5.2.7 Necessary configuration at the imagotag Control CenterAfter the configuration in the LANCOM web-GUI it’s necessary to add this AP via the ESL Client:System -> Access Point Configuration -> New …
Quick Start GuidePage 25 of 50FIGURE 1-22: Figure - ESL Client AP configuration - System -> Access Pont Configuration -> NewChoose “Manual Configuration” and enter Access Point ID (AP ID), IP address (Host) and correctport value.FIGURE 1-23: Figure - New Access Point ConfigurationNote: You can find the Access Point ID under “LCOS Menu Tree – Status – Wireless ePaper” oron the backside of the Access Point, shown below.FIGURE 1-24: Figure - Wireless ePaper AP-ID on the backside of the Access Point
Quick Start GuidePage 26 of 50After saving the AP configuration you should see the AP under System -> Access Point Statusas ONLINE. Also the Status in the web-GUI of the LANCOM Access Point changes from State“Waiting-for-Controller-Connection” to “Running”FIGURE 1-25: Figure – Access Point and Wireless-ePaper status changes5.2.8 Automatic channel selectionIf you don’t want the Access Point(s) to decide the channels (Automatic selection) automaticallya channel must be selected on each access point in the network. There are 11 non overlappingESL channels reserved for the communication with the labels. Five of these channels do notinterfere with typical Wi-Fi installations and should therefore be favored. These are the ESLchannels 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-26: Figure - Visualization of used channels of the imagotag AP-2010Warning: Do not select the same channel on two access points within one area. This will causeinterferences and avoids labels from joining the network. The same channel may only beselected on two access points if it can be guaranteed that every label is within the range ofonly one of these access points.
Quick Start GuidePage 27 of 505.3 Selecting channelsFor a working installation a channel must be selected on each access point in the network.There are 11 non overlapping ESL channels reserved for the communication with the labels.Five of these channels do not interfere with typical Wi-Fi installations and should therefore befavored. These are the ESL channels 3, 5, 8, 9 and 10 and they should be selected if there is aWi-Fi installation on the Wi-Fi channels 1, 6 and 11.FIGURE 1-27: Comparison between common used Wi-Fi and ESLchannelsIf there is a Wi-Fi installation operating at 2.4 GHz (IEEE 802.11b/g/n) or any other radiofrequency (RF) technology that uses the 2.4 GHz ISM band make sure to select the ESLchannels that are least overlapping with the existing installation. If there is no ESL channelwithout any overlapping both the ESL and existing installation should still work but there mightbe a reduced overall speed in both installations.Warning: Do not select the same channel on two access points within one area. This will causeinterferences and avoids labels from joining the network. The same channel may only beselected on two access points if it can be guaranteed that every label is within the range ofonly one of these access points.
Quick Start GuidePage 28 of 506 Setup SecurityThe security concept is based on individual registration codes for each label. Not only that thenew concept simplifies installations, it also provides stronger encryption and a secure keyexchange with individual communication key derived from a user defined network key.6.1 General encryption features and how does it worklSolid improved safetylEncrypted data type AES128 (Advanced Encryption Standard)lUser defined 128 bit network key for each installationlKey is distributed to labels automaticallyThe new system requires a user defined 128 bit network key for each installation. The key isderived from a passphrase that is defined by the customer and stored in the imagotag CoreService and used by all access points connected to that server to encrypt data communicationto 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 andit’s an alphanumeric case-sensitive code with 11 characters). The imagotag Core Service willthan automatically start the key exchange with the label secured by the PIN extracted from theregistration code.6.2 Set the encryption keyFirst step is to set the parameter “encryptionPassphrase“ under System – Configuration (youcan choose the encryption Passphrase on your own).FIGURE 1-28: Set encryption keyNote: Do not change encryption passphrase if labels are already connected and encrypted (ifyou want to change the encryption passphrase you’ll first have to unlock all labels – see[Troubleshooting] on page 45).
Quick Start GuidePage 29 of 507 Register labelsIn order that labels can join the network it is necessary to register them first.7.1 General procedureVia the ESL Client under File – Register Labels it’s possible to register your labels manuallywith the registration code shown on each single label or you could import a CSV file with yourregistration codes. In order to refresh the entries press the refresh button shown in the nextfigure.Important Note: After the registration it could last a certain time until all registered labels arejoined to the network (from 30 minutes up to two hours, depending on configured access pointchannels). After this you can send images to each label (see Start tagging on page 35).FIGURE 1-29: Add/Delete Label and refresh entries7.2 What's on the label?All labels will arrive with its registration code (11-digit alphanumeric)shown on the display ofthe label. The code is printed as a 2D QR code, as a 1D Code128 barcode and as humanreadable text. The registration process for the customer is easy – he has only to scan one ofthis barcodes. The imagotag Core Service will than automatically start the key exchange withthe 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 whichis similar to a MAC address).2. The registration code (11-digit alphanumeric) is required to activate the encryption. Thiscode also contains the label ID and a random PIN code.
Quick Start GuidePage 30 of 507.2.1 Labels before and after registrationPage Layouts G1 4.4Layout when shippedRegistration Page LayoutNote:The label ID can only be read and will not bedisplayed as barcode in this layout.Layout after successful registrationReset Page LayoutNote: After successful registration, the AES key isexchanged for encryption and the label switch to a pagewhere only the label ID is displayed as 1D Code128barcode.The sticker (on the bottom and on the back) always contain only the label ID and thereforeshould not be used for registration. They are only intended for the later article assignment(matching process).Here you can see the registration dialog in the imagotag Control Center where one single labelhas been entered with the registration code (Pin =yes - security enabled)and the other onewith the label ID (for old label versions < 3.0.0, Pin =no, no secured communication).
Quick Start GuidePage 31 of 50FIGURE 1-30: Register labels dialog (registered with registration code and label ID)Note: New versions of the imagotag Core Service, imagotag Control Center and AP-2010 (≥1.3.0) will also support old labels that do not come with a pre-programmed PIN code. Newlabels (≥ 3.0.0) will also work in old installations together with old labels but the imagotag CoreService will not accept registration codes during the registration process. To register the labelsit is required to scan the barcode with the label ID from the backside or the bottom edge of thelabel. As the server will not start the key exchange all data is transmitted unencrypted to thelabels.7.3 Handheld terminals, USB barcode scanner and iOS-AppIt’s also possible to register labels with a commercial USB barcode scanner (2D/1D). You canalso use our 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 thehandheld provides a barcode scanner, it may be used easily to link articles and labels byscanning the article barcode (usually EAN, UPC or GTIN) and the unique ID of the label.Here you can see some screenshots of our iOS-App:
Quick Start GuidePage 32 of 50FIGURE 1-31: ESL-App Home-Screen FIGURE 1-32: ESL-App RegistrationPageFIGURE 1-33: ESL-App MatchingPage7.4 Encryption statusHere are the encryption status a label could have:lAES: Communication with label is encrypted with 128 bit AESlNo PIN: Could not set encryption key as no PIN (registration code) was providedoSolution: Re-register label with registration codelKey unset: Communication is NOT yet encryptedoSolution: Set encryption passphrase and ping the label to start the encryption pro-cesslUnsupported: Encryption is not supported by label firmwarelUnknown: Security status is not determined yet
Quick Start GuidePage 33 of 50FIGURE 1-34: Encryption status7.5 Unlocking labelsIf the label was registered and a communication key was set it will no longer work in othernetworks using a different network key passphrase. To unlock this labels for other networks anunlock code is required. The unlock code is similar to the registration code - it is a combinationof the label ID and a 128 bit PUK code.Via imagotag Control Centerselect File – Unlock labels and enter the unlock key.
Quick Start GuidePage 34 of 50FIGURE 1-35: Unlock Labels DialogNote: The unlock-code for the specific labels is enclosed in the Smart Box (in an envelope).
Quick Start GuidePage 35 of 508 Start tagging8.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 (resetdisplay 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 updatelogs, ...8.2 Sending pictures to labels1. Right click on one or more labels -> Send image…2. Select a picture (Note: Display size must match the resolution of the image)A. In the right pane, a priority (currently not relevant) could be set for the task, as wellas the Page to which the image should be sent and whether the image is pre-loaded.B. 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 beaccessed quickly by switching to the relevant page.3. By clicking on “open” the corresponding task(s) for the label(s) will be created and thetransfer begins.8.3 Article managementFor complete management of your articles select Articles – All Articles in the imagotag ControlCenter. Here you’re able to create/delete and edit your articles.The Smart Box comes with 8 predefined articles which you can see here. You can add somemore demo articles, edit the existing ones or just step further to the next point Matchings.
Quick Start GuidePage 36 of 50FIGURE 1-36: Article management8.4 Matchings/Multi-FacingThe logical link between articles and the label that shows the article information and price ofthis articles is called matching. With a matching the layout of the image rendered for the labelis also defined by specifying the name of a template.In a more technical way a matching is the triple of:lLabel IDlArticle number(s) or GTINlName of the template fileNote: Only one matching per label is allowed but articles may be matched to more than onelabel.Select File – New matchings to open the dialog where you can select the desired data recordsand create a number of matchings at the same time. To generate a multi-matching, multiplearticle numbers separated with a comma have to be specified. Keep in mind that your templatehas to be able to render a image for multiple articles.
Quick Start GuidePage 37 of 50FIGURE 1-37: New matchings dialogAnother way to create/edit matchings is under “Matchings – All Matchings”:lSelect the desired data records (Label ID, Article Number) in the following window “NewMatching Record“ (either manually or with the magnifying glass symbol). Select an appro-priate template via “Template” that should be used to generate the image.lConfirm your choice by clicking Save. After that, the generated image is sent to the selec-ted label.FIGURE 1-38: Create a matchingIt’s also possible to create Matchings with imagotag Control Center under Labels and Articles,for this just select the desired article or label, right-click on it and select “New matching…” (thenew matching dialog will be pre-filled with the article or label information).
Quick Start GuidePage 38 of 508.5 Set (extended) filters for enumsThere are various filter options. Besides the known filter options you'll now have the possibilityto set extended filters. Enable/disable the extended filter as shown in image below.FIGURE 1-39: Use and enable the extended filter modeWith the extended filter options it's possible to set and combine several filters. Click on thedrop down menu to see the different choices.
Quick Start GuidePage 39 of 50FIGURE 1-40: imagotag Control Center extended filter options8.5.1 Extended filter operatorsThe following operators are available:Operator Description<Less than>Greater than<= Less than and equal>= Greater than and equal!Negation (Not)=Equals:Defines a range (e.g. RSSIfilter -65:-75 shows all labels with currentRSSIvalue within -65 and -75) Doesn't apply to date and text.8.5 TemplatesThe template is used to specify the fields, which should be rendered into the image. Theimagotag Core Service can handle multiple templates.8.5.1 General information about templatesThe 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 isbased 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:lGenerating a record XML based on the label/task information and custom informationprovided by the userlApplying the template (XSL) on the generated record XML. This results in a documentcontaining the fields, specified in this reference and values referenced from the XMLlRendering the image (*.PNG) based on the previous outputFIGURE 1-41: Input and result of the rendering process
Quick Start GuidePage 40 of 508.5.2 Template EditorIn order to use our rendering engine you must know our template language which is basicallyXSL. We do also have a Template Editor with live preview, but you need a little bit time to setupeverything 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 manipulationsoftware you want (e.g. Gimp, Photoshop, Paint, …). You can even take some pre-renderedimages from us for each label type with the correct resolution as a template – you’ll find somein the client’s directory under data/images.
Quick Start GuidePage 41 of 508.5.2.1 Starting Template EditorNavigate to the unpacked template directory (see point Installation process on how to unpackthe software package) and execute the “template.jar” file (see [Troubleshooting] on page 45).FIGURE 1-42: Starting the Template Editor8.5.2.2 Open default template-file and load records from server:lOpen the Template Editor by clicking the “template.jar” file located in the template-dir-ectory (In our example it should be C:\imagotag\teamplate\).lNext step is to create a new template file or to open an existing one (The default.xsl tem-plate file is located in the server-directory under C:\imagotag\server\data\template\).lTo get a live preview you’ll have to load some records, in our case we load the demo art-icle records from our running server, see the following figure.FIGURE 1-43: Load Records from Server
Quick Start GuidePage 42 of 50After these steps your Template Editor window should look something like this:FIGURE 1-44: Template Editor with loaded records from server and default.xsl template file8.5.2.3 Design ModeYou can enable the graphical Template Editor by selecting Settings – Configuration – tickEnable Design Mode and finally the Save-button.FIGURE 1-45: Enable Design Mode in Template Editor
Quick Start GuidePage 43 of 50After enabling the Design Mode a new tab will show up.FIGURE 1-46: Template Editor Design Tab8.5.2.4 Enable and show color redAs there are new label types which are capable of showing the color "red"there's a shortdescription how to enable this inside the xsl template file.lOptional: Query whether it is a "red" labell<xsl:when test="Label/DisplayWidth = XXX and Label/DisplayHeight =XXX and Label/DisplayColors = 'BLACK_WHITE_RED'">lAdd colors option to image tag:l<image width="XXX" height="XXX" colors="true" font-family="XXX">lShow something in color red, e.g. text:l<text font-size="XXX" condense="XXX" font-weight="XXX" color=”red”>8.5.2.5 Help ContentThere’s a link to the Help content for the Template Editor, open it by clicking Help – HelpContent in the Template Editor or open the file index.html located inC:\imagotag\template\help\.Also you can find further information on the USB Stick under Documentation - Image RenderingReference.
Quick Start GuidePage 44 of 509 Integration9.1 Webservice integrationThe ESL server 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 ESL server listens for incoming HTTP web service requests on the TCP port 8001 bydefault.You can find further information and documentation about the webservice integration onlineunder https://portal.imagotag.com/get/documentation9.2 PluginsWe provide several plug ins which are used for importing article information into the ESLServer.You can find further information and documentation about our integration plug ins online underhttps://portal.imagotag.com/get/documentation9.3 Custom integrationFor custom integration we provide a Plugin-Interface. Software development service isavailable from imagotag software development team or third-party integration partners.For pricing get in touch with our sales agents (sales@imagotag.com).
Quick Start GuidePage 45 of 50[Troubleshooting]1 FAQIf you run into any errors during connecting or sending images to labels, please refer to thedocumentation included in the server. This documentation can be found in the AP-2010 web UIof the server under “Documentation”.lFor problems updating the labels (error code column in labels window) refer to “UpdateError Codes” or (task status column in labels window) refer to “Task Status”lFor connection status problems refer to “Connection Status”lFor label hardware errors (label error column in labels window) refer to “Label ErrorCodes”Code Problem Solution1 Label not licensed The label is not licensed. Import the proper licensefile for the label or check for typos in the label id.3 Label not registered The label may have been deleted or has never beenregistered at all. Register label.10 Image does not match displaysizeThe size of the image does not match the label’sdisplay size. Please check the width and height ofyour image and look up the display size in pixels forthe label. These sizes have to be equal.11 Error during image rendering Check template (wrong or faulty)12 Error during image conversion Change format of the image to standard format (e.g.PNG or BMP)13 Invalid page Page not supported by label type, choose a differentpage14Could not process task becausethere are unfinished tasks waitingfor this labelAbort task or wait until unfinished tasks arefinished20 Template not found Check template directory for missing template file21 Error during template parsing Correct template file (Invalid content found)22 Error during content documentcreation Check server and article record configuration30Could not send update becauselabel has insufficient power toperform the updateThe power status of the label is “Bad”, which meansit is very low on battery that in may not accomplishthe display update. Replace the battery of the label.62 HTTP communication error withthe access pointThe server was not able to send the task to theAccess Point. Please make sure that the AccessPoint is not offline (System -> Access Point Status)and there is an established network connectionbetween Access Point and Server.64 Task was removed from pipeline Resend the corresponding task(s)
Quick Start GuidePage 46 of 50because previous transmissionwas not finished in time80 Error while writing task todatabase Check database connection92 Task type not supported Upgrade AP software to process this kind of task
Quick Start GuidePage 47 of 501.1 imagotag Core Service DashboardTo get a better overview accross your complete ESLsystem you can use the new dashboard.All kind of helpful information is collected here. You'll find the dashboard under http://<core-service-ip>:<port>/service/dashboard.xml1.2 Running the imagotag Core Service as a background serviceThe imagotag Core Service may be started as a normal application, but on a productive systemit is usually required to have it automatically started without a user logged in. To achieve thisthe imagotag Core Service can be registered as a Windows service. It is than startedautomatically without any graphics user interface.To install the imagotag Core Service as a Windows service the batch file install_service.bat isprovided. If this file is executed with administrator privileges (Right click – Run asAdministrator) it will install the imagotag Core Service installation from the same directory as aWindows service with the name ESL_SERVICE.The file uninstall_service.bat will remove the Windows service if executed with administratorprivileges.If you have any problems regarding the background service:lCheck if you have installed the correct JAVAversion corresponding to your system(x86/x64)lIf the 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).
Quick Start GuidePage 48 of 501.3 Where can I find the license file for my SmartBox?You find the license file (which has to be activated at the imagotag Customer and PartnerPortal enclosed in the SmartBox in a "License Envelope".1.4 Deleting the demo articlesIn order to prevent the example articles from being re-added to the server, go to "System -Configuration"and set the "importFixtures"variable to false.1.5 Labels don’t come onlineAfter the registration it could last a certain time until all registered labels are joined to thenetwork (up to two hours, depending on number of access points and the channels used.lUp to 30 minutes with channels 3, 5, 8, 9 and 10lUp to 2 hours with channels 0, 1, 2, 4, 6 and 7Warning: A label must not be registered to multiple imagotag Core Service installations at thesame time. It will only connect to one of this installations.1.6 The encryption does not workCheck the encryption passphrase in Server Configuration (System – Configuration).If label was already registered with a different passphrase you’ll have to unlock the label first inorder to register it on the server.1.7 Unlocking labelsIf the label was registered and a communication key was set it will no longer work in othernetworks using a different network key passphrase. To unlock this labels for other networks anunlock code is required.Select File – Unlock labels and enter the unlock key.The unlock-code for the specific labels is enclosed in the Smart Box (in an envelope).If you have any problems (the unlock code wasn't included or you can't find it) please contactthe imagotag support (support@imagotag.com).1.8 Starting Java applicationsBefore starting a Java application, make sure you have Java Runtime Environment Version 6 orhigher installed and you have set the necessary environment variables.
Quick Start GuidePage 49 of 50If the .jar file extension is known and associated with Java, just double-click the jar file to startthe 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 –jar“ to 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 couldnot be found) do the following steps:1. Locate your installation directory of your Java Runtime Environment2. Set JAVA_HOME Variable
Quick Start GuidePage 50 of 50Under Windows:lRight-click on “My Computer” and select “Properties”lClick the advanced tablClick the “EnvironmentVariables” buttonlUnder “SystemVariables”, click New.lEnter the variable name as JAVA_HOMElEnter the variable value as the installation directory of your Java Runtime EnvironmentlClick OKlLook for the Path variable in “SystemVariables” and edit itlAppend a semicolon (;) and %JAVA_HOME%\bin to itlClick OKlApplyChangesUnder Linux:lUse the “export” command to set your variableslexport JAVA_HOME=<pathToJRE>lexport PATH=$PATH:<pathToJRE>/binlIn order to make these changes persistent, write them into your .bash_profile file and use“source ~/.bash_profile” to apply the changes1.9 Encoding problemsPer default, UTF-8 encoding is used. If you have any problems regarding encoding you can forceany 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 everytime a JVM is started.1.10 Further documentationPlease visit https://portal.imagotag.com for further documentation:lDeveloper Reference (Web Service)lImage Rendering ReferencelCSV/XML Import PluginlFile Import PluginlCore appliance service mode referencel(M)AP Update HowTolCore Suite UpdatelSecurity WhitepaperlLicensing Whitepaper

Navigation menu