YSOFT SAFEQ® 4 - ChansiSAFEQ/SafeQ4 - Quick Start...By downloading SafeQ, you get everything you need to install the system. In the package, there are also important tools and standalone

making the MFDs think™

YSOFT SAFEQ® 4

26.1.2012

2

Copyright © Y Soft Corporation. All Rights Reserved.

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

What you get when you download YSoft SafeQ

By downloading SafeQ, you get . In the package, there are also everything you need to install the system important toolsand that can help you with configuring or troubleshooting SafeQ and to give youstandalone applications documentationbasics 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 installationwill be a success, please consider following important steps:

There is either physical or virtual server, dedicated for SafeQ installation and following requirements as specified innext chapters.

The printers and multi-functional devices are properly configured and connected to system and you have printdrivers 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 knowall required information, in particular domain controller access and connection information and user directoryFDQN.

BETA VERSION ONLY: If you plan to connect browser based terminals (FX, KM, Sharp, Xerox) on Windows2008 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, itcannot be re-used from the different computer.

Required / Recommended Hardware

Following hardware specification is defined . is required for higherper one server within LAN Multi-server environmentnumbers 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 RecommendedHWspecification

http://wiki.ysoft.local/display/AURA/Distributed+Server+System+-+Private+Cloud

3


Up to devices/server 50

SafeQ Standalone or Clustered Server3.1/3.6/4.0

or SafeQ Remote Spooler (requiresconnection to Central Server) Up to 100 devices for whole installation

or SafeQ Central Reporting Server

Intel i7 or similar processor 4 GB RAM, 1GB Network 100GB HDD 10,000 RPM Equal VM with at least 2 cores and memorytrimming disabled connection to storage with throughput at least120MB/s and 300 IOPS

TBD

Up to devices per server (200 100 devices if) only single server is used

SafeQ Standalone or Clustered Server3.1/3.6/4.0

SafeQ Central Reporting Server

Intel Xeon 5500 or similar processor 6 GB RAM, 1GB Network 100GB HDD 10,000 RPM RAID1 or fibre optics Extra space 100GB (or more, depends on the storagestrategy) for SafeQ Central Reporting Server BI dataojects. Equal VM with at least 2 cores (4 coresrecommended) and memory trimming disabled connection to storage with throughput at least150MB/s and 500 IOPS

TBD

Multi Server:

Up to 100 remote sites (and total 500 devices) -for details see Distributed Server System -Private Cloud

1 Central (CML) server TBD

Up to 500 remote sites (and total 1000 devices) 2 Central (CML) servers with 6GB RAM TBD

Additional remote sites (up to 2000) 1 Additional CML server per 500 connected sites(ORS servers) 500 MB RAM per CML server for every 100connected sites (over 500 sites)

TBD

Remote sites:

devices per server 1-3

SafeQ Remote Spooler (requiresconnection to Central Server)

Intel Atom 3xx/D5xx or similar processor 1 GB RAM, 100 MB Network 20 GB HDD with throughput at least 50MB/s+

TBD


SafeQ Remote Spooler (requiresconnection to Central Server)

Intel i5 or similar processor 1 GB RAM, 100 MB Network 40GB HDD connection to storage with throughput at least120MB/s and 300 IOPS Equal VM with memory trimming disabled

TBD


SafeQ Remote Spooler Appliance(requires connection to Central Server)

(Described Separately)SafeQ Appliance - SafeQube TBD



http://wiki.ysoft.local/display/AURA/SafeQ+Appliance+-+SafeQube

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, becauseDS 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, becauseDS 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 isto run the installation file and proceed through the dialogs displayed by the installation wizard. You can choose between

or installation. While default installation will install SafeQ with recommended settings, withdefault customizedcustomized mode, you can set all the settings yourself.

Installing SafeQ - Basic Installer

1 Run the installation file install.exe

To install SafeQ 4, it is needed to have the installation file. This file can be obtained from the YSoft PartnerNOTE: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 selectthe language that will be used for the whole process.This language will be also used as a default languagefor the SafeQ environment. Please note that you canalways switch the language anytime later.

5


3 Once you aredone withlanguageselection, youcan see the firstdialog of theinstaller,recommendingyou to close allotherapplications toavoid issueswith updatingrelevant systemfiles.

4 The next dialogthen contains a License

. agreement

You areadvised to readthe agreement.If you agreewith all termsand conditions,you cancontinue theinstallation bypressing the I

button.AgreeIf you do notagree, you canquit theinstallation bypressing the

button. Cancel

5

6


After accepting the license agreement, there is a . This procedure checks several conditions andpreinstallation checkdetermines if the server meets requirements for SafeQ 4 installation

If some of these conditions are not met, they will be displayed either in the section or in the Show warnings Show section according to their severity. While the installation can continue if there is some warning, it will notproblems

run if there is some problem. After reviewing warnings and resolving problems (if any warnings or problems aredetected), the installation can continue.

7


The conditionsare:

VersionofWindows

UserinstallingSafeQ 4musthaveadministratorrights

Versionof .NEThas tobe atleast 3.5SP1

