MyQ Print Server Installation Guide

: June 16, 2024
: myQ

Table of Contents

MyQ Print Server
Product Information
Specifications
Table of Contents
Product Usage Instructions
Basic Information
System Requirements
Installation
Cleaning Cache and Temp folders
MyQ Web Interface
MyQ System Settings
- FAQ
Q: What is the purpose of the Print Server?
Q: How do I access the MyQ Web Interface?

MyQ Print Server

Product Information

Specifications

Product: Print Server
Revision: 11
Release Date: December/2023

Basic Information
MyQ Architecture
MyQ Servers and applications
Print Server from the OS process perspective
Network Communication Architecture
System Requirements
Installation
Installation in Private Cloud
MyQ Easy Config
Cleaning Cache and Temp folders
MyQ Web Interface
MyQ System Settings
External Reports
REST API Apps
Log Settings
Management of the Log Notifier Rules
System Management Settings
Disk space checker
History
Advanced
Security settings in config.ini
Security section

Product Usage Instructions

Basic Information

The Print Server is a device that allows users to connect and
share printers over a network. It is part of the MyQ Architecture
and integrates with MyQ Servers and applications. From the
operating system process perspective, it acts as a bridge between
the printer and the network, enabling printing capabilities.

The Network Communication Architecture of the Print Server
ensures seamless communication between printers, computers, and
other devices on the network.

System Requirements

Before installing the Print Server, ensure that your system
meets the following requirements:

Operating System: [Specify compatible operating systems]
Processor: [Specify minimum processor requirements]
Memory: [Specify minimum memory requirements]
Storage: [Specify minimum storage requirements]
Network: [Specify network requirements]

Installation

To install the Print Server, follow these steps:

[Step 1]
[Step 2]
[Step 3]
[Step 4]
[Step 5]

Cleaning Cache and Temp folders

To clean the cache and temp folders, perform the following:

[Step 1]
[Step 2]
[Step 3]

MyQ Web Interface

The MyQ Web Interface provides a user-friendly interface to
manage and configure the Print Server. To access the web interface,
follow these steps:

[Step 1]
[Step 2]
[Step 3]

MyQ System Settings

The MyQ System Settings allow you to customize various aspects
of the Print Server. To configure the system settings, follow these
steps:

[Step 1]
[Step 2]
[Step 3]

FAQ

Q: What is the purpose of the Print Server?

A: The Print Server enables users to connect and share printers
over a network.

Q: How do I access the MyQ Web Interface?

A: To access the MyQ Web Interface, follow the instructions
provided in the user manual.

Print Server
December/2023 Revision 11

Table of Contents

1
1.1 1.1.1 1.1.2 1.2
2
2.1 2.1.1 2.1.2 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.3 2.4 2.5 2.5.1 2.5.2 2.5.3 2.6
3
3.1
4
4.1 4.2 4.3 4.4 4.5 4.6 4.6.1 4.6.2 4.6.3 4.7

Basic Information …………………………………………………………………………….. 13
MyQ Architecture………………………………………………………………………………………………..13 MyQ Servers and applications ………………………………………………………………………………………..13 Print Server from the OS process perspective……………………………………………………………….15 Network Communication Architecture ………………………………………………………………16
System Requirements ……………………………………………………………………… 19
MyQ Print Server – Site mode (Central Server & Site Servers architecture)……….19 Site servers Hardware requirements up to 30 000 devices……………………………………………19 Recommendations ………………………………………………………………………………………………………….20 MyQ Print Server – Standalone mode …………………………………………………………………20 MyQ Print Server Hardware requirements up to 600 devices……………………………………….20 Recommendations ………………………………………………………………………………………………………….21 Storage ……………………………………………………………………………………………………………………………21 MyQ Desktop Client ……………………………………………………………………………………………………….22 Recommended no. of users and groups…………………………………………………………………………22 Operating System …………………………………………………………………………………………………………..22 Additional software required …………………………………………………………………………………………22 Web browser …………………………………………………………………………………………………………………..23 Security……………………………………………………………………………………………………………………………23 MyQ installation in Private cloud………………………………………………………………………..23 Installed parts and possible conflicts………………………………………………………………….24 Main Communication Ports…………………………………………………………………………………24 Incoming Ports………………………………………………………………………………………………………………..24 Outgoing Ports ……………………………………………………………………………………………………………….26 Embedded Packages Ports……………………………………………………………………………………………..28 Windows Server Performance Monitor ………………………………………………………………35
Installation……………………………………………………………………………………….. 38
Installation in Private Cloud………………………………………………………………………………..38
MyQ Easy Config ……………………………………………………………………………… 41
Services ……………………………………………………………………………………………………………….42 Passwords ……………………………………………………………………………………………………………43 MyQ Windows Services Account…………………………………………………………………………44 Data and Jobs Folders…………………………………………………………………………………………45 Security……………………………………………………………………………………………………………….. 46 Database Backup and Restore ……………………………………………………………………………47 Backing up MyQ data ……………………………………………………………………………………………………..47 Restoring MyQ Data ……………………………………………………………………………………………………….48 Importing settings from another MyQ installation………………………………………………………..49 Changing MyQ Web server ports………………………………………………………………………..49

4.8
5
5.1 5.2 5.3 5.4 5.4.1 5.4.2 5.5 5.6
6
6.1 6.2 6.3 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.4 6.4.1 6.4.2 6.4.3 6.5 6.5.1 6.5.2 6.5.3 6.5.4 6.5.5 6.5.6 6.5.7 6.5.8 6.6 6.6.1 6.6.2 6.6.3 6.6.4 6.7 6.7.1 6.7.2 6.7.3 6.8

Cleaning Cache and Temp folders ………………………………………………………………………50
MyQ Web Interface………………………………………………………………………….. 51
Accessing the MyQ Web Interface………………………………………………………………………51 Logging in as an administrator ……………………………………………………………………………51 Main menu and Settings menu……………………………………………………………………………53 Home Dashboard ………………………………………………………………………………………………..54 Quick Setup Guide…………………………………………………………………………………………………………..59 Generate Support Data…………………………………………………………………………………………………..60 MyQ Log ………………………………………………………………………………………………………………61 MyQ Audit Log …………………………………………………………………………………………………….64
MyQ System Settings ………………………………………………………………………. 66
Server Type Settings……………………………………………………………………………………………66 General Settings ………………………………………………………………………………………………….67 Personalization Settings……………………………………………………………………………………..68 Custom application logo…………………………………………………………………………………………………68 Terminal personalization………………………………………………………………………………………………..69 Dashboard custom message…………………………………………………………………………………………..70 Custom help ……………………………………………………………………………………………………………………70 Custom link in the MyQ Desktop Client …………………………………………………………………………71 Task Scheduler Settings………………………………………………………………………………………72 Running and setting task schedules……………………………………………………………………………….72 Providing rights for task schedules ………………………………………………………………………………..74 Automatic database and log backup………………………………………………………………………………74 Network Settings ………………………………………………………………………………………………..74 General ……………………………………………………………………………………………………………………………75 Communication Security…………………………………………………………………………………………………75 Outgoing SMTP Server……………………………………………………………………………………………………76 MyQ SMTP Server……………………………………………………………………………………………………………78 FTP Server……………………………………………………………………………………………………………………….78 MyQ X Mobile Client……………………………………………………………………………………………………….78 HTTP Proxy Server ………………………………………………………………………………………………………….79 Firewall ……………………………………………………………………………………………………………………………79 Connections Settings ………………………………………………………………………………………….79 Microsoft Exchange Online Setup ………………………………………………………………………………….80 Gmail with OAuth2 setup ……………………………………………………………………………………………….84 Azure AD with Microsoft Graph setup……………………………………………………………………………85 MyQ Smart Workflows ……………………………………………………………………………………………………89 Authentication Servers Settings …………………………………………………………………………99 Adding a new LDAP server: …………………………………………………………………………………………….99 Adding a new Azure AD Server: ………………………………………………………………………………….. 100 Adding a new Radius server:……………………………………………………………………………………….. 101 Accounting Settings ………………………………………………………………………………………….102

6.9 External Reports ……………………………………………………………………………………………….103

6.10 REST API Apps……………………………………………………………………………………………………104 6.11 Log Settings ………………………………………………………………………………………………………105 6.11.1 Management of the Log Notifier Rules………………………………………………………………………. 106

6.12 System Management Settings…………………………………………………………………………..107 6.12.1 Disk space checker ………………………………………………………………………………………………………. 108

6.12.2 History …………………………………………………………………………………………………………………………. 108

6.12.3 Advanced …………………………………………………………………………………………………………………….. 109

6.13 Security settings in config.ini…………………………………………………………………………….110 6.13.1 Security section …………………………………………………………………………………………………………… 111

7 Licenses ………………………………………………………………………………………….. 113

7.1 Adding licenses………………………………………………………………………………………………….113 7.1.1 Adding licenses on the Home screen ………………………………………………………………………….. 113

7.1.2 Adding licenses on the License settings tab ………………………………………………………………. 113

7.2 Activating Licenses ……………………………………………………………………………………………116 7.2.1 To manually activate a license:……………………………………………………………………………………. 116

7.2.2 Reactivating Licenses in case of Hardware change…………………………………………………….. 117

7.3 7.4 7.4.1

Deleting licenses ……………………………………………………………………………………………….118 Extending software assurance licenses…………………………………………………………….118 New licensing model (with Installation keys)……………………………………………………………… 119

7.4.2 Old licensing model (with license keys)………………………………………………………………………. 119

7.5 Migrating old licenses to MyQ X ……………………………………………………………………….120 7.5.1 Migration Process ……………………………………………………………………………………………………….. 121

7.6 VMHA License ……………………………………………………………………………………………………122

8 Printers…………………………………………………………………………………………… 124

8.1 Printers and Terminals settings ………………………………………………………………………..125 8.1.1 General ………………………………………………………………………………………………………………………… 125

8.1.2 MyQ X Mobile Client……………………………………………………………………………………………………. 126

8.1.3 Local Print Spooling…………………………………………………………………………………………………….. 126

8.1.4 Offline Login ……………………………………………………………………………………………………………….. 127

8.1.5 Terminal packages ………………………………………………………………………………………………………. 127

8.1.6 Terminal Actions Settings …………………………………………………………………………………………… 130

8.2 8.3 8.4 8.4.1

Manually adding printing devices ……………………………………………………………………..176 Configuration profiles……………………………………………………………………………………….177 Discovering printing devices……………………………………………………………………………..179 Automated printer discovery ……………………………………………………………………………………… 179

8.4.2 To run a discovery and add printing devices: ……………………………………………………………… 180

8.4.3 Printer discovery general configuration …………………………………………………………………….. 181

8.4.4 Printer discovery actions …………………………………………………………………………………………….. 183

8.5 Activating and deactivating printing devices ……………………………………………………186

8.6 Deleting and undeleting printers ……………………………………………………………………..186 8.6.1 Deleting printers …………………………………………………………………………………………………………. 186

8.6.2 Undeleting printers …………………………………………………………………………………………………….. 187

8.7 8.7.1 8.7.2 8.7.3

Editing printers………………………………………………………………………………………………….188 Printer information and settings ………………………………………………………………………………… 189 Adding/removing printers to groups ………………………………………………………………………….. 191 Adding/removing printers to queues …………………………………………………………………………. 192

8.8 8.8.1 8.8.2

Printer groups……………………………………………………………………………………………………192 Creating printer groups ………………………………………………………………………………………………. 193 Deleting printer groups ………………………………………………………………………………………………. 194

8.9 8.10 8.11 8.11.1

Exporting and importing printers……………………………………………………………………..194 Monitoring network printers in offline mode…………………………………………………..195 Monitoring local printers…………………………………………………………………………………..196 Accounting on local printers……………………………………………………………………………………….. 196

8.12 Printer Events ……………………………………………………………………………………………………197 8.12.1 Events ………………………………………………………………………………………………………………………….. 197 8.12.2 Event Actions ………………………………………………………………………………………………………………. 199

