myQX Central Server Printer User Guide

Central Server

Central Server Printer

MyQ Central 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 Central Server.
All changes compared to the previous version are listed in the release notes, available online and in PDF.

Basic Information

The Central/Site architecture consists of one Central server and multiple site servers.
The Central server performs license management, central system management (the Central server administrator can access and manage all the site servers) and user management. In addition, it functions as a central reporting server for statistical data. It cannot be used as a print server and its options are restricted solely to its central management role. Therefore it is not possible to administer printing devices or print jobs there.
All of the Central server’s data are stored to the MyQ Database, where they can be accessed and managed. The server contains an Embedded (Firebird) database, but can also be used with an external MS SQL database.
The site servers work as print servers and perform local management of printing devices and print jobs. Data from these servers are replicated to the Central server’s database and can be displayed in reports on the Central server.

1.1 Database Setup
Within the installation of the MyQ Central Server, you can either use the Embedded (Firebird) database, or later set up a connection to your own MS SQL Server.
If you select to use the Embedded database, you can still choose between both options afterwards, while if you install the MyQ server without it, you have to use the MS SQL Server.
Unless you have already been using an MS SQL server within your company and want to connect MyQ to your MS SQL database, it is recommended to install and employ the Embedded Database.

1.1.1 Embedded Database Configuration
As the Embedded Database is fully integrated with the MyQ server, it does not require any further configuration.

1.1.2 MS SQL Server Configuration
To enable a connection to an MS SQL server, you need to make sure that the following options are set on there:

• Authentication has to be set to the MS SQL Server and Windows Authentication mode.
• A user account with the public fixed server role for access to the MS SQL Server; a user account with the dbcreator fixed server role, for creating the MyQ database. The default language of the user who creates the database must be set to English (US).
• On MS SQL Server 2016 and older, the common language runtime (CLR) integration feature has to be enabled.
• TCP/IP protocol has to be enabled and the IPAll TCP Port has to be set to 1433.
• A TCP 1433 port inbound rule has to be created in the Firewall.

1.1.3 MS SQL Server setup example
This is an example of an installation of a Microsoft SQL server (MS SQL Server 2012 is used) and the setup necessary for its connection to the MyQ Central server.
To install and set up the MS SQL server:

1. Install the MS SQL Server and the MS SQL Server Management Studio application.

2. Open the SQL Server Management Studio app (Windows Apps menu).

3. Change the Server authentication setting of the MS SQL Server from the Windows Authentication mode to SQL Server and Windows Authentication mode (Server Properties, Security).

4. Provide any user account (existing or new) with the Database Creator role.
   This account will be used to access the MS SQL server and manage the MyQ database there, which means that the MyQ administrator needs to know its credentials. The default language of the user who creates the database must be set to English (US).

5. On MS SQL Server 2016 and older, you need to enable the common language runtime (CLR) integration feature. If you are using the MS SQL Server 2017 or newer, you can continue to the next step. To enable the CLR, use the following script:
   sp_configure ‘clr enabled’, 1;
   GO
   RECONFIGURE;
   GO

6. Leave the MS SQL Server Management Studio and open the SQL Server Configuration Manager app.

7. Enable the TCP/IP protocol.

8. Open the TCP/IP properties and set the IPAll TCP Port to 1433.

9. Restart the SQL Server service.

10. Leave the SQL Server Configuration Manager.

11. Create a TCP 1433 port inbound rule in Windows Firewall.

12. Exit the setup.

1.2 Central Server and MS Cluster
1.2.1 About
The MyQ MS Cluster high-availability solution consists of multiple nodes in the active/passive configuration with the MyQ server installed on each node. MS Cluster administrates the MyQ services and if the currently active node becomes unavailable, it switches to one of the available passive nodes.

1.2.2 System Requirements
The fully detailed MyQ Central Server system requirements can be found here.

• Compatibility with Windows Servers

The MyQ MS Cluster solution is supported by the following Windows Server versions and editions:

Storage
Server
Windows Server 2016| Standard, Datacenter
Windows Server 2019| Standard, Datacenter
Windows Server 2022|

• A prepared failover cluster with at least two nodes and storage for MyQ data is needed. Each node must meet the system requirements of the MyQ server and its components.
• The same time zone has to be set on each of the nodes.

If the MyQ Desktop Client, MyQ Smart Job Manager or the MyQ Smart Print Services applications are to be used on the MyQ users workstations, the IP address or hostname of the cluster has to be set in the applications (not the IP address or hostname of the nodes).

1.2.3 Licenses
With the new MyQ X licensing model with Installation Keys used in MS Cluster, there is only one installation key needed. The HW code is taken from the whole cluster, not individual nodes, so the license is activated against the cluster’s HW, and not a single node.

With the old licensing model, when MS Cluster is used with the MyQ server, the amount of licenses needed depends on the number of nodes used, as the licenses need to be added and activated separately on each node.

• MyQ server in Site mode – licenses are received from the Central server automatically every day or during MyQ service or Cluster Node restart.
• MyQ server in Standalone mode – needs an extra licenses set for each node; each licenses set must be activated only on one node.

1.2.4 Setup
Installing MyQ on the server in the cluster (all nodes)
On each cluster node, do the following:

1. Run the MyQ installation file and install MyQ (details can be found here).
2. Make sure that the time zone set on the MyQ server is the same as the time zone set on each node).
3. Stop All MyQ services in the MyQ Easy Config application.

Setting services to manual startup (all nodes)
All services used by the MyQ server need to be set to manual startup, on every node.
The following services need to be changed this way:

• MyQ Central HTTP Server
• Firebird Server – MasterInstance
• MyQ Central Server

Creating the MyQ server MS Cluster role (Failover Cluster Manager)
Open Failover Cluster Manager and do the following:

1. Right-click Roles and select Configure Role on the shortcut menu. The High Availability Wizard opens.
2. Click Next. The Select role tab opens.
3. On the tab, select Other Server, and click Next. The Client Access Point tab opens.
4. On the tab, type a new Name for the MyQ server cluster, for example myqserver, then enter an unoccupied IP address from the network to be used by the MyQ server role, and lastly click Next. The Select Storage tab opens. MyQ will use the hostname for  communication with terminals, as the SMTP server in MFPs etc.
5. On the tab, select the storage volumes that you want to use for the MyQ server.
6. Click Next to finish the installation process.

Adding MyQ resources (Failover Cluster Manager)
Once the MyQ server role is created and configured, MyQ resources need to be configured as well, in the Roles tab in Failover Cluster Manager.

Add the Firebird server – MasterInstance service to the MyQ server role:

1. Right-click the MyQ server role, then click Add resource on the shortcut menu, and click Generic Service. The New Resource Wizard opens.
2. In the list of services, select Firebird Server – MasterInstance, and click Next.
3. On the Confirmation tab, click Next to create the service. The service is created and configured.
4. Click Finish to leave the setup.

Add the Apache Monitor script to the MyQ server role:

1. Right-click the MyQ server role, click Add resource on the shortcut menu, and click Generic Script. The New Resource Wizard opens.
2. Enter the path to the ApacheMonitor.jse script, located in the MyQ installation folder, and click Next. The Confirmation tab opens. The default path to the script is: C:\Program Files\MyQ Central Server\Server\ApacheMonitor.jse
3. On the tab, click Next to create the service. The service is created and configured.
4. Click Finish to leave the setup.

Add the MyQ Monitor script to the MyQ server role:

1. Right-click the MyQ server role, click Add resource on the shortcut menu, and click Generic Script. The New Resource Wizard opens.
2. Enter the path to the MyQMonitor.jse script, located in the MyQ installation folder, and click Next. The Confirmation tab opens. The default path to the script is: C:\Program Files\MyQ Central Server\Server\MyQMonitor.jse
3. On the tab, click Next to create the service. The service is created and configured.
4. Click Finish to leave the setup.

If you are using an MS SQL database instead of the Embedded database, you don’t need to add the Firebird server – MasterInstance service to the MyQ server role. You should only add the Apache Monitor script, and the MyQ Monitor script.

Setting resources dependencies (Failover Cluster Manager)
After adding the services and scripts to the MyQ server role, open the Resources tab of the MyQ server role at the bottom of the Roles tab and set the dependencies of the MyQ services and scripts.

Set the Firebird Server – MasterInstance service dependency

1. In the list at the bottom of the tab, right-click Firebird Server – MasterInstance, and click Properties. The Firebird Server – MasterInstance Properties dialog box opens.
2. In the dialog box, open the Dependencies tab, add the shared disk drive (or NAS) where the system is supposed to work on, add the name of the MyQ server role, and click OK. The dependency is set.

Setting the Firebird Server – MasterInstance service dependency is not needed if you are using an MS SQL database.

Set the MyQMonitor script dependency

1. In the list at the bottom of the tab, right-click MyQMonitor Script, and click Properties. The MyQMonitor Script Properties dialog box opens.
2. In the dialog box, open the Dependencies tab, add the Cluster Disk and the Cluster server, and click OK. The dependency is set.

Set the ApacheMonitor script dependency

1. In the list at the bottom of the tab, right-click ApacheMonitor Script, and click Properties. The ApacheMonitor Script Properties dialog box opens.
2. In the dialog box, open the Dependencies tab, add the MyQMonitor Script, and click OK. The dependency is set.

To open the dependency report, right-click the MyQ server role on the Roles tab of the cluster in Failover Cluster Manager, click More Actions, and click Show Dependency Report.

1.2.5 Additional Setup
Even though the installation is finished, there are some additional steps needed to setup the environment before bringing the resources online.

Setting up the MyQ admin credentials (active node)
On the active node, open the MyQ Central Easy Config application:

1. On the Services tab, Start All services.
2. On the Home tab, set the Server Administrator Account password and the Database Administrator Password (if the passwords have been changed before, they can be changed again on the Settings tab).
3. On the Services tab, Stop All services, and close the MyQ Central Easy Config application.

Setting the location of the data folder (all nodes)
On each node of the cluster, you need to set the location of the Data folder, which requires access to the shared cluster disk, so the node has to be active. Therefore, you need to switch the active mode between all of the nodes (move the MyQ server role between the nodes).
To set the folder’s location, open MyQ Central Easy Config on the currently active node and:

1. On the Services tab, Start All services.
2. On the Settings tab, under the Data folder, click Change location, and then define the path to the shared cluster disk. (For more information about how to do this, check here).
3. On the Services tab, Stop All services, and then close the MyQ Central Easy Config application.
4. In Failover Cluster Manager, move the MyQ server role to the next node and repeat the process.

Running MyQ in the MS Cluster environment
The following instructions have to be followed while MyQ runs in the MS Cluster:

• You should not start, stop or restart MyQ services while MyQ is controlled by the MS Cluster (cluster resources are online). The services should only be managed by Failover Cluster Manager.
• When switching to a different node, MyQ Central Easy Config should not be used on any node.
• When performing system maintenance (cluster resources are offline), but MyQ services are online on any node (activated manually), do not switch to a different node. By doing so, you risk corrupting the MyQ database.
• When switching to a different node, all services on the initial node are stopped by the MS Cluster.
• While MyQ runs in the cluster, the IP address of the MyQ server is the one that you have selected within the setup of the MyQ server role, and the hostname of the MyQ server is the one that you will set in the MyQ web administrator interface after you bring the resources of the MS Cluster online.
• It is strongly recommended to always keep the Storage and Server Name resources online. In case you need to take them offline, make sure that all MyQ services on the active node (the current owner of the MyQ server role) are stopped in the MyQ Central Easy Config application.
• After completing the setup (setup and additional setup) of the MyQ server role, and also after each crucial change on the cluster, it is recommended to test the cluster by moving the ownership of the MyQ server role between all nodes of the cluster.

Starting the system (Failover Cluster Manager)
To start the system, you have to bring the resources of the MS Cluster online. For information on how to do this, check here.

Setting hostname of the MyQ server role
On the Resources tab of the MyQ server role in Failover Cluster Manager, you can see (and change) the DNS Name of the MyQ server role. The Full name of the role (DNS + domain) needs to be used as the server hostname and as the MyQ X Mobile Client server in MyQ.
To see or change the DNS name of the MyQ server role on the MS Cluster, do the following:

1. In the list at the bottom of the Resources tab of the MyQ server role, under Server Name, right-click the server’s name, and then click Properties. The Name:*** Properties dialog box opens.
2. On the General tab , you can see (and change) the DNS Name of the MyQ server role.

To set the hostname of the MyQ server role on the MyQ cluster server, do the following:

1. On the Network settings tab of the MyQ web administrator interface of the MyQ cluster server, use the Full name (DNS + domain) of the MyQ server in the following setting:
   a. This server hostname under General.

2. Then click Save at the bottom of the tab.

1.2.6 Configuration and Maintenance
The below chapters show additional configuration and maintenance steps.
Bringing the resources of the MS Cluster online (Failover Cluster Manager) To start the system, you need to bring all the MS Cluster resources online – the Firebird Server – MasterInstance service, the ApacheMonitor.jse script, and the MyQMonitor.jse script.
To bring a service or script online, open the Failover Cluster Manager application, go to Roles, right-click the service or script, and click Bring Online on the shortcut menu.

Taking the MS Cluster resources offline (Failover Cluster Manager)
To make sure that all the MS Cluster resources -except for Storage and Server Name- are offline, it is sufficient to take the Firebird Server – MasterInstance service offline; all of the scripts will be taken offline due to their dependency on this service.

**** The Storage and Server Name resources must stay online.
To take the Firebird Server – MasterInstance service offline, open Failover Cluster Manager, go to Roles, right-click the Firebird Server – MasterInstance service, and click Take Offline on the shortcut menu.

Basic Information

Restarting MyQ services via the MS Cluster (Failover Cluster Manager)
To restart MyQ services via the MS Cluster, take all the MS Cluster resources, except for Storage and Server Name, offline and then bring them online.

Changing the MyQ admin credentials (active node)
To change the Server Administrator Account and Database Administrator passwords, you need to do the following on the currently active node (the current owner of the MyQ server role):

1. Open the Failover Cluster Manager application.
2. Open the Nodes tab of the cluster, right-click the currently active node, rightclick Pause on the shortcut menu, and click Do Not Drain Roles.
3. Take all the MS Cluster resources, except for Storage and Server Name, offline.
4. Open the MyQ Central Easy Config application, start all services, change the passwords, stop all services, and lastly close the application.
5. Bring the resources of the cluster online.
6. Open the Nodes tab of the cluster in Failover Cluster Manager, right-click the node, right-click Resume on the shortcut menu, and lastly click Do Not Fail Roles Back.

1.2.7 Backup and Restore
Backing up the MyQ database on the MS Cluster
The automatic and manual backup processes do not differ from the standard backup processes described in “Backing up MyQ Data”. The only setting that requires special attention is the backup destination folder. It is recommended to save the backup files on the shared cluster disk.

Restoring the MyQ database on the MS Cluster (all nodes)
Before restoring the MyQ database, MyQ has to be installed and set up on all the MS Cluster nodes.
Now you need to restore the MyQ database and settings on the active node of the Cluster (the current owner of the MyQ server role) via the following steps:

1. Start All services via MyQ Central Easy Config.
2. Open the Database tab in MyQ Central Easy Config.
3. In the Main Database section, click 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.
4. Repeat the process for all the other nodes.

Using Database Encryption
If you are using the Database Encryption feature in MyQ Central Easy Config, it is necessary to perform the following steps after encrypting or restoring your database:

1. Stop all Cluster resources except for Storage and Server Name.
2. Open MyQ Central Easy Config on the active node and start all services.
3. Enable DB encryption.
4. Stop All services in MyQ Central Easy Config.
5. Copy the DB encryption key to all the other nodes. The key is located by default in “C:\Program Files\MyQ Central Server\Firebird\plugins\keyholder.conf”.
6. Start All MyQ services in MyQ Central Easy Config, and bring all the resources online via Failover Cluster Manager.

1.2.8 Upgrading MyQ
Necessary steps before the upgrade
Before starting the upgrade, make sure that you have an up-to-date and properly finished backup of the MyQ database. The database can be backed up either manually in MyQ Central Easy Config or automatically as a scheduled task in the MyQ web administrator interface. To make sure that the backup file is preserved, it is recommended to copy the database backup file to a different location.

Upgrading MyQ (all nodes)
The upgrade needs to be performed on each node of the cluster. To be able to upgrade MyQ on a node, you need to have access to the shared cluster disk, so the node has to be active. Therefore, you need to switch the active mode between all of the nodes (move the MyQ server role between the nodes).
Before upgrading MyQ on the nodes, take all the MS Cluster resources, except for Storage and Server Name, offline.

To upgrade MyQ on all nodes, start with the currently active node (the owner of the MyQ server role) and do the following:

1. Start All services via MyQ Central Easy Config.
2. Run the MyQ installation file.
3. Finish the installation process.
4. Stop All services via MyQ Central Easy Config, and then close the MyQ Central Easy Config application.
5. Move the MyQ server role to the next node and repeat all the steps.

After MyQ is upgraded on all the nodes, bring all the MS Cluster resources online.

During the installation, you might encounter a warning message about a problem related to updating the MyQ database. In such cases, continue with the setup, as the problem does not impact the installation.

1.2.9 Recommended Troubleshooting
The MS Cluster solves issues on the currently active node which might affect the availability of the MyQ server, by switching to one of the available passive nodes.
Problems related to the MyQ server need to be treated manually. In case you encounter such problems, it is recommended to restart MyQ services in the Failover Cluster Manager application. If the problem persists, contact MyQ support.
In case the MS Cluster does not start, try taking all the MS Cluster resources, except for Storage and Server Name, offline, and then try to manually start MyQ services. If successful, it is likely that the problem is on the cluster side; otherwise the problem is probably related to the MyQ server, in which case contact MyQ support.

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 Central Server mode with integrated Firebird database

MyQ Central Server| 1 – 10,000 users| 10,001 – 50,000 users| 50,001 – 100,000 users
---|---|---|---
Physical Core*| 6| 6| 6
RAM| 8GB| 12GB| 16GB

Valid for a typical user case:

• Integrated Firebird database – installed automatically.
• Data Replications from Site servers.
• User synchronization.
• Up to 500 Sites (for the Site servers HW requirements, see MyQ Print Server – Site mode) managed by the Central Server (license distribution, user synchronization, and data replication between Central Server and Site servers).
• Up to 30,000 printers total on MyQ Central Server.

2.1.1 Recommendations

• Install Windows updates out of the replication or user synchronization time.
• 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 Central Server mode with an external MS SQL database

MyQ Central Server| 1 – 10,000 users| 10,001 – 50,000 users| 50,001 – 100,000 users
---|---|---|---
Physical Core| 4| 4| 4
RAM| 4GB| 6GB| 6GB
MS SQL server (database)| 1 – 10,000 users| 10,001 – 50,000 users| 50,001 – 100,000 users
---|---|---|---
Physical Core| 6| 6| 6
RAM| 12GB| 24GB| 32GB

*number of physical cores with 3,5GHz frequency (calculated with AMD Ryzen Threadripper 1920X 3,5GHz).
Valid for a typical user case:

• External MS SQL database used.
• Data Replications from Site servers.
• User synchronization .
• Up to 500 Sites (for the Site servers HW requirements, see MyQ Print Server – Site mode) managed by the Central Server (license distribution, user synchronization, and data replication between Central Server and Site servers).
• Up to 30,000 printers total on MyQ Central Server.

2.2.1 Recommendations

• Install Windows updates out of the replication or user synchronization time.
• 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.2 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 server operating system.

2.2.3 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)
  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.4 Storage sizing
The MyQ Central Server installation files are approximately 300MB.
Minimum 10GB dedicated disk for MyQ Data storage (jobs, main database and log database) is recommended; see the below tables for more details.
Data storage with integrated Firebird database (included users, replications):

| 10k jobs| 100k jobs| 1M jobs
---|---|---|---
MYQ database| 30MB| 200MB| 1,5GB
MYQLOG database| 30MB| 300MB| 3GB

MyQ data folder storage counted for 1 year.

Data storage on external MS SQL database (include users, replications):

| 10k jobs| 100k jobs| 1M jobs
---|---|---|---
MYQ database| 500MB|  700MB| 7GB
MYQLOG database| 1GB| 1,5GB| 3GB

MyQ data folder storage counted for 1 year.
Storage performance

• minimum 100 IOPS required.
• RAID data storage supported.

2.2.5 Database

• Microsoft SQL Server 2014 or newer.
  • Microsoft SQL Server 2017 or newer is recommended.
