Zebra AirWatch™ Connector User Guide P1058563-003
© 2013 ZIH Corp. The copyrights in this manual and the software and/or firmware in the print engine described therein are owned by ZIH Corp. and Zebra’s licensors. Unauthorized reproduction of this manual or the software and/or firmware in the print engine may result in imprisonment of up to one year and fines of up to $10,000 (17 U.S.C.506). Copyright violators may be subject to civil liability.
Apache Tomcat Copyright © 1999-2013, The Apache Software Foundation Sun, Sun Microsystems, Solaris, Java and JavaServer Pages are trademarks or registered trademarks of Oracle Corporation. UNIX is a registered trademark in the United States and other countries, exclusively licensed through 'The Open Group'. Microsoft, Windows, WindowsNT, and Win32 are registered trademarks of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds.
Notes • ____________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ _________________________________________________________
Contents About This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Introduction . . . . . . . . .
Contents Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SSL/TLS Certificate Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Other Typical Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About This Document This section provides you with contact information, document structure and organization, and additional reference documents. Contents Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 How This Document Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About This Document Who Should Use This Document Who Should Use This Document This User Guide is intended for use by any person who needs to install, perform routine maintenance, upgrade, or troubleshoot problems with the Zebra Airwatch Connector software. How This Document Is Organized The User Guide is set up as follows: P1058563-003 Section Description Introduction This section provides general information about the Zebra AirWatch Connector.
About This Document Document Conventions Document Conventions The following conventions are used throughout this document to convey certain information. Alternate Color (online only) Cross-references contain hot links to other sections in this guide. If you are viewing this guide online in .pdf format, you can click the cross-reference (blue text) to jump directly to its location. Command Line Examples Command line examples appear in Courier New font.
About This Document Document Conventions Notes • ___________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ ______________
Introduction This section provides general information about the Zebra AirWatch Connector. Contents Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . What the AirWatch Connector Does . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Operating Systems . . . . . .
Introduction Overview Overview The Zebra AirWatch Connector partners with the AirWatch server to manage your Zebra Link-OS™ printers.
Installation This section outlines the system requirements for installation and provides specific details for the installation of Zebra AirWatch Connector. Contents Installing in a Windows Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Installing in a Windows Operating System Installing in a Windows Operating System Minimum System Requirements The Zebra AirWatch Connector supports the 32-bit or 64-bit versions of the following: • Windows Server 2008 • Windows Server 2008 R2 (also known as Windows 7 Server) Note • This system should be installed on a “clean” Windows Server. A clean system is one that does not already include Apache Tomcat™ or any other server software installation.
Installation Installation Steps Installation Steps Step 1: Install an AirWatch Server 1. Contact AirWatch. a. Contact AirWatch Customer Support to obtain an AirWatch version 6.3 or later installation. b. Obtain the AirWatch Endpoint URL from your AirWatch support representative. Note • The URL you will be searching for usually starts with the deviceservices server. Ask for the Zebra printer management URL. Example • https://airwatchportals.
Installation Installation Steps 2. Once Java is installed, the JAVA_HOME environment variable needs to be set. a. Open the Control Panel. b. Select System. c. See Figure 1. Click on Advanced system settings.
Installation Installation Steps d. See Figure 2. Click on the Advanced tab. e. Click on Environment Variables.
Installation Installation Steps f. See Figure 3. To create a new environment variable under System variables, click on New....
Installation Installation Steps g. See Figure 4. Enter the Variable name and Variable value shown below in the appropriate boxes. Figure 4 • New System Variable h. 10/31/13 Click OK to save the new system variable and value.
Installation Installation Steps i. See Figure 5. To edit the path variable under System variables, click on Edit....
Installation Installation Steps j. See Figure 6. Add the following lines to the end of the Variable value: C:\Program Files (x86)\Java\jre7\bin; C:\openssl\bin; Figure 6 • New System Variable k. Click OK to save the system variable and value. l. Navigate to www.zebra.com/linkos and download the Zebra AirWatch Connector. 3. Run install.exe. 10/31/13 a. You must accept the terms of the License Agreement to continue. b. Click Next.
Installation Installation Steps 4. Determine the location to install the Zebra AirWatch Connector. 5. Click Next. 6. The installer will fill in the Zebra Endpoint URL. Note • If the URL does not match your DNS server name, change the DNS name to your server name. Example • http://zserver.abccompanyinc.com/zebra_airwatch_connector/zebra/wakeup 7. Enter the AirWatch Endpoint URL (obtained during the AirWatch server installation). Note • The URL starts with the deviceservices server.
Installation Installation Steps 8. Enter the string XXXX-XXXX-XXXX-XXXX for the AirWatch Server token. 9. Enter the base Group ID for your company from your AirWatch installation. 10. Click Next.
Installation Installation Steps 11. Verify that the wizard summary file locations are correct as shown.
Installation Installation Steps 12. Click Install. 13. Click Done.
Installation Installation Steps Step 3: Set Up Zebra AirWatch Connector 1. Set up the Zebra AirWatch Connector within the AirWatch console. a. Open a web browser. b. Log into the AirWatch console. 2. Under Menu, select Peripherals > Printer Management (shown in red).
Installation Installation Steps 3. Under System Settings, select Print Server. 4. Select Add Zebra Print Server (see the preceding graphic and area in red). Note the HMAC token. (You will need the token later in this procedure.) 5. Enter your user information. 6. Enter the Zebra ServiceUID in the UID section.
Installation Installation Steps 7. Click Save. The Zebra server will be shown as Pending Registration. 8. On your server, navigate to the install location for Zebra AirWatch Connector (default is C:\Program Files\Zebra Technologies\AirWatch_Connector). 9. Go to the resources folder: .\apache-tomcat-7.0.33\webapps\zebra_airwatch_connector\resources 10. Open the zebraAirwatch.options file with any text editor. 11.
Installation Installation Steps Step 4: Create a Certificate 1. Create a directory named zebra_certs. This directory may reside anywhere you choose (desktop, etc.). 2. From the Start menu, run cmd.exe as the administrator. Opens a DOS prompt. 3. Navigate to your zebra_certs directory. Run the following commands from this directory: a. Type: set RANDFILE=.rnd b. On the command line, type openssl, and then press Enter. 4.
Installation Installation Steps 5. Email the certificate file (.csr file) to softpm@zebra.com. This certificate will be signed and sent back to you. Once you receive a signed copy, proceed to the next step. 6. Copy the zip file containing the signed certificate files to the zebra_certs directory. 7. Extract the signed certificate files into the same directory. Note • You should receive four certificate files: one that matches the one you sent and three with the names ZebraCAChain. 8.
Installation Installation Steps 11. Configure the Tomcat server to use the passkey (created in step 8) and the certificate file. a. From the %TOMCAT_INSTALL_LOCATION%\tomcat7.0.33\conf directory, edit the Tomcat server.xml file as follows: • where %TOMCAT_INSTALL_LOCATION%: your installation directory location b.
Installation Installation Steps 15. Open catalina.bat in a text editor. a. Find the line that sets the JAVA_OPTS: set JAVA_OPTS=%JAVA_OPTS% %LOGGING_MANAGER% b. Edit the JAVA_OPTS line (above) to read as shown below: set JAVA_OPTS=%JAVA_OPTS% %LOGGING_MANAGER% Djava.rmi.server.useCodebaseOnly=false c. Find the next line that sets the JAVA_OPTS: set JAVA_OPTS=%JAVA_OPTS% %LOGGING_CONFIG% - d. Edit the JAVA_OPTS line (above) to read as shown below: set JAVA_OPTS=%JAVA_OPTS% %LOGGING_CONFIG% Djava.
Installation Installation Steps Step 6: Test a Printer Request Settings from a Printer In this section, you will test a printer to verify that the AirWatch console is able to request the current settings from the printer. 1. Turn on the printer. 2. Log into the AirWatch console, if necessary. Note • Once you are logged in, the printer appears on your console after approximately 60 seconds. (See figure below.) 3. To see specific details about this printer, click on the Friendly Name of the printer.
Installation Installation Steps P1058563-003 10/31/13
Installation Installation Steps Receiving Alerts from a Printer In this section, you will test that the AirWatch console receives alerts from the printer. 1. Click the Alerts tab. 2. Open the media door on the printer. 3. Wait 10 seconds, and then refresh the AirWatch console display. You should see the Head Open alert with the orange exclamation mark in the Status column. 4. Close the media door on the printer. 5. Wait 10 seconds, and then refresh the AirWatch console display.
Installation Installation Steps Notes • ___________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ _______________________
Configuring Printers with WebLink This section describes basic, network, and firewall configurations for printers connected to Zebra AirWatch Connector. Contents Configuring Weblink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Basic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . When a Proxy Server is Part of the Network Configuration . . . . . . . . . . . . . . . . . . . . .
Configuring Printers with WebLink Configuring Weblink Configuring Weblink When any WebLink setting (with the exception of the logging settings) is adjusted either via SNMP, SGD, or JSON it is required that the printer be reset before the new value takes effect. The weblink.printer_reset_required setting will be set to "yes" if there are any settings that have been modified that require a printer reset.
Configuring Printers with WebLink Configuring Weblink • The proxy server port (optional) • The username and password for the proxy (optional) To supply the address of the proxy server (assuming a default port and no username/password), configure the proxy setting as follows: ! U1 setvar "weblink.ip.conn1.proxy" "https://my.internal.proxy/" In this scenario, the proxy address is my.internal.proxy and the scheme is HTTPS. The default port (1080) will be used.
Configuring Printers with WebLink Configuring Weblink Additional Firewall Configuration Some firewalls do not allow the first connection attempt for a device to be HTTPS, or they require newconnections to be made periodically in order to keep the initial connections intact. The weblink test branch was provided to address issues that typically arise because the printer is an unattended device.
Configuring Printers with WebLink Configuring Weblink The logging settings are atypical to the Weblink settings as they do not require the printer to be reset before taking effect. This does not mean that previous logging messages that would have been logged will appear when the max_entries setting is changed from zero (0) to a greater value. It means that any new logging messages will be logged from that point forward. Issue the following command to clear any log entries currently in the weblink.logging.
Configuring Printers with WebLink Configuring Weblink Notes • ____________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________
Using AirWatch Connector This section provides specific information about organizing and managing printers via Zebra AirWatch Connector. Contents Printer Discovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Organizing Printers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using AirWatch Connector Printer Discovery Printer Discovery When a new printer is powered on, it will automatically notify Zebra AirWatch Connector that it is operational. There are several methods to validate that the printer is operational, settings are available, and communication is active. • To determine if the settings are available, see Request Settings from a Printer on page 33. • To refresh the printer settings, click Device Query on the Printer Summary page.
Using AirWatch Connector Organizing Printers Organizing Printers After you see the printers on the AirWatch console, you may wish to organize or arrange groups of printers. These groups may be established based on location, role, or region. Create a Group 1. On the AirWatch console, select the Main Menu at the top left of the screen. 2. In the Configuration section, select Location & Groups. 3. Click on the Main Group link (on the left side of the screen).
Using AirWatch Connector Organizing Printers 4. Click Add Child Location Group. 5. Name the Location Group. 6. Enter the Group ID. Important • Even though the Location Group ID is not identified as required, you must fill in this field in order to group the Zebra printers. 7. Fill in the next three fields: a. Location Group Type b. Country c. Locale Y Note • You may change the fields: Internal Name and Display Name even though these and the other fields below them are auto-populated. 8.
Using AirWatch Connector Organizing Printers Add Printers to the Group 1. Navigate to the Printer Asset Management screen. 2. To add a printer to your new group, click on the Printer Friendly Name. 3. In the Device Details, select Admin > Change Location Group. 4. Click the Location dropdown menu, and select your new group. 5. Click Save. 6. Repeat step 1 through step 5 for all printers that you wish to include in the group.
Using AirWatch Connector Organizing Printers View the Location Group Dashboard 1. Navigate back to your Asset Tracking screen. 2. Click on the name of your new Location Group.
Using AirWatch Connector Profiles Profiles Using profiles is the preferred method to manage and ensure that printer settings within a group are the same. Create a Profile 1. From the Main Dashboard screen, click Printer Profiles. 2. From the Printer Profiles screen, click Add a New Profile.
Using AirWatch Connector Profiles 3. Fill in the name and description of the profile. 4. Select the Assignment Type from the dropdown menu. Note • Profiles consist of three Assignment Types: • • • Auto: the profile will be sent automatically to the printers within the Assigned Location Group. Optional: the profile will be assigned to the Assigned Location Group, but it must be manually sent to the group.
Using AirWatch Connector Profiles 8. Click Save. 9. Repeat step 6 through step 8 for all categories you wish to include in the profile. 10. Click Save & Publish. Note • The Save & Publish button will immediately send (“publish”) the settings to those groups with an Assignment Type of “Auto”. Manage a Profile 1. Navigate to the Asset Tracking Dashboard. 2. Click on the Printer Friendly Name. 3. Click on the Profiles tab. You will see all of the profiles that are available to be downloaded. 4.
Using AirWatch Connector Updating Printer Firmware and Files Updating Printer Firmware and Files You can use AirWatch to update printer’s operating system and object files. The steps are similar to managing a profile. Upload a File 1. From the Main Dashboard screen, click Printer Files. 2. From the Printer Files screen, click Add New File.
Using AirWatch Connector Updating Printer Firmware and Files 3. Fill in the name of the file. 4. Select the Assignment Type from the dropdown menu. Note • Profiles consist of three Assignment Types: • • • Auto: the file will be sent automatically to the printers within the Assigned Location Group. Optional: the file will be assigned to the Assigned Location Group, but it must be manually sent to the group.
Using AirWatch Connector Updating Printer Firmware and Files Manage a File 1. Navigate to the Asset Tracking Dashboard. 2. Click on the Printer Friendly Name. 3. Click on the Files tab. You will see all of the files that are available to be downloaded. 4. Click on Actions (see red box) to load the file immediately to the selected printer. 5. Validate that the Auto Assignment Type file has been sent to the printer by checking the Status Indicator.
Using AirWatch Connector Checking Printer Status Checking Printer Status Printer status is communicated to AirWatch via alerts. The following table identifies the current alerts managed by AirWatch Connector. Alert PAPER OUT RIBBON OUT HEAD TOO HOT HEAD COLD HEAD OPEN SUPPLY TOO HOT RIBBON IN REWIND CUTTER JAMMED HEAD ELEMENT BAD POWER ON CLEAN PRINTHEAD MEDIA LOW RIBBON LOW REPLACE HEAD BATTERY LOW RFID ERROR COLD START Description Paper is out. Ribbon is out. The printhead is too hot to print.
Using AirWatch Connector Checking Printer Status Notes • ___________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ __________________________________________________________________________ ______
Troubleshooting This section provides troubleshooting information about the Zebra AirWatch Connector. Contents Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using AirWatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Troubleshooting Troubleshooting Troubleshooting Installation Issue Reason Solution Error when starting Tomcat Various reasons can cause this error. See Apache Tomcat website — http://tomcat.apache.org/tomcat7.0-doc/index.html Tomcat Port conflict error There is another server trying to use the same port as Zebra AirWatch Connector on the computer. The default port is 443. Choose one of the following: • Stop the other servers using Windows services. • Change the port in Tomcat.
Troubleshooting Troubleshooting Using AirWatch Issue Reason Solution I add a printer to a Location Group. Once the printer is powered off and on, it is no longer associated with the original location group. Some settings are not stored until a profile is published to that printer. a. Create a generic profile for the I add a printer to a Location Group. I click Soft Reset on the AirWatch console and it is no longer associated with the original location group.
Troubleshooting SSL/TLS Certificate Errors SSL/TLS Certificate Errors Secure connections to the remote server present the opportunity for several errors when attempting to connect. The errors typically involve the certificates used when connecting via SSL or TLS. This section highlights some of the most common issues involving the certificates.
Troubleshooting SSL/TLS Certificate Errors Error Cause / Solution "SSL certificate problem: certificate is not yet valid" This error indicates that the remote server’s certificate was incorrectly issued or that the printer’s date and/or time are incorrect. Check that the printer’s date and time (rtc.date and rtc.time) are set correctly and that the certificate’s start and expiration date are valid.
Troubleshooting Other Typical Errors Other Typical Errors While SSL/TLS connection errors are the most common, there are issues that can arise that prevent a successful connection. This section highlights the most common issues. Error Cause / Solution "Read failed with an unexpected error" This message typically indicates that connection to the remote server was lost.
Troubleshooting Troubleshooting Troubleshooting Whenever troubleshooting a connection issue, the following questions should be answered to ensure the configuration is correct. 1. Is the printer connected correctly via Wireless or Ethernet? 2. Does the printer have a valid IP address? 3. Can I ping the printer’s IP address from a device on the same network as the printer? 4. Is the remote server URL in weblink.ip.conn1.
Troubleshooting HTTP Messages 17. Does the value in weblink.ip.conn1.location match either the Common Name or one of the names listed in the Subject Alternate Name of the remote server’s certificate? 18. Is the proxy server configured correctly and does the respective proxy server allow HTTPS connections via the HTTP CONNECT method? 19. Are there any HTTP authentication attempts when trying to connect that fail? 20. Are there any HTTP/1.
WebLink Set/Get/Do Commands This section describes the Set/Get/Do commands, parameters, and values that are available with Zebra AirWatch Connector. Contents Introduction to SGD Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . weblink.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . weblink.ip.conn[1|2].authentication.add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WebLink Set/Get/Do Commands Introduction to SGD Commands Introduction to SGD Commands For more specific information about SGD syntax and structure, see the Zebra Programming Guide section on Set/Get/Do Command Structure. To send SGD commands to a printer, use the Zebra Setup Utilities.
WebLink Set/Get/Do Commands weblink.enable weblink.enable Description This command indicates if one or more of the weblink connections are active. If there is more than one connection under the weblink branch (for example, weblink.ip.conn1) and if any of the .location values are set, then this SGD will be set to "on". If all connections are disabled (all connection .location values set to ""), then this value will be set to "off". ^JUF, ^JUS, ^JUN, ^JUA, and device.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].authentication.add weblink.ip.conn[1|2].authentication.add Description This command allows the user to add a single server/username/password triplet into the list of authentication entries. When the printer attempts to connect to the server (url specified in weblink.ip.conn[1|2].location) the server may require HTTP authentication (e.g. digest, basic, DNS, etc.). There may be multiple authentication requests along the route to the destination (e.g.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].authentication.add Commands Details setvar This command adds a single server/username/password triplet to the list of authentication entries. Format: • • ! U1 setvar "weblink.ip.conn1.authentication.add" "servername[ username][ password]" ! U1 setvar "weblink.ip.conn2.authentication.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].authentication.entries weblink.ip.conn[1|2].authentication.entries Description This command lists the server names added to the authentication entries list. Only the server names will be shown. The username and passwords will not be shown.The server names are separated by a \r\n so that each shows up on its own line. ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].authentication.remove weblink.ip.conn[1|2].authentication.remove Description This command allows the user to remove a single server/username/password triplet from the list of authentication entries. To remove an entry only the server name is supplied. If an invalid entry is supplied no action is taken. If the SGD is changed when the connection is enabled (weblink.ip.conn[1|2].
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].enable weblink.ip.conn[1|2].enable Description This command enables or disables the weblink IP connection #1. A side effect of setting this SGD to "on", the weblink.enable will also be set to "on". When this setting is set to "off", if the weblink.ip.conn2.enable is also "off", the weblink.enable will be set to "off".
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].location weblink.ip.conn[1|2].location Description This command assigns the URL of the server for this connection. The URL must follow the URL rules for the HTTP[S] protocol outlined in RFC2396 (http://www.ietf.org/rfc/rfc2396.txt). The setting will not take effect until the printer is reset. Changing this setting will set weblink.printer_reset_required to "yes". ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].maximum_ simultaneous_connections weblink.ip.conn[1|2].maximum_ simultaneous_connections Description This command indicates the maximum number of simultaneous connections that can be initiated by the printer. Via the main connection (the original connection initiated by the printer to the remote server), the remote server can request that additional connetions from the printer be initated (e.g.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].proxy weblink.ip.conn[1|2].proxy Description This command assigns the URL of the proxy for the connection. The proxy server protocol, port, domain, username, and password are all encoded into the URL via the format outlined in RFC2396 (http://www.ietf.org/rfc/rfc2396.txt). The username and password must avoid the invalid characters listed in RFC2396 (e.g. ':', '@', '/', etc).
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].proxy Commands Details do This command assigns the URL of the connection proxy. Format: • • ! U1 do "weblink.ip.conn1.proxy" "url" ! U1 do "weblink.ip.conn2.proxy" "url" Values: • Any valid URL up to 2048 characters • Expected URL format: [scheme://][user:pass@]domain[:port]/[path] • The URL will need to be built according to the server/proxy environment the printer is running within.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].retry_interval weblink.ip.conn[1|2].retry_interval Description This command sets the number of seconds between attempts to connect to the server URL provided in weblink.ip.conn1.location. If an attempt is unsuccessful or the connection is lost, the printer will wait 'retry_interval' seconds before attempting to connect again. ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].test.location weblink.ip.conn[1|2].test.location Description This command holds the URL for testing a connection to the internet. This is meant to assist users in debugging their printer's connection to remote servers when there are issues with the main weblink connection (conn1 or conn2). The URL must follow the URL rules for the HTTP[S] protocol outlined in RFC2396 (http://www.ietf.org/rfc/rfc2396.txt). ^JUF, ^JUS, ^JUN, ^JUA, and device.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].test.location Example • The test connection can assist the user in several ways/scenarios: 1. If the test.test_on value is set to "failure", any time the main weblink (conn[1|2].location) connection fails to connect then the test.location URL will be used. In this situation, an attempt will be made to contact the remote URL in test.location, using authentication and proxy configuration that is specified by the main connection. 2. If the test.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].test.retry_interval weblink.ip.conn[1|2].test.retry_interval Description This command determines how often, in seconds, a connection to the test.location URL should be attempted. This setting is only applicable when the test.test_on SGD is set to "interval" or "both". ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].test.test_on weblink.ip.conn[1|2].test.test_on Description This command determines when the test connection should be attempted. This assists in debugging the printer's connection to remote servers when there are issues with the main weblink connection (conn1 or conn2). ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting.
WebLink Set/Get/Do Commands weblink.ip.conn[1|2].test.test_on Example • The test connection can assist the user is several ways/scenarios: 1. If the test.test_on value is set to "failure", any time the main weblink (conn[1|2].location) connection fails to connect then the test.location URL will be used. An attempt will be made to contact the remote URL in test.location, using authentication and proxy configuration that is specified by the main connection. 2. If the test.
WebLink Set/Get/Do Commands weblink.logging.clear weblink.logging.clear Description This command clears the weblink log. Setting this value to anything will clear it, including an empty string. ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting. Supported Devices • iMZ 220™, iMZ 320™ • QLn220™, QLn320™, QLn420™ • ZT210™, ZT220™, ZT230™ Type setvar, do Commands Details setvar This command clears the weblink log entires. Format: ! U1 setvar "weblink.logging.
WebLink Set/Get/Do Commands weblink.logging.entries weblink.logging.entries Description This command returns the N number of entries in the weblink log, where N has a maximum value that is set by weblink.logging.max_entries. The weblink log is a collection of events related to connecting to a remote Link-OS™ server. The log entries range anywhere from general status to errors that prevented a successful connection.
WebLink Set/Get/Do Commands weblink.logging.max_entries weblink.logging.max_entries Description This command specifies the maximum number of individual log entries that will be stored in the weblink.logging.entries command. Important • Changes to this command are immediate and may result in some log entries being lost. If there are N log entries currently in the log, the user sets the max_entires to M, where M is less than N, the oldest (N-M) log entries will be removed. ^JUF, ^JUS, ^JUN, ^JUA, and device.
WebLink Set/Get/Do Commands weblink.logging.max_entries Example 1 • In this example, weblink.logging.max_entries is set to 3: [01‐04‐2013 08:40:45.659] [conn1.1] Received HTTP code 404 from proxy after CONNECT [01‐04‐2013 08:40:45.660] [conn1.1] Closing connection [01‐04‐2013 08:40:45.662] [conn1.1] Failed to connect (SP = 0, CU = 0, UW = 0, AC = 0, PC = 0) Example 2 • In this example, weblink.logging.max_entries is set to 2: weblink.logging.entries becomes: [01‐04‐2013 08:40:45.660] [conn1.
WebLink Set/Get/Do Commands weblink.printer_reset_required weblink.printer_reset_required Description This command retrives a "yes" or "no" value indicating whether any of the weblink settings have been modified. ^JUF, ^JUS, ^JUN, ^JUA, and device.restore_defaults do not have any affect on this setting. Supported Devices • iMZ 220™, iMZ 320™ • QLn220™, QLn320™, QLn420™ • ZT210™, ZT220™, ZT230™ Type getvar Commands Details getvar This command retrieves whether any of the weblink settings are modified.
WebLink Set/Get/Do Commands weblink.restore_defaults weblink.restore_defaults Description This command defaults, and saves, the weblink branch settings. Any value, including an empty string, will default the weblink branch settings. Note • The entire weblink branch of settings will be defaulted and the settings are saved; however, the weblink connections will not use the new settings until the printer is restarted (e.g. the weblink.printer_reset_required SGD will be "yes" after a default).
10/31/13 P1058563-003
Zebra Technologies Corporation Zebra Technologies Corporation 475 Half Day Road, Suite 500 Lincolnshire, IL 60069 USA T: +1 847 634 6700 Toll-free +1 866 230 9494 F: +1 847 913 8766 Zebra Technologies Europe Limited Dukes Meadow Millboard Road Bourne End Buckinghamshire, SL8 5XF, UK T: +44 (0)1628 556000 F: +44 (0)1628 556001 Zebra Technologies Asia Pacific, LLC 120 Robinson Road #06-01 Parakou Building Singapore 068913 T: +65 6858 0722 F: +65 6885 0838 http://www.zebra.com © 2013 ZIH Corp.
