MyQ Smart Quick Setup Guide
MyQ Smart Quick Setup Guide
8.0+ SMART
June 2020
Revision 5
Table Of Contents
1. Introduction 5
1.1. Welcome 5
2. Installation 7
Installing MyQ® 7
3.1.2. License 11
4. License 14
5. Set up printers 16
5.1. Printers 16
6. User synchronization 19
Users tab: Selecting base DN, assigning attributes and additional settings 21
-3-
Groups tab: Importing groups 24
8. Business contacts 32
-4-
1. Introduction
1.1. Welcome
Welcome to the MyQ Smart Quick Setup Guide! This guide will tell you how easy it is to
get your SMART license, add printers and synchronize your users. After that, all your
users will be able to print from every printer you have installed. It is that easy!
You will come across an array of features in the MyQ Web UI, however, be aware that
not all of them will work with your free SMART license. This can be easily fixed by
upgrading to the ENTERPRISE license at any time. If you are interested, please send
an email to [email protected].
The full functionality of MyQ is detailed in the MyQ Basic Installation Guide, which
you can find in our Community Portal: https://community.myq-solution.com. Just click
Login and follow the procedure after clicking Not a member? next.
l The Smart Job Manager, which can be used for identification of users and
pairing them to all kinds of tasks
l Smart Print Services, which also entail failover printing, where jobs can be sent
to another printer in case of a network breakdown
l The MyQ Mobile Print Agent, which helps set up the server so your users can
print using their mobile phone (as well as AirPrint for Apple iOS users and Mopria
for Google Android users)
Allow us now to give you a short overview of the features that are not available under
the free SMART version:
l Embedded terminals are not available, thus no terminal actions such as Print all,
My Jobs, and ID and Card Registration among others;
l Quota, Credit and Projects can only be viewed on the Web User Interface;
-5-
NOTICE: Your free MyQ SMART license is valid for one year and can then be
renewed. It comes with software assurance support (updates, patches,
community forum). For full MyQ Support, an upgrade to the Enterprise or
Ultimate edition is required.
-6-
2. Installation
This chapter shows you how to install the MyQ print management system. Prior to the
installation, make sure that Microsoft .NET Framework 4.7.2 (Full version) is already
installed on your computer. If it is not, install it using the steps in the following section.
NOTICE: Before the installation on Windows Server 2012 / 2012 R2/ 2016 /
2019 (or on Windows 8+ / 10), make sure that all the latest Windows updates are
downloaded and installed on the server.
Installing MyQ®
1. Download the latest available version of MyQ from the MyQ Community portal.
2. Run the executable file. The Select Setup Language dialog box appears.
3. Select your language, and then click OK. The License Agreement dialog box
appears.
4. You need to accept the terms of the agreement to continue with the installation.
5. Then click Next. The Select Destination Location dialog box appears.
6. Select the folder where you wish to install MyQ. The default path is:
-7-
8. Click Finish. Depending on settings of the operating system on the server, you
might be asked to restart the computer.
l If you are asked to restart the computer, you need to do so in order to finish
the installation. After the restart, the MyQ Easy Config application opens
and the MyQ database is upgraded.
l If not, you can select to directly run the MyQ Easy Config application by
keeping the Run MyQ Easy Config option selected.
l Open your web browser, and then enter the web address in the form:
http://*MyQserver*:8090, where *MyQserver* represents the IP address or the
host name of your MyQ server and 8090 is the default port for access to the
server.
l Log in to the interface from the MyQ Easy Config application by clicking Continue
on the Home tab, under To continue with setup, go to web interface.
-8-
Logging on as an administrator
l Enter the MyQ administrator name (*admin) and the password that you have set
in the MyQ Easy Config application, and then click Login. If you have not
changed the default password yet, enter the default one: 1234.
INFO: In the drop-down list at the top of the login window, you can select your
preferred language.
NOTICE: By not changing the default password, you leave the MyQ system
unsecured and enable others to easily access it. If you have not done it yet, we
strongly recommend you to change the password in the MyQ Easy Config
application.
Once you login, you see the Home dashboard with the Quick Setup Guide gadget.
-9-
- 10 -
3. From time zone to Outgoing SMTP server
In this chapter you will:
l By clicking Edit, you open the General settings tab, where you can view and
change the time zone. For 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.
3.1.2. License
Adding and activating licenses
Click Enter License. The License Settings tab opens. You are asked to enter the
following information about your installation.
- 11 -
Then you can either:
l Click the Enter License button, if you already have license keys to add. Add the
license keys (one key per row) and click Next.
l Or click the Get MyQ ENTERPRISE trial license button, to get a two-month trial
ENTERPRISE license for an unlimited number of printers and a two-month trial
license for ten embedded terminals. (These licenses are automatically activated.)
l Or click Get a free MyQ SMART license, to request for the free MyQ SMART
license.
- 12 -
3.1.4. Outgoing SMTP server
By clicking Configure the outgoing SMTP server, you open the Network settings
tab, where you can set the outgoing SMTP server. You will need this server to send
email reports and send error messages to users . You have to configure the email
server, where all the mails are forwarded.
Do the following:
1. Enter the server hostname or IP address in the Server text box. If the email
server listens on a different port than the 25 TCP port, change the Port setting to
the correct value.
3. Enter the Sender email that you want to be displayed as the sender address on
alert and report messages.
4. After you enter the data, click Test to test connection to the email server.
b. a red line is shown when the test failed with an explanantion on why it
failed.
6. Click OK.
7. Click the Home tab to see that the setup is well underway.
- 13 -
4. License
You can request and enter your MyQ SMART license on the Home screen during the
initial setup of MyQ.
The following pop- up window is displayed, where you need to fill the mandatory
information required.
Make sure the email displayed is the correct one, answer the questions and click OK.
You will then receive an email with your license key and instructions from MyQ.
Click the Enter License button and add the license key you just received. Click Next
and activate your new license.
- 14 -
1. On the Home window click Show license page in the License section.
2. Click Remove license. You are directed to the License page where you previously
entered your contact data.
5. Click OK. You will receive an e-mail with the new license key.
- 15 -
5. Set up printers
To set up printers you must take two steps:
5.1. Printers
In this example of creating a printer discovery we show you how to do this in a full
automatic way. Discovery, embedding and activating all form part of this process.
4. Add a meaningful Description, so you can create more printer discoveries with
different IP ranges.
- 16 -
6. Click Save.
b. Click Create direct queue. Now every single printer will be added to its
own queue. In this way, your users can print from any printer.
NOTICE: You can activate only as many printers as your license supports.
- 17 -
Run a discovery and add all printing devices
1. On the Printer Discovery settings tab, select the printer discovery that you want
to use.
2. Click Run. The Discovering tab with a list of discovered printing devices opens.
3. Click Add to MyQ, and then click Add all in the drop-down box. You can see the
added printing devices on the Printers main tab.
4. Click the arrow next to the MyQ icon and select Queues. You will see that for
every printer, a direct queue has been created.
- 18 -
6. User synchronization
You can add your users one by one, or import user data into MyQ from different
sources.
l By clicking Add users manually, you open the Users main tab, where you can
manually add users. This action is described in the MyQ Basic Installation Guide.
l By clicking Import users, you open the Users Synchronization settings tab,
where you can import users from the Master server, from LDAP servers or from a
CSV file. In this manual we will describe the import via an LDAP server with an
Active Directory. For the other methods, see the MyQ Basic Installation Guide.
1. Click Import Users on the Quick Setup Guide gadget on the MyQ Web Interface
dashboard. The User Synchronization settings window opens.
2. Click +Add sync source on the main ribbon and select Add LDAP source. The
LDAP synchronization window opens.
4. In the LDAP Server field, click on the arrow and select +Add new from the drop-
down list.
l Server: Click +Add to manually add your server's IP address and port, or
leave it empty for automatic discovery.
6. Click Test to make sure the connection is working and then click Save.
- 19 -
FIGURE 2.2. The LDAP server properties panel
7. Your new domain should now occupy the LDAP server field. Add the User and
Password needed for authentication on your LDAP server.
8. You can enable the Export to CSV after successful import option and MyQ
creates a CSV file with the imported users after the synchronization. You can then
browse to select the folder where you want the CSV File to be saved in.
9. Click Save.
- 20 -
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.
FIGURE 2.4. The Users tab on the LDAP synchronization properties panel
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.
- 21 -
Properties:
These are 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. 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 the attribute from the attributes of any individual user and drop it in
the text box.
For assigning default languages of users, you have to use an attribute from the LDAP
server which has abbreviations of languages as its values. For example, you can create
and use an attribute called lang with values en for English, hr for Croatian etc. The list
of the abbreviations used in MyQ can be found here.
Options:
l 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.
l 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 accounts of the users
who are already in MyQ, but does not add any new users.
l Convert user name to lowercase: MyQ is case sensitive. You can use the
Convert user name to lowercase option to prevent creating multiple accounts
for one user.
- 22 -
l 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 the LDAP server.If you synchronize
users with LDAP, the source LDAP server is automatically assigned as the
authentication server.
l 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.
Filter:
You can filter the import of users by specifying values of attributes. Add the conditions
in form: Attribute=Value. Users with different value of this attribute are not accepted
and are filtered out of the import.
For attributes where the values are strings, such as the cn, 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 raw. Users are accepted if they satisfy at least one condition.
- 23 -
FIGURE 2.7. Example of a filter and the resulting synchronization
After you change the settings, click Save to submit the changes.
- 24 -
FIGURE 2.8. The Groups tab on the LDAP synchronization properties panel
A user can be member of multiple groups but all their prints, copies and scans are
accounted to only one group: the Default group of the user.
If you select this option, the default group of the selected user does not change during
the synchronization.
You can select an existing group in MyQ under which you import the groups from the
LDAP database.
Attribute: You can select this option if you want to use an attribute that defines
groups in the LDAP database.
- 25 -
To add the attribute, type the name of the attribute in the property text box or drag
the attribute from the attributes of any individual user and drop it in the Attribute text
box.
You can also create groups by combining multiple attributes. To create such a group,
put each of the attributes between percentage signs (%). For example, the combination
of attributes %attribute1%_%attribute 2% , imports a new group named value1_
value2.
FIGURE 2.10. Example of a combined attribute group definition and the resulting synchronization
Furthermore, you can create tree structures of groups by separating the attributes with
vertical bars. For example, the combination of attributes %attribute1%|%attribute
2%, imports a group attribute1, and its sub-group attribute 2.
Make default: If you select this option, the group becomes the default group of the
imported user.
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 right has index 1, the second from right has index 2 and so on.
FIGURE 2.11. DN Components with three OU groups (Painters, famous_people and MYQ_IMPORT_
TEST)
- 26 -
On the picture above, there are three OU groups: MYQ_IMPORT_TEST has index 1 (as
it is the first OU group from 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.
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 left and from right. In the
respective text boxes, enter the ammount of components to be striped from left and
from right side.
You have to strip at least one component from left (the user CN component) and one
component from right (the right-most DC component).
On the picture above, there are six components. If you strip one component from left
and one from 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.
- 27 -
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 in consideration during the import, you have
to insert the groups base DN. MyQ import 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 the same organizational unit as the users base domain.
If a user is member of more than one groups 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 values of attributes. Add the conditions
in form: Attribute=Value. Groups with different value of 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. >Add
one condition per one raw. Groups are accepted if they satisfy at least one condition.
FIGURE 2.14. Example of an import of groups stored in memberattribute with the cn=test* filter
applied
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.
- 28 -
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.
FIGURE 2.15. Import of groups stored in memberOf attribute with the Import tree of groups option
deselected
FIGURE 2.16. Import of groups stored in memberOf attribute with the Import tree of groups option
selected
Your users are now synchronized in MyQ. You can view them all in MyQ, Users.
- 29 -
7. Appendix of functionalities visible in the
Web Admin UI
The functionalities listed below are visible on the Web Administrator Interface but not
all of them can be used with a free SMART license.
If you are interested in more details, check the linked manuals or contact MyQ at
[email protected].
Available in Available in
Available in
Functionality MyQ MyQ Related Links
MyQ Smart
Enterprise Ultimate
Only on the MyQ Basic
Personalization Yes Yes
Web UI Installation Guide
MyQ Basic
Task Scheduler Yes Yes Yes
Installation Guide
Network /
MyQ Basic
Authentication Yes Yes Yes
Installation Guide
servers / SNMP
MyQ Basic
Printers Yes Yes Yes
Installation Guide
Configuration MyQ Basic
Yes Yes Yes
Profiles Installation Guide
MyQ Basic
Printer Discovery Yes Yes Yes
Installation Guide
MyQ Embedded
Terminal Actions No Yes Yes
Terminal Manuals
MyQ Basic
Users Yes Yes Yes
Installation Guide
MyQ Basic
Policies Yes Yes Yes
Installation Guide
MyQ Basic
User Synchronization Yes Yes Yes
Installation Guide
Only on the MyQ Basic
Credit Yes Yes
Web UI Installation Guide
Only on the MyQ Basic
Quota Yes Yes
Web UI Installation Guide
MyQ Basic
Rights Yes Yes Yes
Installation Guide
- 30 -
MyQ Basic
Jobs Yes Yes Yes
Installation Guide
MyQ Embedded
Scanning & OCR No Yes Yes
Terminal Manuals
Only on the MyQ Basic
Projects Yes Yes
Web UI Installation Guide
MyQ Basic
Price lists Yes Yes Yes
Installation Guide
MyQ Embedded
Code Books No Yes Yes
Terminal Manuals
MyQ Basic
Reports Yes Yes Yes
Installation Guide
MyQ Basic
Mobile Application Yes Yes Yes
Installation Guide
MyQ Embedded
External Systems No Yes Yes
Terminal Manuals
MyQ Basic
Log & Audit Yes Yes Yes
Installation Guide
MyQ Basic
System Management Yes Yes Yes
Installation Guide
MyQ Basic
Service Module Yes Yes Yes
Installation Guide
ScannerVision No No Yes upon request
- 31 -
8. Business contacts
MyQ® Manufacturer MyQ® spol. s r.o.
- 32 -