8.13 8.13.1 8.13.2 8.13.3

SNMP profiles ……………………………………………………………………………………………………201 Adding and editing SNMP v1 and v2c profiles ……………………………………………………………. 201 Adding and editing SNMP v3 profiles …………………………………………………………………………. 203 Attaching SNMP profiles to printers…………………………………………………………………………… 204

9 Users ………………………………………………………………………………………………. 206

9.1 9.2 9.3 9.4 9.5 9.5.1 9.5.2 9.5.3 9.5.4

List of users ……………………………………………………………………………………………………….206 Automatic user registration………………………………………………………………………………207 Add users manually……………………………………………………………………………………………208 Deleting and undeleting users ………………………………………………………………………….209 Editing user accounts ………………………………………………………………………………………..209 User information and settings…………………………………………………………………………………….. 210 Adding/removing users from groups………………………………………………………………………….. 211 Queues tab overview…………………………………………………………………………………………………… 212 Selecting user delegates …………………………………………………………………………………………….. 213

9.6 9.7 9.8 9.9 9.9.1

Enable user profile editing………………………………………………………………………………..214 User groups ……………………………………………………………………………………………………….215 Exporting users………………………………………………………………………………………………….216 Securing MyQ users personal data ……………………………………………………………………217 Providing users with their personal data ……………………………………………………………………. 217

9.9.2 Anonymizing users………………………………………………………………………………………………………. 217

9.10 9.10.1 9.10.2 9.10.3 9.10.4 9.10.5 9.10.6 9.10.7

User import and synchronization………………………………………………………………………218 How does the user synchronization work? …………………………………………………………………. 218 User synchronization from LDAP servers……………………………………………………………………. 221 User synchronization from Azure AD with Microsoft Graph………………………………………. 229 User synchronization from CSV files …………………………………………………………………………… 232 User synchronization from Azure AD with SLDAP ……………………………………………………… 236 Using external authentication servers………………………………………………………………………… 237 Manual and scheduled synchronization run ……………………………………………………………….. 238

9.11 User Authentication ………………………………………………………………………………………….239 9.11.1 ID Card Management…………………………………………………………………………………………………… 239

9.11.2 Generating PIN ……………………………………………………………………………………………………………. 243

9.11.3 Password complexity ………………………………………………………………………………………………….. 245

9.11.4 External Authentication ……………………………………………………………………………………………… 246

9.12 Policies ………………………………………………………………………………………………………………249 9.12.1 Print job policies………………………………………………………………………………………………………….. 249

9.12.2 Printer policies…………………………………………………………………………………………………………….. 252

9.13 Rights…………………………………………………………………………………………………………………254 9.13.1 Providing users and groups with rights………………………………………………………………………. 255

9.13.2 Editing users’ rights …………………………………………………………………………………………………….. 255

9.14 Users Settings ……………………………………………………………………………………………………256

10 Queues …………………………………………………………………………………………… 259

10.1 List of queues…………………………………………………………………………………………………….259 10.1.1 Default queues ……………………………………………………………………………………………………………. 260

10.2 Queue types ………………………………………………………………………………………………………261 10.2.1 Direct queue type ……………………………………………………………………………………………………….. 261

10.2.2 Tandem queue type…………………………………………………………………………………………………….. 261

10.2.3 Pull Print queue type…………………………………………………………………………………………………… 261

10.2.4 Delegated printing queue type…………………………………………………………………………………… 262

10.3 10.4 10.5 10.6 10.6.1

Adding and deleting queues……………………………………………………………………………..262 Editing queues …………………………………………………………………………………………………..262 Online/Offline queues ………………………………………………………………………………………265 Personal Queues ……………………………………………………………………………………………….266 Activating the feature…………………………………………………………………………………………………. 267

10.6.2 Setting personal queues……………………………………………………………………………………………… 267

10.7 Advanced queue options…………………………………………………………………………………..268 10.7.1 General tab ………………………………………………………………………………………………………………….. 269

10.7.2 Job receiving tab…………………………………………………………………………………………………………. 269

10.7.3 Job processing tab………………………………………………………………………………………………………. 277

10.7.4 Job Scripting ……………………………………………………………………………………………………………….. 281

10.7.5 MyQ Desktop Client tab ……………………………………………………………………………………………… 296

11 Printing to MyQ ……………………………………………………………………………… 298

11.1 Print Driver Settings ………………………………………………………………………………………….298 11.1.1 Windows settings………………………………………………………………………………………………………… 298

11.1.2 MacOS settings……………………………………………………………………………………………………………. 300

11.2 Methods of Printing…………………………………………………………………………………………..302 11.3 Direct printing……………………………………………………………………………………………………303 11.4 Pull Print printing………………………………………………………………………………………………303

11.5 Delegated printing…………………………………………………………………………………………….304

11.6 Printing from email and from the MyQ Web UI ………………………………………………..304 11.6.1 Printing from the web UI setup…………………………………………………………………………………… 305

11.6.2 Printing from email setup …………………………………………………………………………………………… 305

11.6.3 Processing documents in Office formats……………………………………………………………………. 308

11.7 Printing via the MyQ X Mobile Client app …………………………………………………………310 11.8 Print from Chromebooks, Chrome and other Google apps………………………………311 11.9 AirPrint and Mopria Print Service ……………………………………………………………………..312 11.10 Microsoft Universal Print…………………………………………………………………………………..315 11.10.1 Setting up Universal Print in Microsoft Azure…………………………………………………………….. 315

11.10.2 Setting up Universal Print in MyQ ………………………………………………………………………………. 319

11.11 Client Spooling ………………………………………………………………………………………………….321 11.11.1 Windows settings………………………………………………………………………………………………………… 322

11.11.2 MacOS settings……………………………………………………………………………………………………………. 323

11.12 Device Spooling …………………………………………………………………………………………………326 11.12.1 Limitations…………………………………………………………………………………………………………………… 327

11.12.2 Setting up Device Spooling …………………………………………………………………………………………. 327

11.12.3 Print drivers for Device Spooling………………………………………………………………………………… 328

11.12.4 IP filters ……………………………………………………………………………………………………………………….. 329

11.12.5 Print languages supported by Device Spooling………………………………………………………….. 329

11.13 Offline Login ……………………………………………………………………………………………………..329 11.13.1 Offline Login setup……………………………………………………………………………………………………… 330

11.13.2 Offline Login ……………………………………………………………………………………………………………….. 331

11.13.3 Offline Login Limitations…………………………………………………………………………………………….. 331

11.14 Fallback printing………………………………………………………………………………………………..331 11.14.1 Windows settings………………………………………………………………………………………………………… 331

11.14.2 MacOS settings……………………………………………………………………………………………………………. 332

12 Jobs………………………………………………………………………………………………… 336

12.1 Jobs settings tab ……………………………………………………………………………………………….336

12.2 List of jobs …………………………………………………………………………………………………………338 12.2.1 Jobs display options ……………………………………………………………………………………………………. 338

12.2.2 Job status ……………………………………………………………………………………………………………………. 338

12.2.3 Favorite jobs………………………………………………………………………………………………………………… 339

12.3 Editing jobs………………………………………………………………………………………………………..339 12.3.1 Deleting jobs ……………………………………………………………………………………………………………….. 339

12.4 12.5 12.6 12.7 12.7.1

Job Parser ………………………………………………………………………………………………………….340 Notifying the admin and users about refused jobs…………………………………………..341 Jobs Preview ……………………………………………………………………………………………………..342 Job Archiving …………………………………………………………………………………………………….342 Setting up job archiving ………………………………………………………………………………………………. 343

12.7.2 Viewing archived jobs………………………………………………………………………………………………….. 343

12.8 Jobs via IPPS………………………………………………………………………………………………………344 12.8.1 IPPS via Windows ………………………………………………………………………………………………………… 345

12.8.2 IPPS via MacOS ……………………………………………………………………………………………………………. 346

12.8.3 IPPS via Chromebook ………………………………………………………………………………………………….. 346

12.8.4 IPPS via Linux ………………………………………………………………………………………………………………. 351

12.9 Job Privacy…………………………………………………………………………………………………………352

12.10 Watermarks ……………………………………………………………………………………………………….353 12.10.1 Creating, editing, and deleting watermark collections………………………………………………. 353

12.10.2 Adding, editing, and deleting watermarks …………………………………………………………………. 354

12.10.3 Attaching watermark collections to queues ………………………………………………………………. 356

13 Reports…………………………………………………………………………………………… 359

13.1 Report Types ……………………………………………………………………………………………………..359 13.1.1 Report Categories……………………………………………………………………………………………………….. 360

13.2 13.3 13.4 13.4.1

Reporting sources ……………………………………………………………………………………………..408 Report values description …………………………………………………………………………………408 Creating and editing reports …………………………………………………………………………….410 Editing a report……………………………………………………………………………………………………………. 410

13.4.2 Creating new aggregated columns …………………………………………………………………………….. 414

13.5 Generating reports ……………………………………………………………………………………………416

14 Connection to BI tools …………………………………………………………………… 418

14.1 Embedded Database Connection Configuration………………………………………………418 14.2 Creating Reports ……………………………………………………………………………………………….420 14.2.1 Manual Reports Creation…………………………………………………………………………………………….. 420

14.2.2 Reports creation via template import ………………………………………………………………………… 424

14.2.3 Report examples …………………………………………………………………………………………………………. 425

14.2.4 Database Views description………………………………………………………………………………………… 426

15 Scanning and OCR ………………………………………………………………………….. 437

15.1 Scan to Me …………………………………………………………………………………………………………437 15.1.1 Setting up the feature…………………………………………………………………………………………………. 437

15.1.2 Set the destinations for the MyQ users on the MyQ server……………………………………….. 438

15.1.3 Using the Scan to Me feature ……………………………………………………………………………………… 439

15.1.4 Scan email size limits …………………………………………………………………………………………………… 439

15.2 OCR ……………………………………………………………………………………………………………………440 15.2.1 Activation and setup……………………………………………………………………………………………………. 440

15.2.2 OCR processing …………………………………………………………………………………………………………… 442

16 Code Books…………………………………………………………………………………….. 443

16.1 16.2 16.3 16.3.1

LDAP Source Code Books ………………………………………………………………………………….444 Internal Code List ………………………………………………………………………………………………445 MS Exchange Address Book………………………………………………………………………………446 MS Exchange Server Configuration…………………………………………………………………………….. 447

16.3.2 Adding a new MS Exchange Code Book in MyQ …………………………………………………………. 448

16.3.3 Using MS Exchange Code Books on a MyQ scan profile …………………………………………….. 449

17 Credit ……………………………………………………………………………………………… 451

17.1 Activation and setup………………………………………………………………………………………….451 17.2 Manual credit recharge ……………………………………………………………………………………..453 17.2.1 Providing users with rights to recharge credit …………………………………………………………… 453

17.2.2 Recharging credit on the Credit Statement tab …………………………………………………………. 453

17.2.3 Recharging credit on the Users main tab ……………………………………………………………………. 454

17.3 17.3.1 17.3.2 17.3.3 17.3.4 17.3.5

Recharging credit by vouchers ………………………………………………………………………….455 Setting the voucher format ………………………………………………………………………………………… 456 Custom logo for Credit Vouchers ……………………………………………………………………………….. 456 Voucher Batches …………………………………………………………………………………………………………. 457 Providing users with rights to manage vouchers ……………………………………………………….. 458 Vouchers usage overview……………………………………………………………………………………………. 458

17.4 Recharging credit via PayPal……………………………………………………………………………..459 17.4.1 Setting up the PayPal payment option……………………………………………………………………….. 459

17.4.2 Recharging credit via PayPal on the user’s account on the MyQ Web Interface……….. 461

17.5 17.5.1 17.5.2 17.5.3