• On MS SQL Server older than 2017:
  • CLR must be enabled (https://docs.microsoft.com/en-us/sql/relationaldatabases/clr-integration/clr-integration-enabling).
  • User with owner privileges for Main and Log database.
• User (Server user/login) used to connect to the DB must have their default language set to us_english.

2.2.6 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

2.2.7 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.
For the Print Server requirements, check the MyQ Print Server guide.

2.4 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.

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

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

license2.myq.cz.
The old MyQ license server address is license.myq.cz. Other enabled services from Settings→Connections (Microsoft Exchange Online)

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

from MyQ.
TCP| Custom| 389/636/18 12| Connection to SMTP server for sending outgoing emails from MyQ.
TCP| Custom| | Site server(s) connection.
TCP| Custom| 8090| Connection to External credit account.

For a complete list of the ports used by Site servers, check Main communication ports in the MyQ Print Server guide.

2.5 Network Communication Architecture
The image below depicts an overview of the components and main network communication channels between MyQ Central server and MyQ Site s rvers.

System Requirements

Installation

This topic shows you how to install the MyQ Central server and how to connect it to a database.

Before you start the installation, make sure your system is up to date and meets the requirements as described in System Requirements.
MyQ Central server is installed simply by running the executable file and following the instructions of the installation wizard.

1. Download the latest available MyQ Central Server version from the MyQ Community portal (MyQ Central Server X.X.X.X).

2. Run the executable file. The Select Setup Language dialog box appears.

3. Select your language, and then click OK. The License Agreement dialog box appears. Select I accept the agreement, and click Next. The Accessibility mode dialog box appears.

4. Select between the Standard or Enhanced accessibility mode, and click Next. The Select Destination Location dialog box appears.

5. Select the folder where you wish to install MyQ Central server. The default path is:
   C:\Program Files\MyQ Central Server.

6. Click Next. The Select Components dialog box opens.

7. If you want to use the MyQ Embedded database server, keep the Embedded Database option selected (default setting). If you want to use an MS SQL database server, you should clear the selection. Click Next. The Ready to Install window opens, with an overview of your selections.

8. Click Install. MyQ Central server is installed on your computer. 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 Central Server Easy Config application opens and you can continue with the setup there.

3.1 Central Server database setup
Once the MyQ Central server is installed, the MyQ Central Server Easy Config application opens and you are asked to select and set the MyQ database. The two following sections describe the setup of the database after the installation.

**** If you have deselected the Embedded Database option during the installation, the MyQ Embedded database option is no longer available on the MyQ server.

3.1.1 Setting up the Embedded Database
To set up the Embedded database:

1. Select the Embedded Database (recommended) option, and click Next. The database is installed and upgraded if needed.
2. Click Finish to leave the MyQ Database Wizard.

3.1.2 Setting up an MS SQL Database
To set up an MS SQL database:

1. Select the Microsoft SQL Server 2012 or higher option and click Next.

2. Fill in the setup fields with the following information: a. Database name: name of the new MyQ MS SQL database (for example MyQDatabase).
   b. Log database name: this is automatically filled according to the Database name.
   c. Database server address: the IP address or the hostname of the MS SQL server.
   d. Server port: TCP port used for communication with the MS SQL server; by default it is 1433. In case of a Local database, the Server port field must be left empty.
   e. Username/Password: Login credentials for accessing the MS SQL database management. The login account has to have the public fixed server role for access to the MS SQL database. You can alternatively use Windows Authentication.

3. Before you can continue, it is necessary to manually create the main and log databases MyQ will be using. You can use the creation scripts that are available to you under the ‘Database name’ and ‘Log database name’ fields. Run the scripts on your MS SQL server and they will create databases using the names you have provided in Step 2.

4. Once the databases are successfully created, click Next to continue. MyQ Central Server Easy Config will run the Database Prerequisites Check.

5. Click Finish to leave the MyQ Database Wizard.

**** An MS SQL database does not support importing temporary cards.

3.2 Installation in Private Cloud
MyQ Central Server can be installed and run, besides on-premise servers, also on an Azure Virtual Machine, with a VPN tunnel connecting the physical network and Azure’s virtual network.

3.2.1 Environment Requirements

• The minimum recommended virtual machine is B4ms, with a dedicated (not 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.
• It is required to open ports used by MyQ or make sure they are not blocked on Azure’s Network security group .

Since MyQ Central Server 10.1, communication with Sites does not require a VPN tunnel. Public IP address of the machine running the Central Server can be used.

Once you set up the Azure virtual environment, follow the Installation instructions to install MyQ.

3.2.2 About MyQ in Private Cloud
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 onpremise 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.
For more information, see Microsoft Universal Print in the MyQ Print Server guide.

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.

MyQ Central Server Easy Config

This topic introduces the MyQ Central Server Easy Config application and describes its main features. Furthermore, it guides you through the following procedures:

• how to change passwords
• how to manage the MyQ Central Server services
• how to relocate MyQ folders
• how to encrypt your MyQ data
• how to back up and restore MyQ data and the MyQ log
• how to clean up MyQ temporary files
• how to change MyQ Web Server ports

The MyQ Central Easy Config application is the basic environment for setup of the essential parts of the MyQ Central server, such as the MyQ database and log.

It automatically opens 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 of the dialog box. From this menu, you can access the following settings:

• On the Home tab, you can quickly change the default passwords for access to the Server Administrator account and the Database Administrator account. You can generate data needed by MyQ Support, and you can also log in to the MyQ Web Administrator Interface from there.
• On the Services tab, you can control the run of the MyQ Central server’s services.
• On the Settings tab, you can change both the Server administrator and the Database administrator passwords, setup the Windows Services account, unlock the Server administrator account, change file paths of the MyQ system data files, change the port of the web 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 jobs encryption.
• On the Database tab, you can change the type and settings of the MyQ database, and back up and restore your data.
• On the Log tab, you can overview all operations executed by the MyQ system.
• On the About tab, you can see the information about the current version of the MyQ Central server.

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

4.2 Passwords
The Server administrator user name is *admin and its default password is 1234.
The MyQ database access user name is SYSDBA and its default password is masterkey.
Changing the default passwords on the Home tab

To change the default passwords:
The first time you open the application, on the Home tab, you can see the Server Administrator Account, and the Database Administrator Password sections. In each of the two sections, 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 passwords, the passwords sections disappear from the Home tab and they can no longer be changed there.
However, both of them can be changed at any time on the Settings tab, under the Server Administrator Account and Database Administrator Password sections.

4.2.1 Unlocking the Server Administrator account
After 5 consecutive failed login attempts to the Server 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.
The administrator can also check their account’s status via the Windows command line, using the following command:

C:\Program Files\MyQ Central Server\PhpApps\MasterServer\src\EasyConfig>”C: \Program Files\MyQ Central Server\PHP\PHP\php.exe” confcli.exe.php cmdConfig adminUnlock check
To Unlock the account via the Windows command line, they can use the following command:
C:\Program Files\MyQ Central Server\PhpApps\MasterServer\src\EasyConfig>”C: \Program Files\MyQ Central Server\PHP\PHP\php.exe” confcli.exe.php cmdConfig adminUnlock SET unlock

4.3 MyQ Windows Services Account
MyQ 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 MyQ 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.

4.4 Data folder
On the Settings tab, you can see the MyQ database folder location.
Depending on the type of the database, the Data folder either does, or does not contain the MyQ database: the MyQ Embedded database is part of the folder, whereas the SQL database is stored on the SQL server. Besides the MyQ database, the folder contains additional files with data used by the MyQ system, such as reports, certificates or the config.ini file.
The default folder path is:
C:\ProgramData\MyQ Central Server\
Under normal circumstances, there is no need to change the location. 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 Select to browse and find the new folder location.
3. Under Change Operation, select the required method of existing data relocation, and then click Change
   Location. The folder is moved to the new location.

If you relocate your Data 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 authority\system” user. You can do this using this guide: https://stackoverflow.com/questions/182750/map-anetwork-drive-to-be-used- by-a-service/4763324#4763324 or it should work when you mount the drive on Windows startup.

4.5 Database Backup and Restore
On the Database tab, you can change the database connection settings, check the main and log database’s status, and perform backup and recovery. 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.5.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 backup*.zip. Depending on the database type, the backup.*zip either does or does not contain the MyQ database file (MyQ.FDB): the MyQ Embedded database is part of the folder, whereas the SQL database is stored on the SQL server. Besides the MyQ database, the folder contains additional files with data used by the MyQ system, such as reports, certificates, the metadata.backup file or the config.ini file.

4.5.2 Restoring MyQ Data
To restore your MyQ data:

1. Open the Database tab.
2. In the Main Database section, click Full Restore…. Select the backup_*.zip file to restore MyQ Data, 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.5.3 Database Connection Settings
In the Connection Settings section, you can view database information, such as the name, server address, server port, username, and password. If you click Edit, you can set up a new MyQ Embedded database or an SQL database. This change is only available if you selected the MyQ Embedded database during the installation.

4.6 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) 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.
This functionality is only available for MyQ Embedded Databases. If you have an SQL Server, this section for encryption/decryption is not displayed.

Click Encrypt next to MyQ Main Database, MyQ Log Database, or Scan Jobs.
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.

4.7 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. A pop-up window informs you that services are not available during the cleanup. Click Yes to continue or No to cancel.

A busy indicator window lets you follow the cleanup process, and informs you when it ends.

4.8 Changing MyQ Web server ports
On the Settings tab, under Web Server Ports, you can change the ports for the connection to the MyQ Web server:

• Port: communication port for the MyQ HTTP server; the default value is 8083.
• Secure port (SSL): communication port for the MyQ HTTPS server; the default value is 8093.

Use the up/down arrows to select the new port, and click Save to apply the changes.

MyQ Central Web Interface

This topic describes the MyQ Central 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 Central Web Interface
To access the MyQ Central 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 Central Web Interface:

1. Open your web browser, and then enter the web address in the form: https://*MyQCentralserver*:8093, where MyQCentralserver represents the IP address or the host name of your MyQ Central server, and 8093 is the default port for access to the server.
2. Log on to the interface from the MyQ Central Easy Config application, by clicking the MyQ Web Administrator link on the Home tab, in the MyQ Web
3. Administrator section.
   Open the MyQ Central 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 MyQ administrator name (*admin) and the password that you have set in the MyQ Central 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.
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.

5.3 Main menu and Settings menu
There are two menus where you can access all the features and settings of the MyQ Central 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.

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 Central 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, to display statistics and to generate data for support.

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 six widgets on the dashboard: Quick Setup Guide, System Status, Total Pages (last 30 days), Environmental Impact, Updates, and License.

The Quick Setup Guide walks you through the initial MyQ setup.
In the System Status widget, you can see the following system status information:

deleted. Cached every 15 seconds. Clicking opens the Printers page.
Sites| Number of active MyQ Site servers. Clicking opens the Sites page.
Last replicated data| Shows when data were last replicated.
Uptime| MyQ system uptime, in hours.
Recent warnings| Number of warning log messages over the last 24 hours.
Cached every 60 seconds.
Recent errors| Number of error and critical log messages over the last 24 hours. Cached every 60 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
  • 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.

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 select Add Widget. The Add Widget pop-up window appears.
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 Administrator’s interface theme, click on Theme at the topright corner of the dashboard. The available options are:

• Synchronize with the operating system
• Blue
• Red (default)
• Dark
• High Contrast

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
Click Enter License. The License settings tab opens. You are asked to enter information about your installation and enter your installation key.

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.

Password for communication
To communicate with your site servers you must set a password. By clicking Enter the password, you open the General settings tab, where you can set the password for network communication, in the Security section.

Outgoing SMTP server
By clicking Configure the outgoing SMTP server, you open the Network settings tab, where you can set the outgoing SMTP server.

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 User Synchronization settings tab, where you can import users from LDAP servers, an MS Azure source or from a CSV file.

5.4.2 Generate data for support
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 contains:

• the Logs folder with error logs from Apache and PHP,
• the MyQ log file log_dateandtime.xlsx,
• the Windows Event log,
• the statsData.xml file,
• and the MyQ-helpdesk.xml file with MyQ system information.

The MyQ log file corresponds to the MyQ log that can be displayed on the MyQ Central Web Interface or in the MyQ Central Easy Config application, and contains attachments with detailed information.
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.

You can also generate data for support in the MyQ Central Easy Config application. In the Home tab, under the Data for Support section, set the Date and Time for the data, and click Generate. The file is generated and you can select where to save it.

5.5 MyQ Log
In the MyQ Central server log, you can find information about all parts of the MyQ Central server: the MyQ Central 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, Replicator or Schedulers, and also about a specific context, for example Email sender or Disk space checker.

The log is updated in real time, but you can pause it 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.
• 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 be displayed.

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.

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 selecting Export. The log is instantly generated and downloaded.
You can also select Schedule Export to have the log regularly exported. The schedule’s properties panel open to the right, where you can set its parameters.

MyQ Central 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 Printers settings tab, you can set the duration of the temporary cards validity in hours.
• 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 General Settings
The General settings tab contains the General, Security, and Job Privacy sections.

In the General section, you can set the administrator email, time zone, default language, currency, and the column delimiter in CSV files.

• 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 of all emails that are automatically sent from MyQ and the language used on all connected terminals and interactive readers.
• 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.

In the Security section, you can set the Password for communication between the MyQ Central server and Site servers. The same password has to be set on your Site servers to ensure the communication between your Central server and Site servers.
In the Job Privacy section, you can enable the Job privacy feature. The Job privacy feature limits access to sensitive job metadata for everyone, except for the job owner and their delegates. If Job Privacy is enabled at your Central server, it will be automatically enabled on all the connected site servers.

**** Once enabled, it cannot be disabled again!
To use the feature, click on the Enable Job Privacy (irreversible) button.

In the confirmation pop-up, type your Server administrator password in the Password field, and click Enable Job Privacy (irreversible).

6.2 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, and custom application logos to be used in MyQ.

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, and on reports.
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.

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).

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.
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 Task Scheduler Settings
The Task Scheduler settings tab serves as an interface for planning regular tasks in MyQ. There are seven predefined tasks:
System health check, History deletion, Data replication from sites, System maintenance, Database and settings backup, Log backup, and User Synchronization.
Apart from these, you can import projects from CSV files, 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.3.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:

• 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.

Adding a new schedule:
You can add two kinds of new schedules, related to reports: Users export and Printers export.
On the main ribbon, click Add and select Users export or Printers export. The task schedule properties panel opens on the right side of the screen and it is divided into four sections like the rest of the schedules. The last section, Report, is present only on these two schedules and contains the following settings:

• Format – Select the report’s format from the list: CSV, XLSX, ODS, XML.
• Language – Select the report’s language from the list.
• All sites must be replicated – If enabled, all sites are replicated and included in the report.
• Send via email
  • Recipient – Select the recipient from the list of users.
  • Subject – Type a subject for the email.
  • Message – Type the body of the email.
  • Embed the report in the email body – If enabled, the report is included in the email body.
  • Maximum email size – Set the maximum email size from 0 to 2047 MB. If the email exceeds the set size, a secure link to the document is included instead.
• Save to a file
  • File – Set the path where the file is stored. The default path is %app% \Data\Export\Users_%datetime%.csv where %app% is the MyQ Data folder and %datetime% is the current date and time.

6.4 Network Settings
On the Network settings tab, you can manage the network communication between the MyQ Central server and other parts of the MyQ solution. It is divided into the following sections: General, Communication Security, Outgoing SMTP server, HTTP Proxy server, and Firewall.

6.4.1 General
In this section, you can enter the hostname of the MyQ Central server. This hostname is used by external components of the MyQ system, such as the MyQ Replicator or Site servers, for communication with the MyQ Central server.

6.4.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 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.4.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:

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 between the Prefer StartTLS (default), Implicit TLS, and Require StartTLS Security options.
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.
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.4.4 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.4.5 Firewall
In this section, you can Allow editing firewall rules of the Microsoft Windows Firewall and you can also Reset firewall rules.

6.5 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

6.5.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.

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.

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.

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 connection 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.
Microsoft Exchange Online is now connected to MyQ and is ready to be used in the Network settings tab as an Outgoing SMTP server.

6.5.2 Gmail with OAuth2 setup
To configure Gmail with OAuth2 in MyQ:

1. Log in to the MyQ web administrator interface, and go to MyQ, Settings, Connections.
2. Click +Add and select Gmail.
3. In the pop-up window, you are requested to authorize the connection by clicking Continue with Google, copying the generated code, pasting it in the Authorization code field, and clicking OK.

Gmail is now connected to MyQ and is ready to be used in the Network settings tab as an Outgoing SMTP server.

6.5.3 Azure AD with Microsoft Graph setup
Azure Application Configuration

1. Log in to the Microsoft Azure portal and go to App registrations.

2. Click New registration to create a new application or select an existing application.

3. If you are creating a new application, set the Name and in Supported account types select Accounts in this organizational directory only ({Tenant name} only – Single tenant) option if all your users are members of your tenant. Multitenant application can also be used if required, depending on the target audience of the application.

4. You can skip the Redirect URI settings for now (described in step 7). Click Register to create the application.

5. From the application’s Overview screen, go to API Permissions and select Microsoft Graph API and the required type of permission (Delegated or Application) as illustrated below.
   The required permissions are:
   Microsoft Graph \ Group.Read.All, Microsoft Graph \ User.Read, Microsoft Graph \ User.Read.All

6. The status “Granted for Default Directory” needs to be set on all permissions that require them. All needed permissions can be added and configured with the buttons at the top of the list of permissions. Use “Add a permission” to add new permission.
   Use “Grant admin consent for Default Directory” to set the status of the permission as “Granted for Default Directory”.

7. Go to the Authentication settings, and under Platform configurations, click Add a platform. Then select Web, and list the Central server and all Site servers. For the actual URLs, use the hostname (and port) of your server in the following format: https://{hostname:port}/auth and click Configure.

8. In the application’s overview page, save the Application (client) ID and the Directory (tenant) ID, as they are needed for the MyQ configuration.

9. Click Add a certificate or secret next to Client credentials and complete the following steps: a. Click New client secret.
   b. Add a Description.
   c. Set the expiration for the key.
   d. Click Add.
   e. Save the client secret key Value, because you need it for the configuration in MyQ and you cannot retrieve it later.

Configuration in MyQ
Go to MyQ, Settings, Connections to connect MyQ to Azure AD. Click Add and select Azure AD from the list. In the pop-up window, fill in the required information:

• Title: Add a title for the connection.
• Tenant ID: Add the Directory (tenant) ID you saved from Azure.
• Client ID: Add the Application (client) ID you saved from Azure.
• Security key: Add the (client secret) Value you saved from Azure.

Click Save and your Azure AD connection is now complete.

Microsoft single sign-on
To use Microsoft single sign-on:

1. Enable “Use as an authentication server” in Azure AD synchronization source – Users tab prior to synchronizing users or enable Azure as an authentication server manually for selected users in their details on the Users main page.
2. In the Azure authentication server settings, enable displaying the ‘Sign in with Microsoft’ login method.

When Microsoft single sign-on is enabled, the Sign in with Microsoft button is always displayed on the MyQ Web UI login page, but only users who use Azure AD as their authentication server can use it to log in. Any attempt to use Microsoft single sign-on by a user who does not use the Azure AD authentication system will end with an error.

What happens when a user tries to sign in with Microsoft in the MyQ Web UI:

• The user clicks the single sign-on button.
  • If the user is not signed in to Microsoft in the browser, they are forwarded  to the Microsoft login page to sign in, and then logged into MyQ with the provided account.
  • If the user is signed in to Microsoft with one account only, they are automatically logged into MyQ with this account (limitation).
  • If the user is signed into two Microsoft accounts, they are forwarded to the Microsoft login page and are given a choice to select the account to continue with.
• Logout in MyQ Web UI signs out the user only locally, not from Microsoft.

Limitations

• If a user uses the Sign in with Microsoft button and they are currently signed into one Microsoft account in the browser, they are automatically logged into MyQ with this account. There is no option to switch to another account. To use another account, the  user has to sign out on any Microsoft services first, and upon the next use of the singlesign-on button, they will be asked for a new login.
• Users using Azure AD authentication server cannot sign in on the MyQ Web User Interface with a PIN. However, they can use their PIN on the MyQ Embedded terminals or in MyQ Desktop Client.

Synchronization and authentication through an Azure AD with Microsoft Graph can now be used via the following steps:

1. Adding an Azure AD authentication server in MyQ, Settings, Authentication Servers.
2. Adding an Azure AD synchronization source in MyQ, Settings, User Synchronization.

6.6 Authentication Servers settings
If you want to authenticate users against an LDAP server, synchronize users from an LDAP server, synchronize users from your MS Azure AD and use Microsoft SSO for the MyQ web UI or authenticate users against a Radius server, you have to add all the servers on this tab.

6.6.1 Adding a new LDAP server:

1. Click +Add and select LDAP Server. The new LDAP server properties panel opens on the right side of the screen.
2. Enter the LDAP domain.
3. Select the LDAP Type. You can select from Active Directory, Novell, OpenLDAP, and Lotus Domino (for Active Directory you must select SSL in the Security field and the Server port must be 636).
4. If you want the communication with the LDAP to be secured, select the Security protocol that you want to use.
5. Enter the Server IP address or hostname and the communication port. (For Active Directory you can leave the IP address or hostname empty if you do not know them. The server will then be saved as Auto-discover.)
6. If you have more addresses related to one LDAP server, you can add them by clicking Add.
7. Click Save. The LDAP server now appears on the list of servers.

6.6.2 Adding a new MS Azure Server:

1. Click +Add and select Azure AD Server. The new Azure AD server properties panel opens on the right side of the screen.
2. If you have already added Azure AD in the Connections settings, the server appears on the list. If not, click Add new and add the Azure AD connection.
3. If you want your users to be able to log in on the MyQ Web UI via Microsoft single-sign-on, select the Enable Sign in with Microsoft checkbox.
4. Click Save. The Azure AD Server now appears on the list of servers.

6.6.3 Adding a new Radius server:

1. Click +Add and select Radius server. The new Radius server properties panel opens on the right side of the screen.
2. Enter the Radius server Name.
3. Enter the Server IP address or hostname, the communication port and the Shared secret.
4. If you have more addresses related to one Radius server, you can add them by clicking Add.
5. Click Save. The Radius server now appears on the list of servers.

6.7 Printers Settings
On the Printers settings tab, in the Validity of temporary cards field, you can set the duration of the temporary cards validity in hours. The default value is 24 hours.

6.8 Accounting Settings
In the Accounting settings tab, in the General section, the MyQ administrator selects the Accounting mode MyQ will be using:

• Accounting Group – This is selected by default. In this mode, all quotas are available and can be spent.
• Cost Center – In this mode, only the selected (cost center) payment account is spent.

It is possible to switch between the modes anytime.
Limitations:

• The Cost Center mode does not work on printers without a terminal.
• The Cost Center mode can be used only with embedded terminal versions 8.2 or higher.
• In the Cost Center mode, if a user has more than one account, the job is paused and the account must be selected via MyQ Desktop Client (v.8.2 or higher). If there is only one account, the account is assigned automatically.

**** If you use the Cost Center mode on embedded terminals with a version older than 8.2, the terminals activation fails. The following error message can be found in the log: “Terminal is incompatible | reason=Terminal version must be at least 8.2 in cost center mode”.
If you switch to the Cost Center mode on embedded terminals with a version older than 8.2, the following warning can be found in the log: “This terminal is not supported in cost center accounting mode. Upgrade terminal at least to version 8.2”. Switch to the Accounting Group mode or upgrade your embedded terminals to version 8.2 for the terminals to be successfully activated and work properly.

Comparison between Accounting Group and Cost Center

