SES imagotag E00005 Networking Transceiver User Manual My

imagotag GmbH Networking Transceiver My

Contents

Quick start guide

Quick StartGuideApplies to software version 1.4.0 or higherLast change: 07.09.2015Author: Kurt Haller-Walzl
Quick Start Guide imagotag GmbHPage 2 of 36[Introduction] 41 Electronic Shelf Labeling – A brief introduction 42 The G1 label family 52.1 Key Features 53 What’s in your Smart Box? 6[Getting Started] 71 Latest Software and Documentation 72 Install software 72.1 System requirements 72.2 Installation process 72.3 Customer Portal 93 Start Server and Client 103.1 Starting ESLServer 103.2 Starting ESLClient 113.3 Activating License 124 Connect and configure Access Point AP-2010 144.1 Connect and configure 144.2 Necessary configuration over the AP-2010 web management interface 154.3 Necessary configuration at the ESL Client 164.4 Selecting channels 174.5 The Status LED 175 Setup Security 185.1 General encryption features and how does it work 185.2 Set the encryption key 186 Register labels 196.1 General procedure 196.2 What's on the label? 196.3 Handheld terminals, USB barcode scanner and iOS-App 216.4 Encryption status 216.5 Unlocking labels 227 Start tagging 237.1 What can I do now? 237.2 Sending pictures to labels 237.3 Article management 247.4 Matchings 247.5 Set filters for enums 26
Quick Start Guide imagotag GmbHPage 3 of 367.5 Templates 278 Integration 318.1 Webservice integration 318.2 Plugins 318.3 Custom integration 31[Troubleshooting] 321 FAQ 321.1 Running the ESLServer as a background service 331.2 Where can I find the license file for my SmartBox? 331.3 Deleting the demo articles 331.4 Establish a network configuration when no DHCP is available – Step by step 331.5 AP discovering with Bonjour Services 341.6 What can I do if the Status LED of the AP-2010 access point doesn’t turn blue? 341.7 Labels don’t come online 341.8 The encryption does not work 351.9 Unlocking labels 351.10 Starting Java applications 351.11 Encoding problems 361.12 Further documentation 36
Quick Start Guide imagotag GmbHPage 4 of 36[Introduction]1 Electronic Shelf Labeling – A brief introductionAn electronic shelf label is a device that shows article data and price information on its display. Incomparison to printed labels the information is automatically updated if price or article datachanges.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 integ-rity – 100% correlation betweencash point 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 prof-itability maximize price per-formance and profit opportunities
Quick Start Guide imagotag GmbHPage 5 of 362 The G1 label familyThe imago G1 electronic shelf label family offers high-quality display options, operating with areplaceable battery and thus working with 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 2 inch to 7.4 inch. They may be used in landscape andportrait mode and can be customized with changeable front covers.(missing or bad snippet)2.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 Guide imagotag GmbHPage 6 of 363 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. Thanksto the perfect readability of the e-Ink displays and our outstanding wireless datatransmission technology you can implement all your sales, marketing, and logisticstrategies.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 Installation Guide with USB StickoESLServer: The ESLServer is a Java software that is required to manage the imag-otag access points and electronic shelf labels.oESLClient: The ESLClient is also Java based software. It’s a graphical user interface(GUI) for monitoring and for the configuration of the ESLServer. The ESLClient con-nects to the ESLClient. The server may be installed on the same machine or anyother machine that is accessible over the network.oTemplate Editor: To render images from article records on the ESLServer, the layoutmust be predefined in a template file. Therefor an editor to create and edit templatefiles with live preview based on example records is also on the imagotag USB stick.oOther documentation: Developer Reference, Image Rendering Reference andCSV/XML Import Pluginl1x Mounting PlateoMetal Mounting Plate for Mounting the AP-2010 on Walls, Ceilings or other Mounting-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 Guide imagotag GmbHPage 7 of 36[Getting Started]1 Latest Software and DocumentationAt the Customer Portal https://portal.imagotag.com you can view all your shipments, get accessto registration- and unlock codes, check the warranty status of your labels, download yourlicense files and access the latest software releases and documentation from this site.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. ESL Server <server.zip>2. 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 36lWindows XP, Windows 7, Windows Server 2008 (R2), Suse Enterprise Linux 11, Ubuntu 12(all 32/64-bit versions)limagotag Server/Client applications (2x .zip archives)limagotag AP-2010limagotag Labels and license files2.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).FIGURE 1-2: Unpack/Install imagotag Software FIGURE 1-3: Unpack/Install imagotag Software #2
Quick Start Guide imagotag GmbHPage 8 of 36#1
Quick Start Guide imagotag GmbHPage 9 of 36After 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 Server and Client-Start Server and Client.2.3 Customer PortalAt the Customer Portal you can view all your shipments, get access to registration- and unlockcodes, check the warranty status of your labels, download your license files and access the latestsoftware releases and documentation from this site.After user registration and activation you will have access to documentation and you canactivate, manage and download your imagotag software licenses see Activating License on page12. Your user account will not be assigned to a customer account yet. If assigned, you haveaccess to all shipments here including lists of label IDs, registration codes and unlock codes. Toget access there must be a completed order and your account needs to be verified (existingcustomer account required).
Quick Start Guide imagotag GmbHPage 10 of 363 Start Server and Client3.1 Starting ESLServerIn 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 (if the windowdoesn’t show up after all, make sure your Java installation and configuration is correct).FIGURE 1-5: ESLServer web management interfaceThe 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 ESLServer will automatically create a Derby1database. If anotherdatabase connection is needed or preferred, the connection parameters should be validated byimagotag.Note: As you can see there are several level numbers, by default the server instance will start inlevel 3. You can find the description of the different levels in the Developer Reference (which isalso available at the Customer Portal) under “Integration Levels”.3.1.1 Example articlesFor easier usage some example articles can be preloaded at the time you start the ESLServer.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 set thecorresponding 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 inJava
Quick Start Guide imagotag GmbHPage 11 of 363.2 Starting ESLClientGo to the extracted client directory and execute the “client.jar” file.FIGURE 1-6: 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!)FIGURE 1-7: Starting ESL Client with parameter
Quick Start Guide imagotag GmbHPage 12 of 363.2.1 ESLClient LoginlUsername: adminlPassword: adminFIGURE 1-8: ESLClient Login3.3 Activating LicenseAfter starting the ESLServer and Client it's necessary to activate the license which is included inthe "Software License Document". To view your current license status there's a License statusdialog. You can find it in the ESLClient under "Help - License status". Since no license isactivated/imported yet the window should look similar to this:FIGURE 1-9: License Status DialogCopy the "System serial" to the clipboard and then click the "License activation". You'll beautomatically redirected to the imagotag Customer 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 Guide imagotag GmbHPage 13 of 36FIGURE 1-10: Activate License (imagotag Customer Center)Download the generated license file and complete the licensing process by importing the licensefile to your ESLsystem. With the successful activation of your SmartBox demo license you'renow able to register and use up to five labels and one access point.FIGURE 1-11: Import of license file downloaded beforeNote: Press "F5"(after 15 seconds) to update the license status after license file import.
Quick Start Guide imagotag GmbHPage 14 of 364 Connect and configure Access Point AP-2010The AP-2010 by imagotag is the communication center in the store that transmits priceinformation to the labels. In order to ensure the communication between ESLServer, accesspoint AP-2010 and the labels the access point has to be configured at the start of theESLServer.One way to configure the access point is on the client.FIGURE 1-12: ESL Client Access Point Configuration4.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 management interface:URL: http://<host|ip>:8080Login: admin/adminImportant Note: In this part of the Quick Start Guide it is assumed that a DHCP server is present(you can find the steps to discover the access point without DHCP in the Troubleshootingsection at points Establish a network configuration when no DHCP is available – Step by step andAP discovering with Bonjour Services).
Quick Start Guide imagotag GmbHPage 15 of 364.1.1 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 ESLServer software on the computerlWhen the access point is booted up, the server will discovery it with an IP address (Note:The discovering process may take up to 2 minutes)lUse the ESLClient to connect to your ESLServerlUnder System – Access Point Status – the AP should be listed as discovered (after suc-cessful boot sequence)lOne Column of the AP should show now the IP addresslNow you’re able to configure the access point via AP-2010 web management interfaceunder http://<DHCP-IP-address> or a right click on the discovered AP –> Open inbrowser…In the status overview you get some details about the AP-2010:FIGURE 1-13: AP-2010 Status overviewIt’s recommended for the demo installation not to use the “Auto-Config” feature and configurethe AP manually.4.2 Necessary configuration over the AP-2010 web management interfaceThe following actions need to be performed over the web-GUI1. Deactivate Auto-Config: Administration -> Auto-Config2. Set up network details (or leave DHCP): Administration -> Network3. Set up a wireless channel: Administration -> Wireless
Quick Start Guide imagotag GmbHPage 16 of 36The AP-2010 supports 11 wireless channels. It’s recommended to choose one ofthe recommended channels: 3, 5, 8, 9 or 10. These channels do not interfere withstandard Wi-Fi channels 1, 6, 11 and are scanned by the labels more often Forfurther information about selecting channels see point Connect and configureAccess Point AP-2010.4.3 Necessary configuration at the ESL ClientAfter the configuration in the AP-2010 web management interface it’s necessary to add this APvia the ESL Client: System – Access Point Configuration – New …FIGURE 1-14: ESL Client AP configuration - System -> Access Pont Configuration -> NewChoose “Manual Configuration” if you don’t use Auto-Config and enter Access Point ID (AP ID)and IP address (Host).Note: After the basic configuration in the AP-2010 web management interface, it is also possibleto fill in AP-ID and AP-IP-Address automatically. For this choose "Create Configuration..." underSystem – Access Point Status - Right click on the discovered and configured Access Point.After saving the AP configuration you should see the AP under System – Access Point Status asONLINE. In addition the AP status LED should turn BLUE.
Quick Start Guide imagotag GmbHPage 17 of 364.4 Selecting channelsFor a working installation a channel must be selected on each access point in the network. Thereare 11 non overlapping ESL channels reserved for the communication with the labels. Five ofthese 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-Fiinstallation on the Wi-Fi channels 1, 6 and 11.FIGURE 1-15: 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 ESL channelsthat are least overlapping with the existing installation. If there is no ESL channel without anyoverlapping both the ESL and existing installation should still work but there might be a reducedoverall 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 be selectedon two access points if it can be guaranteed that every label is within the range of only one ofthese access points.4.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].
Quick Start Guide imagotag GmbHPage 18 of 365 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.5.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 ESLServer and usedby all access points connected to that server to encrypt data communication to the labels.A per-label communication key is transmitted to the labels during the registration of them. Eachlabel is assigned an individual registration code (it combines label ID and PIN code and it’s analphanumeric case-sensitive code with 11 characters). The ESLServer will than automaticallystart the key exchange with the label secured by the PIN extracted from the registration code.5.2 Set the encryption keyFirst step is to set the parameter “encryptionPassphrase“ under System – Configuration (you canchoose the encryption Passphrase on your own).FIGURE 1-16: 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 32).
Quick Start Guide imagotag GmbHPage 19 of 366 Register labelsIn order that labels can join the network it is necessary to register them first.6.1 General procedureVia the ESL Client under File – Register Labels it’s possible to register your labels manually withthe 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 23).FIGURE 1-17: Add/Delete Label and refresh entries6.2 What's on the label?All labels will arrive with its registration code (11-digit alphanumeric)shown on the display of thelabel. The code is printed as a 2D QR code, as a 1D Code128 barcode and as human readabletext. The registration process for the customer is easy – he has only to scan one of thisbarcodes. The ESLServer will than automatically start the key exchange with the label secured bythe 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 issimilar 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 Guide imagotag GmbHPage 20 of 366.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 therefore shouldnot be used for registration. They are only intended for the later article assignment (matchingprocess).Here you can see the registration dialog in the ESLClient where one single label has been enteredwith the registration code and the other one with the label ID (for old label versions < 3.0.0).FIGURE 1-18: Register labels dialog (registered with registration code and label ID)
Quick Start Guide imagotag GmbHPage 21 of 36Note: New versions of the ESLServer, ESLClient and AP-2010 (≥ 1.3.0) will also support oldlabels that do not come with a pre-programmed PIN code. New labels (≥ 3.0.0) will also work inold installations together with old labels but the ESLServer will not accept registration codesduring the registration process. To register the labels it is required to scan the barcode with thelabel ID from the backside or the bottom edge of the label. As the server will not start the keyexchange all data is transmitted unencrypted to the labels.6.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:FIGURE 1-19: ESL-App Home-ScreenFIGURE 1-20: ESL-App RegistrationPageFIGURE 1-21: ESL-App MatchingPage6.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 key as described in section Setup Security -Setup SecuritylUnsupported: Encryption is not supported by label firmwarelUnknown: Security status is not determined yet
Quick Start Guide imagotag GmbHPage 22 of 36FIGURE 1-22: Encryption status6.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 ESLClientselect File – Unlock labels and enter the unlock key.FIGURE 1-23: Unlock Labels DialogNote: The unlock-code for the specific labels is enclosed in the Smart Box (in an envelope).
Quick Start Guide imagotag GmbHPage 23 of 367 Start tagging7.1 What can I do now?As soon as labels are online you can do several things:lSend image to labellAssign tagslShow the current imagelPing labellReset label (reset display to show label ID and label ID barcode)lRefresh displaylSwitch to a preloaded pagelCreate a new matchinglSet filtersl…7.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 well asthe Page to which the image should be sent and whether the image is preloaded.B. When preloading, the image is placed in the memory of the label, but not yet dis-played. The image change will only be performed after the change to the relevantpage. 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.FIGURE 1-24: Send image to label
Quick Start Guide imagotag GmbHPage 24 of 367.3 Article managementFor complete management of your articles select Articles – All Articles in the ESLClient. Hereyou’re able to create/delete and edit your articles.The Smart Box comes with 4 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.FIGURE 1-25: Article management7.4 MatchingsThe logical link between an article and the label that shows the article information and price ofthis article is called matching. With a matching the layout of the image rendered for the label isalso defined by specifying the name of a template.In a more technical way a matching is the triple of:lLabel IDlArticle number or GTINlName of the template fileNote: Only one matching per label is allowed but a single article may be matched to more thanone label.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.
Quick Start Guide imagotag GmbHPage 25 of 36FIGURE 1-26: 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-27: Create a matching
Quick Start Guide imagotag GmbHPage 26 of 36It’s also possible to create Matchings with ESLClient under Labels and Articles, for this just selectthe desired article or label, right-click on it and select “New matching…” (the new matchingdialog will be pre-filled with the article or label information).7.5 Set filters for enumsIt's possible to set and combine several filters. Click on the drop down menu to see the differentchoices.FIGURE 1-28: ESLClient filter options7.5.1 Filter optionsThe 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.
Quick Start Guide imagotag GmbHPage 27 of 367.5 TemplatesThe template is used to specify the fields, which should be rendered into the image. TheESLServer can handle multiple templates.7.5.1 General information about templatesThe image rendering process is based on XSL (EXtensible Stylesheet Language) templates. Theindividual 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 document con-taining the fields, specified in this reference and values referenced from the XMLlRendering the image (*.PNG) based on the previous outputFIGURE 1-29: Input and result of the rendering process7.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 some inthe client’s directory under data/images.
Quick Start Guide imagotag GmbHPage 28 of 367.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 32).FIGURE 1-30: Starting the Template Editor7.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 articlerecords from our running server, see the following figure.FIGURE 1-31: Load Records from Server
Quick Start Guide imagotag GmbHPage 29 of 36After these steps your Template Editor window should look something like this:FIGURE 1-32: Template Editor with loaded records from server and default.xsl template file7.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-33: Enable Design Mode in Template Editor
Quick Start Guide imagotag GmbHPage 30 of 36After enabling the Design Mode a new tab will show up.FIGURE 1-34: Template Editor Design Tab7.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 = XXXand 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”>7.5.2.5 Help ContentThere’s a link to the Help content for the Template Editor, open it by clicking Help – Help Contentin the 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 RenderingReference.
Quick Start Guide imagotag GmbHPage 31 of 368 Integration8.1 Webservice integrationThe ESL server provides access to its interfaces methods through a RESTful web service API. Theweb service is designed according to the “Representational State Transfer” (REST) architecturalpattern.The ESL server 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 onlineunder https://portal.imagotag.com/get/documentation8.2 PluginsWe provide several plug ins which are used for importing article information into the ESL Server.You can find further information and documentation about our integration plug ins online underhttps://portal.imagotag.com/get/documentation8.3 Custom integrationFor custom integration we provide a Plugin-Interface. Software development service is availablefrom imagotag software development team or third-party integration partners.For pricing get in touch with our sales agents (sales@imagotag.com).
Quick Start Guide imagotag GmbHPage 32 of 36[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 webmanagement interface of 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 Error Codes”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 pixelsfor the 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 adifferent page14Could 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”, whichmeans it is very low on battery that in may notaccomplish the display update. Replace the batteryof 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.80 Error while writing task todatabase Check database connection92 Task type not supported Upgrade AP software to process this kind of task
Quick Start Guide imagotag GmbHPage 33 of 361.1 Running the ESLServer as a background serviceThe ESL server may be started as a normal application, but on a productive system it is usuallyrequired to have it automatically started without a user logged in. To achieve this the ESL servercan be registered as a Windows service. It is than started automatically without any graphics userinterface.To install the ESL server as a Windows service the batch file install_service.bat is provided. If thisfile is executed with administrator privileges (Right click – Run as Administrator) it will install theESL server 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 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 ESLServer is already installed as a Windows service you have to uninstall it first (unin-stall_service.bat) and reinstall it again (install_service.bat).1.2 Where can I find the license file for my SmartBox?You find the license file (which has to be activated at the imagotag Customer Portal enclosed inthe SmartBox in a "License Envelope".1.3 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.4 Establish a network configuration when no DHCP is available – Step bystep1. Set a laptops Ethernet adapter to DHCP2. Turn off all other network adapters (Wi-Fi)3. Connect to the same network as the AP-2010 (use a common Ethernet cable to connectyour device directly with the AP-2010)4. Start local ESL Server on laptop5. Use the ESL client to connect to your local server6. Under System – Access Point Status – the AP should be listed as discovered (after suc-cessful boot sequence – may take up to 2 minutes)lPress F5 on your keyboard or the refresh button in the ESL client to refresh theaccess point status (the Client doesn’t refresh the status automatically!)7. One Column of the AP should now show the IP address8. Open a browser, type in http://<discovered-ip>:8080 orlat the ESL client perform a right click on the discovered access point – Open inbrowser – Maintenance – StatusNote: Restart your access point if discovering process takes more than 2 minutes.
Quick Start Guide imagotag GmbHPage 34 of 36FIGURE 1-35: Restart and Factory Defaults button1.5 AP discovering with Bonjour ServicesYou still got problems to find your AP in your network? There's another workaround: You can useApple's "Bonjour Print Services".Download and install “Bonjour Print Services“ for Windows (pre-installed under OSX):http://support.apple.com/kb/DL999Note: After installation there’s 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 thefollowing 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 (customhostnames are only available on newer versions of the access point)1.6 What can I do if the Status LED of the AP-2010 access point doesn’tturn blue?lCheck the AP statuslCheck AP configurationoNo Channel setlCheck network reachability of APlAP registered to Server?lReboot AP1.7 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 ESL server installations at the same time. Itwill only connect to one of this installations.
Quick Start Guide imagotag GmbHPage 35 of 361.8 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.9 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 contact theimagotag support (support@imagotag.com).1.10 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.If 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“ tothe 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 notbe found) do the following steps:1. Locate your installation directory of your Java Runtime Environment2. Set JAVA_HOME VariableUnder 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 it
Quick Start Guide imagotag GmbHPage 36 of 36lClick 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.11 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.12 Further documentationPlease contact the support for further documentation:lDeveloper Reference (Web Service)lImage Rendering ReferencelCSV/XML Import PluginlFAQ

Navigation menu