Recharging credit via WebPay…………………………………………………………………………..462 Setting up WebPay ……………………………………………………………………………………………………… 462 Setting up the WebPay payment option on the MyQ Web Interface ………………………… 462 Recharging credit via WebPay on the user’s account on the MyQ Web Interface …….. 463

17.6 Recharging credit via CASHNet…………………………………………………………………………464 17.6.1 Setting up the CASHNet payment option…………………………………………………………………… 464 17.6.2 Recharging credit via CASHNet on the user’s account on the MyQ Web Interface …… 467

17.7 Recharging credit via SnapScan ………………………………………………………………………..468 17.7.1 Setting up the SnapScan payment option ………………………………………………………………….. 468

17.7.2 Recharging credit via SnapScan on the user’s account on the MyQ Web Interface…… 469

17.8 17.9 17.9.1
17.9.2

Bulk credit recharge ………………………………………………………………………………………….469 Manual reset of users’ credit on the MyQ Web Interface…………………………………471 Resetting credit on the Credit Statement tab ……………………………………………………………. 471
Resetting credit on the Users main tab………………………………………………………………………. 472

17.10 Credit accounting reports …………………………………………………………………………………474

18 Quota……………………………………………………………………………………………… 475

18.1 18.2 18.3 18.4 18.4.1
18.4.2

Activation and general setup…………………………………………………………………………….475 Creating quotas …………………………………………………………………………………………………476 Editing quotas……………………………………………………………………………………………………476 Boosting quotas ………………………………………………………………………………………………..478 Boosting quotas on the Quota Boosts main tab ………………………………………………………… 478
Boosting quota of a particular user on the Users main tab ……………………………………….. 479

19 Projects ………………………………………………………………………………………….. 481

19.1 19.2 19.3 19.3.1

Projects activation and setup ……………………………………………………………………………481 Creating projects……………………………………………………………………………………………….481 Project management…………………………………………………………………………………………482 Managing project groups ……………………………………………………………………………………………. 483

19.4 19.4.1 19.4.2 19.4.3

Importing projects from CSV files …………………………………………………………………….483 Manually importing projects……………………………………………………………………………………….. 484 Setting up the Project synchronization scheduled task……………………………………………… 484 Syntax of the projects’ CSV file …………………………………………………………………………………… 485

19.5 Assigning projects to print jobs ………………………………………………………………………..486 19.5.1 Assigning projects in MyQ Desktop Client………………………………………………………………….. 486 19.5.2 Assigning Projects on the Jobs main tab ……………………………………………………………………. 487

20 Price List…………………………………………………………………………………………. 488

20.1 20.2 20.2.1
20.2.2

Adding price lists……………………………………………………………………………………………….488 Editing price lists ……………………………………………………………………………………………….488 Setting prices of print, copy, scan and fax services ……………………………………………………. 489
Attaching price lists to printing devices……………………………………………………………………… 490

20.3 20.3.1 20.3.2 20.3.3

Discounts …………………………………………………………………………………………………………..491 Creating a new discount ……………………………………………………………………………………………… 492 Editing a discount………………………………………………………………………………………………………… 492 Deleting a discount……………………………………………………………………………………………………… 493

21 System Health Check……………………………………………………………………… 494

22 Updating MyQ………………………………………………………………………………… 496

23 Uninstalling MyQ……………………………………………………………………………. 498

24 MyQ and MS Cluster ………………………………………………………………………. 499

24.1 24.2 24.3 24.4 24.4.1 24.4.2 24.4.3 24.4.4 24.4.5 24.4.6

About …………………………………………………………………………………………………………………499 System Requirements ……………………………………………………………………………………….499 Licenses ……………………………………………………………………………………………………………..500 Setup………………………………………………………………………………………………………………….500 Installing MyQ Print Server in the cluster (all nodes) …………………………………………………. 500 Setting services to manual startup (all nodes)……………………………………………………………. 501 Creating the MyQ server MS Cluster role (Failover Cluster Manager)……………………….. 502 Adding MyQ resources (Failover Cluster Manager) ……………………………………………………. 503 Setting resources dependencies (Failover Cluster Manager)…………………………………….. 505 Dependency Reports…………………………………………………………………………………………………… 509

24.5 Additional Setup………………………………………………………………………………………………..510 24.5.1 Setting up the MyQ admin credentials (active node) …………………………………………………. 510

24.5.2 Setting the location of the data folder (all nodes) …………………………………………………….. 510

24.5.3 Running MyQ in the MS Cluster environment…………………………………………………………….. 510

24.5.4 Starting the system (Failover Cluster Manager)…………………………………………………………. 511 24.5.5 Setting hostname of the MyQ server role ………………………………………………………………….. 511

24.6 24.6.1 24.6.2 24.6.3 24.6.4

Configuration and Maintenance ……………………………………………………………………….512 Bringing the resources of the MS Cluster online (Failover Cluster Manager)……………. 513 Taking the MS Cluster resources offline (Failover Cluster Manager) ………………………… 513 Restarting MyQ services via the MS Cluster (Failover Cluster Manager) …………………… 514 Changing the MyQ admin credentials (active node)…………………………………………………… 514

24.7 Backup and Restore…………………………………………………………………………………………..515 24.7.1 Backing up the MyQ database on the MS Cluster ………………………………………………………. 515

24.7.2 Restoring the MyQ database on the MS Cluster (all nodes) ………………………………………. 515

24.7.3 Using Database Encryption …………………………………………………………………………………………. 516

24.8 Upgrading MyQ …………………………………………………………………………………………………516 24.8.1 Necessary steps before the upgrade ………………………………………………………………………….. 516 24.8.2 Upgrading MyQ (all nodes) …………………………………………………………………………………………. 516 24.9 Recommended Troubleshooting ………………………………………………………………………517
25 Available languages……………………………………………………………………….. 518
26 Business Contacts ………………………………………………………………………….. 520

MyQ Print Server 10.1 RTM Check the below video with MyQ’s CTO introducing MyQ X version 10.1: https://www.youtube.com/watch?v=tELIhICH3No MyQ is a universal printing solution that provides a wide variety of services related to printing, copying, and scanning. All functions are integrated into a single unified system, which results in an easy and intuitive employment, with minimal requirements for installation and system administration. The main areas of application of the MyQ solution are monitoring, reporting and administration of printing devices; print, copy, and scan management, extended access to printing services via the MyQ Mobile application and the MyQ Web Interface, and simplified operation of printing devices via MyQ Embedded terminals. Here you can find all the information needed to install, configure, upgrade, and uninstall the MyQ® print management system, how to set up the system through the MyQ Web Administrator Interface, activate licenses, and set print ports. Furthermore, you can learn how to maintain the MyQ® system, acquire its statistical data, and monitor the print environment. All changes compared to the previous version are listed in the release notes, available online and in PDF.
12

Basic Information
1 Basic Information
Here you can find all the information needed to install, configure, upgrade, and uninstall the MyQ® print management system. It describes how to set up the system through the MyQ web administrator interface, activate licenses, and set print port. Furthermore, it shows how to maintain the MyQ® system, acquire its statistical data, and monitor the print environment. MyQ is a universal printing solution that provides a wide variety of services related to printing, copying, and scanning. All functions are integrated into a single unified system, which results in easy and intuitive employment with minimal requirements for installation and system administration. The main areas of application of the MyQ solution are monitoring, reporting and administration of printing devices – print, copy, and scan management- extended to printing services via the MyQ Mobile application, and the MyQ web interface and simplified operation of printing devices via MyQ Embedded terminals.
1.1 MyQ Architecture
1.1.1 MyQ Servers and applications
MyQ is a distributed system made of servers and client applications. The image below depicts a high level overview of all the components and main communication channels. Each component usually runs on its own computer be it a server, a PC, a mobile phone, or a printer.
13

Basic Information
The Central Server is responsible for Site Servers configuration, reporting, and licensing. Site Servers still need additional individual configuration. A Site Server is responsible for print job spooling, scan delivering, user interaction with printers, printer monitoring, and many more. MyQ Desktop Client is an additional application running on users PCs. It offers user authentication and identification, project and cost-center selection, local printers monitoring (mostly USB), client spooling and many other features. The OCR Server is used for Optical Character Recognition on scan jobs. An OCR server uses lots of resources, so it usually runs on its own machine.
14

Basic Information
The MyQ X Mobile Client is used for native printing on iOS, macOS, and Android devices. Mobile Print Agent gives users access to printers via AirPrint (for iOS), and Mopria Print Service (for Android smart phones or tablets). It usually runs on its own machine with access to a Wi-Fi network where mobile devices can discover it.
1.1.2 Print Server from the OS process perspective
In the image below, you can see what OS processes are running on a Print Server, and what the main communication channels are.
The heart of the system is the Print Server. It’s based on the WSF Platform MyQ’s platform for network services development. MyQ specific logic is implemented as Platform services, which are packaged in plugin*.dll files. These plugins are written in C++ and a few of them also in C#. WSF Platform also supports services implemented in PHP. PHP doesn’t support DLLs, so the platform services implemented in PHP are invoked via a set of php.exe workers. The Print Server also manages a set of Job Processor workers which are used for job parsing. The Job Processor is running as a process and not as a part of the Print Server, to avoid its failure in case of the Job Processor’s failure.
15

Basic Information

As a network server, Print Server Service is responsible for receiving print jobs via LPR, IPP, and other protocols. It also handles Messages, which is our pushnotifications engine. Messages are used to notify clients about events in the system.
Apache is an HTTP server for our Web UI and MyQ REST API. Both applications are implemented in PHP. Apache is maintaining a set of php-cgi.exe workers to handle execution.
HTTP Router is our reverse proxy through which all incoming HTTP based traffic flows. It’s main functionality is TLS termination.
Terminal Packages implement the embedded terminal for a specific vendor. They expose their own API used by the printers.
PM Server is a component created by Kyocera. It provides API to configure Kyocera devices and to install the embedded terminal application. PM Server uses the Thrift technology to implement its API. MyQ is also providing part of its API via Thrift, so PM Server can access it.
Many of the components use the Database Server to store data. Furthermore, many of the components including Firebird, store their data in the MyQ Data Folder which is located by default in C:ProgramDataMyQ. In production, this folder is typically located on a network drive.

Executable names
Friendly name

Executable name

Alternative names

HTTP Router

traefik.exe

Traefik

HTTP Server

httpd.exe

Apache

Database Server

firebird.exe

Firebird

Print Server

myq.exe

Kyocera Provider

knum.server.exe

PM Server

*Terminals

MyQ*Terminal.exe

Terminal Package

Job Processor *used for vendor name

MyQJobProcessor.exe

1.2 Network Communication Architecture
The image below depicts an overview of the components and main network communication channels.

Basic Information
MyQ –> License server: An external connection to the MyQ license server is required for license activation. (Old license model license.myq.cz, new license model license2.myq.cz). The connection is protected via 443 TCP. If a connection to the license server is not possible, there is also the possibility of offline activation. MyQ <–> Active Directory: User synchronization (LDAP/ Open LDAP) takes place via port 389 or 636 by default. MyQ –> Email Server: Scans/emails are first transmitted from the MFP to MyQ server. This server acts as a relay for emails and forwards the emails to the stored customer email server. The required ports are individual, depending on the corresponding settings of the customer email server. MyQ –> MyQ Web UI: HTTP protocol for accessing the MyQ web interface as well as communication with embedded terminals and job roaming between MyQ servers.: https//:serverhostname:8090 If needed, the unsecure connection can be enabled in MyQ Easy Config, using port 8080. MyQ –> Print job Release: The output of the print jobs from MyQ server to the MFP is done via RAW 9100 by default (can be changed if required LPR, IPP, IPPS, MPP, MPPS). The device status of the printing systems, as well as toner and ink stands, are read out via SNMP UDP 161. (SNMP protocol can be changed if required SNMP v1, SNMP v2, SNMP v3).
17