user
If multiple quotas are assigned to a user, all of them are spent.| Only one quota is spent. If credit, or a cost center without quota is selected, no quota is used.
If credit or personal quota is selected, the job is still accounted to the accounting group| If credit or personal quota is used, no cost center is accounted.
Every job performed by user is accounted to their Accounting group| A job is accounted to the cost center only if selected, or if it is the only account the user has.

6.9 Data replication from sites Settings
In the Data replication from sites settings tab, in the General section, the MyQ administrator selects the data to replicate from Site servers. This option was added in MyQ Central Server 8.2 (Patch 6) and requires MyQ Print (Site) Server 8.2 (Patch 7). Check the checkbox next to an option to enable the data replication and uncheck it to disable it (all options are selected by default). Click Save to apply any changes. The available options are:

• User sessions (non-editable)

• Printers (non-editable)

• Printer groups

• Printer events

• Price Lists

• Projects

• Jobs

• Toner replacements

• When data are excluded from the replication settings, they are not replicated to the MyQ Central server.

• If an older MyQ Print Server version is used, then segmentation settings on MyQ Central server don’t take effect.

• If job-related data (Jobs, Projects) were skipped during replication, then including the data again doesn’t lead to replication of already skipped data; only new data are replicated.

• If printer-related data (Printer groups, alerts, Price lists) were skipped during replication, then including the data again also replicates previously skipped data.

6.10 External Reports
By default, the only access to the MyQ Firebird database is via the SYSDBA account.
Since this account has full read/write rights, it is not secure to use it for accessing the database from 3rd party software (for example BI tools for reporting). A read-only access account is needed to avoid unintentional database corruption.
In the External Reports settings tab, the administrator can enable a database readonly account to be used with external reports.

Activating the Enabled switch automatically creates a read-only access account to the MyQ Firebird database with the following settings:

• Account name: db_datareader. This is the newly created read-only database user. The account name cannot be changed.
• Password: password for the db_datareader account, set by the administrator. A new password must be set every time when switching from the Disabled to Enabled state.
• Confirm password: confirmation of the above password.

Enabling the database read-only account automatically enables a Windows Firewall rule to allow incoming connections to the MyQ Firebird database. If disabled, the rule is deleted.
After restoring a backup using MyQ Easy config, the Windows Firewall rule and the db_datareader’s account password will be restored if the account state was Enabled when the backup was created. If the account state was Disabled, then the existing Windows Firewall rule will be deleted and the user account will be dropped in the restored Firebird database.

6.11 Log Settings
On this tab, you can set general settings for the MyQ Log, and the Log notifier feature, which enables sending notifications about selected log events to the administrator and/or any number of MyQ users. The notifications can be sent via email or they can be sent to Windows Event Viewer.

General – If you select the Log debug level messages option, the system will generate more information for troubleshooting. The information will be shown in the MyQ Log.
However, this feature will impact your system’s performance. Therefore, we recommend you enable it only in case of a system malfunction or if it is requested by MyQ support.
History – Here you can set when the logs should be deleted (in days).
Log Notifier – The notifications and their destinations are both specified by log notifier rules. Here you can set the period after which the log is checked for new events in the Check new records in log every: … seconds text box (300 by default).

6.11.1 Management of Log Notifier Rules
To add a new rule, click +Add item at the upper-left corner of the Log Notifier rules section. The properties panel of the new rule opens on the right side of the tab. On the tab, edit and save the rule.
To open the editing options of a rule, double-click the rule (or right-click the rule, and then click Edit on the shortcut menu). The following settings can be changed:

• Enabled: activate, deactivate the rule
• Rule name: name of the rule
• Type: the available event types – Info, Warning, Error, Notice, Debug, Critical
• Subsystem: subsystems of the MyQ application (Terminal, SMTP Server, CLI, etc.)
• Context: specific part of the subsystem
• Text: text of the log event message; you can use Regular expressions to search for specific patterns

After you set the notification rule, click Save. The rule is saved and you can select its destinations.
To add the destination, click +Add item under Destinations.

You can select between two destination options: E-mail and Windows Event Log. If you select the E-mail destination, you need to add one or more recipients; you can either select them from the list of MyQ users in the Recipients drop- down or directly type the addresses there. After you set the destination, click Save.
The new rule is displayed on the tab.

To enable/disable Log Notifier rules:

1. Right-click on the rule.
2. Select Enabled (or Disabled) on the shortcut menu.

6.12 REST API Apps
In MyQ, Settings, REST API Apps, you can add REST API applications.
Click +Add and fill in the Title, Client ID, Secret, and Scope of the application and click OK.

6.13 System Management Settings
On the System Management settings tab, you can set warning levels for the disk space checker, change the settings of the MyQ history, and also do system maintenance.

6.13.1 Disk space checker
In the Disk space checker section, you can set the Warning level and the Critical level (in MB) for the free disk space where the MyQ Central server is stored. Once one of these levels is reached, an email notification is sent to the MyQ administrator.
If the critical level is reached, services are also stopped.

6.13.2 History
In the History section, you can change the periods after which data stored on the MyQ server is deleted. You can set time periods for the following data:

• Delete history older than: User sessions remain on the MyQ Central server for the period (in days) set here. Anything older deleted.
• Delete printer events older than: Printer events remain on the MyQ Central server for the period (in days) set here. Older ones are deleted.
• Delete archived reports older than: Reports are archived for the period (in days) set here. Older reports are deleted.
• Close payment sessions older than: Payment sessions remain on the MyQ Central server for the period (in hours) set here. Older ones are deleted.
• Delete Audit log older than: The audit log stores information about change in MyQ Central server for the period (in days) set here. Anything older is deleted.

To change the values, enter new values to the particular text box, and then click Save.

6.13.3 System Maintenance

In the System maintenance section, you can delete data from the MyQ database, and manage advanced options.
Data Deletion section
The delete/remove buttons perform the following actions. These actions cannot be undone. It is recommended you backup your data before performing any of them.

• Users to delete: Deletes all users without user sessions.
• Deleted inactive users: Removes all inactive users from the MyQ database.
• Inactive printers: Removes all printers without a user session from the MyQ database.
• Projects to delete: Removes projects that were never used.
• User data: User Sessions, Jobs, Groups, Users: Removes all user related data from the MyQ database.

Advanced section

• Click the Restart HTTP Server (Apache) button, to restart the HTTP server.
• Click the Reconfigure MS Cluster monitoring script button to reconfigure the MS Cluster monitoring script.

6.14 Central and Site administration
As opposed to the MyQ Print server standalone model, where all parts of the MyQ system run on one server, the MyQ Central/Sites model consists of one Central server and multiple site servers.
The Central server cannot be used as a print server and its options are restricted to its central management role. Therefore it is not possible to administer printing devices or print jobs there. The site servers work as the print servers and perform local management of printing devices and print jobs. Their function and management options are similar to those of a standalone server.
After you setup your Central server and add and activate your licenses, you should setup your Site servers as well. In a Site server’s MyQ web interface, go to MyQ, Settings, Server Type and fill in the following information:
In the Server Type section, choose Site server. This can only be used within a MyQ Central server installation and the change is permanent. You cannot switch back to standalone mode afterwards.

In the Connection settings section:

• 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 secured.
• Port – 8093 by default.
• Password for communication – password used for the communication between the MyQ Central server and Site servers.

In the Licenses section:

• Embedded terminals – add the number of embedded terminal licenses to be used on this site (distributed by the Central server).
• Embedded Lite terminals – add the number of embedded lite terminal licenses to be used on this site (distributed by the Central server).

Once the site servers are connected to your Central server, you can manage them via the Central’s server MyQ web interface, in MyQ, Sites.
In the Sites main page, select a Site server and click Edit on the main ribbon (or double-click or right-click and select Edit on the Site server) to modify it. The Site server’s properties panel opens on the right side.

• On the General tab, you can view the Site’s name, port, and if the connection is secure. You can also add a description for the Site server.
• On the User Synchronization tab, you can select the user groups that you want to synchronize.
• On the Client tab, you can add IP ranges for the client PCs that will be used with MyQ Desktop Client (mandatory if you are using the Central server API to obtain the server address for MDC. Check here for more information). You can also exclude IP ranges on the tab.
• On the Rights tab, you can manage user rights for the Site server.

After any modification, click Save. Any changes are then distributed during the User Synchronization.

6.14.1 Site server data replication
Data replication from sites is set as a scheduled task on the Central server. You can change the time and period of its run on the Task Scheduler settings tab.
In case you want to run the task outside of the schedule, you can do so on the Sites main tab.
The replication consists of two stages: at the first stage, the data are downloaded from the site server to a folder on the Central server, and at the second stage, they are uploaded to the Central server’s database. Only data that are already uploaded to the database are included in the reports on the Central server.
On the Sites main tab, you can check the current state of replications for all site servers:

• The Status column gives you the following information:
  • Ready
  • Unknown, http 404
  • Error; this can be an http 5xx or http 200 with body ‘0’ error
  • Unreachable, a timeout. As an admin you can set the timeout and the period in the config.ini.
• The Last downloaded data column displays date and time of the last successful download of the site server data.
• The Download Status column shows either OK or a red (error) icon.
• The Last successfully replicated data column shows if any error happened during the replication. The displayed date and time represent the last record replicated before the error.
• The Replication status shows you any of three colored icons:
  • OK – all the downloaded data were successfully replicated.
  • Pending – there are downloaded data waiting to be replicated.
  • Error – replication was not finished due to errors (not warnings!).

To manually run a replication of a site servers’ data:

1. Open the Sites main tab (MyQ, Sites).
2. On the Sites main tab, select a Site, click Actions on the toolbar, and then click Replicate data.

Scheduled run of data replication from sites
By default, the data replication from sites is set to run once per day.

To change the Data replication from sites schedule, open the Task Scheduler settings tab (MyQ, Settings, Task Scheduler), and then double click the Data replication from sites schedule to open its properties panel, where it can be set. For more information, see Task Scheduler.

The statistical data on Site servers are stored for the period of time that is set on the System Management settings tab of the site server MyQ Web Interface, under History. To maintain the data, make sure that the time intervals between replications are shorter than these periods. Furthermore, the time periods for storing the data on Site servers should be long enough to avoid losing data, in case the scheduled replication is delayed, for example due to lost connection between the Central server and a Site server.

6.14.2 Site server rights management

Once a Site server is connected to the Central server, the MyQ administrator can manage the user rights for that server. Any changes are then distributed during the User Synchronization. As soon as the changes are synchronized, the previous user rights settings in the Site server are overwritten and the new rights are read-only in the Site server’s rights settings.
To manage a Site server’s rights in the Central Server, go to MyQ, Sites, select the Site server and click Edit on the main ribbon (or double-click or right-click and select Edit on the Site server). The Site server’s properties panel opens on the right side. Go to the Rights tab, click on Add user to select the user (or user group), and then assign rights to them.
There is also the option to copy these settings to another Site server. Select the Site server that you want to copy the settings to, and click Actions – Duplicate settings on the main ribbon (or right-click and Duplicate settings). On the Duplicate settings pop-up, select the Source of the settings from the drop-down, and in Duplicate settings, mark the checkbox next to the settings that you want to duplicate, User Synchronization and/or Rights. Click OK and the changes are copied to the selected Site server.

6.14.3 Job Roaming
The Job Roaming feature enables users to transfer their jobs from one location to another: jobs sent to one Site can be printed on printing devices at another Site.
The feature only works in the Central/Site mode, however, it does not have to be centrally managed; Job Roaming between two locations depends exclusively on the settings of the locations Site servers.
The print job is stored on the original Site server until the user logs in at another Site, where they download the job to the Job Roaming queue. Thanks to the fact that the files are not unnecessarily transferred between servers, this method guarantees the lowest possible network load.
On a Site’s server MyQ web interface go to MyQ, Settings, Jobs. In the Job roaming section:

• Allowed users – Select from the list which users are allowed to use job roaming.
• Manage queue for these jobs – Click to open and manage the job roaming queue’s properties.
• Separate job list – With this option, the remote jobs are displayed on a separate job list. This is optimal for 10+ servers and a slow network connection.
• Shared job list – With this option, the remote jobs are displayed on the same job list as the local jobs. This is optimal for up to 10 servers and a fast network connection.
  • Print remote jobs with Print All – This option is only available with a shared job list. If you select it, the Print All terminal action prints both local and remote jobs.

Licenses

A MyQ Enterprise or MyQ Ultimate license is required. You can purchase the license with rights to a certain number of printers.
For information about the differences between the two types of licenses, see http://myq-solution.com/products.
There are two ways of licensing in MyQ. The one that has been used so far (old licensing model), with separate keys for each license, and the new MyQ X licensing model -in use since MyQ Server 8.1 (patch 2), that introduced the use of an Installation Key per MyQ setup.
This chapter covers the following topics:

• adding, activating and deleting licenses
• extending software assurance licenses

7.1 License distribution to Site servers
When using a MyQ Central Server, licenses are first added to the Central server and then distributed to Site servers; no licenses are added directly to Site servers. On each Site server, you set parameters of the Site licenses (exact number of embedded and embedded lite terminals that will be available on the Site server). The Central server generates corresponding Site server licenses (Embedded terminals, Embedded Lite terminals) and accordingly subtracts the number of items from its own licenses.
When you add licenses to the Central server, make sure that you cover the needs of all the Site servers that are used together with the Central server. For example, if you run two Site servers, one with 12 activated printing devices and one with 17 activated printing devices, you need to add and activate a license supporting at least 29 printing devices. If there are 23 embedded terminals used with these printing devices, you need to add and activate a license supporting at least 23 embedded terminals, etc.

Once the installation key is added and activated on your Central Server setup, you can go to each Site server’s MyQ web interface and allocate licenses. Go to MyQ, Settings, Server type, in the Licenses section, add the number of licenses for Embedded terminals and/or Embedded Lite terminals and click Save.

7.2 Adding licenses
You can add new licenses either on the Home dashboard during the initial setup of MyQ, or any time on the License settings tab.
After activation, the license is linked with the hardware configuration of the server where MyQ is installed. If the configuration changes (for example, after you reinstall MyQ on a different server, or after you change any of the hardware components of the server), the license becomes invalid and you have to reactivate it within seven days.
The total number of devices allowed to be activated at the same time is equal to the number allowed by individual licenses (for example: a license allowing ten printing devices + a license allowing one printing device + a license allowing five printing devices = sixteen printing devices allowed to be activated).

Adding licenses on the Home dashboard
The first time you set up the system, you can add new licenses on the Home dashboard. In the License section, click Enter License. You are redirected to the License Settings tab, where you can add your license information.

Adding licenses on the License settings tab
On the License settings tab, you are asked to enter the following information about your installation:

• Company – Your company’s name
• Person – Your full name (e.g. the MyQ administrator’s name)
• Address – The company’s address
• Country – Select the country from the drop-down
• Email – Your email address
• Phone – Your phone number (optional)

Then, enter your Installation keys in the Enter the installation key field and click Save, and then Activate.

• If you are connected to the internet and you have used an Installation key, your licenses are now added and activated.
• If you have used license keys, your licenses are added but need to be activated. Follow the activation steps below.
• If you want to manually activate your licenses, see the steps below.
• If you haven’t purchased any license or installation keys yet, you can register in the MyQ Community portal and request for the free MyQ SMART license.

You can see the newly added licenses on the License settings tab, under License.
If you are using a subscription license, you can see when the subscription is expiring or when it is going to be automatically prolonged:
10 days before the expiration, a banner message appears on the interface, reminding you to prolong your subscription:
“Your subscription is about to expire soon, all services will stop in 10 day(s). Please prolong your subscription”
If you don’t prolong it on time, your licenses will expire and MyQ will stop working.
The following banner message is displayed: “MyQ is not running: There is an issue with your license. Check details on the ‘Settings > License’ page.”

If the MyQ server cannot connect to the License server:

• After the first unsuccessful connection, the MyQ server starts displaying the alert banner “MyQ server cannot connect to License server, subscription cannot be prolonged and all services will stop in X days. Check internet connection and try to connect manually”. X = number of days until the expiration + 10.
• If the MyQ server can’t connect to the License server for 10 subsequent days after the subscription has expired, the MyQ server will stop working and display the alert banner “Server stopped working, because it cannot reach License server to update the  subscription. Check internet connection and try to connect manually.”

7.3 Activating licenses
7.3.1 To automatically activate a selected license:
The HTTP Proxy Server setting for license activation is not supported for License Keys generated on the MyQ X Partner portal. Manual (offline) activation must be used instead.
Installation Keys are automatically activated as soon as they are added (if connected to the Internet).

7.3.2 To manually activate a license:
If you are using the old licensing model (with license keys):

1. Generate the MyQ-helpdesk .zip file. For information about how to do this, see “Generate data for support”.
2. Send a request for an activation key to license@myq-solution.com with the MyQ-helpdesk.zip file attached. You will get an email response with the generated activation key.
3. Go to the Licenses settings tab (MyQ, Settings, Licenses). Under License, click Activate manually (or right-click the license, and then click Activate manually on the shortcut menu.) A dialog box for entering the activation key appears.
4. In the dialog box, enter the received activation key, and then click OK.

If you are using the new licensing model (with Installation Keys):

1. Go to the MyQ Web Administrator interface, in MyQ, Settings, Licenses. Add your Installation Key and click Next. The online activation fails and you get the following message. Click on Manual Activation.
2. In the newly opened window, click on Download the activation request file.
3. Upload the file in the MyQ X Partner portal and download the activation response file.
4. Go back to the MyQ Web Administrator interface, upload the activation response file and click Activate.

7.3.3 Reactivating Licenses in case of Hardware change
When moving a MyQ installation from an old server to a new server, a Support task needs to be created with the MyQ License department (Support task – Type license issue) for license installation key reactivation

Steps:

1. Prepare the new server with a clean MyQ installation.
2. Create a backup of MyQ (MyQ Easy Config\Database\Backup) on the old MyQ server.
3. Restore the backup file from step 2 on the new MyQ server (MyQ Easy Config\Database\Restore).
4. With the Installation key now in MyQ Web UI\Settings\License on the new MyQ server, you should request for license installation keys activation in 10 days.
5. Generate the Helpdesk support file from the new MyQ server installation (MyQ Web UI\Log\Tools\Generate data for support).
6. Create a Support request (type License issue) for reactivating the installation key with attached Helpdesk support file on the MyQ Helpdesk partner portal.
7. When reactivation is confirmed in the task, activate the installation key in MyQ Web UI\Settings\License on the new MyQ server.

Notes:

• A valid Software Assurance is required for the period when these changes are made.
• In case of offline activation, provide the Helpdesk support file from the old MyQ server as well.
• Be sure that you are not using 2 MyQ servers with the same database at the same time.
• Licenses on the old MyQ server will no longer be activated (there is a 10 days period from deactivation).

When significant hardware changes are done on the MyQ server and MyQ installation key required activation in 10 days (MyQ Web UI\Settings\License), a Support task needs to be created with the License department (Support task – Type license issue) for license installation key
Steps:

1. Check MyQ Web UI\Settings\License in case any HW changes are done on MyQ server.
2. If the installation key in MyQ Web UI\Settings\License requires activation in 10 days or less, continue with the next steps.
3. Generate the Helpdesk support file (MyQ Web UI\Log\Tools\Generate data for support).
4. Create a Support request (type License issue) for reactivating the installation key with the Helpdesk support file attached on the MyQ Helpdesk partner portal.
5. When reactivation is confirmed in the task, activate the installation key in MyQ Web UI\Settings\License.

Notes:

• A valid Software Assurance is required for the period when these changes are made.

7.4 Deleting licenses
To delete a license:

1. Select the license that you want to delete.
2. On the Licenses settings tab, under License, click Delete.

7.5 Extending software assurance licenses
You can extend the support period by assigning a support license to the particular main license. This can be done at any time, even before your current support period expires. In this case, the service is extended from the last day of validity of the current support.

7.5.1 New licensing model (with Installation keys)
You can order to prolong your support on the MyQ X Partner portal. Once your order is approved, go to the MyQ Web Administrator interface, in MyQ, Settings, License and click the Update from License Server button to update your prolonged Software Assurance license. If the new date is not displayed, refresh the web page.

Manual activation

1. Once your additional licenses order is approved, go to the MyQ Web Administrator interface, in MyQ, Settings, License and click the Update from License Server button. Since there is no network, you will be prompted to Download the activation request file.
2. After you download the file, go to the MyQ X Partner portal, under your Project, in the Installations tab. Click Offline activation.
3. In the pop-up window, upload the offlineActivation.zip file you downloaded from the MyQ Web Administrator interface and click OK. The activation response file is then automatically downloaded.
4. Go back to the MyQ Web Administrator interface, upload the activation response file and click Activate. Your additional licenses are added and activated.

7.5.2 Old licensing model (with license keys)
The licenses can be extended on the License settings tab.

1. On the License settings tab, under License, click Manage Support. The license properties panel opens on the right side of the screen.
2. On the panel, click +Add Support license. The Add support license dialog box appears. You have to manually activate the license, as described below.

Manual activation

1. Generate the MyQ-helpdesk.zip file.
2. Send a request for an activation key to license@myq-solution.com with the MyQhelpdesk.zip file attached. You will get an email response with the generated activation key.
3. Add the support license key in the Activate support license dialog box, select the Activate manually option, enter an activation key, and then click OK.

7.6 Migrating old licenses to MyQ X
If you are using older MyQ editions, it is recommended to migrate your licenses to MyQ X.

Compared to older editions, MyQ X offers a new price list with updated and new functionalities, one Installation key containing all the license information instead of multiple license keys, a fast and automated license ordering process, and a complete overview in the MyQ X Partner portal of all the products and their software assurance.
Moreover, if you use embedded lite licenses, during the license migration to MyQ X, their price is halved (two embedded lite = one embedded license). If you have an odd number of embedded lite licenses, the total is rounded up, and then halved (eleven lite = twelve lite = six embedded licenses).

The software assurance expiration date is recalculated during the migration:

