Difference between revisions of "Zebra Cloud Connect Setup Guide"

From 42Q
Jump to navigation Jump to search
 
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
 +
<small>[[42Q_Cloud-Based_MES/MOMS|42Q Home]] > [[Tools|Tools]] > Zebra Cloud Connect Setup Guide </small><br/> &nbsp;
  
 
&nbsp;
 
&nbsp;
  
 +
&nbsp;
  
 +
&nbsp;
 +
<center>'''Tools'''</center> <center>'''Zebra Cloud Connect Setup Guide'''</center> <center>&nbsp;</center> <center>&nbsp;</center>
 +
&nbsp;
  
 +
&nbsp;
  
== Prerequisites(Android): ==
+
== <span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:"><span class="mw-headline" id="Prerequisites_.28Android.29:">Prerequisites (Android):</span></span></span></span></span></span></span></span></span></span></span> ==
  
 
*Port 9443 must be open on the printer's network.  
 
*Port 9443 must be open on the printer's network.  
 
*Install the Zebra Printer Setup Utilities app on your Android device.  
 
*Install the Zebra Printer Setup Utilities app on your Android device.  
 
*Print queue must be set up by 42Q. In order for 42Q to create the print queue, 42Q must know the UUID (Serial Number) of the printer, as well as the desired print queue name.  
 