Basic Information
MyQ <– Scanning via MFP: All scans (email/folder) are done via port 25 by default, FTP port 21 if required. MyQ <– BYOD & MyQ Mobile App: For working with smartphones/tablets, both AirPrint/Mopria and MyQ Mobile App, port 8632 and 8090 are required. MyQ <– User Clients: Printing to a MyQ queue is done via a print object configured for this purpose. By default, printing to the MyQ server is done via LPR port 515.
18

System Requirements

2 System Requirements
The operating system and other software require their own additional system resources. The system requirements described below are only for MyQ solution.

2.1 MyQ Print Server – Site mode (Central Server & Site Servers architecture)

2.1.1 Site servers Hardware requirements up to 30 000 devices

1-10 devices

11-100 devices

101-300 devices

301-600 devices

601 – 30 000 devices

Physical

Core

RAM

6GB

8GB

12GB

14GB

Minimum number of servers

1x Central server 1x Site server

1x Central server More Site servers with max 600 devices each

Storage space

30GB

33GB 350GB

380GB 1TB

1,4T – 2TB 2TB per 600 devices

(calculated with AMD Ryzen Threadripper 1920X 3,5GHz)
For the MyQ Central Server Hardware specification, check the MyQ Central Server guide.
Valid for a typical use case:
· Print job spooling via Windows spooler or directly to MyQ print queue · Integrated Firebird database – installed automatically · Activated Job Parser · Activated Credit Accounting · Activated Quota · Activated Job Archiving · High number of Office documents printed via email/web/mobile · Use of MyQ Desktop Client (MDC) or
Use of MyQ Smart Job Manager (SJM) Use of MyQ Smart Print Services (SPS) · Watermarks used in queues

System Requirements
· Heavy usage of MyQ API · 170 users per device (up to 100 000 users total) · Heavy printing · 30% active user sessions at once · Embedded terminal installed on all devices · User synchronization from Central Server · Data replication to Central Server
2.1.2 Recommendations
· Install Windows updates out of working hours. · Always monitor the server performance during peak usage hours and adjust
the settings accordingly. · Changing the power plan of Windows Server in Control Panel Hardware
Power Options from Balanced (the default setting) to High performance is recommended to utilize the maximum performance. This may help speed up database operations.
It is possible to install MyQ Central Server and MyQ Site Server on one Server, but it is recommended only for small installations (small Site Server). In this case, the HW requirements for both MyQ Central and MyQ Site Server need to be taken into account.

2.2 MyQ Print Server – Standalone mode

2.2.1 MyQ Print Server Hardware requirements up to 600 devices

1-10 devices

11-100 devices

101-300 devices

301-600 devices

Physical

Core*

RAM

6GB

8GB

12GB

14GB

Storage space

30GB

33GB – 350 GB 380GB – 1TB 1,4TB – 2TB

*It is recommended to use +1 physical core if Credit/Quota is used. (calculated with AMD Ryzen Threadripper 1920X 3,5GHz)
Valid for a typical use case:
· Print job spooling via Windows spooler or directly to MyQ print queue

System Requirements

· Integrated Firebird database – installed automatically · Activated Job Parser · Activated Job Archiving · High number of Office documents printed via email/web/mobile · Use of MyQ Desktop Client (MDC) or
Use of MyQ Smart Job Manager (SJM)
Use of MyQ Smart Print Services (SPS) · Watermarks used in queues · Heavy usage of MyQ API · 170 users per device (up to 100 000 users total) · Heavy printing · 30% active user sessions at once · Embedded terminal installed on all devices

2.2.2 Recommendations
· Install Windows updates out of working hours. · Always monitor the server performance during peak usage hours and adjust
the settings accordingly. · Changing the power plan of Windows Server in Control Panel Hardware
Power Options from Balanced (the default setting) to High performance is recommended to utilize the maximum performance. This may help speed up database operations.

2.2.3 Storage
The MyQ Print Server installation files are approximately 700MB. The annual printing volume for 1 printer is approximately 10,000 jobs; it is possible to multiply this value for the particular number of printers.
MyQ data folder (jobs, main database, and log database increasing):

10k jobs

100k jobs

1M jobs

35GB

300GB

3,5TB

Counted for jobs with 2,9MB size.
By default, jobs are deleted every 7 days.
The Job archiving feature needs additional free space in data storage due to used configuration.
A dedicated disk for MyQ Data storage (jobs, main database and log database) is recommended.
During upgrades of the MyQ Print Server system, the actual size of the MyQ installation on the server (including MyQ database) may temporarily grow up to four times.

System Requirements
The size of the MyQ database depends on the size and complexity of your printing environment (number of users, printing devices, sent jobs etc.).
Storage performance · minimum 100 IOPS required. · RAID data storage supported. · for systems with a large number of direct queues, it is strongly recommended using SSD.
2.2.4 MyQ Desktop Client
If there are 100 – 1000 or more client computers using MyQ Desktop Client (MDC) (or MyQ Smart Job Manager (SJM) and/or MyQ Smart Print Services (SPS)), the MyQ Print Server requires 2+ physical cores just for the MyQ Desktop Client operations. The recommended configuration may vary according to the system load.
2.2.5 Recommended no. of users and groups
Users: up to 100,000 (30,000 – 60,000 per one synchronizing line). Depends on the length and number of fields for synchronization. Groups: up to 40,000/10 tree levels (group in group in group). Each user can be in up to 50 groups.
2.2.6 Operating System
Windows Server 2012/2012 R2/2016/2019/2022, with all the latest updates; only 64bit OS supported. Windows 8.1/10/11, with all the latest updates; only 64bit OS supported. Be aware of the connection limit of up to 20 clients (Windows EULA). For the trouble-free running of the machine, it is strongly recommended using a Windows Server OS.
2.2.7 Additional software required
· Microsoft .NET Core 6.0 · Microsoft .NET Framework (any version recommended by Microsoft) · For Windows Server 2022, it is necessary to install Server Core App
Compatibility Feature on Demand (FOD) ( https://docs.microsoft.com/en-us/ windows-server/get-started/server-core-app-compatibility-feature-ondemand )
22

System Requirements
It can be installed from PowerShell as a Windows Update using this command: ” Add-WindowsCapability -Online -Name ServerCore.AppCompatibility~~~~0.0.1.0 ” and then restart.
Microsoft .NET Core 6.0 is installed automatically at the beginning of the MyQ installation. If the installation fails, the installer cannot proceed, and the installation is terminated. In such cases, .NET Core 6.0 has to be manually installed prior to the MyQ installation. Microsoft .NET Framework is not automatically installed and needs to be installed prior to running the MyQ installation.
2.2.8 Web browser
· Microsoft Edge 91 or higher (Recommended) · Google Chrome 91 or higher · Mozilla Firefox 91 or higher · Apple Safari 15 or higher · Opera 82 or higher · Internet Explorer and MS Edge Legacy are no longer supported
WebSocket notifications only work with valid certificates in some browsers. Some MyQ features may have limited functionality without them, and it’s recommended to have them valid and installed on all client devices.
2.2.9 Security
DigiCert Global Root CA certificate (required for Installation Key license activation) https://www.digicert.com/kb/digicert-root-certificates.htm#roots. It should be included by default in the latest updated Windows versions. Supported Public Key Infrastructure for asymmetric cryptography.
Limitations:
· To make sure that the MyQ system runs smoothly, you need to set an exception for MyQ in your antivirus setup.
· MyQ should not be installed on a Domain Controller.
2.3 MyQ installation in Private cloud
MyQ can also be installed in Private Cloud. For requirements and further details, see Installation in Private Cloud.
23

System Requirements

2.4 Installed parts and possible conflicts
The installation file contains, besides the MyQ system itself, installations of a Firebird database server, an Apache web server, PHP runtime, and PM server. With the Scan Management function activated, the MyQ system uses its own SMTP server.
If there are other systems that run on the same server and use databases, web interfaces, PHP, or email servers, there is a risk of system conflicts. These conflicts can cause malfunctions on one or more of the systems. Therefore, we recommend you install MyQ on a server with a clean OS installation.
MyQ fully supports installation on virtual servers.
2.5 Main Communication Ports
If you need to adjust your firewall, it is recommended to allow MyQ processes in the firewall and not particular ports. If you allow particular ports, MyQ may stop working if:
1. you change port settings in MyQ, or 2. you upgrade to a newer version and the port specification has changed.
Terminal packages may use additional ports. Check the particular terminal package specification for details.
Make sure to create an exception that allows ICMP Echo Requests/Replies (Ping) through your Windows Firewall, as MyQ uses it by default to check the printers’ status.

2.5.1 Incoming Ports
The server is listening on the following ports (does not include private ports):

Protoc ol

Port

Configurable

Description

TCP

21 Yes (WebUI) FTP protocol for receiving scans. The server runs

only in passive mode and each data connection

runs over a dynamic port in the 49152 – 65535

range.

TCP

25 Yes (WebUI) SMTP protocol for Scan Management function,

receiving email notifications from printers, and

for receiving emails with jobs.

TCP

587 Yes (WebUI) SMTPS protocol. Used in the same scenarios as

SMTP.

System Requirements

Protoc ol

Port

Configurable

Description

TCP

515 Yes (WebUI) LPR protocol for print job transmission to the

MyQ server.

TCP

910 Yes (WebUI) RAW protocol for print job transmission to the

MyQ server.

TCP

863 Yes (WebUI) IPPS protocol for print job transmission to the

MyQ server.

TCP

863 Yes (WebUI) AirPrint/MOPRIA protocol for print job

transmission to the MyQ server.

TCP

809 Yes (Easy

HTTP protocol for accessing MyQ web interface,

Config)

communication with Embedded terminals and job

roaming among MyQ servers.

UDP

111 No 12

Communication with MyQ Desktop Client (MDC) former MyQ Smart Job Manager (SJM) and MyQ Smart Print Services (SPS). The answer is returned on a dynamic port in the 49152 – 65535 range.

UDP

111 No 08

Communication with old terminals (7.6 and older).

TCP

808 Yes (Easy

Upgrade only.

Config)

Obsolete HTTP protocol for accessing MyQ web

interface, communication with Embedded

terminals and job roaming among MyQ servers.

Can be removed in Easy Config and only 8090 can be used.

PM Server:

Protoc ol

Port

Configurabl e

Description

TCP

631 No

Port for Mobile print via IPP.

System Requirements

Protoc ol

Port

Configurabl e

Description

TCP

717 No

Port for Mobile print via IPPS.

TCP

909 No

909

Necessary for remote setup of Kyocera embedded terminals.

TCP

909 No

Felica reader

TCP

909 Yes (WebUI) Authentication / Authorization.

TCP

909 No

Driver access, mobile access.

TCP

909 Yes (WebUI) Spooler service.

TCP

909 Yes (WebUI) Log information event.

TCP

909 Yes (WebUI) Job status event.

TCP

909 Yes (WebUI) Thrift access.

TCP

910 No

User session service.

2.5.2 Outgoing Ports
The server is connecting to the following ports (does not include localhost connections):

System Requirements

Protoco l

Port

TCP

443

Description
· IPPS protocol for print job transmission from MyQ to printing devices.
· License activation server. The MyQ license server address is license2.myq.cz. The old MyQ license server address is license.myq.cz.
· Other enabled services from SettingsConnections (Microsoft Universal Print, One Drive, …)

TCP

515 LPR protocol for print job transmission from MyQ to printing

devices.

TCP

631 IPP protocol for print job transmission from MyQ to printing

devices.

TCP

910 Raw protocol for print job transmission from MyQ to printing

devices.

TCP

100 MPP/MPPS protocol for print job transmission from MyQ to

40 printing devices.

UDP

111 Communication with old terminals (7.6 and older). 08

You can also setup additional services that require further configuration and their port will often differ:

Protoco l

Port

Default

Description

TCP

Cust 110

Connection to email server via POP3 protocol for receiving jobs via email.

TCP

Cust 143/993 Connection to email server via IMAP/IMAPS

protocol for receiving jobs via email.

TCP

Cust 25/465/58 Connection to SMTP server for sending outgoing

om 7

emails from MyQ.

TCP

Cust 389/636/1 Connection to Authentication server(s) (LDAP,

om 812

Radius, …) for user authentication/synchronization.

System Requirements

Protoco l

Port

Default

Description

TCP

Cust 8093

Connection to MyQ Central Server.

UDP

Cust 161 om

SNMP protocol for communication with printing
devices. Answer from printer is returned on a dynamic port.

TCP

Cust –

Connection to External credit account.

MyQ can connect to dynamic ports in the following contexts:

Protoc ol

Port

Description

UDP

Dynami Communication with MDC (Former SJM and SPS). The port

range is 49152 – 65535.

2.5.3 Embedded Packages Ports
Kyocera

If SSL is on, it’s used for the following events:

Events are notified internally to the embedded application. No network communication is used.

MyQ Server
(Protocol: Port – Description)

· HTTP or HTTPS: 8090 (default) – it depends on the configuration in MyQ Easy Config.
· SMTP: 25 (default) – it depends on the port configured in MyQ, Settings, Network, SMTP. Used for Panel Scan to email)