1. Expiration dates are converted to a real number and the average is computed. (for example, you have 100 x Embedded (E) and 200 x Embedded Lite (EL)  | so 100 x ‘expiration date’ of (E) + 200/2 x ‘expiration date’ of (EL)) / count of  ((E) + (EL/ 2))
2. The computed average is a real number and, converted back to the date format may produce, for example, 23h:56min – for this reason 1 day is added.
3. From the average corrected date, only the month + year are used, without day + time, and one month is added to the final date.

The prerequisites for license migration are:

• MyQ Print Server or MyQ Central Server 8.2 or higher installed (valid support required).
• Valid support required; support date for version 8.2 is 15 January 2021, but it is recommended having valid support all the time, especially when there are planned system changes and MyQ Helpdesk would be contacted.
• Access to the MyQ X Partner portal (Partner ID and password. If you do not have access, contact your Sales representative).

With the above prerequisites fulfilled, you can start the Migration Process.

7.6.1 Migration Process
You can start the license migration process in the MyQ web administrator interface.
Go to MyQ, Settings, License. At the top bar, click Upgrade to installation key.

The Upgrade to installation key wizard starts, guiding you through the upgrade:

1. If you already have an Installation Key, click Yes and continue to step 4. If not, click No.
2. The MyQ server will now export the MyQ-licenses.xml file. You need this file to generate the new installation key at the MyQ X Partner Portal. Click Next.
3. The MyQ-licenses.xml file has been downloaded. Go to the MyQ X Partner portal and follow the process to generate a new installation key. Once you generate it, your old license keys cannot be used again.
4. Back in the MyQ web administrator interface, insert the installation key in the field, and click Next.
5. MyQ is contacting the License server to get the license information. In case you have no internet connection, click Manual activation to manually activate the license.
6. Check the overview and if everything is correct, click Activate; otherwise, click Cancel.
7. Your license keys were successfully upgraded to an installation key and are now activated.

You can see your new licenses overview in the License settings tab.
If the activation fails due to connection issues, or for any other issues with the migration, contact MyQ Support.

7.7 VMHA License
Normally, the hardware signature of the server hosting MyQ is occasionally verified to make sure that the license is still installed on the same server and isn’t misused. In certain scenarios, the underlying hardware may change and so a license reset is required to re-activate the license. If the hardware changes often (which is common when the server is hosted in a virtual environment), the Virtual Machine High Availability (VMHA) feature may be required.

• The VMHA license is included free of charge in MyQ Enterprise and MyQ Ultimate 8.0+ licenses.
• For the VHMA feature to function, a domain environment is mandatory – the server running MyQ must be a member of a domain. For MyQ installed in an MS Azure environment, a domain is not required. Changing the domain or migrating to a completely different server will still require a license reset.

To verify that the VHMA feature is available, go to MyQ, Settings, License.
With old license keys, once the VMHA license is registered and activated, you can enable the VMHA feature in MyQ, Settings, Network. Once enabled, the license verification mechanism will no longer check for changes in the hardware when checking the HW license signature key.
With the new licensing model, with installation keys, VHMA is enabled by default in a Print Server or Central Server setting. If you are using Site servers, you have to enable the feature in each Site server.

User Management

Each Site server connected to your MyQ Central server can synchronize users directly from the Central server and be almost entirely dependent on the changes made there, described below.

There are, however, a few exceptions:

• Users can register themselves by swiping an unknown ID card, on the Web user interface, by sending a job via LPR protocol, or by sending a job via email. The newly created user is automatically replicated to the Central server. If the connection to the Central server is working, the user is automatically added to the server database and also replicated to the Central server database. From there, the accounts are imported to all other sites using the Central server as a synchronization source during the scheduled process of synchronization. If there is no online connection to the Central server, the registration of the new user fails.
• Users that are already in the system can change their language and generate PIN on the Web User Interface. In addition, they can register their cards on MyQ terminals. Every such change has to be authorized by the Central server. If there is no connection to the Central server, the registration of the new PIN/ card fails.
• The administrator can add a new card, and add or generate a new PIN for users that are already in the system. Every change has to be authorized by the Central server. If there is no connection to the Central server, the registration of the new PIN/card fails.

In the following sections, you can find information on user management options on the MyQ Central server:

• Overview, registration, adding, importing, synchronizing and deleting users: List of users, Manually adding users, Users synchronization from LDAP servers, Deleting users
• PIN generation: Generating PIN
• Individual users settings: Editing user accounts, Groups of users, Exporting users
• Special administrative rights: Rights

8.1 List of users
On the Users main tab, you can see users and information about them. With the All users search option selected, you see a list of all the users that are currently in the system.

Apart from this search option, you can also choose from:

• Unclassified – select to display only the users that do not belong to any group
• Managers – select to display only group managers
• Locked – select to display users whose accounts have been locked
• Deleted – select to display only deleted users

Default system users
The database of every installation of MyQ contains five default system users. These users are used for administration of the MyQ system and cannot be deleted.

1. *admin – This is the MyQ administrator account. It is used for administration of the MyQ system on the Web Administrator User Interface.
2. *api – MyQ uses this account to connect to external applications.
3. *fax – All printed faxes are charged to this account.
4. system – All the actions performed by the MyQ system are charged to the system user.
5. *unauthenticated – If there are any printed, copied or scanned pages that for some reason cannot be assigned to concrete users, they are charged to this account. This can happen, for example, if the print server is not available and users print in an emergency, offline mode on a printing device. It can also happen if someone prints directly on a printing device, bypassing the MyQ system. In such cases, you might need to check the printing device security settings.

8.2 Add users manually
To manually add a new user, follow these steps:

1. On the Users main tab, click +Add User. The properties panel of the new user opens on the right side of the screen.
2. On the panel, enter the username and full name of the user, and eventually set other data of the user account (see User information and settings), and then click Save.

8.3 Deleting users
When you delete a user, they are removed from all groups (including All users) and are marked Deleted. They are not completely removed from the MyQ database and can be undeleted.

Deleting users
To delete a user:

1. On the Users main tab, select the users that you want to delete, and then click Actions. The Actions drop-down box appears.
2. In the Actions drop-down box, click Delete. You can find the deleted users under the Deleted search option.

Undeleting users
To undelete a user:

1. On the Users main tab, under searches, select the Deleted search option. The list of deleted users appears.
2. On the list, select the users that you want to undelete, and then click Actions. The Actions drop-down box appears.
3. Click Undelete.

8.4 Editing user accounts
Each individual user has their own properties panel. To open the panel, double-click the user on the list on the Users main tab (or right-click the user, and then click Edit).
The properties panel opens on the right side of the screen. The panel is divided into three tabs: General, Groups, and Delegates.

8.4.1 User information and settings

• User name – Here you can enter or change the user name. This entry is mandatory. It is unique and is used to identify the user. It is compared to the parameter obtained from the User detection method.
• Aliases – In addition to their user name, each user can have a number of aliases. MyQ treats the aliases as alternative user names.
• Card – Here you can set the number of the user’s identification card.
• PIN – Here you can manually create or automatically generate new PIN code for the user and remove existing ones. An unlimited number of PINs can be added.
• Full name – Here you can enter or change the user’s full name. This entry is mandatory.
• E-mail – Here you can enter or change the user’s email.
• Phone – Here you can set the user’s phone number
• Personal number – The personal number can be used as the user ID in MyQ. The primary ID is the user name property.
• Default language – Here you can select the language of the user’s sessions on MyQ embedded terminals.
• User’s storage – Here you can set the folder or email, where scanned documents are saved.
• Use authentication server – If you select this option, an LDAP server is used for the user authentication. The user uses their LDAP credentials to authenticate to MyQ instead of having a password set in MyQ. Select the domain for the authentication on the setting below.
• Authentication server – Here you can select the LDAP domain for user authentication.

8.4.2 Adding/removing users from groups
To add a user to a group on the user properties panel, in the Groups tab:

1. On the bar at the top of the Groups tab, click +Add. The Select group dialog box appears.
2. In the Select group dialog box, select the groups where you want to add the user to.
3. Click OK.

A user can also be added to a group on the Users main tab using drag and drop. Drag the user and drop it on the group icon, on the groups tab on the left side of the screen.
Default group and Group manager options
On the bar at the top of the Groups tab, you can see two options: Accounting Group and Manager.
The Accounting Group is the group where the user is counted in reports and it is set to every user by default.
If you make a user the Manager of a certain group, the user can see jobs and reports of all the users from the group. To make the user a manager of a group, select the group and click Manager.
To remove a user from a group:
On the bar at the top of the Groups tab, click –Remove. The group disappears from the Groups tab.
To remove selected users from a group on the Users main tab, select the group there, select the users that you want to remove, click Actions, and then click Remove from group in the Actions drop-down.

8.4.3 Selecting user delegates
On the Delegates tab, you can select delegates (users or groups) who are able to print all of the delegating user jobs sent to a Delegate printing type of queue. The delegate will see the jobs on the embedded terminal. The print jobs are displayed in the form: (Sending user**Name of the print job).
Users need to have rights to a delegate printing type queue to be able to select delegates.

To select delegates:
On the bar at the top of the Delegates tab, in the Delegates combo box, enter the user (or the group of users), and then click Save. This way, you can add multiple users (or groups of users).

To deselect delegates:
On the bar at the top of the Delegates tab, in the Delegates combo box, point to the user (or group of users) that you want to deselect, and then click the remove button (X) on the right side of the user (or group of users).

8.5 User groups
On the Users main tab, you can create new user groups.
Creating user groups
To create a group, do the following:

1. On the group tab on the left side of the Users main tab, point on the group under which you want to create the new group. A drop-down box appears to the right.
2. On the drop-down box, click +New Group. The new group properties panel opens on the right side of the screen.
3. Enter a Name for the new group, and optionally add a Description.
4. Click Save.

To select delegates for the group:

1. Open the group properties panel by double-clicking on the group.
2. On the bar at the top of the Delegates tab of the group properties panel, in the Delegates combo box, enter or select the user (or the user group).
3. Click Save. This way you can add multiple users (or the user group).

To deselect delegates for the group:
On the bar at the top of the Delegates tab, in the Delegates combo box, point to the user (or user group) that you want to deselect, and then click the remove button (X) on the right side of the user (or user group).

Deleting user groups

1. On the group tab on the left side of the Users main tab, right-click the group that you want to delete.
2. Click Delete.

8.6 Exporting users
In case you need to export the complete list of MyQ users or a specific user group to a CSV file — for example if you want to use the CSV file for user synchronization — you can do so on the Users main tab of the MyQ Web Interface.
To export users:

1. Click Tools on the toolbar at the top of the Users main tab.
2. Click Export in the Tools drop-down.
3. In the pop-up window, select which user group you want to export, and click OK. The file is downloaded to your default Downloads folder.

8.7 User import and synchronization
User synchronization is a method of synchronizing user related data in the MyQ database with data in external sources, such as LDAP servers or CSV files. Importing new users is an optional part of the synchronization process. Within the synchronization setup, you can activate or deactivate the new users import; if you deactivate it, MyQ only updates accounts of users that already are in its database.
This topic provides detailed information about the synchronization. It fully describes the methods of import and synchronization available in MyQ, and presents two options of running the synchronizations:

• User synchronization from LDAP servers
• User synchronization from Azure AD with Microsoft Graph
• User synchronization from CSV files
• Manual and scheduled synchronization run
• User synchronization from Azure AD with SLDAP
• User synchronization from Google Workspace
• Using external authentication servers

User passwords are not synchronized/stored in the MyQ Database in case of LDAP/Azure synchronizations.

8.7.1 How does the user synchronization work?
First, you need to add a new synchronization source. Overall, there are the following possible types of synchronization sources: LDAP server, CSV file, Azure AD, and Custom script, but in this topic, we will discuss only the first three types. The synchronization from a custom script is used only in very specific cases; for information about this option, please contact your MyQ Support.
As soon as you add the synchronization source, MyQ opens its properties panel where you can set it up. Although they differ in their sources, all synchronizations have one thing in common; their goal is to adequately synchronize the user data in the source with the users’ data in MyQ.

User properties and synchronization options
User properties in MyQ

• User name: Name of the user account in MyQ. In Active directory and Open LDAP, this property corresponds to the samaccountname user attribute on the LDAP server.
• Full name: This is the full name of the user. In Active directory and Open LDAP, this property corresponds to the cn user attribute on the LDAP server. Usually, it is the given name and the surname of the user.
• Alias: In addition to their user name, each user can have a number of aliases. MyQ treats aliases as alternative user names. You can use aliases, for example, if you need to enable one user to send jobs to MyQ from different OS accounts.
• Card: The number of the user’s identification card. It can be either imported from LDAP or added to MyQ on the user’s properties panel. Also, it can be registered by an administrator on a card reader connected to a USB slot or registered by the user on an embedded terminal.
• PIN: The MyQ personal identification number is used for access to MyQ Web Interface and MyQ terminals.
• Personal number: The personal number can be used as the user ID in MyQ. The primary ID is the user name property. If you select the Pair by the personal number property during the user synchronization, the personal number is used instead.
• Email: The user’s primary email address.
• Notes: You can use this text box to enter additional notes concerning the user.
• Language: The language used on the user’s MyQ Web Interface and their home screen on the embedded terminal.
• User’s storage: You can select a folder or one or more email addresses where MyQ sends the user’s scans. Depending on the scanning setup, scans can be sent here, to the user primary email set in the Email property text box, or to other sources defined in MyQ or entered by the scanning users.

User synchronization options

• Deactivate missing users: If you select this option, MyQ deletes users that are imported from the current synchronization source and that are not in the source anymore. To delete users that were added from different sources, select the Ignore synchronization source option together with this option.

• Add new users: If you select this option, MyQ adds new users from the current synchronization source. If you do not select it, MyQ updates the user accounts of the users who are already in MyQ, but does not add any new users.

• Convert user name to lowercase: Unlike some other systems that do not differ between two words with the same letters but different cases (such as “Pear”, “pear”), MyQ is case sensitive. You can use the Convert user name to lowercase option to prevent creating multiple accounts for one user.

• Use authentication server: If you select this option and a user logs in by entering their username and password, the credentials are not authenticated against the MyQ database, but instead against an LDAP or Radius server. If you synchronize users via LDAP, the source LDAP server is automatically assigned as the authentication server. If you synchronize users via CSV, you can select the authentication server from the list of predefined authentication servers.

• Pair by the personal number: If you select this option, MyQ identifies users by their personal number instead of their user names. This way you can keep track of a single user with different names in different sources or a user whose name has changed for some reason. For example, if this option is activated and a username in LDAP changes from cat.stevens to yusuf.islam, MyQ does not create a new user account, but recognizes the old user by their personal number.

• Ignore synchronization source: If this option is not selected, MyQ recognizes two users from different synchronization sources as two different entities. This can cause conflicts during synchronizations from multiple sources. If it is selected, MyQ ignores the synchronization sources and treats all users the same, regardless of their synchronization source. For example, if you run a synchronization and MyQ would import/update a user that has been already added from a different synchronization  source, it does not update the user. Instead, it shows the message The name/alias “X” is already used by the user “X” among the synchronization results. After you select the Ignore synchronization source option, the user is updated by the latest synchronization.
  If you select this option together with the Deactivate missing users option, all users that were added from different sources and are not in the current synchronization source are deleted during the synchronization.

• Append the domain name to the username (username@domain.local): With this option selected, the name of the domain can be retrieved from the MyQ username. The information about the domain may be needed for example, when scanning to users’ home folders is used on an embedded terminal.

8.7.2 User synchronization from LDAP servers
An LDAP server contains a database that stores all user accounts, passwords and other user related data of an organization. On the LDAP Synchronization settings tab on the MyQ Web Interface, you can synchronize users directly from the server database.
MyQ can communicate with as much as five LDAP servers at the same time. It supports Active Directory, OpenLDAP, Novell, Lotus Domino and Google Workspace. To synchronize the users, you need to add the synchronization source first, and then setup the synchronization. After the synchronization is set up, you can either run it manually on the User Synchronization settings tab or set it as a regular task on the Task Scheduler settings tab.

The settings described here apply only to Active Directory, although the settings for OpenLDAP, Novell, Lotus Domino and Google Workspace are similar.
**** OpenLDAP, with its default settings, limits the number of returned entries and the maximum total time for a query. The default size limit is 500 entries and the default time limit is one hour. In case of a larger customer installation with OpenLDAP, you must adjust these limits appropriately in the OpenLDAP settings, otherwise the user sync will give incomplete results.
For more details see: https://www.openldap.org/doc/admin24/limits.html

Creating an LDAP synchronization
Before creating the synchronization, you have to add the LDAP server to MyQ. You do this on the Authentication Servers settings tab (MyQ, Settings, Authentication Servers).

To create a new LDAP synchronization:

1. Add the new synchronization:
   Under User synchronization, click +Add. A drop-down box appears. In the drop- down, click LDAP Server. The LDAP synchronization properties panel opens. On the panel, you can set up the synchronization.

2. Set up the synchronization on the LDAP synchronization properties panel:
   Set up the synchronization on all three tabs on the LDAP synchronization properties panel. On each of the tabs, click Save after changing the settings.
   For information about the synchronization setup, see “Setting up the LDAP synchronization” on the next page.

3. Return to the User synchronization overview:
   The new LDAP synchronization is displayed on the list of synchronizations.

Setting up the LDAP synchronization
The setup consists of three parts: creating the synchronization on the General tab, setting import of users on the Users tab and setting import of groups on the Groups tab. You can swap between these tabs on the bar at the upper-left corner of the LDAP synchronization properties panel.

General tab: Creating the synchronization
On the General tab, set the general properties of the synchronization: enable or disable the synchronization, select the LDAP server domain, enter user name and password for access to the server, eventually select to export the imported users to a CSV file. See the list below for a description of individual settings.

• Enabled: Here you can enable or disable the synchronization.
• LDAP Server: Here you can select the domain that you want to synchronize from.
• User: Enter the user name for access to the LDAP domain server.
• Password: Enter the password for access to the LDAP domain server.
• Enabled: If you enable the Export to CSV after successful import option, MyQ creates a CSV file with the imported users after the synchronization.
• File: Add the path to the folder where you want to save the created file.

After you correctly set the connection parameters (LDAP server, username and password) and save the settings, the LDAP browser opens on the right side of the screen.

In the User setting, a sub-domain user account with enough rights can also be used for authentication, but the sub-domain has to be specified in the username.
For example, the user Administrator connects to the testAD.local LDAP server, but their account is in the cz.testAD.local sub-domain. For successful authentication, the filled in username should be: Administrator@cz.testAD.local

Users tab: Selecting base DN, assigning attributes and additional settings
On the Users tab, pick one or more base DNs (distinguished names) from which you import the users. In addition, you can assign user attributes from the LDAP server to user properties in MyQ and select additional options concerning the synchronization.

• Base DN: Here you can pick the base domain or domains from which you import users. Click +Add to add a text box for the new base DN, and then drag a group from the database browser and drop it in the text box. You can add multiple domains this way.
• Properties: These are the properties of every individual user. MyQ will automatically find and assign the user’s SAM account name to user name, cn to full name and mail to Email (this applies to Active directory and OpenLDAP only). The user name property is the only one that cannot be changed. To assign an attribute to a property, write the name of the attribute in the property text box or drag it from the attributes of any individual user and drop it in the text box. The following properties support adding multiple values to them, separated by a semicolon (;):
  • Alias
  • PIN
  • Card

For example, in the Alias property, you could add alias1;alias2;alias3.
The AD attribute name should not contain the semicolon (;) character. If a semicolon is part of the attribute’s name, that attribute will not be synchronized in MyQ.

For assigning default languages to users, you have to use an attribute from the LDAP server that has the language abbreviations as its values. For example, you can create and use an attribute called lang with the values en for English, hr for Croatian, etc.
The list of the abbreviations used in MyQ can be found here.

• Options: For a description of the common synchronization options, see User information and settings. In addition to the basic options that are common for both the synchronization from LDAP servers and for synchronization from CSV files, there is one specific option that belongs only to the import from LDAP servers: append the domain name to the username (username@domain.local).
  This option enables you to save the information about the LDAP server in the user name. For more information about this option, contact your MyQ support.

• Filter: You can filter the users import by specifying the values of attributes. Add the conditions in the form: Attribute=Value. Users with a different value on this attribute are not accepted and are filtered out of the import.
  For attributes where the values are strings, such as the cn attribute, you can use the symbol to search for substrings. The symbol can be appended from both sides. For example, if you add a cn=in* condition, only users whose common name attribute contains “in” are accepted. Add one condition per row. Users are accepted if they satisfy at least one condition.

Groups tab: Importing groups
On this tab, you can import groups and the group structure from the LDAP source.
There are four different ways of specifying which groups are imported. You can use multiple different methods together and by each method, you can create different groups of users. You can also select to import the groups under an existing group in MyQ.

• Do not change default group: A user can be a member of multiple groups but all their prints, copies and scans are accounted to only one group: the default (accounting) group of the user. If you select this option, the default group of the selected user does not change during the synchronization.

• Import groups under this group: You can select an existing group in MyQ under which you import the groups from the LDAP database.

• Groups stored in user’s attribute:

  • Attribute: You can select this option if you want to use an attribute that defines groups in the LDAP database. To add it, type the name of the attribute in the property text box or drag the attribute from any individual user and drop it in the Attribute text box. You can also create groups by combining multiple attributes. To create such groups, put each of the attributes between two percentage signs (%). For example, the combination of attributes %attribute1%_%attribute 2% , imports a new group named value1_value2. Furthermore, you can create tree structures of groups by separating the attributes with vertical bars. For example, the combination of attributes %attribute1%|%attribute2%, imports a group value1, and its sub-group value 2.
  • Make default: If you select this option, the group becomes the default group of the imported user.

• Group stored in user’s DN:

  • OU component index: Here you can select a group by its OU (organizational unit) index among the DN components. The index is counted from right to left: the first OU group from the right has index 1, the second from the right has index 2 and so on. On the image above, there are three OU groups: MYQ_IMPORT_TEST has index 1 (as it is the first OU group from the right), famous_people has index 2 and Painters has index 3. The other components are not OU and therefore have no index.
  • Make default: If you select this option, the group becomes the default group of the imported user.

