making the MFDs think

YSOFT SAFEQ 4

26.1.2012
 2

Quick Start Guide

This page serves as a quick start guide to let you install SafeQ easily and set it up for direct printing in no time. It also
contains a lot of links to detailed pages about various SafeQ aspects from installation and activation to installation of a
device.

What you get when you download YSoft SafeQ

By downloading SafeQ, you get everything you need to install the system. In the package, there are also important tools
and standalone applications that can help you with configuring or troubleshooting SafeQ and documentation to give you
basics and details about various aspects of the system.

Installing SafeQ - Pre-requisites

Once you have the SafeQ installation package, you can begin with the installation. However, to make sure your installation
will be a success, please consider following important steps:

There is either physical or virtual server, dedicated for SafeQ installation and following requirements as specified in
next chapters.
The printers and multi-functional devices are properly configured and connected to system and you have print
drivers and additional hardware components (e.g. readers) you want to use.
If you plan to integrate YSoft SafeQ with User Domain such as Active Directory, Novell or OpenLDAP, you know
all required information, in particular domain controller access and connection information and user directory
FDQN.
BETA VERSION ONLY: If you plan to connect browser based terminals (FX, KM, Sharp, Xerox) on Windows
2008 R2 or Windows 7, make sure that in "Server Role Manager - Features" or "Programs and Features", you have
".NET 3.5 WCF Activation" feature(s) enabled.
You have valid unused activation key. Please note that Activation Key is hardware-bound and once used, it
cannot be re-used from the different computer.

Required / Recommended Hardware

Following hardware specification is defined per one server within LAN. Multi-server environment is required for higher
numbers of connected devices.
HW server sizing is based on approximately 10 000 pages per device (monthly) / about 20 user per device (in average).

Main sites: Minimal HW specification Recommended

HW
specification

Copyright Y Soft Corporation. All Rights Reserved.

3
Up to 50 devices/server
SafeQ Standalone or Clustered Server
3.1/3.6/4.0
or SafeQ Remote Spooler (requires
connection to Central Server)
Up to 100 devices for whole installation 120MB/s and 300 IOPS
or SafeQ Central Reporting Server
Up to 200 devices per server (100 devices if
only single server is used)
SafeQ Standalone or Clustered Server
3.1/3.6/4.0
SafeQ Central Reporting Server
Multi Server:
Up to 100 remote sites (and total 500 devices) -
for details see Distributed Server System -
Private Cloud
Up to 500 remote sites (and total 1000 devices)
Additional remote sites (up to 2000)
Remote sites:
1-3 devices per server
SafeQ Remote Spooler (requires
connection to Central Server)
Up to 10 devices/server
SafeQ Remote Spooler (requires
connection to Central Server)
Up to 30 devices/server
SafeQ Remote Spooler Appliance
(requires connection to Central Server)
Copyright Y Soft Corporation. All Rights Reserved.
Intel i7 or similar processor TBD
4 GB RAM, 1GB Network
100GB HDD 10,000 RPM
Equal VM with at least 2 cores and memory
trimming disabled
connection to storage with throughput at least
Intel Xeon 5500 or similar processor TBD
6 GB RAM, 1GB Network
100GB HDD 10,000 RPM RAID1 or fibre optics
Extra space 100GB (or more, depends on the storage
strategy) for SafeQ Central Reporting Server BI data
ojects.
Equal VM with at least 2 cores (4 cores
recommended) and memory trimming disabled
connection to storage with throughput at least
150MB/s and 500 IOPS
1 Central (CML) server TBD
2 Central (CML) servers with 6GB RAM TBD
1 Additional CML server per 500 connected sites TBD
(ORS servers)
500 MB RAM per CML server for every 100
connected sites (over 500 sites)
Intel Atom 3xx/D5xx or similar processor TBD
1 GB RAM, 100 MB Network
20 GB HDD with throughput at least 50MB/s+
Intel i5 or similar processor TBD
1 GB RAM, 100 MB Network
40GB HDD
connection to storage with throughput at least
120MB/s and 300 IOPS
Equal VM with memory trimming disabled
SafeQ Appliance - SafeQube (Described Separately) TBD
 4

Software Requirements
Server Operating System for SafeQ Server and SafeQ Remote Spooler v4.0
Windows 2003/2003R2/2008 32bit including Clustered Installation
Windows 2003R2/2008/2008R2 64bit including Clustered Installation

Workstation Operating System for SafeQ Remote Spooler v4.0 up to 10 connected devices.
Windows XP SP3/7 32bit
Windows XP SP3/7 64bit

Notes