System Requirements

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.
TCP: (OUT) 11108 – TCP link to device. Send request to Printers.
Kyocera 8.0+ A random TCP port is opened on each package service start/ restart, to be used for receiving scans over FTP. The package then tries to configure the Windows firewall to open the port for outside connections.

Printer
(Protocol: Port – Description)

TCP: (IN/OUT) 11108 – TCP link to device. Usage: Receive requests from Package.
TCP: (IN) 10040 – Usage: Use printer as a proxy for TCP communication.
UDP: (IN) 11108 in – UDP Link to device. Multipurpose. It dispatches all the received UDP packages. Usage: Receive requests to get local jobs.
UDP: (OUT) 11108 – Send broadcast to printers. GetJobs (Local Spooling)
TCP: (IN/OUT_ 10030 – TCP link to device. Usage: Receive requests or responses from other devices.
TCP: (IN) 10010 – Usage: Receive raw data of print jobs for local direct print job.
TCP: (IN) 10011 – Usage: Receive raw data of print jobs for local hold job.
TCP: (IN) 10013 – Usage: Receive raw data of print jobs for local delegate job.
TCP: (IN) 10020 – Usage: Receive raw data of print jobs for local LPR jobs.
TCP: (IN) 10012 – Usage: Receive raw data of print jobs for local pull print jobs (Pull Print).

Note: Other ports used by the printer (common for all printers. Eg. 9100 for raw printing, etc.).

System Requirements

If SSL is on, it’s used for the following events:

All types of events go through SSL

MyQ Server
(Protocol: Port – Description)

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.

Printer
(Protocol: Port – Description)

(OUT) 57627 – non SSL (OUT) 7627 – SSL

Toshiba

If SSL is on, it’s used for the following events:

All types of events go through SSL

MyQ Server
(Protocol: Port – Description)

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.

Printer
(Protocol: Port – Description)

(OUT) 49629, 50083 – non SSL (OUT) 49630, 50083 – SSL

Xerox

System Requirements

If SSL is on, it’s used for the following events:

Always SSL

MyQ Server
(Protocol: Port – Description)

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.

Printer
(Protocol: Port – Description)

HTTP: (OUT) 80 – Used to access to Xerox EIP
SNMP: (OUT) 161 – Used to set up the configuration of the printer.

Canon

If SSL is on, it’s used for the following events:

Events are notified internally to the embedded application. No network communication is used.

MyQ Server
(Protocol: Port – Description)

Package
(Protocol: Port – Description)

System Requirements

Printer
(Protocol: Port – Description)

TCP: 11108 – TCP link to device. Usage: Receive requests from Package.
TCP: 10040 – Usage: Use printer as a proxy for TCP communication.

Note: Other ports used by the printer (common for all printers. Eg 9100 for raw printing, etc.).

Ricoh

If SSL is on, it’s used for the following events:

Events are notified internally to the embedded application. No network communication is used.

System Requirements

Printer
(Protocol: Port – Description)

TCP: 49109 – sends live application logs from the device.
TCP: 11108 – TCP link to device. Usage: Receive requests from Package.
TCP: 10040 – Usage: Use printer as a proxy for TCP communication.
UDP: 11108 in – UDP Link to device. Multipurpose. It dispatches all the received UDP packages. Usage: Receive requests to get local jobs.
UDP: 11108 out – Send broadcast to printers. GetJobs (Local Spooling)
TCP: 10030 – TCP link to device. Usage: Receive requests or responses from other devices.
TCP: 10010 – Usage: Receive raw data of print jobs for local direct print job.
TCP: 10011 – Usage: Receive raw data of print jobs for local hold job.
TCP: 10013 – Usage: Receive raw data of print jobs for local delegate job.
TCP: 10020 – Usage: Receive raw data of print jobs for local LPR jobs.
TCP: 10012 – Usage: Receive raw data of print jobs for local pull print jobs (Pull Print).

Note: Other ports used by the printer (common for all printers. Eg 9100 for raw printing, etc.).

Sharp

If SSL is on, it’s used for the following events:

All types of events go through SSL.

MyQ Server
(Protocol: Port – Description)

System Requirements

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.

Printer
(Protocol: Port – Description)

Any port from the <0-65535> range.
Default:
· (OUT) 10080 – non SSL · (OUT) 10443 – SSL

Epson

If SSL is on, it’s used for the following events:

All types of events go through SSL.

MyQ Server
(Protocol: Port – Description)

Package
(Protocol: Port – Description)

HTTP: (IN) 8081 to 8089 (default) – It depends on the port selected during the installation of the package on the server. This is used only in localhost.

Printer
(Protocol: Port – Description)

· (OUT) 80 – non SSL · (OUT) 443 – SSL

Some of the above mentioned ports can be changed in case of conflicts with other applications.
Conflicts of the communication ports with other software will be revealed by the Windows socket error 10048 error message.

System Requirements
2.6 Windows Server Performance Monitor
You can use Windows Server Performance Monitor to gather system performance information that can help MyQ Support to troubleshoot MyQ server performance issues. The following procedures describe how to configure Performance Monitor to log processor, disk, and memory performance information, respectively. Enabling performance counters for processor, disk, and memory objects:
· Connect to the MyQ server, using an account with administrator rights. · On the Windows taskbar, select Start > Run. · In the Run dialog box, type perfmon , and then click OK. · In Performance Monitor:
In the panel on the left, expand Data Collector Sets. Right-click User Defined, and then select New > Data Collector Set in the contextual menu. In the first Create new Data Collector Set wizard dialog box:
In the Name box, type MyQPerformanceSet . Select Create manually (Advanced). Click Next. In the second Create new Data Collector Set wizard dialog box: Select Create data logs. Select the Performance counter checkbox. Click Next. In the third Create new Data Collector Set wizard dialog box: Click Add. In the dialog box that appears, in the Available counters list, successively select the following performance counters, clicking Add for each of them:
· Memory · PhysicalDisk · Processor Click OK. Click Finish.
35

System Requirements
When you are ready to start gathering performance information, in the main panel on the right, right-click MyQPerformanceSet, and then select Start in the contextual menu. When you are ready to stop gathering performance information, in the main panel on the right, right-click MyQPerformanceSet, and then select Stop in the contextual menu.
36

System Requirements
To review the logged performance information, in Windows Explorer, locate and double-click the .blg file indicated in the Output column in Performance Monitor. The Performance Monitor opens showing the collected data. Send the .blg file to MyQ Support.
37

Installation
3 Installation
This chapter shows you how to install the MyQ print management system.
Before you start the installation, make sure your system is up to date and meets the requirements as described in System Requirements.
1. Download the latest available version of MyQ from the MyQ Community portal. 2. Run the executable file. The Select Setup Language dialog box appears. 3. Select your language and click OK. The Select Destination Location dialog box
appears. 4. Select the folder where you wish to install MyQ. The default path is:
C:Program FilesMyQ. 5. Click Install. MyQ is installed on the server. 6. Click Finish. Depending on the OS settings on the server, you might be asked
to restart the computer. If you are asked to restart the computer, you need to do so in order to finish the installation. After the restart, the MyQ Easy Config application opens and the MyQ database is upgraded. If not, you can select to directly run the MyQ Easy Config application by keeping the Finish installation in MyQ Easy Config option selected.
3.1 Installation in Private Cloud
MyQ Server can be installed and run, besides on-premises servers, also on an Azure Virtual Machine, with a VPN tunnel connecting the physical network and Azure’s virtual network. Environment Requirements:
· The minimum recommended virtual machine is B4ms, with a dedicated (non system disk) standard HDD. The recommended CPU, RAM and HDD resources are the same as a standard installation and can be found in system requirements.
· VPN tunnel (100mbps line is recommended) connecting the physical network and Azure’s virtual network where the MyQ Server is installed.
· Outgoing communication on ports used by MyQ must be allowed on Azure’s Network security group. See main communication ports for a full list.
· The geolocation of the cloud server should be as physically close as possible. · The Ping answer from printers to the cloud server should be within 750 ms
(max 1 second, can be adjusted in config.ini)
For more information about Azure – Extend an on-premises network using VPN, see: https://docs.microsoft.com/en-us/azure/architecture/reference- architectures/ hybrid-networking/vpn#architecture
Once you set up the Azure virtual environment, follow the Installation instructions to install MyQ. About MyQ in Private Cloud
38

Installation
Customers using Microsoft 365 as a private cloud hosting their internal systems can add MyQ to the list of IT services they no longer need to have installed on an onpremises server. Part of the leased private cloud space can be dedicated to MyQ server(s), and MyQ running in Azure can make use of Azure Active Directories. The single sign-on feature already used by users to access applications in the Microsoft cloud can also cover cloud printing with MyQ, without the need to use a VPN connection.
MS Universal Print is also fully integrated in MyQ, offering mobility, quick printer discovery, and no need for a VPN connection. What is more, MyQ’s Universal Print connector can work with older devices, so there’s no need to invest into upgrading your fleet with more recent models which would natively support Universal Print.
39

Installation
A VPN tunnel connecting the physical network and Azure’s virtual network is also required when using Microsoft Universal Print. Thanks to this VPN tunnel, there is no need for a VPN connection from the client’s side to the MyQ Server.
40

MyQ Easy Config
4 MyQ Easy Config
This topic introduces the MyQ Easy Config application and briefly describes its main features. Furthermore, it guides you through the following basic procedures:
· how to manage MyQ services · how to change MyQ passwords · how to encrypt your MyQ data · how to relocate you Data and Jobs folders · how to back up and restore your MyQ database · how to change MyQ Web server ports · how to clean up your Cache and Temp folders The MyQ Easy Config application is the basic environment for the setup of essential parts of the MyQ server, such as the MyQ database. It automatically opens if you keep the Finish installation in MyQ® Easy Config option selected during the installation of the server. Otherwise, you can find it on the Apps screen in Windows 8.1+, Windows Server 2012 and newer. After you open the application, you see its menu on the left side. From this menu, you can access the following settings: · On the Home tab, you can quickly change the default passwords for the Server
and Database Administrator accounts, and generate data for support. You can also be redirected to the MyQ Web Administrator Interface to finish the server setup. · On the Services tab, you can view and control the MyQ services. · On the Settings tab, you can modify the Windows Services, Server administrator, and Database Administrator accounts, change file paths of the MyQ system data and jobs files, change the port configuration of the MyQ server, and clean up your Cache and Temp folders. · On the Security tab, you can enable/disable unsecure communication, and manage the MyQ DB, the Log DB, and print jobs encryption. · On the Database tab, you can view information about the Main and Log Databases, as well as backup, and restore your database. · On the Log tab, you can overview all the operations executed by the MyQ system. · On the About tab, you can view information regarding the current version of MyQ. · Lastly, you can select the MyQ Easy Config display language from the dropdown list. If there are no issues, the “It looks good here!” message is displayed on the Home tab:
41

MyQ Easy Config
4.1 Services
On the Services tab you can stop, start, and restart the services of the MyQ server.
42

MyQ Easy Config
4.2 Passwords
Once you open the MyQ Easy Config application for the first time, you should change the Server Administrator Account’s password, which is the password for accessing the MyQ web administrator interface.
The MyQ web administrator interface access user name is *admin and its default password is 1234.
Changing the password on the Home tab The first time you open the application, on the Home tab, you can see the Server Administrator Account section. To change the password, type the new password, confirm the password, and then click Save.
After you change the password for the first time, its initial setup section disappears from the Home tab. Changing passwords on the Settings tab As soon as you replace the default password, the section disappears from the Home tab and the password can no longer be changed there. It can be changed at any time on the Settings tab under the Server Administrator Account section. You can also change the database administrator’s account password under the Database Administrator Password section.
43

MyQ Easy Config
The MyQ database access user name is SYSDBA and its default password is masterkey.
Unlocking the MyQ Administrator account After 5 consecutive failed login attempts to the MyQ administrator account, the account is locked. The admin can see a warning that the *admin account is locked, and unlock it, in the Server Administrator Account section on the Settings tab. Once they click Unlock, the account is unlocked.
4.3 MyQ Windows Services Account
MyQ Windows Services run, by default, under the Local System account, meaning the account that was used during the installation. This can be changed in the Settings tab, in the Windows Services Account section:
· Under Log on services as, select Custom account. · Click on Browse, select the user account to be used for Windows services and
click OK. The selected user account should have “Local administrator” rights or be a member of the Local Administrators Group. It should also already have rights to “Log on as service”. · Type the account’s password and then confirm it in the next field. · Click Save. MyQ Services are automatically stopped and restarted.
· To change back to the default account, select Local System account, and click Save. MyQ Services are automatically stopped and restarted.
44

MyQ Easy Config
4.4 Data and Jobs Folders
On the Settings tab, you can see the folder locations of MyQ database and MyQ print jobs. The default folders are: C:ProgramDataMyQ for the database, and C:ProgramDataMyQJobs for the print jobs. Under normal circumstances, there is no need to change these locations. In case you have to do it, for example when there is not enough space on the system disk, follow the instructions below:
1. On the Settings tab, in the respective section, click Change Location. The Change folder location dialog box appears.
2. In the dialog box, under New folder, enter the path to the new folder or click the browser icon and find the folder location.
3. Under Change Operation, select the required method of existing data relocation, and then click Change location. Keep in mind that the server needs to be stopped during the change. The folder is moved to the new location.
If you relocate your Data and Jobs folder to a network drive, be aware that Apache or Firebird service cannot access network drives created by the Administrator or other users. The network drive needs to be created by the “nt authoritysystem” user. You can do this using this guide: https://stackoverflow.com/questions/182750/ map-a-network-drive-to-be-used- by-a-service/4763324#4763324 or it should work when you mount the drive on Windows startup.
45

MyQ Easy Config
4.5 Security
On the Security tab, you can enable/disable unsecure communication, and encrypt/ decrypt the MyQ DB, the Log DB, as well as print jobs. In the Web Server section, you should enable Allow unsecure communication only in case of communication problems. In the Data Encryption section, for better security, you can encrypt the main database, the log database, and print jobs using a certificate. MyQ does not provide these certificates. You should install and use your own. The certificate used for the encryption needs to have the “Encrypting File System” Enhanced Key Usage (EKU), it must be valid, and it must be located in one of the following computer certificate stores:
· Personal · Trusted Publishers · Third-Party Root Certification Authorities · Other people Once installed, it will be visible in the Certificate drop-down.
Click Encrypt next to MyQ Main Database, MyQ Log Database, or Print jobs. Scan Jobs are encrypted by default. During the encryption, other services will not be available. A busy indicator will let you follow the encryption/decryption process: After the encryption, the Encrypt button will change to Decrypt so you can reverse the action.
46

MyQ Easy Config
4.6 Database Backup and Restore
On the Database tab, you can check the main and log database’s status, perform backup and recovery, and import settings from a different MyQ installation. You can also see information about the current version of the database, available updates, and also a warning in case there is a need for an upgrade.
4.6.1 Backing up MyQ data
To back up your MyQ data: 1. Open the Database tab. 2. In the Main Database section, click Backup. 3. Provide and confirm a password to protect the backup. If skipped, the backup will be created unprotected. 4. A new backup file is created, called database_*.zip. The file contains the MyQ database and additional files with data used by the MyQ system, such as reports, certificates, or the config.ini file. Print jobs (by default in C:ProgramDataMyQJobs) are not part of the backup, because of size. If required (especially favorite jobs could be required by users after restoring MyQ on the new server), they must be copied and backed up manually or by a 3rd-party software.
47

MyQ Easy Config
4.6.2 Restoring MyQ Data
If you had manually backed up print jobs, then when restoring a backup, it is necessary to first copy the print jobs to the Jobs folder and then restore the MyQ backup using MyQ Easy Config. To restore your MyQ data: 1. Open the Database tab. 2. In the Main Database section, click Full Restore…. Select the database _*.zip file and click Open. If the backup is password protected, there is a prompt to provide the password. The database is restored and, if needed, upgraded as well.
48

MyQ Easy Config
4.6.3 Importing settings from another MyQ installation
This feature simplifies large-scale deployments as it allows using one MyQ installation as a “template” to set up more installations without the need to manually configure most of the settings. Creating a database template basics
· Use groups for any assignation such as Rights, Policies, etc. User and Printer groups are kept in contrast with specific users or printers.
What the import does During the import, the database is restored in the normal way, but the following data are changed:
· deleted users (groups are kept), · deleted printers (groups are kept) · deleted accounting data, · deleted jobs, · deleted payments, credit events, · deleted vouchers and voucher batches, · deleted quota boosts and quota periods, · deleted reports execution history, · deleted audit log records, · deleted sites, · new installation UUID, · updated hostname, · updated server name (if Site), · non archived price lists get new UUIDs, · MyQ license removed. Limitations · Terminal packages need to be reinstalled after the settings import. This
process is not automated. To import settings from a different MyQ installation:
1. Open the Database tab. 2. In the Main Database section, click Restore Settings…. Select your
“template” backup database _*.zip file and click Open. If the backup is password protected, there is a prompt to provide the password. The database is restored and, if needed, upgraded as well.
4.7 Changing MyQ Web server ports
On the Settings tab, under Web Server, you can change the port for the connection to the MyQ Web server:
· Port: communication port for the MyQ HTTP server; the default value is 8090.
49

MyQ Easy Config
4.8 Cleaning Cache and Temp folders
In the Server Maintenance section of the Settings tab, you can clean up your Cache and Temp folders. This might be necessary in cases when problems with the temporary files affect the MyQ system. To delete the two folders, click Start Cleanup.
50

MyQ Web Interface
5 MyQ Web Interface
This topic describes the MyQ Web Interface where you manage most of MyQ functions. It shows you how to access the web interface and the two menus where you can access all settings and functions on the web interface: the Main menu, and the Settings menu. Furthermore, it describes the web interface’s Home dashboard and shows you how to perform the initial MyQ setup. The last two sections introduce two MyQ logs: the MyQ Log and the MyQ Audit Log.
5.1 Accessing the MyQ Web Interface
To access the MyQ Web Interface, you need to open it in your web browser and log in as an administrator: There are three ways to open the MyQ Web Interface:
1. Open your web browser, and then enter the web address in the form: https://*MyQserver*:8090, where MyQserver represents the IP address or the host name of your MyQ server and 8090 is the default port for access to the server.
2. Log on to the interface from the MyQ Easy Config Home tab, by clicking on the MyQ Web Administrator link in the MyQ Web Administrator section.
3. Open the MyQ Web Administrator application. You can find this application on the Apps screen in Windows 8.1+, Windows Server 2012 and newer.
5.2 Logging in as an administrator
Enter the Server administrator name (*admin) and the password that you have set in the MyQ Easy Config application, and then click Log In. If you have not changed the default password yet (not recommended), enter the default one: 1234. In the drop-down at the top of the login window, you can select your preferred language.
51

MyQ Web Interface
Before logging in, you can click Theme to choose the theme for the interface. The options are: Synchronize with the operating system, Blue, Red (default), Dark, High Contrast. Click Lost PIN and you are taken to a window where you can either enter your email in order to receive a PIN reset code or if you already have the code, you can type it and reset your PIN.
52

MyQ Web Interface
5.3 Main menu and Settings menu
There are two menus where you can access all the features and settings of the MyQ server: the Main (MyQ) Menu and the Settings menu. In this guide, all the tabs accessed from the Main menu, except for the Home screen and Settings menu, are called main tabs as opposed to settings tabs that are accessed from the Settings menu. Main Menu To open the Main menu, click the MyQ logo at the upper-left corner of the screen. From there, you can access the Home dashboard, the Settings menu, and a number of tabs where you can manage and use MyQ functions.
53

MyQ Web Interface
Settings menu To open the Settings menu, click Settings on the Main menu. The tabs that are accessed from the Settings menu serve for the global setup of the MyQ server.
5.4 Home Dashboard
On the Home dashboard, you can perform the initial MyQ setup. After the setup, you can use the dashboard to directly access MyQ key features, display statistics, and generate support data.
54

MyQ Web Interface
The dashboard is fully adjustable; it consists of multiple building blocks (widgets) that can be added and removed from the screen. You can use the blocks to customize both the layout and functionality of the dashboard. By default, there are seven widgets on the dashboard: Quick Setup Guide, System Status, Total Pages (last 30 days), Environmental Impact, Updates, License, and Printers with Issue. Apart from these, you can also add the following widgets:
· Quick Links: From the Quick Links widget, you can directly access the most important tabs of the MyQ Web Interface: Jobs, Printers, Users, Reports, Settings, and Log.
· Top Active: Printers: Shows the most active printing devices. · Top Active: Groups: Shows the most active printing groups. · Top Active: Users: Shows the most active users. The Quick Setup Guide walks you through the initial MyQ setup. In System Status, you can see the following system status information:
55

MyQ Web Interface

Name
Pages printed today Pages copied today Pages scanned today Uptime Users
Printers
Recent warnings
Recent errors

Description
Number of printed pages over the last 24 hours. Cached every 60 seconds.
Number of copied pages over the last 24 hours. Cached every 60 seconds.
Number of scanned pages over the last 24 hours. Cached every 60 seconds.
MyQ system uptime, in hours.
Number of active users. Clicking opens the Users page overview.
Number of printers where the status is not: Local, replicated or deleted. Cached every 15 seconds. Clicking opens the Printers page.
Number of warning log messages over the last 24 hours. Cached every 30 seconds.
Number of error and critical log messages over the last 24 hours. Cached every 30 seconds.

In the Total Pages (last 30 days) widget, you can see a graph of the prints, copies, and scans in the last 30 days.
The Environmental Impact widget shows your environmental impact in Trees, CO2, and Energy. 1 tree = 8333 pages / 1 page = 12.7g of CO2 / 1 page = 48Wh of energy / 1 recycled page = 32Wh of energy
The Updates widget shows available updates for the MyQ installation and its components (terminal packages). To get the updates status, a valid license needs to be added to MyQ. Once a license is added, the MyQ administrator (or a user with the Manage settings rights) may see the following:
· LATEST – the currently installed version is the latest one · UPDATE AVAILABLE – there is a newer version in this branch

MyQ Web Interface
e.g. MyQ 10.1 patch 1 will show that MyQ 10.1 patch 2 is available e.g. 10.2 BETA will show that 10.2 BETA 2 is available e.g. Terminal 8.2 patch 23 will show the latest patch released for that 8.2 Terminal · DEPRECATED – this version is not being updated anymore, an upgrade path is recommended Shown currently only for Server components – Print and Central Server, not Terminal Packages. In the event that a license has been installed, the update information may not be immediately downloaded and displayed in the widget. If there is no information about updates, the “Check now” button is displayed in the widget. The administrator can manually initiate the retrieval of update information using this button.
The “Check now” button is only displayed if a license is installed. Without a license, the widget displays the message “Insert a license to get Update status”. If the server is offline or there are any errors, a warning is displayed on the widget.
The License widget shows license information and can redirect you to the License settings tab.
Printers with Issue shows unreachable active printers and active printers with unresolved alerts. You can also see these issues in the Issues column, in the Printers overview (MyQ, Printers).
Adding new widgets and moving widgets on the dashboard To add a new widget:
1. Click Tools at the top-right corner of the dashboard, and then click Add Widget. The Add Widget pop-up window appears.
57

MyQ Web Interface
2. In the pop-up, select the widget, and then click OK. The new widget is displayed on the board.
To move widgets, drag and drop them on the board. To delete widgets, click on the three dots at the top-right corner of the widget, and click Remove. Select Default layout in the Tools menu, to restore the dashboard to its default layout. Changing the theme To change the MyQ Web UI theme, click on Theme at the top-right corner of the dashboard. The available options are:
· Synchronize with the operating system · Blue · Red (default) · Dark · High Contrast
58

MyQ Web Interface
5.4.1 Quick Setup Guide
On the Quick Setup Guide widget, you can set the basic and most important features of the MyQ system: License Adding and activating licenses Click Enter License. The License settings tab opens. You are asked to enter the following information about your installation:
Then, Enter the installation key in the field and activate your licenses. You can also register in the MyQ Community portal and request for the free MyQ SMART license.
59

MyQ Web Interface
Administrator email By clicking Enter the administrator’s email, you open the General settings tab, where you can set the administrator email. Important system messages (disk space checker warnings, license expiration etc.) are automatically sent to this email.
Outgoing SMTP server By clicking Configure the outgoing SMTP server, you open the Network settings tab, where you can set the outgoing SMTP server.
Printers Adding printers:
· By clicking Discover Printers, you open the Printer Discovery settings tab, where you can discover and add printing devices.
· By clicking Add printers manually, you open the Printers main tab, where you can manually add printing devices.
Activating added printers: Click Activate to activate all the added printing devices.
Users · By clicking Add users manually, you open the Users main tab, where you can manually add users. · By clicking Import users, you open the Users synchronization settings tab, where you can import users from the MyQ Central server, from LDAP servers, or from a CSV file.
5.4.2 Generate Support Data
In case you encounter a problem that requires help from the MyQ support team, you may be asked to provide more information about your MyQ system configuration, licenses, printer devices, terminals, etc. In such case, you need to generate a MyQhelpdesk.zip file, which contains multiple files with all the necessary information, and send it to the MyQ support team. The .zip file includes the Logs folder which contains:
· error logs from Apache and PHP, · the MyQ log file log_dateandtime.xlsx, · the Windows Event log, · the statsData.xml file, · httperr*.log files, · and the MyQ-helpdesk.xml file with MyQ system information.
60

MyQ Web Interface
The MyQ log file corresponds to the MyQ log that can be displayed on the MyQ Web Interface or in the MyQ Easy Config application, but they differ from each other. To generate the MyQ-helpdesk.zip file:
1. Click Generate Support Data on the bar at the top of the Home dashboard. The Generate Support Data dialog box appears.
2. In the dialog box, specify the Day and the exact Time span of the MyQ events to include in the MyQ-helpdesk file, and then click Export. The file is generated and saved to your Downloads folder.
5.5 MyQ Log
In the MyQ server log, you can find information about all parts of the MyQ server: the MyQ server, MyQ Web UI, etc. Log messages are sorted into these types Critical, Error, Warning, Info, Notice, Debug, Trace and you can select the types that you want to be displayed. You can also set the log to display only messages informing about specific MyQ subsystems, such as the Web UI, remote printer setup, user sessions on MyQ terminals, and also about a specific context, for example, direct printing or a specific printing device.
61

MyQ Web Interface
The log is updated in real time, but you can pause it by clicking Watch live, and select to show messages from a specific time period, such as yesterday, this week, last week, last X hours, last X weeks, etc. Opening the MyQ Log On the MyQ Web User Interface, go to MyQ, Log, or on the Home dashboard, click Log on the Quick links widget. Pausing/Refreshing the log To pause or resume the real time run of the log, click Watch live on the bar at the top of the Log tab. To refresh the log up to the current moment, click Refresh on the same bar. Filtering the log: selecting time period, types of information, subsystem or context You can filter the log on the panel:
· After you pause the log, you can select the period in the Date combo box.
62

MyQ Web Interface
· The types can be selected and deselected on the panel at the right side of the Log tab.
· On the Subsystem combo box, you can select/type one or more subsystems to be displayed in the log.
· In the Context text box, you can type the context you want to view. After the filters are set, click Search to submit them. Exporting the log/Generating support data Click Tools on the bar at the top of the Log tab, and then select one of the following export options:
· Save as Excel — export the log as an Excel file. · Save as CSV — export the log as a CSV file. · Generate Support Data — generates a .zip file with multiple files for MyQ
support.
Highlighting log messages You can highlight particular log messages. To do so, select the message that you want to highlight and then press the SHIFT + SPACE keyboard shortcut.
To remove all highlights, click Tools on the bar at the top of the Log tab, and then click Remove highlighting.
63

MyQ Web Interface
5.6 MyQ Audit Log
In the MyQ Audit Log, you can view all the changes of MyQ settings, along with information about who made the changes, the time when they were made, and which subsystem of MyQ was affected by them.
Opening the MyQ Audit Log On the MyQ Web User Interface, click MyQ, and then click Audit Log. Filtering the Audit Log: selecting time period, user and type of event The displayed data can be filtered by a time period, the user who made the changes and the type of the event. To display additional information about a particular change, double-click the change. A panel with the detailed information opens on the right side of the Audit Log tab. Exporting the Audit Log You can export the Audit Log by clicking Tools and then Export on the main ribbon. The log is instantly generated and downloaded. You can also click Schedule Export to have the log regularly exported. The schedule’s properties panel open to the right, where you can set its parameters.
64

MyQ Web Interface 65

MyQ System Settings
6 MyQ System Settings
This topic discusses basic system settings of the MyQ system. The settings are located on separate tabs, accessed from the Settings menu:
· On the General settings tab, you can set the administrator email, change regional settings, and other general settings.
· On the Personalization settings tab, you can add custom help links and custom logos to be used in various parts of the MyQ system.
· On the Network settings tab, you can modify network settings such as certificates, server ports, etc.
· On the Authentication servers settings tab, you can add LDAP and Radius servers for user authentication.
· On the Task scheduler settings tab, you can add new task schedules, change their settings and run scheduled tasks.
· On the Log settings tab, you can set the Log notifier feature, which enables sending notifications about selected log events to the administrator and/or any number of MyQ users.
· On the System management settings tab, you can change settings of the MyQ history, set the maximum size of files that can be uploaded on the MyQ Web Interface, delete data from the MyQ database, and also reset MyQ components to apply settings previously made on other tabs.
6.1 Server Type Settings
In the Server Type settings tab, the MyQ administrator can set the type of server to use:
66

MyQ System Settings
· Standalone server – this is enabled by default. It corresponds to the MyQ Print server.
· Site server – this option can only be used within a MyQ Central server installation. Site name – add a name for your site server. Central Server address – add the Central server’s host name or IP address. Enable secure connection – enabled by default. The connection between the Central server and the Site servers is secure. Port – 8093 by default. Password for communication – password used for the communication between the MyQ Central server and Site servers. Embedded terminals – add the number of embedded terminal licenses to be used on this Site server (distributed by the Central server). Embedded Lite terminals – add the number of embedded lite terminal licenses to be used on this Site server (distributed by the Central server).
In older versions, in the Server type settings tab, it was possible to switch between the Standalone server, a Site server, or a Central server. This is no longer available, as the MyQ Print server and MyQ Central server are different products and use separate installers. If you have such a setup and plan to upgrade to MyQ Central server 8.2+, be advised that the upgrade will not be successful. It is required to upgrade your system to version 8.1, download the latest MyQ Central server installer, and migrate your setup (described in detail in MyQ Central Server).
6.2 General Settings
In the General settings tab. you can set the administrator email, time zone, default and additional languages, currency, and the column delimiter in CSV files.
67

MyQ System Settings
· Administrator email: The administrator email receives important system messages (disk space checker warnings, license expiration, etc.) automatically sent from MyQ.
· Time zone: For the proper functioning of the MyQ system, make sure that the time zone set here is the same as the time zone set in the Windows operating system. After changing the time zone, you will be asked to restart the web server.
· Default Language: The default language setting determines the language (list of available languages) of all emails that are automatically sent from MyQ and the language used on all connected terminals and interactive readers.
· Additional languages: You can set additional languages that will be used for custom fields. This way you can enter different names of the fields to be used in different languages.
· Currency: In the currency setting, you can enter the 3-letter currency code of the currency that you want to use in your pricelist. The Number of digits after the decimal point option can be set from 0 to 5 (default is 2).
· Column delimiter in CSV: The column delimiter in CSV files setting determines the delimiter in source and destination files used for all the import and export operations to and from the CSV file format. The default value is based on the regional settings of your operating system.
6.3 Personalization Settings
On this tab, you can set a custom message to be shown on the Web accounts of MyQ users, add links to your own custom help, add custom application logos to be used in MyQ, on MyQ terminals, and in MyQ Desktop Client, and personalize your terminals with the available themes.
6.3.1 Custom application logo
Here you can add your company’s logo to be used in the MyQ system. The logo will appear on the upper-right corner of the MyQ Web Interface, on MyQ credit vouchers, in MyQ Desktop Client, and on reports.
68

MyQ System Settings
Supported picture formats are JPG/JPEG/PNG/BMP and the recommended size is 398px x 92px. To import the logo, click +Add, Browse for the file and Open it, and then click Save at the bottom of the tab. A preview of the new logo is displayed on the tab.
6.3.2 Terminal personalization
Here you can add your company’s logo to be used on all your MyQ embedded terminals. Supported formats are JPG/JPEG/PNG/BMP and the recommended size is 340px x 92px. To import the custom logo, click +Add, Browse for the file and Open it, and then click Save at the bottom of the tab. A preview of the new logo is displayed on the tab.

To change the theme, select one of the available themes, click Activate, and then click Save.

Blue Ice

Cherry Blossom

Classic Purple Peace

MyQ System Settings
Coloured Rays
Spring Touch (Default)

You can also add your own Theme, however the MyQ Theme Editor app is needed for the creation of such a theme. Click Add, browse for the zip archive generated by MyQ Theme Editor, and click OK.
6.3.3 Dashboard custom message
Here you can enter a message to be displayed on the MyQ users web accounts. After you change the message, click Save at the bottom of the Personalization settings tab. The %admin% parameter can be used to display the email address of the MyQ administrator within the message (the Administrator email set on the General settings tab).
6.3.4 Custom help
Here you can add a link to your own web-based help that will be displayed as a widget on the user’s MyQ home page.
70

MyQ System Settings
To add a custom help link, enter the title and the link of your custom help, and then click Save at the bottom of the tab.
6.3.5 Custom link in the MyQ Desktop Client
Here you can add a link to your own web-based help (weblink, network path or local path) that will be displayed in MyQ Desktop Client.
To add the custom help link, enter the title and the link of your custom help, and then click Save at the bottom of the tab.
71

MyQ System Settings
6.4 Task Scheduler Settings
The Task Scheduler settings tab serves as an interface for planning regular tasks in MyQ®. There are seven predefined tasks: Database and settings backup, Log backup, System Health Check, History deletion, Printer Discovery, System maintenance, and User Synchronization. Apart from these, you can import projects from CSV files, add scheduled reports, and execute external commands. External commands are disabled by default. To enable them, switch the scheduleExternalCommand parameter in the config.ini file from 0 (disabled) to 1 (enabled).
6.4.1 Running and setting task schedules
To manually run a task schedule: · Select the task schedule that you want to run. · Click Run on the Task Scheduler toolbar.
Or · Right-click the task schedule. · Click Run on the shortcut menu.
To set a task schedule: Double-click the task schedule that you want to set (or right-click it, and then click Edit in the actions shortcut menu). The respective task schedule properties panel opens on the right side of the screen. The task schedule properties panel is divided into four sections:
72

MyQ System Settings
· In the uppermost section, you can enable or disable the schedule, enter its Name, and write its Description.
· In the Schedule section, you must set a period of Repetition for the task run and change the exact time of the task run start.
· In the Notification section, you can select to send an email notification. You must also choose if you want to send the notification every time or just in case of an error.
· The bottom section, if present, is particular to the type of task. After you set the schedule, click Save.
73

MyQ System Settings
6.4.2 Providing rights for task schedules
You can provide users with rights to change some task schedules settings themselves. To provide users with rights to change settings of a task schedule:
1. Double-click the schedule that you want to set. The respective schedule properties panel opens on the right side of the screen.
2. On the bar on the upper-left corner of the panel, click Rights. The Rights tab opens.
3. Click +Add user. The Select user or group dialog box appears. 4. Select the user or the group of users that you want to provide with the rights,
and then click OK.
6.4.3 Automatic database and log backup
There are two automatic backup tasks on the Task Scheduler tab. The database and settings backup and the log backup. The backup process is automatic. The files are compressed and saved to the Backup folder. Backup settings
· Destination folder: The folder that stores the backup data. · Backup Password: Password-protect the backup. If this field is left empty, the
created backup is unprotected. · Confirm Password: Confirm the above password. · Delete backup after ___ days: The days after which the data are deleted from
MyQ.
6.5 Network Settings
On the Network settings tab, you can manage the network communication between the MyQ server and other parts of the MyQ solution. It is divided into the following sections: General, Communication Security, Outgoing SMTP Server, MyQ SMTP Server, FTP Server, MyQ X Mobile Client, HTTP Proxy Server, Firewall, and PM Server.
74

MyQ System Settings
6.5.1 General
In this section, you can enter the hostname of the MyQ Print server. This hostname is used by external components of the MyQ system, such as embedded terminals or MyQ Desktop Client, for communication with the MyQ server.
During remote setup, the server hostname should be a valid hostname or IP address. A licenses update might change the hostname to myq.local. Then the remote setup will fail and result in an error message.
6.5.2 Communication Security
In this section, you can choose how your security certificates are managed. MyQ offers three different certificate management modes:
1. Built-in Certificate Authority – This is the default mode for new installations. MyQ creates a self-signed CA certificate and uses it to sign server and client certificates. The public key of the CA certificate can be exported (click the Export CA certificate button) to install it to clients, so they trust MyQ server. It is possible to specify the Subject Alternative Name (SAN), which is set as a comma separated list of domain names and/or IP addresses. In case the certificate is compromised, click the Generate new CA certificate button, to generate a new one.
2. Company Certificate Authority – Your company CA generates an intermediate CA certificate which MyQ uses to sign certificates for the server and clients. To
75

MyQ System Settings
generate an intermediate CA certificate click Create CSR to create a Certificate Signing Request (CSR), sign it by your CA and click Finish CSR to finish CSR by importing signed certificate. If the intermediate CA certificate does not contain a CA root certificate in its chain, the administrator is prompted to upload the public key of the CA root certificate as well (the Import CA root certificate button appears). 3. Manual Certificate Management – Provide a certificate for the MyQ Server. MyQ creates no certificates; all certificates are managed by you. Click Import Server certificate to upload it. The certificate can be uploaded in PEM (public + private key separately) or in PFX format. The PFX format may be password encrypted. This mode is recommended only for expert users.
When upgrading an existing MyQ installation, the Certificate Authority mode is selected according to the existing server certificate:
· if the certificate is not CA, then the mode is set to Manual Certificate Management.
· if it was generated by MyQ before, then the mode is set to Built-in Certificate Authority.
· in other cases, the mode is set to Company Certificate Authority.
6.5.3 Outgoing SMTP Server
To send email reports, send error messages to users, send automatically generated PIN to users, and forward scanned documents, you have to configure the email server where all the emails are forwarded to. To configure the server, do the following: Select a Type from Classic SMTP Server, Microsoft Exchange Online or Gmail. For Classic SMTP Server:
76

MyQ System Settings
1. Enter the server hostname or IP address in the Server text box. If the email server listens to other than the 25 TCP port, change the Port setting to the correct value.
2. Choose one of the available Security options. a. Prefer StartTLS – allows even unencrypted communication (default) b. Implicit TLS – allows only full encryption c. Require StartTLS – allows for the handshake to be unencrypted then switches to encrypted
3. Optionally choose to Validate certificate or not. 4. If credentials are required, enter the User and Password. 5. Enter the address that you want to be displayed as the Sender email on PIN,
alert and report messages. 6. After you enter the data, you can click Test to test the connection to the email
server, and click Save to save your changes. For Microsoft Exchange Online:
1. If you have already set up a Microsoft Exchange Online server in the Connections settings, the server is available in the Connections field dropdown. If not, you can click on the Connections field and then click Add new to add your Microsoft Exchange Online server connection. For more information, check Microsoft Exchange Online Setup.
2. If credentials are required, enter the User. 3. Enter the address that you want to be displayed as the Sender email on PIN,
alert and report messages. 4. After you enter the data, you can click Test to test the connection to the email
server, and click Save to save your changes. For Gmail:
1. If you have already set up a Gmail server in the Connections settings, the server is available in the Connections field drop-down. If not, you can click on the Connections field and then click Add new to add your Gmail server connection. For more information, check Gmail with OAuth2 Setup.
77

MyQ System Settings
2. If credentials are required, enter the User. 3. Enter the address that you want to be displayed as the Sender email on PIN,
alert and report messages. 4. After you enter the data, you can click Test to test the connection to the email
server, and click Save to save your changes.
6.5.4 MyQ SMTP Server
In this section you can view and modify the SMTP server settings. · SMTP (STARTTLS) – Enable when using unsecure communication or secure communication over STARTTLS. Port 25 by default. · SMTPS(SSL/TLS) – Enable when using secure communication over SSL/TLS. Port 587 by default.
If scanning to MyQ is enabled, set the port shown here in the device’s SMTP settings.
6.5.5 FTP Server
In this section, you can set the FTP server port that terminals use when sending scan jobs to MyQ over the FTP protocol. The FTP port is 21 by default, and the range is 0 to 65535. If you click the Generate new password button, there is a confirmation pop-up informing that if a new password is generated, all the terminals need to be reconfigured.
6.5.6 MyQ X Mobile Client
In this section, you can set the server hostname or IP address and the communication port for using the MyQ X Mobile Client application and MyQ Print Agent. They may differ from the general settings because mobile devices connect via Wi-Fi. Choose Use the same settings as on the LAN (hostname:port) to use the same settings as the MyQ server (default) or choose Use custom settings and add the Server and Secure port (SSL) you want to use.
78

MyQ System Settings
6.5.7 HTTP Proxy Server
In this section, you can set up a MyQ Proxy server which can be used for activating a license. Mandatory fields are Server (name) and Port. After changing ports, restart all MyQ services.
6.5.8 Firewall
In this section, you can Allow editing firewall rules of the Microsoft Windows Firewall and you can also Reset firewall rules.
6.6 Connections Settings
On the Connections settings tab, you can connect MyQ to external cloud services.
Click Add and select one of the following available services: · Microsoft Exchange Online · Gmail · Azure AD · SharePoint Online · Amazon S3 · OneDrive Business · Microsoft Universal Print
79

MyQ System Settings
· the MyQ and ScannerVision integration (embedded terminals and a MyQ Ultimate license are required)
6.6.1 Microsoft Exchange Online Setup
It is first needed to set up Microsoft Exchange Online in Microsoft Azure, and then configure it in MyQ. Microsoft Exchange Online setup in Microsoft Azure
1. Log in to the Microsoft Azure portal and go to App registrations.
2. Create a New registration:
3. Create an Azure application: a. Name – The name for this application (this can be changed later). For example, MS Exchange Online. It is important to use the same name as the one used in MyQ under Connections. b. Supported account types – Who can use this application or access this API? Select the Accounts in this organizational directory only ({Tenant name} only Single tenant) option. Multitenant application can also be used if required, depending on the target audience of the application (what account will be used for authorization in MyQ). c. Redirect URI (optional) – The authentication response is returned to this URl after successfully authenticating the user. Select the Public client/native (mobile&desktop) option from the drop-down and fill in https:// login.microsoftonline.com/common/oauth2/nativeclient as the redirect URI. d. Click Register.
80

MyQ System Settings
4. The new app overview page opens. Copy the Application (client) ID and the Directory (tenant) ID, as they are needed for the connection to MyQ.
5. On the left-hand menu, click Authentication. In Advanced settings, under Allow public client flows, select Yes next to Enable the following mobile and desktop flows, and then click Save at the top.
81

MyQ System Settings
6. On the left-hand menu, click API permissions and add the additional permissions required for the correct functionality: a. Microsoft Graph: offline_access – Allows the app to see and update the data you gave it access to, even when you are not currently using the app. This does not give the app any additional permissions. b. Microsoft Graph: User.Read – Sign in and read user profile. c. Microsoft Graph: IMAP.AccessAsUser.All – Allows the app to read, update, create and delete email in your mailbox. Does not include permission to send mail. d. Microsoft Graph: POP.AccessAsUser.All – Allows the app to read, update, create and delete email in your mailbox. Does not include permission to send mail. e. Microsoft Graph: SMTP.Send – Allows the app to send emails on your behalf from your mailbox.
Microsoft Exchange Online setup in MyQ 1. Log in to the MyQ web administrator interface, and go to MyQ, Settings, Connections. 2. Click +Add and select Microsoft Exchange Online from the list.
82

MyQ System Settings
3. In the pop-up window, fill in the required fields:
a. Title – add the name you chose during App registration in MS Azure; for example, MS Exchange Online.
b. Client ID – the Application (client) ID you copied during the MS Azure setup.
c. Tenant ID – the Directory (tenant) ID you copied during the MS Azure setup.
4. Click OK. 5. After setting up the external system in MyQ, you are requested to confirm a
code through the Microsoft website (https://microsoft.com/devicelogin). The code you need to confirm is shown in the pop-up window, just below the link to the Microsoft website. There is timeout for confirming the code (usually it is 15 minutes).
The email functionality will not work until the confirmation is successfully completed. This confirmation must be done with the Microsoft account that owns the email box (email address), which is used to connect to the exchange (Sender email in the MyQ, Settings, Network tab). For example, if you use the sender email “print@somedomain.com”, then you need to authenticate on the Microsoft website as this user during this step.
83

MyQ System Settings
Microsoft Exchange Online is now connected to MyQ and is ready to be used in the Network settings tab, as an Outgoing SMTP server, and in the Jobs settings tab, in Jobs via Email as a POP3 or IMAP server.
Additional Settings Send scan as the logged-in user If MyQ is set to send scans as the logged-in user in MyQ, Settings, Scanning & OCR Default settings of an email with scan – Sender, the mailbox authenticated in MyQ has to have a Send As permission for all users.
1. Log in to Exchange admin center. 2. Go to Mailboxes, select all users. 3. Click on “Mailbox delegation”. 4. Select the mailbox that has been a

MyQ Print Server Installation Guide

MyQ Print Server

Product Information

Specifications

Table of Contents

Product Usage Instructions

Basic Information

System Requirements

Installation

Cleaning Cache and Temp folders

MyQ Web Interface

MyQ System Settings

FAQ

Q: What is the purpose of the Print Server?

Q: How do I access the MyQ Web Interface?

References

Read User Manual Online (PDF format)

Download This Manual (PDF format)

myQ User Manuals

Related Manuals