• Tree group stored in user’s DN: Here you can import the whole tree structure of groups. You can restrict the import to any part of the structure by striping the DN components from the left and from the right. In the respective text boxes, enter the amount of components to be striped from the left and from the right side. You have to strip at least one component from the left (the user CN component) and one component from the right (the right-most DC component). On the image above, there are six components. If you strip one component from the left and one from the right, you import the following structure of groups: testAD > MYQ_IMPORT_TEST > famous_people > Painters. By stripping components from the left, you remove the groups from the bottom to the top of the structure. By stripping components from the right, you remove the groups from the top to the bottom of the structure.

  • Make default: If you select this option, the bottom group of the imported structure becomes the default group of the imported user.

• Group stored in user’s memberOf attribute:

  • Group base DN: MyQ can import security and distribution groups stored in the user’s memberOf attribute. The security groups are used to define access permissions granted to their members. Distribution groups can be used for sending emails to a group of users. To specify which groups should be taken into consideration during the import, you have to insert the groups base DN. MyQ imports only groups that are included in the base DN; other groups stored in the memberOf attribute are ignored. The group base DN does not have to be in the same organizational unit as the users base domain. If a user is member of more than one group on the LDAP server, all the groups are stored in the memberOf attribute. Therefore, the Make default option, which requires a single value, is not available for this method of import.
    To add the groups base DN, drag it from the database browser and drop it in the Group base DN text box.

  • Filter: You can filter this import by specifying the values of attributes. Add the conditions in the form: Attribute=Value. Groups with a different value on this attribute are not accepted and are filtered out of the import. You can use the symbol to search for substrings. The symbol can be appended from both sides. For example, if you add a cn=in* condition, only users whose common name attribute contains “in” are accepted. You can add one condition per row. Groups are accepted if they satisfy at least one condition.

  • Import empty groups: If you select this option, groups from the Group base DN are imported even if there is no user having them in their memberOf attribute.

  • Import tree of groups: If you select this option, the whole tree structure is imported. Otherwise all groups are added separately; not as a part of a tree structure.

8.7.3 User synchronization from Azure AD with Microsoft Graph
Azure AD with Microsoft Graph is a service accessed from the Microsoft Azure Portal, where it has to be enabled and configured.
Once the Azure AD connection is established, go to MyQ, Settings, User Synchronization.

1. Click Add, and then click Add Azure AD source.

2. In the Azure AD synchronization properties panel to the right, in the General tab, if you have already set up an Azure AD connection, the Azure AD server is already in the Authentication Server field. Otherwise, click Add new and set up an Azure AD connection.

3. Click Save.

4. In the Users tab: a. You can map user information from Azure AD to the credentials in MyQ.
   b. If you plan to authenticate users towards Azure using Active Directory credentials and use the Microsoft single sign-on option, select the Use as authentication server option and click Save.

5. In the Groups tab, you can select what Active Directory groups you want to remove from synchronization using the Ignore groups and Ignore groups containing string fields.

Users can be now synchronized by selecting your Azure AD source from the list and clicking Synchronize now.

8.7.4 User synchronization from CSV files
To synchronize users from a CSV file, you have to create a new CSV synchronization on the User Synchronization settings tab and on the synchronization properties panel, add the source file and set properties of the synchronization.
After the synchronization is set up, you can either manually run it on the User Synchronization settings tab or set it as a regular task on the Task Scheduler settings tab.
CSV synchronization:

• Creating a new CSV synchronization
• CSV synchronization setup options
• CSV file syntax

Creating a new CSV synchronization
To create a new synchronization:

1. On the bar at the top of the User Synchronization settings tab, click Add, and then click Add CSV source. The CSV synchronization properties panel appears on the right side of the screen.
2. Set up the synchronization: On the CSV synchronization properties panel, set the path to the CSV file and configure the synchronization. For information about the synchronization options, see “CSV synchronization setup options” below.
3. Save the setup.

CSV synchronization setup options
These are the CSV synchronization setup options:

• Enabled: Here you can enable or disable the synchronization.
• CSV file: Here you can set the path to the CSV file on the MyQ server.
• Encoding: Select the encoding that is used in the CSV file. The default value depends on the OS settings of the computer where you access the MyQ Web Interface on.
• Column delimiter in CSV: Select the delimiter that is used in the CSV file. If you select the Default option, MyQ scans for the delimiter set on the Column delimiter in CSV drop-down list box on the General settings tab.
• Skip header line: In case the CSV file contain a header line, you need to select this option and skip the first line of the file during the synchronization. All lists of users exported from MyQ contain the header line.
• Import groups under this group: Here you can select an existing group in MyQ under which you import the groups from the CSV file.
• Synchronization source: Here you can specify a different source than the CSV to be marked as the synchronization source by the MyQ system. For example, you can insert an LDAP server domain.
• Ignore synchronization source: If you select this option together with the Deactivate missing users option, all users that are not in the current synchronization source are deleted.
• Use authentication server: If you select this option, an LDAP or Radius server is used for the authentication of the imported users.
• Authentication server: Here you can select the LDAP or Radius domain for the user authentication.
• Deactivate missing users: If you select this option, MyQ deletes users that are imported from the current synchronization source and that are not in the source anymore. To delete users that were added from different sources, select the Ignore synchronization source option together with this option.
• Add new users: If you select this option, MyQ adds new users from the current synchronization source.
• Pair users by personal number: If you select this option, multiple accounts with a single personal number are paired.
• Convert user name to lowercase: If you select this option, all letters in user names are converted to lowercase.
• Cards/PIN/Groups/Delegates: In each of the mandatory drop-down boxes, you can select from these synchronization options for the respective parameter (Cards, PIN, Groups):
  • Do not synchronize: The value of the respective parameter in MyQ is not changed.
  • Full synchronization: The value of the respective parameter in MyQ is always replaced by the value in the CSV file. If the value in the source file is empty, the value in MyQ is erased.
  • Synchronize if not empty: If the respective field in the CSV file is not empty, the parameter value in MyQ is replaced by the value in the CSV file. Otherwise, the parameter value remains unchanged. This is the default setting.
  • Add new: If the parameter is already set in MyQ, it is not replaced. Only new values are added.

CSV file syntax
In the list below, you can find information about individual fields of the CSV file.
A single word or a plain number can be put in the CSV fields as they are, while more complex strings, such as full name or email address, have to be bounded by quotes.

• FULLNAME: Name of the user in double quotation marks, for example “Thomas Pineapple”.
• USERNAME_ALIASES: Login of the user and eventually their aliases. The login should be the same as the user’s domain login name, for example Tom. When you import multiple aliases, separate them with commas, for example “Tom,Tomy,Apple”.
• EMAIL: Email of the user, for example “t.pinapple@domain.com“.
• CARDS: Number of the user’s authentication card/chip. It has to be inserted in the form in which it is read by the card/chip reader, for example 7E9700C9.
• GROUPS: Here you can add user groups. You can import a whole branch of the groups tree structure. The groups on the imported branch have to be separated by vertical bars. If you want to import multiple groups (or groups tree branches), separate them by commas. For example, if you add two branches separated by a comma: “Activities| Outdoor| Swimming, Activities| Outdoor|Birdwatching”, MyQ imports a single parent group Activities with a single child group Outdoor, with two child groups Swimming and Birdwatching (Activities>Outdoor>Swimming,Birdwatching). Commas and vertical bars cannot be used in group names as they are used as group delimiters.
• CODE: The personal number of the user. The ID number must be unique for each user. This parameter is very useful when using multiple sync sources.
• SCANSTORAGE: The folder or email where the user wants their scans to be sent to, for example “\Users\Tomy”.
• PIN: You can define one or more PINs to be assigned to users within the synchronization process. It is not absolutely necessary, as PINs may also be generated later within the setup of the user account. The PINs should be in the hashed MD5 format, for example 14BFA6BB14875E4.
• MANAGED_GROUPS: You can make the user the manager of a particular group by adding the group or path to the group here in the way in which you would import the group. If you want the user to be a manager of a child group, enter a whole branch ending with this group. For example, enter the branch “Activities| Outdoor| Swimming” to make the user a manager of the Swimming group. If there are no parents of the group in the group structure, enter just the group name, e.g. Activities. Commas and vertical bars cannot be used in group names as they are used as group delimiters.
• AUTHSERVER: In this field you may define the domain for user authentication, for example “testAD.local”.
• PHONE: The user’s phone number, for example 080008020.
• LANG: Default language of the user, for example en.
• PWD: If you want to use the MyQ password, insert the password in the hashed MD5 format, for example 18BFA6BB14875E8. If you are using a different authentication server (i.e. LDAP server), you can leave it empty.
• EXTID: EXTID is an internal MyQ parameter. This field has to be left empty.
• DELEGATES: For each user, you can import any number of delegates. If you import multiple delegates, separate them with commas, for example “Carol,Kohei,Eliot”.

8.7.5 User synchronization from Azure AD with SLDAP
Azure AD with SLDAP is a service accessed from the Microsoft Azure Portal. It has to be enabled and configured in Azure Active Directory Domain Services.
The activation and setup of the service are described in the following Microsoft guides:

• To enable and configure Azure Active Directory Domain Services: https://docs.microsoft.com/en-us/azure/active-directory-domain-services/tutorial-create-instance
• Configure Azure AD Domain Servers to use SLDAP: https://docs.microsoft.com/en-us/azure/active-directory-domain-services/tutorial-configure-ldaps

After you activate the Azure AD, you need to add it to MyQ and set up the synchronization in the standard way (see User Import and synchronization). When setting up the Authentication server in MyQ, you need to make sure that the LDAP server parameters are set to the following values:

• Domain = DNS DOMAIN NAME of the Azure AD Domain
• Security: SSL
• Server = SECURE LDAP EXTERNAL IP ADDRESS of the Azure AD Domain

8.7.6 User synchronization from Google Workspace
Google Workspace (previously named G-Suite), a set of cloud computing, productivity and collaboration tools, software and products developed by Google Cloud, can be used with MyQ Central Server (versions 8.0+). For setting up the connection to MyQ follow the short procedure below.

• Go to https://support.google.com/a/answer/9048541?hl=en to configure your
  Google Workspace Environment for working with MyQ as an LDAP Client.

  • Turn service status on or off
  • Edit access permissions

• Go to https://support.google.com/a/answer/9048541#generatecertificateauthentication to get a private key and a certificate.

  • Generate certificate authentication
  • Generate access credentials.
    The downloaded file is a *zip file containing the private key and the certificate you need for connecting to MyQ.

• After the above procedure, you need to set up the user synchronization from Google Workspace in the standard way. When setting up the Authentication server in MyQ, you need to make sure that the LDAP server parameters are set to the following values:

  • Domain – add your Google Workspace domain
  • Type – select Google Workspace from the drop-down
  • Certificate – click Add and browse to upload the downloaded certificate file (.crt)
  • Private key – click Add and browse to upload the downloaded private key file (.key)

8.7.7 Using external authentication servers
In addition to the internal MyQ authentication methods (password, PIN or ID card), you can use two types of external authentication servers: LDAP and Radius. With the two external methods, MyQ does not use the internal MyQ PIN or password for user authentication, but instead authenticates users against an LDAP or Radius server. After the user enters their credentials during the authentication, the credentials are sent to be verified directly by the external server. If there is no online connection with the LDAP or Radius server, users cannot log in.

To enable this method of authentication, you have to take two steps:

1. register the external authentication servers in MyQ
2. select to use them for user authentication

To register external authentication servers in MyQ, see Authentication Servers Settings.

Selecting to use the registered external authentication servers for user authentication, can be done either automatically during the user import from an LDAP server or a CSV file, or manually on the properties panels of individual users.

Automatically selecting the external authentication option

Importing users from a CSV file
When you import users from a CSV file, you have two options of selecting the authentication server for the users:

1. You can select the Use authentication server option and select the server during the synchronization setup on the synchronization properties panel.
2. You can specify the Authentication server for a particular user in the AUTHSERVER field of the CSV file. If the field is not empty, its value has priority over the value selected on the properties panel.

For more information about importing users from CSV files, see User synchronization from CSV files.

Importing users from an LDAP server
During the users import from an LDAP server, you can select the Use authentication server option, to use the current synchronization source server for users authentication. For information about importing users from LDAP servers, see User synchronization from LDAP servers.

Unlike the Use authentication server setting for the import from a CSV file, which allows you to select the authentication server, the Use authentication server setting here gives you a single option — users will be authenticated against the LDAP server where they are imported from.

Manually selecting the external authentication option
To manually select the external authentication option

1. Open the Users main tab and double-click the user. The user’s properties panel opens on the right side of the screen.
2. On the panel, select the Use authentication server option. The Authentication server setting becomes available.
3. On the Authentication server drop-down, select the server you want to use, and then click Save at the bottom of the panel.

8.7.8 Manual and scheduled synchronization run
The synchronization can be manually run on the User Synchronization tab of the MyQ Web Interface, or it can be set as a scheduled task on the Task Scheduler tab.

Manual synchronization run
On the User Synchronization settings tab, enable the synchronizations that you want to run, and then click Synchronize now on the bar at the top of the tab.

Scheduled synchronization run
On the Task scheduler settings tab, you can setup a scheduled run of the synchronization. For more information about this option, see Task scheduler.

8.8 Users Settings
In the Users settings tab (MyQ, Settings, Users), the MyQ administrator can manage MyQ users General settings, the MyQ users PIN options, the MyQ accounts Password complexity, and the MyQ Account lockout options.

General section

• Enable user profile editing – By default, all users can change their password and their default language on their MyQ Web accounts and on some embedded terminals, while the rest of their properties can be changed only by the administrator. If the Enable user profile editing option is enabled, users can also change their full name and email, and select their delegates.
• Show more info about user profile – If enabled, the User profile widget on the MyQ web interface will contain more information.
• Enable deleting all ID cards – If enabled, all ID cards can be deleted.

PIN section

With the User can change PIN option selected, the users can generate a new PIN on their account on the MyQ Web User interface, by clicking Generate PIN on the Home screen of their user account.
The Minimal PIN length option determines the mandatory minimum PIN length. The number can be set between 4 and 16. If the administrator creates the PIN manually, it cannot be shorter than the value set in this field. If the PIN is generated by the system, it cannot be shorter than the value in this field, and also cannot be shorter than the minimal value enforced by the number of users, described below.

The required minimal PIN length that depends on the number of MyQ users is:

• < 1000 — 4-digit pin is required
• 1000 – 10 000 — 5-digit pin is required
• 10 000 – 100 000 — 6-digit pin is required

The required minimal length lowers the chance of randomly guessing the PIN. Also, trivial PINs, such as 1111 or 22222, are excluded from the automatic PIN generation process.
If the administrator increases the Minimal PIN length value, a pop-up will prompt them to generate new PINs for all the active users. If the administrator chooses to generate new PINs, the old PINs will be deleted and new PINs will be automatically sent via email to all the active users. Otherwise, the old, potentially shorter PINs will be kept.

With the Generate PIN for users created in synchronization or manual input option selected:

• A new PIN is generated for new, manually created users.
  • A manually created user without an email address will not receive the new PIN via email.
• During User synchronization, a new PIN is generated for every user that does not already have a PIN.
  • PINs are generated only for users with an email address. Users without an email address are skipped.

With the Send new PIN via email option selected, users are sent an email informing them about the new PIN every time a new PIN is generated. This is automatically checked if the above option (Generate PIN for users created in synchronization or manual input) is selected.
There are also email templates you can use for informing the users about their new PIN (Email with a new PIN) or for providing them with a reset code in case of a lost/ forgotten PIN (Email with the PIN reset code). The template is editable and the values can be reset to their defaults if needed, by clicking Revert values.

Temporary PIN section
With the option to Generate PINs as temporary selected for the user groups in the Only for users in groups field, the automatically generated PINs are always temporary. You can set the Validity of temporary PINs in hours (24 hours by default).

Password Complexity section
In this section, the MyQ administrator manages the password complexity of MyQ users accounts.

• Minimum length – set the minimum character length for the password, in range 1-100 (8 by default).
• Enforce password complexity – set how many of the four password complexity rules are to be enforced (2 by default):
  • At least one upper-case letter
  • At least one lower-case letter
  • At least one number
  • At least one special (non-alphanumeric) character

Account lockout section
In this section, the MyQ administrator can set the number of failed login Attempts before lockout, and the Lockout time (in minutes).

8.9 Rights
On the Rights settings tab, you can provide users or groups of users with administrator rights or provide them with rights to run one or more of the MyQ agendas: they can perform actions, change settings or see information that are inaccessible under a standard user account. On the tab, you can add users or groups and provide them with the rights.
To add a new user or a group of users to the list on the Rights settings tab:

1. On the Rights settings tab, click +Add User. The Select user or group dialog box appears.
2. In the dialog box, select the user (or group) and click OK.
3. Select the user (or group) rights.
4. Click OK. The user (or group) appears on the list on the Rights settings tab.

To edit a user’s rights:
Double-click the user (or the group) on the list of users and groups on the Rights settings tab. The panel appears on the left side of the screen.
In the user rights panel, under the General section, you can change the user’s rights.
These rights are described below:

• Administrator – The user is provided with administrator (*admin) rights.
• Manage licenses – The user can view and manage MyQ licenses on the License settings tab.
• Manage payments – The user gets access to the Payments main tab.
• Manage reports – The user can manage all reports.
• Manage settings – The user gets access to management of all settings on the Settings tab of the MyQ Web interface except for the settings on the Rights tab.
• Manage users – The user gets access to the Users main tab, the Users settings tab and the Policies settings tab, can add users and change their settings and rights. The user also gets access to the Accounting settings tab, but cannot change the settings. Access to the Credit settings tab is granted, but the user is only allowed to change Users and Groups.
• Manage vouchers – The user can get access to the Voucher Batches main tab.
• Read Jobs – The user can see other users’ jobs.
• Recharge credit – The user gets access to the Recharge credit main tab.
• View log – The user can view the MyQ log.
• View printers – The user gets access to the Printers main tab, to monitor printers.
• Delete Cards – If granted, the user has the Delete all ID cards button available on their User profile widget in the MyQ web UI and they able to delete all their ID cards.

Credit

With the credit accounting feature activated, users can copy, print, and scan only if they have enough credit on their account in MyQ. Printing is allowed only for print jobs that do not exceed the credit, and copying is terminated immediately after the credit is exceeded. The credit system can be restricted to selected users and groups.
Users can view the current amount of credit on their accounts on the MyQ Web Interface and in the MyQ mobile application. If a printing device is equipped with an embedded terminal or a reader with an LCD display, the logged users check the current state of their credit there and are allowed to select only those jobs that do not exceed their credit.
Based on the setup and properties of the printing environment, a variety of recharge methods may be employed. The MyQ administrator can manage the credit on the MyQ Web Interface, and also provide the users with the option to recharge the credit themselves on embedded terminals, on recharging terminals, in the MyQ mobile application, via recharging vouchers, or via a third-party payment method.
The MyQ Administrator (and authorized MyQ users) can also reset the credit to a specific amount on the MyQ Web Interface.

9.1 Activation and setup
The activation and setup of credit accounting is managed on the Credit settings tab (MyQ, Settings, Credit).
To set up credit accounting:
On the Credit settings tab, set credit accounting to Enabled and click Save:

Activate credit for a user or for a group of users:

• Under Users and Groups, click +Add item. A new item appears on the list of users and groups on the Credit settings tab. Select a Name (user or group) from the drop-down.
• Click OK to save the settings.

Enable/disable methods of payment for credit recharge
Available payment methods:

• CASHNet
• External Payment Providers
• PayPal
• SnapScan
• TouchNet uPay
• Voucher
• WebPay

To enable any of these options (if disabled), select it in the Payment providers section, and then click Enabled on the bar at the top of the section (or right-click the item, and then click Enabled on the shortcut menu).

Make sure to refresh your browser (reload the page or press the F5 button) after enabling or disabling Credit to display/hide credit-related functions.

9.2 Manual Credit recharge
The administrator (and users authorized to recharge credit) can manually recharge the credit of each user to a specific value. This can be done either on the Credit Statement main tab, or on the Users main tab in the MyQ Web administrator interface.
On the Credit Statement tab, you first open the credit recharge action, and subsequently select the users and groups to recharge credit.
On the Users tab, first select the users or group, and then recharge their credit.
Users’ credit can be reduced by entering a negative number in the recharge credit dialog box. By entering -100, the credit is decreased by 100.

9.2.1 Providing users with rights to recharge credit
By default, the only person who can recharge credit is the administrator. However, the administrator can authorize a MyQ user to recharge credit as well. The user needs to be provided with the rights to access the credit settings and to recharge credit. This is done on the Rights settings tab of the MyQ Web Interface.
To authorize a user to recharge credit on the Credit Statement tab, you need to provide them with the right to Recharge credit.
To authorize a user to recharge credit on the Users tab, you need to provide them with the right to Recharge credit, and the right to Manage Users.
The authorized user can then recharge credit on their MyQ Web interface in the same way as the MyQ administrator.

9.2.2 Recharging credit on the Credit Statement tab
On the Credit Statement tab, you can overview the changes in the credit balance of MyQ users, and also recharge credit to users and groups. To open the tab on the MyQ Web administrator interface, go to MyQ, Credit Statement.

To recharge credit to users or groups:

1. Click Recharge Credit. The Recharge Credit dialog box appears on the tab.
2. In the dialog box, either Enter the card ID of a user card, or select the User or group to recharge the credit to, then Enter amount to be recharged, and lastly click Recharge credit.

You can also Reset Credit and Unblock Credit to users or groups, by clicking the relevant button, selecting the user or group, and the credit amount.

Depending on the administrator and device settings, when the server blocks credit on the account, it temporarily decreases the available balance until the user session finishes. This prevents spending the same credit multiple times resulting in a negative balance. Credit may also be blocked when there is a server or account failure while the user’s session is active.

9.2.3 Recharging credit on the Users main tab
To open the Users main tab on the MyQ Web administrator interface, go to MyQ, Users.
To recharge credit to selected users:

1. Select the users.
2. Click Actions.
3. Click Recharge Credit in the Actions drop-down. The Recharge Credit dialog box opens.
4. Enter amount to be recharged, and then click Recharge credit. The credit is increased by the specified amount.

To recharge credit to a group of users:

1. In the panel on the left side of the Users main tab, right-click the group, and select Recharge credit. The Recharge Credit dialog box appears.
2. In the dialog box, Enter amount to be recharged and click Recharge Credit.
   The credit is increased by the specified amount.

9.3 Recharging credit via CASHNet
The CASHNet payment gate enables customers to directly pay for their credit via a payment card or via a digital wallet.
To be able to integrate the CASHNet payment gate into MyQ, you need to have a Checkout store created by the service provider. For the correct setup and MyQ integration, you need to save the following data:

• Operator ID, Password, Station, and Client Code are necessary for logging in to the CASHNet Web User Interface.
• Merchant name, Station, Store URL, and Item code of the Checkout store are necessary for the integration into MyQ.

9.3.1 Setting up CASHNet
Set up the eMarket store on the CASHNet Web User Interface

1. Log in to the CASHNet Web User Interface.
2. Open the Store Setup tab.
3. On the tab, click the dark blue button with the text Click here to use new eMarket store setup for Storefronts&Checkouts. The eMarket store setup page opens.
4. On the page, double-click the Checkout store button to open its setup page.
5. On the Checkout setup page, under End of transaction behavior, configure the following options:
   a. Show receipt page: disable
   b. Use redirect URL(s): enable
   c. Redirect URL for successful transactions & successful online post responses: leave empty
   d. Redirect URL for unsuccessful transactions or non-responsive online post attempts: leave empty
   c. Append data to the redirect URL: set to Yes, and redirect using HTTP post

You can now leave the CASHNet Web User Interface.

Set up the CASHNet payment option on the MyQ Web Interface

1. Open the Credit settings tab (MyQ, Settings, Credit).
2. On the tab, under Payment providers, double-click the CASHNet payment provider (or right-click the CASHNet payment provider, and then click Edit on the shortcut menu). The CASHNet properties panel opens on the right side of the tab.
3. The value of the Currency setting corresponds to the currency set on the General settings tab of the MyQ Web Interface.
4. Type the Minimal amount that users will have to pay when they buy credit.
5. Enter the Merchant name, Station, Store URL, and Item Code of the Checkout store, and then click Save.

9.3.2 Recharging credit via CASHNet on the user’s account on the MyQ Web Interface
First of all, the user needs to log in to their account on the MyQ Web Interface. To recharge the credit there, the user has to click Recharge credit under Credit. The Recharge credit dialog appears.

In the dialog box, the user has to select the CASHNet payment provider, enter the amount of credit that they want to buy, and then click Recharge Credit.
A window with the CASHNet payment options opens in the web browser; the rest of the steps correspond to the standard CASHNet payment process.
After the payment is successfully sent to MyQ, the Payment successful dialog box appears.

CASHNet tries to connect to the MyQ server via the hostname or IP address that is set on the Network settings tab of the MyQ Web Interface. In case a hostname is set on the tab and paying users receive the “This site can’t be reached / XYZ’s server DNS address could not be found. / DNS_PROBE_FINISHED_NXDOMAIN” message. Try to replace the hostname with the IP address of your server.

9.4 Recharging credit via PayPal
Another way of recharging credit in MyQ is to let users directly buy the credit via PayPal on their accounts on the MyQ Web interface.
A PayPal Business account is required to receive the payments.
The currency used on the PayPal account of the paying users has to match the currency set on the MyQ server. In case someone pays in a different currency, the payment does not go through and stays in the pending transactions of the receiving PayPal account. In order to receive the payment, the administrator has to approve the transaction on the PayPal account. After this, the credit must be manually recharged on the MyQ server as the information about the payment is not sent to MyQ.

9.4.1 Setting up PayPal
To set up PayPal as a payment option, you have to create a new App to link your company’s PayPal business account with MyQ, and then set up the PayPal payment option on the MyQ Web Interface.

Create a new REST API app in the PayPal Developer environment

1. Log in to the PayPal Developer environment (https://developer.paypal.com/) with your PayPal Business account’s credentials, and then open the Dashboard.
2. On the Dashboard, under MyApps & Credentials, create a new REST API app. The new app’s settings tab opens.
3. Select Live at the upper-right corner of the tab, and remember (copy) the app’s Client ID and Secret. The credentials will be used to connect the account to MyQ.

Set up the PayPal payment option on the MyQ Web Interface

1. Open the Credit settings tab (MyQ, Settings, Credit).
2. On the tab, under Payment providers, double-click the PayPal payment provider. The PayPal properties panel opens on the right side of the tab.
3. The value of the Currency setting corresponds to the currency set on the General settings tab on the MyQ Web Interface.
4. Type the minimal amount that users will have to pay when they buy credit.
5. Enter the Client ID of the REST API app into the Client ID text box on the PayPal properties panel and the Secret into the Security key text box below it.
6. Make sure that the LIVE Mode is selected, and then click Save. (The SANDBOX mode is used only for testing purposes).

9.4.2 Recharging credit via PayPal on the user’s account on the MyQ Web Interface
First of all, the user needs to log in to their account on the MyQ Web Interface. To recharge the credit there, the user has to click Recharge credit under Credit. The Recharge credit dialog appears.

In the dialog box, the user has to select the PayPal payment provider, enter the amount of credit that they want to buy, and then click Recharge Credit.
A window with the PayPal payment options opens in the web browser; the rest of the steps correspond to the standard PayPal payment process.
After the payment is successfully sent to MyQ, the Payment successful dialog box appears.

PayPal tries to connect to the MyQ server via the hostname or IP address that is set on the Network settings tab of the MyQ Web Interface. In case a hostname is set on the tab and paying users receive the “This site can’t be reached / XYZ’s server DNS address could not be found. / DNS_ PROBE_FINISHED_NXDOMAIN” message, try to replace the hostname with the IP address of your server.

9.5 Recharging credit via SnapScan
With the SnapScan app, users can pay for their MyQ credit via a QR code displayed in the app on their mobile phones.
To be able to connect SnapScan to MyQ, you need to create a Merchant SnapScan Account and obtain the Merchant Account API. Within the setup of the connection on the MyQ Web Interface, you must enter the Merchant ID and the API key of the account.

As SnapScan is a South African service, users need to use a phone with a South African Mobile number (+27) to be able to scan the QR code and pay for the credit.

Setting up the SnapScan payment option
To set up the SnapScan payment option on the MyQ Web Interface:

1. Open the Credit settings tab (MyQ, Settings, Credit).
2. On the tab, under Payment providers, double-click the SnapScan payment provider. The SnapScan properties panel opens on the right side of the tab.
3. The value of the Currency setting corresponds to the currency set on the General settings tab of the MyQ Web Interface. For the SnapScan payment method to work, it needs to be set to ZAR.
4. Type the Minimal amount of money that has to be paid when a user buys the credit.
5. Enter the Merchant ID(Company Name) and the API key provided by SnapScan.
6. Set the Time interval to get payments (in seconds), and click Save. The Time interval to get payments setting limits the time for the recharge action; if MyQ does not receive confirmation of the payment within the interval, the credit recharge is canceled. If the payment is successful but MyQ does not receive the response within the time limit, the user has to contact the MyQ administrator, who can manually recharge the credit.

9.5.1 Recharging credit via SnapScan on the user’s account on the MyQ Web Interface
First of all, the user needs to log in to their account on the MyQ Web Interface. To recharge the credit there, the user has to click Recharge credit under Credit. The Recharge credit dialog appears.

In the dialog box, the user has to select the SnapScan payment provider, enter the amount of credit that they want to buy, and then click Recharge Credit.
A window with the SnapScan payment options opens in the web browser; the rest of the steps correspond to the standard SnapScan payment process.
After the payment is successfully sent to MyQ, the Payment successful dialog box appears.

SnapScan tries to connect to the MyQ server via the hostname or IP address that is set on the Network settings tab of the MyQ Web Interface. In case a hostname is set on the tab and paying users receive the “This site can’t be reached / XYZ’s server DNS address could not be found. / DNS_ PROBE_FINISHED_NXDOMAIN” message, try to replace the hostname with the IP address of your server.

9.6 Recharging credit via TouchNet uPay
With partner driven recurring payments, the TouchNet Ready Partner application is the recurring engine controlling when payments take place, as well as the amount of each payment. The TouchNet Ready Partner’s application links the user to the uPay payment pages where the user enters their payment information. This can be either a credit card or a bank account. This solution is widely used on American campuses for making payments.

9.6.1 Setting up TouchNet uPay
To use this option in MyQ you must be a partner of TouchNet.
MyQ only supports SSL, so your MyQ application must use a secure port. The default is 8093.
You also need to copy the following information Client ID, API Key and uPay Site ID.
To setup TouchNet uPay in MyQ:

1. Open the Credit settings tab (MyQ, Settings, Credit).
2. On the tab, under Payment providers, double-click the TouchNet uPay payment provider. The TouchNet uPay properties panel opens on the right side of the tab.
3. The value of the Currency setting corresponds to the currency set on the General settings tab on the MyQ Web Interface. TouchNet uPay uses USD as currency.
4. Type the Minimal amount that users will have to pay when they buy credit. Leaving it blank will accept every payment.
5. Enter the information you got from TouchNet into the mandatory fields Client ID, API Key and uPay Site ID.
6. Use TEST as Mode when you are not yet in production, otherwise use PRODUCTION.
7. Click Save to store your settings.

9.6.2 Recharging credit via TouchNet uPay on the user’s account on the MyQ Web Interface
First of all, the user needs to log in to their account on the MyQ Web Interface. To recharge the credit there, the user has to click Recharge credit under Credit. The Recharge credit dialog appears.

In the dialog box, the user has to select the TouchNet uPay payment provider, enter the amount of credit that they want to buy, and then click Recharge Credit.
A window with the TouchNet uPay payment options opens in the web browser; the rest of the steps correspond to the standard TouchNet uPay payment process.

After the payment is successfully sent to MyQ, the Payment successful dialog box appears.
TouchNet uPay tries to connect to the MyQ server via the hostname or IP address that is set on the Network settings tab of the MyQ Web Interface. In case a hostname is set on the tab and paying users receive the “This site can’t be reached / XYZ’s server DNS address could not be found. / DNS_ PROBE_FINISHED_NXDOMAIN” message, try to replace the hostname with the IP address of your server.

9.7 Recharging credit by vouchers
The MyQ administrator (and users authorized to manage vouchers) can generate and print any number of vouchers of a defined value to be distributed to users.
The vouchers can be sold to MyQ users through any standard distribution channel.
Once the user has the credit voucher, they can recharge their credit on their account on the MyQ Web Interface, on embedded terminals, on MyQ TerminalPro terminals and in the MyQ mobile application.
All generated and used vouchers are logged in the MyQ database. The information about which voucher was used and for which user can be accessed on the MyQ Web administrator interface. This ensures full control and transparency and enables the administrator to prevent possible misuse.
To enable users to manage vouchers on the Voucher Batches main tab, provide them with the Manage Vouchers rights. For more information about rights and how to provide them, see Rights.

9.7.1 Setting the voucher format
Before the vouchers are generated, it is necessary to set the format of the voucher unique code and define the text printed on the voucher. These parameters can be set and modified on the Credit settings tab, under Payment providers. Double-click the Voucher item (or select the item and click Edit) to open the Voucher properties panel.
The unique code format can be defined by creating a Voucher code mask ‒ a predefined code template consisting of zeroes and lower case a’s. Zeroes are substituted by numbers and a’s are substituted by upper case letters or numbers. For example, the 00a0000aaa mask will generate numbers such as 86D9841POE, 03E8976E67, etc.
Always set the code format adequate to the number of users and the frequency of the voucher generation process, to ensure a sufficient variety of codes. If the amount of the currently valid codes is large and the variety not sufficient, the chance of randomly guessing the valid code number is high and the credit system can be easily bypassed.
The text entered in the Voucher-custom lines 1 and 2 fields is displayed on the printed vouchers. You can enter, for example, the name of your company and additional information.

Do not forget to set the currency on the General settings tab, if you have not set it earlier. The currency on the printed voucher is the same as the one set in MyQ.

9.7.2 Custom logo for Credit Vouchers
If you want to use your own logo on MyQ credit vouchers instead of the default MyQ logo, you can import the new logo on the Personalization settings tab in the MyQ Web Administrator Interface.
The file with the logo has to be in the JPG, JPEG, PNG or the BMP format; the recommended size of the logo is 398px x 92px.
To import the logo:

1. On the MyQ Web administrator interface, open the Personalization settings tab. (MyQ, Settings, Personalization).
2. On the tab, under Custom application logo, click +Add, browse and upload the file with the logo, and lastly click Save at the bottom of the tab. A preview of the new logo is displayed on the tab.

9.7.3 Voucher Batches
Vouchers can be generated on the Voucher Batches tab of the MyQ Web Interface.
To open this tab, go to MyQ, Voucher Batches.
To generate new vouchers:

1. On the bar at top of the Voucher Batches tab, click +Add. The New Voucher Batch dialog box appears. In the dialog box, enter the number of vouchers to be generated in the Count field, the Price of the vouchers in the batch, add the validity period in the Valid till field, and then click OK. The new voucher batch record is displayed in the voucher batches list. You can overview all of the vouchers by double-clicking this record.

Managing Voucher Batches
Voucher batches can be filtered by serial number, date, creator, price and expire date. From the Voucher Batches main tab, you can export the list of voucher batches to a CSV, and display and print vouchers included in particular batches.

9.7.4 Vouchers usage overview
To open the table of all the vouchers generated in one batch, double-click the batch on the Voucher Batches main tab (or select the batch, and then click Open on the bar at the top of the tab).
In the table, you can see records of all of the generated vouchers with information such its unique code, price, validity, the current status of the voucher usage, etc. If the number of records is too high to be displayed clearly, you can filter them by using filters on the left side. Vouchers can be filtered by code, voucher batch, price, etc.
To delete a voucher, select it in the table and click Delete on the bar at the top of the tab. When a voucher is deleted, the code on the voucher becomes invalid.
Click Save as CSV to download a CSV file with the vouchers usage overview.

9.8 Recharging credit via external payment providers
The external payment provider option is used for managing credit via a Recharge Terminal.
For information on how to set it up, please check the MyQ Recharge Terminal Guide.
If a Recharge Terminal is used, you can view the transaction info in MyQ, Payments.

Central Server Reports Management

On the MyQ Central server, you can create and run reports which include all sorts of information that are downloaded from the site servers and stored on the Embedded or MS SQL database. Running reports on the Central server is useful, especially if you have several branch offices and want to access overall statistics.
The process of downloading data from site servers and storing them on the MyQ Central server’s database is called Replication. It is essential for central reporting, as all site servers that are included in reports have to be fully replicated to ensure that the data in the reports are correct and up-to-date.

10.1 Reports
In the MyQ web interface, on the Reports main tab (MyQ, Reports), you can create and generate reports with a variety of data concerning your printing environment.
The reports can be related to users, printing devices, print jobs, etc.

Reports in MyQ are divided into two main categories: My reports and Shared reports. My reports show
users reports created by themselves, while Shared reports show them reports created by the administrator or by other users.
There are three default reports: My daily summary, My sessions and My monthly summary. These are displayed in the My reports folder of the MyQ administrator, who can modify them, delete them or change their design. For all the other users, the default reports are displayed in the Shared reports folder and cannot be changed in any way.
In addition to the three default reports, the administrator can create an unlimited number of reports and sort them into sub-folders of the My reports folder. Users can create their own reports but they are limited to use only certain report types depending on the rights granted by the administrator.
Each report can be directly displayed on the web interface and saved in any of the following formats: PDF, CSV, XML, XLSX and ODS. The reports can be automatically generated and stored in a predefined folder. There is no data limitation for the generated report, it includes all the data from the specified period.
All the reports have the MyQ logo displayed by default, but it can be replaced by your company’s logo. To upload a custom logo go to MyQ, Settings, Personalization. In the Custom application logo section, click +Add next to Custom logo and upload your own file (supported formats – JPG, JPEG, PNG, BMP and recommended size – 398px x 92px).

10.1.1 Report Types
When you are creating reports on the Reports main tab, you can choose from a large number of built-in report types that are sorted into multiple categories. Some of the types are included in more categories (for example, Groups: Daily Summary, Print Jobs: Daily Summary, etc.), while some of the types are particular to only one category (for example, Device Alerts in Alerts Maintenance or Credit Balance in Credit). You can overview all of the report types on the Reports settings tab (in MyQ, Settings, Reports).

Providing users with rights to use a report
The administrator can run all the built-in reports and provide other users and groups with rights to run them as well. In MyQ, Settings, Reports, right-click on a report and click Edit. On the General tab, in the Permission for running the report field, choose users and groups from the list and click Save.

Add custom reports
You can also add custom report types developed by the MyQ development team. To do so, just click +Add, upload the custom report definition file, select users or groups to access it, and click OK. For more information about custom report types, contact MyQ support.

Report Categories

• Alerts and Maintenance – These reports provide information about device alerts and unusual changes on device counters.
• Credit – These reports contain information concerning credit, for example the remaining credit of selected users.
• Environmental – These reports inform about the environmental impact of printing. They show how many trees needed to be harvested, how much energy was spent and how much carbon dioxide was emitted during the production of the paper used for printing and copying within your company’s printing environment. Data sources vary in their estimations. MyQ calculations in the report are based on the following data estimates:
  • Carbon dioxide for paper production: 12,7 gram per paper sheet
  • Energy used for production: 48 Wh per paper sheet or 32Wh for a recycled paper sheet
  • Trees: 8333 paper sheets are counted as 1 tree.
• General – These reports provide general information about the MyQ system, such as total counters statistics and printing peaks or comparison of price lists used for printers.
• Groups – These reports inform about groups of users. They can contain information about membership, printed pages, weekly stats etc.
• Print Jobs – These reports contain information about jobs printed in MyQ, such as the list of all expired and deleted jobs over a certain period.
• Printers – These reports inform about all the printing devices in the MyQ system (both local and network). Generated reports can contain graphs of the device usage, daily, weekly and monthly counters, etc.
• Projects – These reports contain information regarding projects and project accounting in MyQ, such as daily summary of projects or projects assigned to selected users over a certain period.
• Users – These reports can contain various information about users. They can concern their print jobs, credit statements, printed pages etc.

Alerts and Maintenance Reports
The reports included in the Alerts and Maintenance category are:

• Counter Analysis
• Event History
• Toner replacement**
• Top N alerts summary

Parameters, filters, and columns available:

User name
User group
Page counter
value (<, =, >)
Site| Site
Printer name
Full name
Session finish date
Page counter
B&W pages
Color pages
Total pages
Scans
Total price
(additional column: Administrator price)| User name
Event History| Period| Event name
Event type
Printer name
Site| Site
Event name
Event type
Printer name
Created
Resolved|
Toner replacement| Period| Printer name
Site| Site
Printer name
Toner color
Installed
Replaced
Pages printed
Total counters|
Top N Alerts Summary| Period N| Printer name Site| Site
Alert name
Alert training level
Alert code
Occurrences| Alert name

The above reports don’t support aggregate columns.
Charts are not available, except for the Top N alerts summary report where a Pie,
Doughnut or Bar chart can be selected with the Alert name and Occurrences values.

** Toner replacement report addendum
The number displayed in the Toner replacement report in the Pages printed and Total counters columns depends on the toner it relates to:

• Pages printed – The number of pages printed with the replaced toner. Only color pages for color toners (CMY) and all pages for black toners (K) are considered.
• Total counters – Total counters of the printer related to the replaced toner. Color pages for color toners (CMY) and all pages for black toners (K) are considered.

Credit Reports
The reports included in the Credit category are:

• Credit balance
• Credit operations

Parameters, filters and columns available:

Full name
User group
Credit balance| Personal number
Phone
Email
Notes
Credit operations| Period| User name
User group| Full name
User group
Created (date & time)
Credit charge
Credit balance
Operation type
Charge method
Charger name
Voucher code| Personal number
Phone
Email
Notes

The above reports don’t support aggregate columns, they are all grouped by the User name parameter and charts are not available.
Environmental Reports
The reports included in the Environmental category are:

• Expired and deleted jobs
• Printers
• User groups
• Users

Parameters, filters, and columns available:

Name| Parameters| Filters| Default Columns| Additional Columns
---|---|---|---|---
Expired and deleted jobs| Period| User name
Queue name
Site| Site
Queue name
Job name
Created (date & time)
Job size (KB)
B&W pages
Color pages
Total pages
Job owner user name
Job owner full name
Trees
CO2 (gram)
Energy (Wh)
Energy recycled (Wh)|
Printers| Period| Printer name
Site| Site
Printer name
Total pages
Trees
CO2 (gram)
Energy (Wh)
Energy recycled (Wh)|
User groups| Period| Printer name
User name
User group
Site| Site
User group
Total pages
Trees
CO2 (gram)
Energy (Wh)
Energy recycled (Wh)|
Users| Period| Printer name
User name
User group
Site| Site
User name
Full name
Total pages
Trees
CO2 (gram)
Energy (Wh)
Energy recycled (Wh)| Personal number
Phone
Email
Notes

1 tree = 8333 pages / 1 page = 12.7g of CO2 / 1 page = 48Wh of energy / 1 recycled page = 32Wh of energy
The above reports don’t support aggregate columns or charts.

General Reports
The reports included in the General category are:

• Day of week
• Hourly activity
• Monthly statistics
• Pricelist comparison
• Weekly statistics

Parameters, filters, and columns available:

User name
User group
Site| Period (Day)
B&W pages
Color pages
Total pages
Scans
Total price
Administrator price| Pie, Doughnut or Bar
Category: Day of the week
Values: Page counter
Hourly activity| Period
Page counter| Printer name
User name
User group
Site| Period (Hour)
B&W pages
Color pages
Total pages
Scans
Total price
Administrator price| Pie, Doughnut or Bar
Category: Daily hours
Values: Page counter
Monthly statistics| Period| Printer name
User name
User group
Site| Site
Period (Year – Month)
B&W pages
Color pages
Total pages
Scans
Total price
(Additional columns: Administrator price Simplex
Duplex)| Line
X-axis: Month & year
Y-axis: Page counter
Pricelist comparison| Pricelist
Item| Printer name| Site
Printer name
B&W price
Color price| Bar
Category: Printers
1st value: Pricelist item
Weekly statistics| Period| Printer name
User name
User group
Site| Site
Period (Year – Week)
B&W pages
Color pages
Total pages
Scans
Total price
(Additional columns: Administrator price Simplex
Duplex)| Line
X-axis: Month & year
Y-axis: Page counter

The above reports don’t support aggregate columns.

Groups Reports
The reports included in the Groups category are:

• Counters by function and duplex(BETA)
• Counters by function and paper format(BETA)
• Counters by paper format and duplex(BETA)
• Daily summary
• Day of the week
• Monthly summary
• Top N
• Total summary
• User group membership

Parameters, filters, and columns available:

Counters by function and
duplex (BET A)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Group name
User name
Full name
Print B&W
Simplex
Print Color
Simplex
Print B&W
Duplex
Print Color
Duplex
Print Sheets
Copy B&W
Simplex
Copy Color
Simplex
Copy B&W
Duplex
Copy Color
Duplex
Copy Sheets| Notes
Personal
Number
Email
Incoming Fax
B&W Simplex
Incoming Fax
B&W Duplex
Fax Sheets| Group name
User name
Counters by function and
paper format (BET A)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Group name
User name
Full name
Print A4 B&W
Print A4 Color
Copy A4 B&W
Copy A4 Color
Print A3 B&W
Print A3 Color
Copy A3 B&W
Copy A3 Color| Notes
Personal
Number
Email
Incoming Fax
A4 B&W
Incoming Fax
A4 B&W
Print A5 B&W
Print A5 Color
Copy A5 B&W
Copy A5 Color
Incoming Fax
A5 B&W
Print B4 B&W
Print B4 Color
Copy B4 B&W
Copy B4 Color
Incoming Fax
B4 B&W
Print B5 B&W
Print B5 Color
Copy B5 B&W
Copy B5 Color
Incoming Fax
B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming Fax
Ledger B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming Fax
Letter B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming Fax
Legal B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming Fax
Statement
B&W| Group name
User name
Counters by paper format and duplex (BET A)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Group name
User name
Full name
A4 B&W
Simplex
A4 Color
Simplex
A4 B&W Duplex
A4 Color Duplex
A3 B&W
Simplex
A3 Color
Simplex
A3 B&W Duplex
A3 Color Duplex
A4 Sheets
A3 Sheets| Notes
Personal
Number
Email
Incoming Fax
A4 B&W
Incoming Fax
A4 B&W
Print A5 B&W
Print A5 Color
Copy A5 B&W
Copy A5 Color
Incoming Fax
A5 B&W
Print B4 B&W
Print B4 Color
Copy B4 B&W
Copy B4 Color
Incoming Fax
B4 B&W
Print B5 B&W
Print B5 Color
Copy B5 B&W
Copy B5 Color
Incoming Fax
B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming Fax
Ledger B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming Fax
Letter B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming Fax
Legal B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming Fax
Statement
B&W| Group name
User name
Daily summary| Printer name
User name
User group
Site| Site
Date
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
B&W prints
B&W copies
Color prints
Color copies
Single color copy
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W cost
Color cost
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)
Print color pages(L1)
Copy color pages (L1)
Cost color pages(L1)
Print color pages(L2)
Copy color pages (L2)
Cost color pages(L2)
Print color pages(L3)
Copy color pages (L3)
Cost color pages(L3)
Simplex
Duplex| Group name
Day of the week| Printer name
User name
User group
Site| Site
Day
B&W pages
Color pages
Total pages
Scans
Total price| Same as Daily summary +
Day number| Group name
Monthly summary| Printer name
User name
User group
Site| Site
Period (Year – Month)
B&W pages
Color pages
Total pages
Scans
Total price| Same as Daily summary| Group name
Month & Year
Top N| Printer name
User name
User group
Site| Site
Group name
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price|
Total summary| Printer name
User name
User group
Accounting group
Site| Site
Full name
User name
Group name
Period (Year & Month)
B&W print
B&W copies
Color print
Color copies
Total pages
Scans
Total price| Same as Daily summary| Accounting group
User group membership| User group
Accounting group
Managed group
Site| Site
User name
Full name
Group name
Accounting group
Managed group| Personal number
Phone
Email
Notes|