VersionofWindowsInstaller(has tobe 4.5to 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 offeryou the default installation folder, database engine and IP address of the SafeQ server. If you wish to use differentvalues than the default ones, you can check the checkbox. I want to customize my SafeQ installation

see section for more information Customized Installation

8


7 If you have chosen default installation, you are informed about the account name and password for this databaseat 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 themessage, theinstaller will beginto copy all filesneeded by SafeQand the chosendatabase system tothe selecteddestination folderon the server. Ifyou want to see thefiles that are beingcopied to thesystem, you can use the button under the progress bar. Show detail

8 Systemproceeds withthe installation

9


9 At the end ofthe installation,installer deletesall temporaryfiles it hadcreated before.Once theinstallationprocess iscomplete, youcan continue byclicking the

button. Next

10 The last dialoginforms youabout the resultof the wholeinstallationprocess andgives you theoptions todisplay theSafeQ webinterface orfinish theinstallationwizard.

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

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

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.

http://wiki.ysoft.local/display/AURA/Network+communication+overview

http://wiki.ysoft.local/display/AURA/Network+communication+overview

11


If you use a webbrowser andyour YSoftSafeQ webinterface isconfigured touse a differentport than thestandard port80, you mustenter thecomplete URL,including theprefix “http”, inyour Webinterface (e.g.:[http://safeq.mydomain.com:8080/]).

Use your defaultcredentials tostart 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 your copy of SafeQ. SafeQ supports two types of activation - activate and activation. which is a part of license agreement received afteronline offline System requires an activation code

product purchase.

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

Please follow instructions as available at the SafeQ Dashboard.

12


Offline ActivationIf the server is unable to reach YSoft SafeQ Activation Portal, administrator logs to the SafeQ web interface and selects theoffline activation. Once he enters the requested activation code, SafeQ generates an encoded integrity key containinginformation for the activation process. The next step is to the manual activation on . Integrityhttp://portal.ysoft.com/activatekey has to be entered into the offered text box on the webpage. If the integrity key is correct, license is generated. Licensecan be then uploaded to the SafeQ server via the web interface or manually uploaded to the corresponding folder followedby 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 dashboardscreen to start working with SafeQ. , using theAdditional help and instructions are available directly in the applicationHELP icon, locate in the top-right corner of the screen.

http://portal.ysoft.com/activate

13


After the login, you see the screen. ThereSafeQ Dashboard

is a list of widgets available withinformation on various SafeQfunctions. The most important step at thismoment is to follow the Welcome to YSoft SafeQ widget. This widget shows youwhat steps need to be takenbefore the SafeQ system isready.If you need more informationabout the initial SafeQ settings,please refer to Widgets -

sectionWelcome to YSoft SafeQof the Help pages.

Adding Users

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

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

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

LDAP

2 Open the section Connection

http://wiki.ysoft.local/display/AURA/Widgets+-+Welcome+to+YSoft+SafeQ

http://wiki.ysoft.local/display/AURA/Widgets+-+Welcome+to+YSoft+SafeQ

14


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

Availablesettings are:

LDAPservertype(AD,NDS,OpenLDAP)

URL ofLDAPserver

Searched LDAP subtree

Service account

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

Please ask your domain administrator for these information!

3 Open the section Scheduling

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

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 alsochoose days, when the replication will run.

15


3 Open the section User login

Define the domain name you want to connect to

4 Run the synchronization using "Sync now" button

5 Check the result.

The tab contains only the information about last synchronization with the LDAP server (date, duration andStatusresult) 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 andconfiguration of terminals, please refer to separate document ( - also available thru built-in helpInstalling SafeQ Terminalssystem 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 releasesa print job from the workstation and it is delivered through SafeQ directly to the printer without any additional

. Thanks to this, direct printing resembles most closely the traditional network printing environment.delay in processing

http://wiki.ysoft.local/display/AURA/Installing+SafeQ+Terminals

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 byfollowing these steps:

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

Hover the mouse over the option in the top right section of the screen and select the Items... Add new device option.manually

In the new dialog please go through all the tabs on the left side and set everything according to your needs. Do notconfigure "Terminal" tab, unless you want to connect terminal to the system.

In the tab, click the option and select a unique name for the direct printingDirect printing Add queuequeue. We recommend to name the queue like , for example .direct-<name of the machine> direct-printer1

Once all needed settings are set, save the device by pressing the button.Save Device

Adding device to Windows

The device we have created in SafeQ few moments ago, has to be also so that they can sendinstalled on workstationsprints 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 SafeQsystem.

17


Adding a new device (MFD, printer)

1 Open the dialog. Devices and Printers

2 Click the option. Add a printer

3 Select the Add a localprinteroption.

18


4 In the Choosea printer portsection selectthe Create anew portoption. As a Type of portselect Standard

.TCP/IP port

5 As a Hostname orIP addressenter theaddress of thedevice. Thenchoose theappropriatename for theport.

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

19


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

8 Right-click the newly(or already) createddevice and select the Printer propertiesoption and Switch tothe tab. Ports

20


9 The port you havecreated should bealready selected andhighlighted. Pressthe Configure

button. Port...

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

In the section, switch from to .Protocol Raw LPR

In the section, enter the name of the queue which will be used for the device (for example LPR Settings).secure

If needed, change also the other settings in the dialog (LPR Byte Counting, SNMP status).

11 Confirm all changes by pressing the button.OK

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 . This can be done using access rights and/or restrictions Rolesdefined in the SafeQ system. There are already some predefined roles. If you want to create your own role, you can do it bygoing 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 tab.Roles

21


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

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

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

After the settings are complete, click the button.Add

Basic Troubleshooting

SafeQ installation cannot proceedPlease 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 or sections.Warnings Problems

SafeQ installation failsIn case the installation proceeds but fails after some time, you can try to find the possible cause of the failure in theinstallation 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 issuesIf you meet any issues during the activation process (online/offline), firstly please check if you are using correctactivation code. Both online and offline activation processes should tell you exactly where the fault is so thetroubleshooting should be easy.

The job sent to the printer is not printedIf 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 theused device (in Windows). Please verify if the device and its port are configured exactly as it is described in this guide andthat 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 setaccess 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 Serviceswho will be always glad to help you.

Documents

YSOFT SAFEQ® 4 - ChansiSAFEQ/SafeQ4 - Quick Start...By downloading SafeQ, you get everything you need to install the system. In the package, there are also important tools and standalone