Microsoft .NET 3.5 SP1 or .NET 4.0 is required for Embedded Terminal and Vender-provided accounting support.
In case there are both versions (.NET 3.5 and .NET 4.0) installed .NET 3.5 must be patched to SP1, because
DS service will choose 3.5 primarily.
ORS Installation always requires .NET 3.5 SP1 or .NET 4.0 support.
In case there are both versions (.NET 3.5 and .NET 4.0) installed .NET 3.5 must be patched to SP1, because
DS service will choose 3.5 primarily.
Linux-based Operating Systems installation is not yet supported in SafeQ4

Once you have the server ready, you can begin with the installation itself. With the interactive installer, all you need to do is
to run the installation file and proceed through the dialogs displayed by the installation wizard. You can choose between
default or customized installation. While default installation will install SafeQ with recommended settings, with
customized mode, you can set all the settings yourself.

Installing SafeQ - Basic Installer

1 Run the installation file install.exe

NOTE: To install SafeQ 4, it is needed to have the installation file. This file can be obtained from the YSoft Partner
Portal and contains everything what it takes to install a fully functional SafeQ server.
Once you have the file and the server is ready for installation, you can begin with SafeQ 4 installation.

2 After running the installation file, it is needed to select

the language that will be used for the whole process.
This language will be also used as a default language
for the SafeQ environment. Please note that you can
always switch the language anytime later.

Copyright Y Soft Corporation. All Rights Reserved.

5

3 Once you are

done with
language
selection, you
can see the first
dialog of the
installer,
recommending
you to close all
other
applications to
avoid issues
with updating
relevant system
files.

4 The next dialog

then contains a
License
agreement.

You are
advised to read
the agreement.
If you agree
with all terms
and conditions,
you can
continue the
installation by
pressing the I
Agree button.
If you do not
agree, you can
quit the
installation by
pressing the
Cancel button.

Copyright Y Soft Corporation. All Rights Reserved.

 6

After accepting the license agreement, there is a preinstallation check. This procedure checks several conditions and
determines if the server meets requirements for SafeQ 4 installation

If some of these conditions are not met, they will be displayed either in the Show warnings section or in the Show
problems section according to their severity. While the installation can continue if there is some warning, it will not
run if there is some problem. After reviewing warnings and resolving problems (if any warnings or problems are
detected), the installation can continue.

Copyright Y Soft Corporation. All Rights Reserved.

7

The conditions
are:

Version
of
Windows
User
installing
SafeQ 4
must
have
administrator
rights
Version
of .NET
has to
be at
least 3.5
SP1
Version
of
Windows
Installer
(has to
be 4.5
to install MS SQL)
All required ports are open and free
Available disk space
Available system memory
Presence of previous version of SafeQ

6 Default Installation

At this point of the installation you are presented with SafeQ 4 installation settings. SafeQ will automatically offer
you the default installation folder, database engine and IP address of the SafeQ server. If you wish to use different
values than the default ones, you can check the I want to customize my SafeQ installation checkbox.

see Customized Installation section for more information

Copyright Y Soft Corporation. All Rights Reserved.

 8

7 If you have chosen default installation, you are informed about the account name and password for this database
at the very beginning of the installation process. The password is automatically copied to clipboard. It is advised to
save this password to a safe place so that you can either use it when you need it or change it if you want.

By confirming the
message, the
installer will begin
to copy all files
needed by SafeQ
and the chosen
database system to
the selected
destination folder
on the server. If
you want to see the
files that are being
copied to the
system, you can use the Show detail button under the progress bar.

8 System
proceeds with
the installation

Copyright Y Soft Corporation. All Rights Reserved.

9

9 At the end of
the installation,
installer deletes
all temporary
files it had
created before.
Once the
installation
process is
complete, you
can continue by
clicking the
Next button.

10 The last dialog

informs you
about the result
of the whole
installation
process and
gives you the
options to
display the
SafeQ web
interface or
finish the
installation
wizard.

Copyright Y Soft Corporation. All Rights Reserved.

 10

11 The installation is now complete.

Troubleshooting of the installation process

If there was any error during the installation process, the best way to troubleshoot it is to check several logfiles, that are
created during the process. All installation logfiles are located in the selected SafeQ installation folder:

dsinstall.log - contains information about Device Server installation (if component was selected to be installed)
pginstall.log - contains information about PostgreSQL installation (if PostgreSQL was selected to be installed)
sqinstall.log - contains information on the whole SafeQ installation process.

NOTE: On servers with enabled firewall it may be necessary to enable several network ports. See YSoft SafeQ Network
communication overview document for more information.

At the end of the installation, SafeQ system will be installed and ready for use.

Using YSoft SafeQ

To start using SafeQ please login to the Administrative Web Interface. The default credentials to login are:

login: admin
password: admin

For the best user experience, please use Microsoft Internet Explorer v9 or Google Chrome.

Copyright Y Soft Corporation. All Rights Reserved.