The above reports all have the Period parameter, except for the Top N report that has the Period, Page counter, N, Add remaining sum parameters.
The above reports don’t support aggregate columns except for the Monthly summary report.
Charts are not available, except for the Top N report, where a Pie, Doughnut or Bar chart can be selected with the Groups and Page Counter values.

Print Jobs Reports
The reports included in the Print Jobs category are:

• Daily summary
• Expired and deleted jobs
• Printed jobs summary

Parameters, filters and columns available:

Name| Filters| Default Columns| Additional Columns| Group by
---|---|---|---|---
Daily summary| User name
Job name
Site| Site
Full name
Created (date & time)
Printed (date & time)
Job name
Document time| Queue name
Personal
number
Phone
Email
Notes
Total pages
B&W pages
Color pages| User name
Expired and deleted jobs| User name
User group
Queue name
Site| Site
Full name
User name
Job name
Created (date & time)
Document type
Duplex
Job size (KB)
Total pages
B&W pages
Color pages| Personal number
Phone
Email
Notes
Trees
CO2 (gram)
Energy (Wh)
Energy recycled (Wh)| Queue name
Printed jobs summary| User name
User group
Job name
Site| Site
Full name
Period
Queue name
Printed (date & time)
Job name
Document type| Personal number
Phone
Email
Notes
Total pages
B&W pages
Color pages| User name
Month & Year

All the reports use the Period parameter.
Charts are not available.
The reports don’t support aggregate columns except for the Expired and deleted jobs reports, where aggregate columns are available.

Printers Reports
The reports included in the Printers category are:

• Counters by function and duplex(BETA)
• Counters by function and paper format(BETA)
• Counters by paper format and duplex(BETA)
• Daily summary
• Day of the week
• Meter reading via SNMP
• Monthly summary
• Top N
• Total summary

Parameters, filters, and columns available:

Name| Filters| Default Columns| Additional Columns| Group by
---|---|---|---|---
Counters by
function and
duplex(BETA)| Printer name
User name
User group
Project name
Accounting
group
Site| Site
Printer Name
Serial Number
Group name
User name
Full name
Print B&W
Simplex
Print Color
Simplex
Print B&W
Duplex
Print Color
Duplex
Print Sheets
Copy B&W
Simplex
Copy Color
Simplex
Copy B&W
Duplex
Copy Color
Duplex
Copy Sheet| Notes
Personal
Number
Email
Incoming
Fax B&W
Simplex
Incoming
Fax B&W
Duplex
Fax Sheets| Printer name
User name
Counters by function and
paper format (BETA)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Printer name
Serial number
Group name
User name
Full name
Print A4 B&W
Print A4 Color
Copy A4 B&W
Copy A4 Color
Print A3 B&W
Print A3 Color
Copy A3 B&W
Copy A3 Color| Notes
Personal Number
Email
Location
IP address
Brand
Model
MAC
Incoming
Fax A4 B&W
Incoming
Fax A4 B&W
Print A5
B&W
Print A5
Color
Copy A5
B&W
Copy A5
Color
Incoming
Fax A5 B&W
Print B4
B&W
Print B4
Color
Copy B4
B&W
Copy B4
Color
Incoming
Fax B4 B&W
Print B5
B&W
Print B5
Color
Copy B5
B&W
Copy B5
Color
Incoming
Fax B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming
Fax Ledger
B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming
Fax Letter
B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming
Fax Legal
B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming
Fax
Statement
B&W| Printer name
User name
Counters by paper format
and duplex (BETA)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Printer name
Serial number
Group name
User name
Full name
A4 B&W
Simplex
A4 Color
Simplex
A4 B&W
Duplex
A4 Color
Duplex
A3 B&W
Simplex
A3 Color
Simplex
A3 B&W
Duplex
A3 Color
Duplex
A4 Sheets
A3 Sheets| Notes
Personal
Number
Email
Location
IP Address
Brand
Model
MAC
A5 B&W
Simplex
A5 Color
Simplex
A5 B&W
Duplex
A5 Color
Duplex
A5 Sheets
B4 B&W
Simplex
B4 Color
Simplex
B4 B&W
Duplex
B4 Color
Duplex
B4 Sheets
B5 B&W
Simplex
B5 Color
Simplex
B5 B&W
Duplex
B5 Color
Duplex
B5 Sheets
Folio B&W
Simplex
Folio Color
Simplex
Folio B&W
Duplex
Folio Color
Duplex
Folio Sheets
Ledger B&W
Simplex
Folio Color
Simplex
Folio B&W
Duplex
Folio Color
Duplex
Folio Sheets
Ledger Color
Simplex
Ledger B&W
Duplex
Ledger Color
Duplex
Ledger Sheets
Letter Color
Simplex
Letter B&W
Duplex
Letter Color
Duplex
Letter
Sheets
Legal Color
Simplex
Legal B&W
Duplex
Legal Color
Duplex
Legal Sheets
Statement
Color
Simplex
Statement
B&W Duplex
Statement
Color Duplex
Statement
Sheets
Other Color
Simplex
Other B&W
Duplex
Other Color
Duplex
Other
Sheets| Printer name
User name
Daily summary| Printer name
User name
User group
Site| Site
User name
Full name
Date
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
B&W prints
B&W copies
Color prints
Color copies
Single color copy
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W cost
Color cost
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)
Print color pages(L1)
Copy color pages (L1)
Cost color pages(L1)
Print color pages(L2)
Copy color pages (L2)
Cost color pages(L2)
Print color pages(L3)
Copy color pages (L3)
Cost color pages(L3)
Simplex
Duplex| Printer name
Day of the week| Printer name
User name
User group
Site| Site
Day
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily
summary +
Day number| Printer name
Meter reading via SNMP| Printer name Site| Site
Printer name
IP address
Serial number
MAC address
Model
Location
Terminal ID
B&W prints
B&W copies
Color prints
Color copies
Scans
Fax counter| A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Start Mono
Start Color
Finish Mono
Finish Color
Printer ID
Printer
Group
Finish M
Print
Finish C Print
Finish M
Copy
Finish C
Copy
Finish Scan|
Monthly summary| Printer name
User name
User group
Site| Site
IP address
Serial number
MAC address
Model
Location
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily summary| Printer name
Month & Year
Top N| Printer name
User name
User group
Site| Site
Printer name
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
Printer ID
Printer
Group|
Total summary| Printer name
User name
User group
Site| Site
Printer name
User group
User name
Full name
Total pages
B&W prints
B&W copies
Color prints
Color copies
Scans
Total price| Same as
Daily summary| Printer name

The above reports all have the Period parameter, except for the Top N report that has the Period, Page counter, N, Add remaining sum parameters.
Aggregate columns are supported in the above reports, except for the Top N and the Monthly summary reports.
Charts are not available, except for the Top N report, where a Pie, Doughnut or Bar chart can be selected with the Printers and Page Counter values.

Projects Reports
The reports included in the Projects category are:

• Counters by function and duplex(BETA)
• Counters by function and paper format(BETA)
• Counters by paper format and duplex(BETA)
• Daily summary
• Day of the week
• Monthly summary
• Print jobs per project
• Project groups total summary
• Projects per user
• Top N
• User project assignment
• User Session details
• Users per project

Parameters, filters, and columns available:

Name| Filters| Default Columns| Additional Columns| Group by
---|---|---|---|---
Counters by function and
duplex(BETA)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Project name
Project code
Group name
User name
Full name
Print B&W
Simplex
Print Color
Simplex
Print B&W
Duplex
Print Color
Duplex
Print Sheets
Copy B&W
Simplex
Copy Color
Simplex
Copy B&W
Duplex
Copy Color
Duplex
Copy Sheets| Notes
Personal
Number
Email
Incoming
Fax B&W
Simplex
Incoming
Fax B&W
Duplex
Fax Sheets| Project name
User name
Counters by function and
paper format (BETA)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Project name
Project code
Group name
User name
Full name
Print A4 B&W
Print A4 Color
Copy A4 B&W
Copy A4 Color
Print A3 B&W
Print A3 Color
Copy A3 B&W
Copy A3 Color| Notes
Personal
Number
Email
Incoming
Fax A4 B&W
Incoming
Fax A4 B&W
Print A5
B&W
Print A5
Color
Copy A5
B&W
Copy A5
Color
Incoming
Fax A5 B&W
Print B4
B&W
Print B4
Color
Copy B4
B&W
Copy B4
Color
Incoming
Fax B4 B&W
Print B5
B&W
Print B5
Color
Copy B5
B&W
Copy B5
Color
Incoming
Fax B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming
Fax Ledger
B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming
Fax Letter
B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming
Fax Legal
B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming
Fax
Statement
B&W| Project name
User name
Counters by paper format
and duplex (BETA)| Printer name
User name
User group
Project name
Accounting group
Site| Site
Project name
Project code
Group name
User name
Full name
A4 B&W
Simplex
A4 Color
Simplex
A4 B&W
Duplex
A4 Color
Duplex
A3 B&W
Simplex
A3 Color
Simplex
A3 B&W
Duplex
A3 Color
Duplex
A4 Sheets
A3 Sheets| Notes
Personal
Number
Email
Incoming
Fax A4 B&W
Incoming
Fax A4 B&W
Print A5
B&W
Print A5
Color
Copy A5
B&W
Copy A5
Color
Incoming
Fax A5 B&W
Print B4
B&W
Print B4
Color
Copy B4
B&W
Copy B4
Color
Incoming
Fax B4 B&W
Print B5
B&W
Print B5
Color
Copy B5
B&W
Copy B5
Color
Incoming
Fax B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming
Fax Ledger
B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming
Fax Letter
B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming
Fax Legal
B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming
Fax
Statement
B&W| Project name
User name
Daily summary| Project name
Printer name
User name
User group
Site| Site
Date
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
B&W prints
B&W copies
Color prints
Color copies
Single color copy
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W cost
Color cost
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)
Print color pages(L1)
Copy color pages (L1)
Cost color pages(L1)
Print color pages(L2)
Copy color pages (L2)
Cost color pages(L2)
Print color pages(L3)
Copy color pages (L3)
Cost color pages(L3)
Simplex
Duplex| Project name
Day of the week| Project name
Printer name
User name
User group
Site| Date
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily summary +
Day number| Project name
Monthly summary| Project name
Printer name
User name
User group
Site| Site
Period (year – month)
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily
summary| Project name
Month & Year
Print jobs per project| Project name
Job name
User name
Site| Site
Job name
Printed (date & time)
Document type| | Project name
Project groups total summary| Project name
Site| Site
Project name
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
Group
Phone
Email
Notes
Color cost
B&W cost
Simplex
Duplex
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W prints
B&W copies
Color prints
Color copies
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)| Project name
Projects per user| Project name
Printer name
User name
User group
Site| Site
Full name
Personal number
Project name
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily summary| User name
Top N| Project name
Printer name
User name
User group
Site| Site
Project name
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price|
User project assignment| Project name
Printer name
User name
User group
Site| Site
Full name
Personal
number
Project name
B&W pages
Color pages
Total pages
Scans
Total price| Personal number
Phone
Email
Notes| Project name
User Session details| Project name
User name
Accounting group
Printer name
Site| Site
Project Code
Project Name
Date
Job Name
User name
B&W Print
B&W Copy
Color Print
Color Copy
Simplex
Duplex
B&W Pages
Color Pages
Scans
B&W Cost
Color Cost
Total Cost|  Fax| Project name
Users per project| Project name
Printer name
User name
User group
Site| Site
User name
Full name
Project name| Administrator price
Group
Phone
Email
Notes
Color cost
B&W cost
Simplex
Duplex
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W prints
B&W copies
Color prints
Color copies
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)| User name

The above reports all have the Period parameter, except for the Top N report that has the Period, Page counter, N, Add remaining sum parameters.
Aggregate columns are supported in the above reports, except for the Print jobs per project, Top N and the User project assignment reports.
Charts are not available, except for the Top N report where a Pie, Doughnut or Bar chart can be selected with the Page Counter values.

Users Reports
The reports included in the Users category are:

• Counters by function and duplex(BETA)
• Counters by function and paper format(BETA)
• Counters by paper format and duplex(BETA)
• Daily summary
• Day of the week
• Monthly summary
• Session details
• Top N
• Total summary
• User Rights

Parameters, filters, and columns available:

Name| Filters| Default Columns| Additional Columns| Group by
---|---|---|---|---
Counters by function and duplex (BETA)| Printer name
User name
User group
Project name
Accounting
group
Site| Site
Group name
User name
Full name
Printer name
Serial Number
Print B&W
Simplex
Print Color
Simplex
Print B&W
Duplex
Print Color
Duplex
Print Sheets
Copy B&W
Simplex
Copy Color
Simplex
Copy B&W
Duplex
Copy Color
Duplex
Copy Sheets| Notes
Personal
Number
Email
Location
IP Address
Brand
Model
Mac
Incoming
Fax B&W
Simplex
Incoming
Fax B&W
Duplex
Fax Sheets| User name
Printer name
Counters by function and paper format (BETA)| Printer name
User name
User group
Project name
Accounting
group
Site| Site
Group name
User name
Full name
Printer name
Serial Number
Print A4 B&W
Print A4 Color
Copy A4 B&W
Copy A4 Color
Print A3 B&W
Print A3 Color
Copy A3 B&W
Copy A3 Color| Notes
Personal
Number
Email
Location
IP Address
Brand
Model
Mac
Incoming
Fax A4 B&W
Incoming
Fax A4 B&W
Print A5
B&W
Print A5
Color
Copy A5
B&W
Copy A5
Color
Incoming
Fax A5 B&W
Print B4
B&W
Print B4
Color
Copy B4
B&W
Copy B4
Color
Incoming
Fax B4 B&W
Print B5
B&W
Print B5
Color
Copy B5
B&W
Copy B5
Color
Incoming
Fax B5 B&W
Print Ledger
B&W
Print Ledger
Color
Copy Ledger
B&W
Copy Ledger
Color
Incoming
Fax Ledger
B&W
Print Letter
B&W
Print Letter
Color
Copy Letter
B&W
Copy Letter
Color
Incoming
Fax Letter
B&W
Print Legal
B&W
Print Legal
Color
Copy Legal
B&W
Copy Legal
Color
Incoming
Fax Legal
B&W
Print
Statement
B&W
Print
Statement
Color
Copy
Statement
B&W
Copy
Statement
Color
Incoming
Fax
Statement
B&W| User name
Printer name
Counters by paper format and duplex (BETA)| Printer name
User name
User group
Project name
Accounting
group
Site| Site
Group name
User name
Full name
Printer name
Serial Number
A4 B&W
Simplex
A4 Color
Simplex
A4 B&W
Duplex
A4 Color
Duplex
A3 B&W
Simplex
A3 Color
Simplex
A3 B&W
Duplex
A3 Color
Duplex
A4 Sheets
A3 Sheets| Notes
Personal
Number
Email
Location
IP Address
Brand
Model
Mac
A5 B&W
Simplex
A5 Color
Simplex
A5 B&W
Duplex
A5 Color
Duplex
A5 Sheets
B4 B&W
Simplex
B4 Color
Simplex
B4 B&W
Duplex
B4 Color
Duplex
B4 Sheets
B5 B&W
Simplex
B5 Color
Simplex
B5 B&W
Duplex
B5 Color
Duplex
B5 Sheets
Folio B&W
Simplex
Folio Color
Simplex
Folio B&W
Duplex
Folio Color
Duplex
Folio Sheets
Ledger B&W
Simplex
Folio Color
Simplex
Folio B&W
Duplex
Folio Color
Duplex
Folio Sheets
Ledger Color
Simplex
Ledger B&W
Duplex
Ledger Color
Duplex
Ledger Sheets
Letter Color
Simplex
Letter B&W
Duplex
Letter Color
Duplex
Letter
Sheets
Legal Color
Simplex
Legal B&W
Duplex
Legal Color
Duplex
Legal Sheets
Statement
Color
Simplex
Statement
B&W Duplex
Statement
Color Duplex
Statement
Sheets
Other Color
Simplex
Other B&W
Duplex
Other Color
Duplex
Other
Sheets| User name
Printer name
Daily summary| Printer name
User name
User group
Site| Site
Full name
Date
B&W pages
Color pages
Total pages
Scans
Total price| Administrator price
B&W cost
Color cost
Personal number
Phone
Email
Notes
B&W prints
B&W copies
Color prints
Color copies
Single color copy
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Fax
B&W cost
Color cost
Color pages (L1)
Color cost (L1)
Color pages (L2)
Color cost (L2)
Color pages (L3)
Color cost (L3)
Print color pages(L1)
Copy color pages (L1)
Cost color pages(L1)
Print color pages(L2)
Copy color pages (L2)
Cost color pages(L2)
Print color pages(L3)
Copy color pages (L3)
Cost color pages(L3)
Simplex
Duplex| User name
Day of the week| Printer name
User name
User group
Site| Site
Full name
Day
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily
summary +
Day number| User name
Monthly summary| Printer name
User name
User group
Site| Site
Full name
Period (yearmonth)
B&W pages
Color pages
Total pages
Scans
Total price| Same as
Daily summary| User name
Month & Year
Session details| Printer name
User name
User group
Site| Site
User group
Full name
Printer name
Job name
Date
Total pages
Scans| Same as
Daily summary except for Administrator price| User name
Top N| Printer name
User name
User group
Site| Site
User name
Full name
B&W pages
Color pages
Total pages
Scans
Total price| |
Total summary| Printer name
User name
User group
Site| Site
User name
Full name
B&W prints
B&W copies
Color prints
Color copies
Total pages
Scans
Total price| Administrator price
Single color copy
Personal number
Phone
Email
Notes
B&W pages
Color pages
A4 paper
A3 paper
A5 paper
B4 paper
B5 paper
Other paper
Folio paper
Ledger
paper
Legal paper
Letter paper
Statement paper
Rest of paper formats
Simplex
Duplex| User name
User Rights| User
Access Rights
Site| Site
IP/Hostname
User name
Full name
Assign access
rights| Aliases
Email
Personal
number
Phone| User name
Server site

