Introduction
QZ Tray is a program that facilitates client-side printing through web browsers. This process will assist SDA with installing QZ tray on VIU computers.
Background and Definitions
What is QZ Tray
QZ Tray is a program that facilitates client-side printing through web browsers. The program enables web applications to send jobs to printers directly. This feature allows web applications to perform raw printing jobs, such as barcodes, without needing a browser-based plugin.
Why QZ Tray
Currently, barcode printing from web applications (SRS and VIUWeb/Student) requires a Java applet. All major vendors have dropped support for Java in web browsers; Mozilla Firefox ESR (extended support release) was the last to stop support in Fall 2018. QZ Tray replaces the reliance on Java for printing. Web browsers on a workstation can be safely updated to the latest version.
How Does QZ Tray Work
QZ Tray opens a connection, a web socket, on the client machine using standard TCP/IP communication. The web browser can then use this socket to send a formatted request with print job information. QZ Tray takes this request, processes it, and sends the job onto the printer. Communication with QZ Tray is done over HTTPS using one of VIU certificates, communications between the browser and the application are as secure as other web traffic which is sent via HTTPS.
Installation and Use
Some of VIU’s web applications already support QZ Tray, including SRS, VIUWeb - Student, and VIUWeb – Photo ID. Once installed, the ability to print with QZ Tray should be relatively seamless.
Installation from Software Center
- Start the Software Center from the shortcut on your desktop (or Company Portal on newer VIU laptops but installation will look different)
- Once started, you should see a list of available applications for installation as such:
- Click on the QZ Tray icon to select the application, and begin the installation by clicking the ‘Install’ button.
- Once installed, QZ Tray should start automatically and you can verify this by checking the system tray (bottom-right of the screen beside the clock):
Use of QZ Tray
QZ Tray should be work with current printing procedures. You may notice some interface differences inside the web applications, the barcode printing window in VIUWeb – Student, for example. You may also see pop-up notifications from the system tray when a print job is sent to and received by QZ Tray (these notifications can be disabled if you like).
Upon first use, or when using the VIU Testing site (https://testing.viu.ca) a dialogue from QZ Tray may pop up asking you to confirm communications. It is safe to allow and remember the connection.
Note for Firefox Users
If Mozilla Firefox is your browser of choice, an extra step is required to allow QZ Tray to function. The certificate we send printing data over HTTPS requires a security exception to be added within Firefox. This step is manual until an automated solution can be found or the issue with the certificate signing for QZ Tray with Firefox is resolved by either one of the vendors. To add the exception:
- Start Firefox if not already open
- Navigate to https://localhost:8181 – this is one of the web sockets QZ Tray communicates over
- You should be presented with a page similar to the one below:
- Click on the ‘Advanced’ button and a more detailed message will be displayed
- Click the ‘Add Exception…’ button, which will open another dialog window with the exception details:
- Verify that the address remains ‘https://localhost:8181/’ or ‘https://127.0.01:8181/’
- Click ‘Confirm Security Exception’
- The window will close and the page will reload, presenting new information. “QZ Tray” should be listed as the title under the product section.
Troubleshooting
- QZ tray cannot run on multiple sessions; only one person can be logged into the computer at one time. Ask users to perform a restart of the computer to ensure others are not logged in.
- “Printer connection failed” or other error:
- Printing a document or barcode failed:
- Ensure that QZ Tray is running – a green icon in the system tray
- Ensure that the printer is turned on and connected to the workstation (from the devices and printers area in Windows)
- Ask the client to test the printer using another piece of software or to use the printer on a colleges computer to see if it works
- If QZ Tray shows as not online in the web browser:
- Run QZ TRAY: Reset setting -- QZ Tray Reset Settings from the software centre (only)
- If the user enters y the script will clear out the %appdata%\qz folder and remove the cert_override.txt file from all firefox profiles within the user's appdata (C:\Users\usernamehere\AppData\Roaming).
- The printer want is not listed:
- QZ Tray allows printing to all installed printers on the client's machine, including OneNote and XPS Writer entries. Some of these options have been removed from the list, and one of the installed printers may have been erroneously removed. Please contact support, providing the exact name of the printer you expect to see listed.