*Print queue must be set up by 42Q. In order for 42Q to create the print queue, 42Q must know the UUID (Serial Number) of the printer, as well as the desired print queue name.  
*''[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]'' must be reachable from inside the customer's network, e.g. traffic to this address must be allowed through the customer's firewall.&nbsp;  
+
*The relevant URL(s) must be reachable from inside the customer's network, e.g. traffic to this address must be allowed through the customer's firewall.
**'''<u>NOTE</u>''': If testing in the uatportal.42-q.com environment, the Cloud Connect URL is ''[http://42qmesuat2.42-q.com:9443/zebra/weblink/ http://42qmesuat2.42-q.com:9443/zebra/weblink/]''    
+
**UAT:&nbsp;[https://zprintersuat.42-q.com:9443/zebra/weblink/ https://zprintersuat.42-q.com:9443/zebra/weblink/]  
 +
**Production:&nbsp;[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]
 +
**Medical: [https://medprod-zprinter.42-q.com:9443/zebra/weblink/ https://medprod-zprinter.42-q.com:9443/zebra/weblink/]   
 
*A Bluetooth enabled Zebra printer  
 
*A Bluetooth enabled Zebra printer  
  
Line 18: Line 27:
 
&nbsp;
 
&nbsp;
  
=== Configuration: ===
+
=== <span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:"><span class="mw-headline" id="Configuration:">Configuration:</span></span></span></span></span></span></span></span></span></span></span> ===
  
 
1. Ensure Bluetooth is Open the Zebra Printer Setup Utilities app on the Android Device.
 
1. Ensure Bluetooth is Open the Zebra Printer Setup Utilities app on the Android Device.
  
2. Select the printer from the list of nearby printers. 1. Select Connectivity Settings
+
2. Select the printer from the list of nearby printers.
 +
 
 +
3. Select Connectivity Settings
  
3. Select Wireless and follow the steps to connect to the wireless network.
+
4. Select Wireless and follow the steps to connect to the wireless network.
  
4. Select Available Files, then navigate to the configuration file on your Android device.
+
5. Select Available Files, then navigate to the configuration file on your Android device.
  
5. Select the file. The file will be sent to the printer.
+
6. Select the file. The file will be sent to the printer.
  
 
If successful, the printer should reboot and reconnect to the correct weblink address.
 
If successful, the printer should reboot and reconnect to the correct weblink address.
  
== Prerequisites (Windows): ==
+
&nbsp;
 +
 
 +
== <span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:"><span class="mw-headline" id="Prerequisites_.28Windows.29:">Prerequisites (Windows):</span></span></span></span></span></span></span> ==
  
 
*Port 9443 must be open on the printer's network.  
 
*Port 9443 must be open on the printer's network.  
*Zebra Setup Utilities must be installed on a local computer( Windows) and the printer must have an established communication method for Zebra Setup Utilities, e.g. USB, Bluetooth, etc. For more information and using/downloading the Zebra Setup Utilities application, see,&nbsp;[https://www.zebra.com/us/en/products/software/barcode-printers/zebralink/zebra-setup-utility.html https://www.zebra.com/us/en/products/software/barcode-printers/zebralink/zebra-setup-utility.html].  
+
*Zebra Setup Utilities must be installed on a local computer and the printer must have an established communication method for Zebra Setup Utilities, e.g. USB, Bluetooth, etc. For more information and using/downloading the Zebra Setup Utilities application, see,&nbsp;[https://www.zebra.com/us/en/products/software/barcode-printers/zebralink/zebra-setup-utility.html Zebra Setup Utilities Support].  
 
*Print queue must be set up by 42Q. In order for 42Q to create the print queue, 42Q must know the UUID (Serial Number) of the printer, as well as the desired print queue name.  
 
*Print queue must be set up by 42Q. In order for 42Q to create the print queue, 42Q must know the UUID (Serial Number) of the printer, as well as the desired print queue name.  
*''[https://zprinters.42-q.com:9443/zebra/weblink https://zprinters.42-q.com:9443/zebra/weblink]'' must be reachable from inside the customer's network, e.g. traffic to this address must be allowed through the customer's firewall.
+
*The relevant URL(s) must be reachable from inside the customer's network, e.g. traffic to this address must be allowed through the customer's firewall.
**'''<u>NOTE</u>''': If testing in the uatportal.42-q.com environment, the Cloud Connect URL is ''[http://42qmesuat2.42-q.com:9443/zebra/weblink/ http://42qmesuat2.42-q.com:9443/zebra/weblink/]''    
+
**UAT:&nbsp;[https://zprintersuat.42-q.com:9443/zebra/weblink/ https://zprintersuat.42-q.com:9443/zebra/weblink/]  
 +
**Production:&nbsp;[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]
 +
**Medical: [https://medprod-zprinter.42-q.com:9443/zebra/weblink/ https://medprod-zprinter.42-q.com:9443/zebra/weblink/]   
  
 
&nbsp;
 
&nbsp;
  
=== Configuration ===
+
=== <span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2"><span class="mw-headline" id="Configuration:_2">Configuration:</span></span></span></span></span></span></span> ===
  
 
1. Open Zebra Setup Utilities.
 
1. Open Zebra Setup Utilities.
  
1. Select the desired printer. (This assumes that the printer has been configured in the Setup Utility. For information on how to&nbsp;
+
2. Select the desired printer. (This assumes that the printer has been configured in the Setup Utility. For information on how to setup a printer in Zebra Setup Utilities, refer to the video tutorials on the&nbsp;[https://www.zebra.com/us/en/support-downloads/printer-software/printer-setup-utilities.html Zebra Setup Utilities Support Page].
  
1. Select Open Communication with Printer. If connection with the printer is open, the command editor will allow you to Send to the Printer. Depending on the printer configuration, commands can be sent by ZPL, CPCL, or Set Do Go (SDG) commands.
+
3. Select Open Communication with Printer. If connection with the printer is open, the command editor will allow you to Send to the Printer. Depending on the printer configuration, commands can be sent by ZPL, CPCL, or Set Do Go (SDG) commands.
  
1. Send the following Set Do Go commands:
+
4. Send the following Set Do Go commands:
  
 +
&nbsp;
 +
 +
<code>! U1 setvar "weblink.ip.conn1.location" "[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]"&nbsp;</code>
  
<code>! U1 setvar "weblink.ip.conn1.location" "[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]"</code>
+
'''<u>Note</u>:''' This configuration must be done using the corresponding URL based on customer's environment (UAT, Production, and/or Medical) mentioned above in the Prerequisites.&nbsp;
  
 
<code>! U1 setvar "weblink.enable" "on"</code>
 
<code>! U1 setvar "weblink.enable" "on"</code>
 
<code>! U1 setvar "device.unique_id" "**UUID of your printer**"</code>
 
  
 
<code>! U1 setvar "device.languages" "hybrid_xml_zpl"</code>
 
<code>! U1 setvar "device.languages" "hybrid_xml_zpl"</code>
  
<code>! U1 do&nbsp;"device.reset" ""</code>
+
<code>! U1 setvar "weblink.logging.max_entries" "100"</code>
  
 +
<code>! U1 setvar&nbsp;"device.reset" ""</code> <!--
  
 +
If there are specific network needs, additional variable may be set.&#160;For example, the followings commands demonstrate the settings needed for connection using the specified DNS servers: &#160;(replace “8.8.8.8” and “domain_name.com” with the appropriate values for your network)
  
If there are specific network needs, additional variable may be set.
+
&#160;
  
For example, the followings commands demonstrate the settings needed for connection using the specified DNS servers: (_replace "8.8.8.8" and "domain_name.com" with the appropriate values for your network_)
+
<code>! U1 setvar "ip.dhcp.enable" "on"&#160;</code>
 
 
 
 
<code>! U1 setvar "weblink.logging.max_entries" "50"</code>
 
 
 
<code>! U1 setvar "ip.dhcp.enable" "on"&nbsp;</code>
 
  
 
<code>! U1 setvar "internal_wired.ip.protocol" "dhcp"</code>
 
<code>! U1 setvar "internal_wired.ip.protocol" "dhcp"</code>
Line 82: Line 95:
 
<code>! U1 setvar "weblink.ip.conn1.location" "[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]"</code>
 
<code>! U1 setvar "weblink.ip.conn1.location" "[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]"</code>
  
<code>! U1 do&nbsp;"device.reset" ""</code>
+
<code>! U1 setvar&#160;"device.reset" ""</code>
  
**<span style="text-decoration:underline;">NOTE</span>: **The UUID is the SN of the printer.&nbsp;
+
-->
**<span style="text-decoration:underline;">NOTE</span>: **There are many additional variables/commands than can be set/checked depending on a specific need or configuration. Please see, [Zebra Programming Guide]([https://support.zebra.com/cpws/docs/zpl/zpl_manual.pdf https://support.zebra.com/cpws/docs/zpl/zpl_manual.pdf]) for a list of commands and their descriptions.
 
  
If the commands were executed successfully, the printer will restart and automatically connect to the Zebra Web Service.
+
'''<span style="text-decoration:underline;">Note</span>:''' There are many additional variables/commands than can be set/checked depending on a specific need or configuration. Please see the [https://support.zebra.com/cpws/docs/zpl/zpl_manual.pdf Zebra Programming Guide] for a list of commands and their descriptions.
  
 
&nbsp;
 
&nbsp;
 +
 +
If the commands were executed successfully, the printer will restart and automatically connect to the Zebra Web Service. To view the weblink logs, send the following command:
 +
 +
<code>! U1 getvar "weblink.logging.entries" ""</code>
  
 
&nbsp;
 
&nbsp;
  
==== Check Zebra Web Socket Configurations ====
+
=== <span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations"><span class="mw-headline" id="Check_Zebra_Web_Socket_Configurations">Check Zebra Web Socket Configurations</span></span></span></span></span></span></span> ===
  
 
&nbsp;
 
&nbsp;
Line 109: Line 125:
 
&nbsp;
 
&nbsp;
  
=== Check the Network Connection ===
+
=== <span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection"><span class="mw-headline" id="Test_the_Printer.27s_Network_Connection">Test the Printer's Network Connection</span></span></span></span></span></span></span> ===
 
 
To determine whether ''https://zprinters.42-q.com:9443/zebra/weblink/'' is reachable from inside your network, execute the following tests.
 
  
 +
To determine whether ''[https://zprinters.42-q.com:9443/zebra/weblink/ https://zprinters.42-q.com:9443/zebra/weblink/]&nbsp;or ''[https://zprintersuat.42-q.com:9443/zebra/weblink/ https://zprintersuat.42-q.com:9443/zebra/weblink/]&nbsp;is reachable from inside your network, execute the following tests.
  
1. **) Ensure that [zprinters.42-q.com]([http://zprinters.42-q.com/ http://zprinters.42-q.com/]) can be resolved.**
+
'''<u>Note</u>''':&nbsp;This tests must be done using the corresponding URL based on customer's environment (UAT, Production, and/or Medical) mentioned above in the Prerequisites.
  
 +
1. Ensure that zprinters.42-q.com&nbsp;can be resolved.
  
From a linux terminal or windows command screen run the command
+
From a Linux terminal or Windows command screen run the following command:
  
&nbsp; &nbsp; _nslookup [zprinters.42-q.com]([http://zprinters.42-q.com/)_ http://zprinters.42-q.com/)_]
+
&nbsp; &nbsp; <code>nslookup zprinters.42-q.com</code>
  
 
If executed successfully, you should see external output like the following example&nbsp;:
 
If executed successfully, you should see external output like the following example&nbsp;:
  
_ Server: 127.0.1.1_
+
[[File:Nslookup Cloud Connect.png|RTENOTITLE]]
 
 
_ Address: 127.0.1.1#53_
 
 
 
_ [zprinters.42-q.com]([http://zprinters.42-q.com/ http://zprinters.42-q.com/]) canonical name = [42qmes1.42-q.com]([http://42qmes1.42-q.com/)._ http://42qmes1.42-q.com/)._]
 
 
 
_ Name: [42qmes1.42-q.com]([http://42qmes1.42-q.com/)_ http://42qmes1.42-q.com/)_]
 
 
 
_ Address: 52.22.186.27_
 
  
 
If this output is not seen, your DNS settings must be changed to resolve this host.
 
If this output is not seen, your DNS settings must be changed to resolve this host.
Line 137: Line 145:
 
&nbsp;
 
&nbsp;
  
1. **) Check the egress access of your network.**
+
2. Check the egress access of your network.
  
If a telnet utility is available then run the command&nbsp;:
+
If the Telnet utility is available, run the following command&nbsp;:
  
&nbsp;&nbsp; _telnet [zprinters.42-q.com]([http://zprinters.42-q.com/ http://zprinters.42-q.com/]) 9443_
+
&nbsp;&nbsp; <code>telnet zprinters.42-q.com 9443</code>
  
You should see a successful connection like the following example:
+
If the connection is successful, a response similar to the following example should display:
  
_ Trying 52.22.186.27..._
+
[[File:Telent Cloud Connect.png|RTENOTITLE]]
  
_ Connected to [42qmes1.42-q.com]([http://42qmes1.42-q.com/)_ http://42qmes1.42-q.com/)_]
+
If telnet is not found on a Windows system it can be made available with instructions from the following sites:
  
_ Escape character is '^]'._
+
*[https://social.technet.microsoft.com/wiki/contents/articles/38433.windows-10-enabling-telnet-client.aspx https://social.technet.microsoft.com/wiki/contents/articles/38433.windows-10-enabling-telnet-client.aspx]  
  
_ Type "ctrl-]" and then "q" to exit_
+
*[https://www.wikihow.com/Activate-Telnet-in-Windows-7 https://www.wikihow.com/Activate-Telnet-in-Windows-7]  
  
&nbsp; If telnet is not found on a windows system it can be made available with instructions from the
+
If external access cannot be achieved, the customer may need to modify their firewall configuration for egress access to the server.
  
&nbsp;&nbsp; following sites:
+
&nbsp;
 
 
&nbsp;&nbsp; [https://social.technet.microsoft.com/wiki/contents/articles/38433.windows-10-enabling-telnet-client.aspx [5]]([https://social.technet.microsoft.com/wiki/contents/articles/38433.windows-10-enabling-telnet-client.aspx https://social.technet.microsoft.com/wiki/contents/articles/38433.windows-10-enabling-telnet-client.aspx])
 
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -or-
+
== <span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links"><span class="mw-headline" id="Helpful_Links">Helpful Links</span></span></span></span></span></span></span> ==
  
&nbsp;&nbsp; [https://www.wikihow.com/Activate-Telnet-in-Windows-7 [6]]([https://www.wikihow.com/Activate-Telnet-in-Windows-7 https://www.wikihow.com/Activate-Telnet-in-Windows-7])
+
[https://www.zebra.com/us/en/support-downloads/knowledge-articles/zebra-setup-utilities--configuring-printer-settings.html Configuring Printers Settings] - Outlines using Zebra Setup Utilities for Windows to set Label, Media, and other printer settings.
 
 
If external access cannot be achieved, the customer may need to modify their firewall configuration for egress access to the server.
 
 
 
&nbsp;
 
  
== Helpful Links ==
+
[https://www.zebra.com/content/dam/zebra/manuals/printers/common/programming/zpl-zbi2-pm-en.pdf Zebra Programming Guide] - Printer Programming Command Index for ZPL, SGD, ZBI2, and other printers command languages.
  
https://www.zebra.com/us/en/support-downloads/knowledge-articles/zebra-setup-utilities--configuring-printer-settings.html
+
----
  
 
&nbsp;
 
&nbsp;

Latest revision as of 23:37, 3 November 2023

42Q Home > Tools > Zebra Cloud Connect Setup Guide
 

 

 

 

Tools
Zebra Cloud Connect Setup Guide
 
 

 

 

Prerequisites (Android):

For more information using the Printer Setup Utility for Android, see Printer Setup Utility for Android User Guide

 

Configuration:

1. Ensure Bluetooth is Open the Zebra Printer Setup Utilities app on the Android Device.

2. Select the printer from the list of nearby printers.

3. Select Connectivity Settings

4. Select Wireless and follow the steps to connect to the wireless network.

5. Select Available Files, then navigate to the configuration file on your Android device.

6. Select the file. The file will be sent to the printer.

If successful, the printer should reboot and reconnect to the correct weblink address.

 

Prerequisites (Windows):

 

Configuration:

1. Open Zebra Setup Utilities.

2. Select the desired printer. (This assumes that the printer has been configured in the Setup Utility. For information on how to setup a printer in Zebra Setup Utilities, refer to the video tutorials on the Zebra Setup Utilities Support Page.

3. Select Open Communication with Printer. If connection with the printer is open, the command editor will allow you to Send to the Printer. Depending on the printer configuration, commands can be sent by ZPL, CPCL, or Set Do Go (SDG) commands.

4. Send the following Set Do Go commands:

 

! U1 setvar "weblink.ip.conn1.location" "https://zprinters.42-q.com:9443/zebra/weblink/

Note: This configuration must be done using the corresponding URL based on customer's environment (UAT, Production, and/or Medical) mentioned above in the Prerequisites. 

! U1 setvar "weblink.enable" "on"

! U1 setvar "device.languages" "hybrid_xml_zpl"

! U1 setvar "weblink.logging.max_entries" "100"

! U1 setvar "device.reset" ""

Note: There are many additional variables/commands than can be set/checked depending on a specific need or configuration. Please see the Zebra Programming Guide for a list of commands and their descriptions.

 

If the commands were executed successfully, the printer will restart and automatically connect to the Zebra Web Service. To view the weblink logs, send the following command:

! U1 getvar "weblink.logging.entries" ""

 

Check Zebra Web Socket Configurations

 

! U1 getvar "ip.dhcp.enable"

! U1 getvar "internal_wired.ip.protocol"

! U1 getvar "internal_wired.ip.dns.servers"

! U1 getvar "internal_wired.ip.dns.domain"

! U1 getvar "weblink.ip.conn1.location"

 

Test the Printer's Network Connection

To determine whether https://zprinters.42-q.com:9443/zebra/weblink/ or https://zprintersuat.42-q.com:9443/zebra/weblink/ is reachable from inside your network, execute the following tests.

Note: This tests must be done using the corresponding URL based on customer's environment (UAT, Production, and/or Medical) mentioned above in the Prerequisites.

1. Ensure that zprinters.42-q.com can be resolved.

From a Linux terminal or Windows command screen run the following command:

    nslookup zprinters.42-q.com

If executed successfully, you should see external output like the following example :

RTENOTITLE

If this output is not seen, your DNS settings must be changed to resolve this host.

 

2. Check the egress access of your network.

If the Telnet utility is available, run the following command :

   telnet zprinters.42-q.com 9443

If the connection is successful, a response similar to the following example should display:

RTENOTITLE

If telnet is not found on a Windows system it can be made available with instructions from the following sites:

If external access cannot be achieved, the customer may need to modify their firewall configuration for egress access to the server.

 

Helpful Links

Configuring Printers Settings - Outlines using Zebra Setup Utilities for Windows to set Label, Media, and other printer settings.

Zebra Programming Guide - Printer Programming Command Index for ZPL, SGD, ZBI2, and other printers command languages.