The above reports all have the Period parameter, and they don’t support aggregate columns.
Charts are not available, except for the Top N report where a Pie, Doughnut or Bar chart can be selected with the Users and Page Counter values.

Creating new aggregated columns

For some types of reports, you can create any number of custom aggregated (summary) columns. An aggregated column can display either the sum or the average of a selection of any number of other columns available for the type.
To create a new aggregated column for a report:

1. Go to MyQ, Reports. On the list of reports on the right side, select the report and click Edit on the ribbon (or right-click, edit). The report properties panel opens on the right side of the screen.
2. Go to the Design tab on the properties panel.
3. In the Table section, click +Add and select +Add aggregated column. The properties panel of the new column opens.
4. In the panel, set the columns properties, select the Aggregate operation you want to use (Sum or Average), and click Save. The new aggregated column is listed with the other table columns, and you can double-click on it to edit it.

Supported types of reports for aggregated columns
The aggregated (summary) columns can be created for the following types of reports:

• From the Groups category: Monthly summary
• From the Print jobs category: Expired and deleted jobs
• From the Printers category: Daily summary, Day of the week, Meter reading via SNMP
• From the Projects category: Daily summary, Day of the week, Monthly summary, Project groups total summary, Projects per user, Users per project.

10.1.2 Reporting sources
Accounting in MyQ depends on the MyQ server version, the MyQ embedded terminal version and the printing device. MyQ 8.0+ currently uses the user-session architecture. The values in every report are based on user sessions (except for the Meter reading via SNMP printers report, described below).

• Counters are calculated in the following way:
  • B&W pages = B&W prints + B&W copies + Fax
  • Color pages = Color prints + Color copies + Single color copy
  • Total Pages = B&W pages + Color pages
  • Total prints = B&W prints + Color prints
  • Total copies = B&W copies + Color copies
• Price related columns include discounts.
• Any printers monitored via MyQ Desktop Client are included in the reports.
• Any non-MyQ users activity (*unauthenticated) is included in the reports.
• MyQ does not track deleted printers. If a deleted printer is later added and activated in MyQ, the reports will not include any activity during the time the device was deleted.
• If a printer is deactivated but not deleted, the reports include information about the period it was inactive only after it is reactivated. In that case, after the reactivation, all the activity is accounted to users not authenticated in a single session. The reports cannot include printers’ data while they are deactivated.
• When an embedded terminal is installed on the printing device, accounting is also done for any direct/tandem print queues of the device.
• When an embedded terminal is not installed or a device is used with a MyQ Hardware terminal, accounting is done via SNMP by the MyQ Print Server (depends on provided data via SNMP from the device).

Values calculation in the Meter reading via SNMP printers report
The values in this report are based on counters read directly from the printers.

• Any printers monitored via MyQ Desktop Client are not included in the reports.
• The highest and lowest values are compared for a selected period and printer/group of printers.
• The total value displayed in the report is the summary of all the subtotal values, without Pages printed while the device was deactivated.

10.1.3 Report values description
Description of values in the reports’ default and additional columns and how they are accounted.
These values are accounted as page counts in the following way: 2 clicks for the A3/ Ledger page format and 1 click for the rest (A4 etc..); in case of Duplex, it is 4 clicks for the A3 / Ledger format and 2 clicks for the rest (A4 etc.). L formats are coverage counters.

• B&W prints
• B&W copies
• Color prints
• Color copies
• Single color copy
• Total prints
• Total copies
• Fax
• Color pages (L1)
• Color cost (L1)
• Color pages (L2)
• Color cost (L2)
• Color pages (L3)
• Color cost (L3)
• Print color pages (L1)
• Copy color pages (L1)

If discounts are used, they are not applied to all “cost” values in reports, e.g. Color cost (L1)”, “Color cost (L2)” or “Color cost (L3). However, “Total cost”, “Color cost” do reflect discounts.

These values are accounted as paper sheets in the following way : 1x A3 / 1x A4 etc.

• A4 paper
• A3 paper
• A5 paper
• B4 paper
• B5 paper
• Other paper
• Folio paper
• Ledger paper
• Legal paper
• Letter paper
• Statement paper
• Rest of the paper formats

These values are accounted as paper sheets as well, however, when a printing device is used without an installed Embedded terminal, this counter is specified via SNMP and depends on the counter used from the printing device.

• Simplex
• Duplex

Terminals version 7 and lower might have reported Duplex values differently depending on the vendor – either as the number of images (e.g. 1 page printed duplex as Duplex=2) or the number of sheets (Duplex=1). Since Terminals 8.2, these values are unified as the number of sheets. The combination of data from older Terminals with Terminals 8.2 in Reports may cause an inconsistency in the Duplex values.

A job printed in 1x A3 monochrome sheet, on both sides in duplex mode, on a device where an Embedded terminal is installed, is accounted in MyQ as 1x A3 paper + 4x print monochrome and 1x duplex. In the MyQ log it will look like this: PM=4, A3=1, Duplex=1

10.1.4 Creating and editing reports
You can create a new report in a few steps:

1. At the top-right corner of the Reports main tab, click +Add report. The Add report dialog box appears.
2. In the box, select the type of the new report and the folder to place it, and then click OK. The editing panel of the new report opens. On the panel, edit and save the report.

Editing a report

1. On the General tab of the report’s editing tab, you can change the report’s Name, add a Description, select Sharing rights, meaning the users or groups who will have the rights to Run the report and those who will have the rights to Edit the report. You can also click Schedule to set its scheduled run. Once done, click Design to open the Design tab of the report.
2. On the Design tab, you can set the report’s layout, select the items (Users, Printers, etc.) to be included in the report, add or remove columns and change their order.

Options

• Orientation: Select either the Portrait, or the Landscape orientation.
• Show filters in the final report: Mark the checkbox if you want filters to be visible in the final report.

Filters and parameters
Available filters and parameters differ depending on the report type. These are the main parameters available for most of the standard reports types:

• Site: Select the Site to be included in the report.
• User: Select the users to be included in the report. If you select the Me option and share this report with all users, each user can only see just the data that concern themselves; this way you can make personalized reports for each user.
• Accounting Group: Select the accounting groups of users to be included in the report.
• Printer: Select the printers to be included in the report.
• Period: Select the time period to be covered by the report.
• Exclude data – User: Select the users to be excluded from the report (only available in reports where User is one of the filters used).

Table
Here you can enable and disable the table option.

You can also add and remove columns to the table, edit them and change their order.
For each column, you can change the width, alignment and the type of summary that will be shown on the final (bottom) row (Sum, Average or None).
To add a new column, click +Add. To open the editing options of an existing column, double-click it (or select it, and then click Edit). To remove a column, select it and click X. To move a column up or down the order, select it, and then use the up/down arrows.

Some reports do not include the option to use tables and their data can be displayed only in the chart form.

Chart
Here you can enable and disable the chart option.

You can also select from the Bar, Pie and Doughnut chart types. Furthermore, you can add and remove data types to be shown on the chart and select colors for each data type (depending on the report type).
To add a data type, click +Add. To open editing options of a data type, double-click it (or select it, and then click Edit). To remove a data type, select it and click X. To move a data type up or down the order, select it, and then use the up/down arrows.
Some reports do not include the option to use charts and their data can be displayed only in the table form.

Designing your own reports can be a bit tricky, since it always depends on many factors – amount of data included (columns), length of column names and values, report orientation etc. To get the best result, you can click Preview anytime during the report’s creation to check what the new design will look like. Only after you are satisfied with the layout, click Save to save the report.

10.1.5 Generating reports
To preview a report
Select the report and click Preview (or right-click it and click Preview on its shortcut menu). The report is shown in HTML format and the number of included data is limited. You can switch between Graphical view and Grid view.

To run a report
Select the report and click Run. (Or right-click it and click Run on its shortcut menu).
The report runs in the specified format (PDF, CSV, XML, XLSX or ODS) with no data limitation.

To export the displayed report
After the report is generated, click on the report’s format link in the file column to download it.

Connection to BI tools

Starting from version 8.1(patch 2), MyQ Central Server exposes data to be analyzed with external BI tools (Business Intelligence tools).
The below information refers to the setup and use of Power BI by Microsoft, along with a MyQ setup.
For further information about Power BI, visit: https://docs.microsoft.com/en- us/power-bi/fundamentals/desktop-getting-started

11.1 Embedded Database Connection Configuration
Power BI can access the MyQ Embedded Database via ODBC. In order to create an ODBC data source:

Power BI will only let you connect to a ODBC data source that is available on the local PC it is running within. Your data source should be created on the same PC that Power BI desktop run.

1. Download and install the latest ODBC driver for Firebird from: https://firebirdsql.org/en/odbc-driver/
2. Once installed, open the ODBC Data Sources application from the Windows Apps menu.
3. Go to the System DSN tab and click Add.
4. In the Create New Data Source window, select Firebird/InterBase(r) driver and click Finish.
5. In the Firebird ODBC Setup tab, enter the connection details:
   a. Data Source Name (DSN): Add a name as an identifier for the connection
   b. Database: Add the path to your database file (C:\ProgramData\MyQCentral\MYQ.FDB by default)
   c. Client: Add the path to the Firebird library client used for the connection. It is recommenced to use the MyQ Central Server client, found in C:\Program Files\MyQ Central\Firebird\fbclient.dll by default
   d. Database Account: Add the Database Account user name. The default one is SYSDBA, but it is highly recommended not to use the default database account, but enable and use the database read-only account available in the External Reports settings tab
   e. Password: Add the Database Account password. In case you are using the default database account (not recommended) and you haven’t changed the password in MyQ Central Easy Config, the default one is masterkey.
   f. The rest of the fields can be left unchanged. Click Test Connection and if successful, click OK.

11.2 Creating Reports
Reports can be created according to each customer’s specific requirements. It is possible to create the reports manually, or use the Power BI template created by MyQ and available in the MyQ Community, in order to generate reports quickly.

• Manual reports creation
• Reports creation via template import
• Report examples
• Database Views description

11.2.1 Manual Reports Creation
To manually create the reports, open Power BI and:

1. Establish the connection to your database:
   a. For direct connection (only for MS SQL servers), click Get data, SQL Server and add the server and database name.
   b. For ODBC, click Get data, More…. In the new window, select Other, click on ODBC on the list, and click Connect. In the new prompt, select the Data source name (DSN) you created in the ODBC Data Sources app and click OK.

2. In the Navigator window, select all the options with the DIM and FACT prefixes and click Load (see Database Views description). 3. Power BI loads the data, however the relationships between them must be created manually, since Power BI cannot extract them:
   a. Go to the Modeling menu and click on Manage relationships
   b. Click New… and create the relationships between the views, selecting the IDs in each of them. Click OK once done.

3. Your model has been created and you can add visualizations to the report.

11.2.2 Reports creation via template import
There are two template versions, one to be used with an Embedded database and one to be used with an SQL server. An ODBC DSN for either an SQL Server or Firebird must be configured before using the template.

• ODBC template
  MyQ Central Server Repor…

• SQL template
  MyQ Central Server Repor…

To import the template provided by MyQ , open Power BI and:

1. Open the File menu, select Import, and click on Power BI template. Find and open the correct template according to your database.

2. Establish the connection to your database:
   a. For direct connection to an MS SQL server, add the SQL Server and Database name and click Load. b. For ODBC, add the Data source name (DSN) you created in the ODBC Data Sources app and click Load.

3. Power BI imports the data. The reports can be edited; the changes are saved in a different file so the template can be reused.

11.2.3 Report examples
The examples below were generated using the MyQ templates.

11.2.4 Database Views description
There are two groups of views; dimensions and facts. The fact views contain measures, numeric data which can be used in calculations for reports. The dimension views contain descriptive information used for the measures in the facts. Dimension views have the dim prefix and fact views have the fact prefix.
The IDs in the views are internal MyQ IDs and can be used to establish relationships between views.

Printer Dimension (dim_PRINTER_V2) – Information about the printer

Values: 1 = Offline , 2 = Online , 8 = Local
IS_COLOR| Color printing. Values: 1 = Color print available, 0 = Monochrome print only
IS_COPIER| Copier function. Values: 1 = Copier , 0 = Copier function is not available
IS_A3| A3 paper format support. Values: 1 = A3 format is supported, 0 = No A3 format support
COPIER_COLOR_COU NTER| Total counter of color copies
COPIER_MONO_COU NTER| Total counter of monochrome copies
PRINTER_COLOR_CO UNTER| Total counter of printed color pages
PRINTER_MONO_CO UNTER| Total counter of printed monochrome pages
SCANNER_COUNTER| Total counter of scanned pages
FAX_COUNTER| Total counter of fax pages

User Dimension (dim_User) – Information about the user

Printer Events Fact (fact_PRINTER_EVENTS) – Information about printer events.

tonerReplacement )
Created| Date and time in which the event was created
Closed| Date and time in which the event was closed
Data| Data of the event (JSON example:
{“TONER_K.LEVEL”:”8″,”EVENT.TONER.INFO”:
“TK-8305Y”,”TONER_C.LEVEL”:”6″,”TONER_K.INFO”:”TK-8305K”,” TONER_C.INFO”:
“TK-8305C”,”TONER_M.INFO”:”TK-8305M”,”TONER_M.LEVEL”:”0″, “TONER_Y.INFO”:
“TK-8305Y”,”TONER_Y.LEVEL”:”6″,”SUPPLY.INFO”: “TK-8305C;TK8305M;TK-8305Y; TK- 8305K”,”EVENT.TONER.LEVEL”:”6″})
Printer_Id| ID of the printer where the event was raised

Toner replacements (fact_TONER_REPLACEMENTS) – It provides certain data about printer toners that have been replaced and currently installed. This view combines the results of V_TONERS_REPLACED and V_TONERS_INSTALLED into one view.

V_TONERS_REPLACED

the toner was replaced
Period| Number of days from the toner installation to the toner replacement
Pages| Number of pages printed by the toner
Printer_Id| ID of the printer where the toner was installed

V_TONERS_INSTALLED

type installation
Period| Number of days since the toner installation
Pages| Number of pages printed by the toner
Printer_Id| ID of the printer where the toner was installed

Printer jobs counter fact (fact_PRINTERJOB_COUNTERS_V3) – Information about printer jobs counters

faxTx  (Outgoing fax – scan)
PAYMENTACCO UNT| Payment Account. Values Credit , Quota , Cost Center
FINISH_DATE| Date when job was finished
FINISH_TIME| Time when job was finished
FINISH_YEAR| Year when job was finished
FINISH_MONTH| Month when job was finished
FINISH_DAY| Day of a month when job was finished
FINISH_HOUR| Hour when job was finished
PAPER_FORMAT| Paper format
DUPLEX| Duplex print. Values: Yes , No
SHEETS| Used sheets of paper
MONO| Monochrome print job
COLOR| Color print job
SINGLE| Single color print job
PRICE| Job price
CLICK_MONO| Click mono
CLICK_COLOR| Click color
SESSION_ID| User session id
JOB_ID| Job id (Reference to user’s job)

Job Fact (fact_job) – Information about print jobs

Session Fact (FACT_SESSION_COUNTERS) – Information about sessions

Session Environmental Impact Fact (FACT_SESSION_ENV_IMPACT) – Information about sessions’ environmental impact

units)
TOTAL_ENERGY_WH| Approximate amount of Energy consumed per session (in watt- hour units)
TOTAL_ENERGY_WH_RE CYCLED| Estimated approximate amount of Energy will be consumed to recycle used amount of paper per session (in watt-hour units)

Printer Job Environmental Impact Fact (FACT_PRINTERJOB_ENV_IMPACT)
-Information about printer job’s environmental impact

units)
TOTAL_ENERGY_WH| Approximate amount of Energy consumed per session (in watt- hour units)
TOTAL_ENERGY_WH_RE CYCLED| Estimated approximate amount of Energy will be consumed to recycle used amount of paper per session (in watt-hour units)

There is a limitation that even if you are using a Job Privacy license, the data in the database are not changed by this feature and are still readable.

System health check

This option presents you with an overview of error messages with the level of severity added after some registered checks are done. The errors concern database health, disk space availability, PIN length settings and time zone configuration, etc.
They are listed in the table below.

the log
102| High| Log database health is not good; multiple messages can appear in the log
103| Medium| PIN length needs to be increased
104| High| Disk space is on warning level
105| Critical| Disk space is on critical level
106| High| Time zones misconfiguration
109| High| License subscription is going to expire
110| High| License Subscription expired
111| High| Contacting license server failed
112| High| HW code mismatch
113| High| License activation required
114| High| License expires soon

When the error message has a Critical severity, the administrator gets an email.
Every error message with a Low severity is logged in the MyQ main log.

12.1 Using system health check
To access the system health check overview go to MyQ, System Health Check, or click on the system health check button on the top-right side of the window.

Click Run to trigger the System health check Task schedule to perform a check.
Click Show hidden to view any hidden checks on the list.
Click Scheduled task to open the System Health Check task in Task Scheduler, where you can view and modify it.

Updating MyQ

The MyQ update to a higher version or reinstalling the same version is performed automatically after running the installation executable file.
Before a MyQ update on Windows Server 2012/2012 R2/2016/2019 (or on Windows 8.1/10), make sure that the latest Windows updates are downloaded and installed on the server.
When upgrading or updating MyQ, ensure all antivirus exclusions are made and that there are no running scan operations on the MyQ directories structure.
It is strongly recommend to backup your database before the update.

A direct upgrade to version 10.0 is only possible from version 8.2.

To update MyQ:

1. Run the MyQ software installation executable file. The Select Setup Language dialog box appears.
2. Select your language, and then click Next. The Setup dialog box appears. It informs you that there is an older version of MyQ and that the installer will start the update process.
3. Click Yes. The License Agreement dialog box appears.
4. Select I accept the agreement and click Next.
5. In the Ready to Install dialog, click Install. The rest of the update process is nearly identical to this of installing MyQ.

In older MyQ versions, it was possible to switch between a 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 it to MyQ Central server 10.0, be advised that the upgrade will not be successful. This kind of upgrade and migration is only available between MyQ Central server 8.1 and MyQ Central server 8.2. Check here for further details.

Uninstalling MyQ

To uninstall MyQ:

1. Run unins000.exe. You can find this file in your MyQ program folder (the default folder is: C:\Program Files\MyQ Central Server\). The MyQ Uninstall dialog box appears.
2. Click Yes.

All parts of MyQ will be uninstalled except for the Data Folder. You can delete the folder manually. In case you install MyQ again, the installation program will ask if you want to use the old database files or replace them with new files.

Business Contacts

MyQ® Manufacturer| MyQ® spol. s r.o.
Harfa Office Park, Ceskomoravska 2420/15, 190 93 Prague 9, Czech Republic
MyQ® Company is registered in the Companies register at the Municipal Court in Prague, division C, no. 29842
---|---
Business information| www.myq-solution.com
info@myq-solution.com
Technical support| support@myq-solution.com
Notice| MANUFACTURER WILL NOT BE LIABLE FOR ANY LOSS OR DAMAGE CAUSED BY INSTALLATION OR OPERATION OF THE SOFTWARE AND HARDWARE PARTS OF THE MyQ® PRINTING SOLUTION.
This manual, its content, design and structure are protected by copyright. Copying or other reproduction of all or part of this guide, or any copyrightable subject matter without the prior written consent of MyQ® Company is prohibited and can be punishable.
MyQ® is not responsible for the content of this manual, particularly regarding its integrity, currency and commercial occupancy. All the material published here is exclusively of informative character.
This manual is subject to change without notification. MyQ® Company is not obliged to make these changes periodically nor announce them, and is not responsible for currently published information to be compatible with the latest version of the MyQ® printing solution.
Trademarks| MyQ®, including its logos, is a registered trademark of MyQ® company. Microsoft Windows, Windows NT and Windows Server are registered trademarks of Microsoft Corporation. All other brands and product names might be registered trademarks or trademarks of their respective companies.
Any use of trademarks of MyQ® including its logos without the prior written consent of MyQ® Company is prohibited.
The trademark and product name is protected by MyQ® Company and/or its local affiliates.

References

• toner.info
• MyQ License Server
• MyQ License Server
• login.microsoftonline.com/common/oauth2/nativeclient
• Get your Plan | MyQ
• Get your Plan | MyQ
• solution.com is for sale | www.oxley.com
• supply.info
• MyQ Print Management Solution | Security | Productivity | Efficiency
• developer.paypal.com/
• Microsoft Learn: Build skills that open doors in your career
• Microsoft Entra Domain Services documentation - Microsoft Entra ID | Microsoft Learn
• Tutorial - Configure LDAPS for Microsoft Entra Domain Services - Microsoft Entra ID | Microsoft Learn
• Tutorial - Create a Microsoft Entra Domain Services managed domain - Microsoft Entra ID | Microsoft Learn
• Get started with Power BI Desktop - Power BI | Microsoft Learn
• Enabling CLR Integration - SQL Server | Microsoft Learn
• Server Core App Compatibility Feature on Demand in Windows Server | Microsoft Learn
• Updating MyQ
• Guides in PDF
• Release Notes
• Download .NET Framework | Free official downloads
• Firebird: ODBC Driver
• login.microsoftonline.com/common/oauth2/nativeclient
• Sign in to your account
• Log in with Atlassian account
• Log in with Atlassian account
• Log in with Atlassian account
• Log in with Atlassian account
• MyQ Community
• Microsoft Azure
• windows - Map a network drive to be used by a service - Stack Overflow
• windows - Map a network drive to be used by a service - Stack Overflow
• DigiCert Root Certificates - Download & Test | DigiCert.com
• New Page
• OpenLDAP Software 2.4 Administrator's Guide: Limits

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>