11

If you use a web

browser and
your YSoft
SafeQ web
interface is
configured to
use a different
port than the
standard port
80, you must
enter the
complete URL,
including the
prefix http, in
your Web
interface (e.g.:
[http://safeq.mydomain.com:8080/]).

Use your default

credentials to
start working with SafeQ.

By clicking on the national flag you can choose an language of SafeQ web interface.

YSoft SafeQ Activation

After the installation is complete it is needed to activate your copy of SafeQ. SafeQ supports two types of activation -
online and offline activation. System requires an activation code which is a part of license agreement received after
product purchase.

Online Activation
Administrator enters the activation code after logging into the SafeQ web interface. SafeQ server contacts YSoft Partner
Portal and if activation code entered matches with a sold license, license is encoded and sent to the SafeQ server. The server
then stores the license and gets activated. No restart is required in this case.

Please follow instructions as available at the SafeQ Dashboard.

Copyright Y Soft Corporation. All Rights Reserved.

 12

Offline Activation
If the server is unable to reach YSoft SafeQ Activation Portal, administrator logs to the SafeQ web interface and selects the
offline activation. Once he enters the requested activation code, SafeQ generates an encoded integrity key containing
information for the activation process. The next step is to the manual activation on http://portal.ysoft.com/activate. Integrity
key has to be entered into the offered text box on the webpage. If the integrity key is correct, license is generated. License
can be then uploaded to the SafeQ server via the web interface or manually uploaded to the corresponding folder followed
by the SafeQ services restart.

Now you are ready!

You are ready to start working with SafeQ. Please follow the "Welcome to YSoft SafeQ" wizard available at the dashboard
screen to start working with SafeQ. Additional help and instructions are available directly in the application, using the
HELP icon, locate in the top-right corner of the screen.

Copyright Y Soft Corporation. All Rights Reserved.

13

After the login, you see the

SafeQ Dashboard screen. There
is a list of widgets available with
information on various SafeQ
functions.
The most important step at this
moment is to follow the
Welcome to YSoft SafeQ
widget. This widget shows you
what steps need to be taken
before the SafeQ system is
ready.
If you need more information
about the initial SafeQ settings,
please refer to Widgets -
Welcome to YSoft SafeQ section
of the Help pages.

Adding Users
If you use Active Directory and wish to integrate SafeQ with your domain, please follow following steps. In another
case, skip for next chapter.

Following steps will guide you thru the default Active directory integration setup. For expert options please refer to further
chapters of LDAP Integration document.

1 Open the LDAP integration wizard thru Welcome to SafeQ Widget at the main screen
NOTE: The settings for LDAP replication can be found on web interface: Users -> Actions... -> Import data from
LDAP

2 Open the Connection section

Copyright Y Soft Corporation. All Rights Reserved.

 14

On the Connection tab, you can setup the integration setting with LDAP.

Available
settings are:

LDAP
server
type
(AD,
NDS,
OpenLDAP)
URL of
LDAP
server
Searched LDAP subtree
Service account

There is a possibility to use either anonymous account or authorized account to log into the LDAP server
to search for users. The selected account has to have at least read access to reach the users and their attributes.

Please ask your domain administrator for these information!

3 Open the Scheduling section

The Scheduling tab gives you a possibility to schedule the run of replication. All settings are revealed after you check
the Enable regular synchronizations checkbox. Then the options are:

Start full replication

Start differential replication

In the text fields near these settings, you can enter at which hour(s) the replication will start. You can also
choose days, when the replication will run.

Copyright Y Soft Corporation. All Rights Reserved.

15

3 Open the User login section

Define the domain name you want to connect to

4 Run the synchronization using "Sync now" button

5 Check the result.

The Status tab contains only the information about last synchronization with the LDAP server (date, duration and
result) and count of added/updated/deleted users, cost centers and roles.
In case of any error, this error will be displayed here.

6 For more advanced integration options, please refer to LDAP Integration document

Adding Terminal and Configuring Follow me print

YSoft SafeQ server provides number of feature that require terminal that controls printer/MFP. For Installation and
configuration of terminals, please refer to separate document (Installing SafeQ Terminals - also available thru built-in help
system at SafeQ web interface)

Direct Print Tracking & Force B/W from Windows

Direct printing is used for SafeQ Office Print Tracking without any interference with standard user workflow. User releases
a print job from the workstation and it is delivered through SafeQ directly to the printer without any additional
delay in processing. Thanks to this, direct printing resembles most closely the traditional network printing environment.

Copyright Y Soft Corporation. All Rights Reserved.

 16

Adding device to SafeQ

The first thing to do is to add some device to SafeQ so that you can use it to print. You can add the device to SafeQ by
following these steps:

Go to the SafeQ web interface and switch to the Devices tab.

Hover the mouse over the Items... option in the top right section of the screen and select the Add new device
manually option.
In the new dialog please go through all the tabs on the left side and set everything according to your needs. Do not
configure "Terminal" tab, unless you want to connect terminal to the system.
In the Direct printing tab, click the Add queue option and select a unique name for the direct printing
queue. We recommend to name the queue like direct-<name of the machine>, for example direct-printer1.
Once all needed settings are set, save the device by pressing the Save Device button.

Adding device to Windows

The device we have created in SafeQ few moments ago, has to be also installed on workstations so that they can send
prints to it. To install an MFD to the Windows operating system, usual steps are required:
We need to set the port of the device to send the jobs to SafeQ first. This will allow us to track prinitng with the SafeQ
system.

Copyright Y Soft Corporation. All Rights Reserved.

17

Adding a new device (MFD, printer)

1 Open the Devices and Printers dialog.

2 Click the Add a printer option.

3 Select the
Add a local
printer
option.

Copyright Y Soft Corporation. All Rights Reserved.

 18

4 In the Choose
a printer port
section select
the Create a
new port
option. As a
Type of port
select
Standard
TCP/IP port.

5 As a
Hostname or
IP address
enter the
address of the
device. Then
choose the
appropriate
name for the
port.

6 From the list of printer drivers, select the appropriate driver (or use the drivers from disk).

Copyright Y Soft Corporation. All Rights Reserved.

19

7 Choose a name for new device and wait for the installation process to finish. Select the other options according to
your needs (sharing, setting the printer as default, test page printing) and finish the wizard.

8 Right-click the newly

(or already) created
device and select the
Printer properties
option and Switch to
the Ports tab.

Copyright Y Soft Corporation. All Rights Reserved.

 20

9 The port you have

created should be
already selected and
highlighted. Press
the Configure
Port... button.

10 Change the Printer Name or IP Address value to the IP address of the SafeQ server.

In the Protocol section, switch from Raw to LPR.

In the LPR Settings section, enter the name of the queue which will be used for the device (for example
secure).
If needed, change also the other settings in the dialog (LPR Byte Counting, SNMP status).

11 Confirm all changes by pressing the OK button.

Now the device is configured to send jobs to SafeQ server.

Configuring roles

The last thing you may need to do is to set up correct access rights and/or restrictions. This can be done using Roles
defined in the SafeQ system. There are already some predefined roles. If you want to create your own role, you can do it by
going to Users -> Roles list -> Add new item.

Each user can be assigned one or more roles. To assign a role to user, edit the user and assign him a role in the Roles tab.

Copyright Y Soft Corporation. All Rights Reserved.

21

Once everything is set, you can go to the Rules section and switch to the Access definition tab. To create access definition
for the created role, click the Add new item option. In the newly displayed dialog, select the created (or predefined) role
and a group of devices where our device is installed (group Default by default). Then you can allow or restrict usage of the
devices in this group by clicking the icons below print, copy and color items. Green check means that users in the
specified role are permitted to perform the operation, red cross means restriction.

By default, users are not restricted to work with the system

To force black&white printing for all users in the selected role, switch the color icon to red cross.

After the settings are complete, click the Add button.

Basic Troubleshooting
SafeQ installation cannot proceed
Please check if the server meets all prerequisities needed for SafeQ installation. If you use graphical SafeQ installer,
you can check if all conditions are met after the preinstallation check in the Warnings or Problems sections.

SafeQ installation fails

In case the installation proceeds but fails after some time, you can try to find the possible cause of the failure in the
installation logfiles. All installation logfiles can be found in the SafeQ program folder. The files are:

dsinstall.log - contains information about Device Server installation

pginstall.log - contains information about PostgreSQL installation
sqinstall.log - contains information on the whole SafeQ installation process

Activation issues
If you meet any issues during the activation process (online/offline), firstly please check if you are using correct
activation code. Both online and offline activation processes should tell you exactly where the fault is so the
troubleshooting should be easy.

The job sent to the printer is not printed

If you have sent a job to SafeQ and it is not printed, there can be several causes.

Firstly check the joblist in the SafeQ web interface. If the job is not there, the issue will be probably in the settings of the
used device (in Windows). Please verify if the device and its port are configured exactly as it is described in this guide and
that the queue to which you send the printjob is created in SafeQ. If the job is in the SafeQ joblist, please check its details.
They should tell you why the job was not printed.

The other causes of this issue can be wrong settings of the device in SafeQ (IP address, queue name, ...) or wrongly set
access definition for a device. These causes can be usually easily found in the job details.

Generally, if you cannot find any cause of the issue, you can contact YSoft Customer Support Services
who will be always glad to help you.

Copyright Y Soft Corporation. All Rights Reserved.