This Quick Start Guide enables you to quickly and easily install YSoft SafeQ and set it up for direct printing. In addition, this guide includes links to pages where you can find more information about installing and setting up YSoft SafeQ, such as detailed installation instructions and how to add printers to the YSoft SafeQ system.

What you get when you download YSoft SafeQ

When you download the YSoft SafeQ package, you get everything you need to install the system. The package also includes important tools and standalone applications that can help you configure and troubleshoot YSoft SafeQ, as well as documentation that provides basic and detailed information about various aspects of the system.

Installing YSoft SafeQ – Prerequisites

Once you have the YSoft SafeQ installation package, you can begin the installation. However, to make sure your installation is successful, before you begin, consider the following important preliminary requirements:

A physical or virtual server must be available, dedicated for the YSoft SafeQ system and which meets the requirements to support YSoft SafeQ functions.
MFPs and other printers that will be used with YSoft SafeQ must be configured and connected to the network, and the associated required print drivers and hardware components (for example, terminals or network readers) must be available.
If you plan to integrate YSoft SafeQ with a User Domain such as Active Directory, Novell, or OpenLDAP, make sure you have all required information, especially domain controller access/connection information and user directory FDQN.
If you plan to connect embedded, browser-based terminals (FX, KM, Sharp, Xerox) with Windows 2008 R2 or Windows 7, make sure that in "Server Role Manager - Features" or "Programs and Features", ".NET WCF Activation" feature(s) are enabled.
Make sure you have a valid, new activation key.
NOTE: The activation key is hardware-bound and once used cannot be re-used by a different computer.

When you are sure your system meets all the prerequisites, you can begin the YSoft SafeQ installation. With the interactive installer, all you need to do is to run the installation file and follow the steps in the installation wizard. You can choose between the default installation or a customized installation. The default installation will install YSoft SafeQ with the recommended settings, but with a customized installation, you can set all the settings yourself.

Installing YSoft SafeQ – Basic Installer

1	Obtain and run installation file ysf-sq5-install.exe from YSoft Partner Portal. Once you have the file and the server is ready for installation, you can begin YSoft SafeQ installation. NOTE: In order to install YSoft SafeQ, this file is required. It contains everything necessary for installing a fully functional YSoft SafeQ server.
2	Select a language that will be used for the installation process. This language will also be used as the default language for the YSoft SafeQ system. NOTE: You can change the language for YSoft SafeQ at any time after installation is done.
3	Close all other applications to avoid issues with updating the relevant system files.
4	If you agree to all the license terms and conditions, click I Agree to continue. If you do not agree, click Cancel to quit the installation.
5	After you accept the license agreement, the installer runs a preinstallation check. This procedure checks several conditions and determines if the server meets all requirements for YSoft SafeQ installation. If any of these conditions are not met, they will be displayed in either the Show warnings or Show problems area, depending on their severity. If there are warnings, installation can continue. If there are problems, installation cannot continue. If any warnings or problems are indicated, review the warnings and resolve the problems, then continue. The conditions the installer checks are: Correct version of Windows User installing YSoft SafeQ has administrator rights Version of .NET (must be .NET 4.5.1 or higher) Version of Windows Installer (must be 4.5 to install MS SQL) All required ports are open and free Enough available disk space Enough available system memory Presence of a previous version of YSoft SafeQ
6	The installer now displays YSoft SafeQ installation settings. To use the default installation settings: Accept the default YSoft SafeQ server installation folder, database engine, and IP address. Check Use server hostname and provide host name of your server. CML web will be reachable under this host name. This configuration serves as protection against DNS rebind attack. To use values other than the default ones: Check I want to customize my YSoft SafeQ installation; then go to Customized Installation for more information.
7	If you chose the default installation, the installer displays the account name and password for the database. The password is automatically copied to the clipboard. Save this password to a safe place so that you can either use it when you need it or change it if you want. Click OK.
8	The installer begins to copy all the files required by YSoft SafeQ and the database system you chose to the selected destination folder on the server. In case you wish to see detailed installation progress, press Show details button (or D key).
9	The last page of the wizard informs you about the results of the installation process and gives you the option to display the YSoft SafeQ Web Interface. Click Finish when you are ready to close the installation wizard.
10	Installation is now complete. You might also want to check firewall and antivirus settings.

Troubleshooting the installation process

If an error occurred during the installation process, please check the following log files that were created during the process. All the installation log files are located in the YSoft SafeQ installation folder.

pginstall.log - contains information about PostgreSQL installation (if you selected PostgreSQL as the database to install).
sqinstall.log - contains information about the entire YSoft SafeQ installation process.

Additional logs can be obtained from AppData\local\Temp\1\ of currently logged user.

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

At the end of the installation, you can set up the YSoft SafeQ system for use.

Logging into YSoft SafeQ

To use YSoft SafeQ, log into the YSoft SafeQ Administrative Web Interface. The default login credentials are:

user: admin
password: admin

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

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_ip:8080/).

Use your default credentials to start working with YSoft SafeQ.

You can choose the language of YSoft SafeQ web interface by clicking a national flag.

images/download/attachments/21955566/login.jpg

Activating YSoft SafeQ

After installation is complete, SafeQ must be activated. YSoft SafeQ supports two types of activation: online and offline. The system requires an activation key, which is a part of the license agreement you received after the product was purchased.

(See Activating YSoft SafeQ for a detailed description of the activation process.)

Using the online activation method - Log into the YSoft SafeQ Web Interface as administrator and, on the Dashboard, enter the activation key. YSoft SafeQ automatically contacts the YSoft Partners Portal and downloads the license.

If the YSoft SafeQ server is not connected to the Internet, perform the Using the offline activation method procedure.

Now you are ready!

You can now start working with YSoft SafeQ. On the Dashboard, follow the Welcome to YSoft SafeQ wizard to begin. Additional help and instructions are available in the YSoft SafeQ Web Interface --- click the help icon located in the top right corner of the page.

images/download/attachments/21955685/oprava2.jpg

After you log in, the YSoft SafeQ Dashboard page opens. A list of widgets is available that you can use to get information about various YSoft SafeQ functions.

The most important first step is to use the Welcome to YSoft SafeQ widget. This widget shows you the steps you need to perform before the YSoft SafeQ system is ready to use.

If you need more information about the initial YSoft SafeQ settings, see Widgets - Welcome to YSoft SafeQ in the Help pages.

images/download/attachments/21955685/ad_en_welcome.png

Adding users

If you use Active Directory and want to integrate YSoft SafeQ with your AD domain, follow these steps. Otherwise, add users manually using User list.The following steps will guide you through the default Active directory integration setup. For advanced and expert options please refer to LDAP Integration - Advanced and Expert settings.

1	Open the LDAP integration wizard through the Welcome to YSoft SafeQ Widget at the main screen. NOTE: The settings for LDAP replication can be also found on the web interface: Users -> Actions... -> Connect to LDAP
2	Open the Connection section. On the Connection tab, you can setup the integration setting with LDAP. Available settings are: LDAP server type (AD, NDS, OpenLDAP) Load users on demand - This type of replication mode is sometimes referred as semi-online. When enabled, users are created only during job reception or when logging into the terminal. Full and differential replication updates only users already registered within YSoft SafeQ. Replication of Roles and Cost centers is unaffected. Note: User's card when is removed from LDAP is not synchronized to the database with configuration option removeCardsInDiffLdapReplication . Having semi-online mode enabled (ldap-replicator-online-mode = true) can result in issuing multiple identical LDAP requests to remote AD server. This can clash with configured user-locking policy. Possible workaround would be: a) do not use semi-online mode, when there is strict user-locking policy on AD, b) increment number of attempts after which user gets locked to at least 5. URL of LDAP server LDAP bind method - method used for authentication and data security on the LDAP level The correct setting of LDAP bind method needs to be selected so that YSoft SafeQ can authenticate to the LDAP server configured, supported options are: Simple bind – This is universal password-based authentication method simply passing the username and password in plain. From a security perspective, this is acceptable if an LDAPS connection is used since the entire communication is protected on the TLS level. LDAP servers might refuse to accept an unsecured LDAP connection using simple bind (e.g. based on registry settings of an Active Directory server). Select this method if an anonymous connection is to be used. LDAPv3 SASL DIGEST-MD5 – An advanced authentication mechanism added in LDAP version 3 is used which does not expose plain-text passwords. In addition, if an unsecured LDAP connection is used, the data transferred will be integrity-protected and also encrypted if the LDAP server supports it. However, using LDAPS is still recommended for better security. This method can also be used together with LDAPS, when only the initial authentication might be affected (LDAP servers might refuse to accept connections with a doubled data protection mechanism). Note there are limitations when using this method, e.g. the IP address in the URL of LDAP server setting is not supported. Please see Client authentication below for more information and the full list of limitations. Searched LDAP subtree Service account There is a possibility to use either an 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 LDAP credentials. Specific username (principal) format might be required based on LDAP bind method selected. For LDAPv3 SASL DIGEST-MD5 setting, use only the username string with no prefix or suffix. Simple bind setting supports more formats, e.g. user@domain or distinguished name.
3	Open the Scheduling section. The Scheduling tab gives you the possibility to schedule the run of replication. All settings are revealed after you check the Enable regular synchronizations checkbox. The options are: Start full replication - Here you can select the days and times for full replication, by clicking checkboxes. Start differential replication - Here you can specify the hours or time interval from the last replication to start differential replication. This type of replication will be started every day. NOTE: You have to restart YSoft SafeQ CML services to apply these changes.

4	Run the synchronization using the "Sync now" button.
5	Check the result. The Status tab contains only information about the last synchronization with the LDAP server (date, duration and result) and the count of added/updated/deleted users, cost centers and roles. In case of an error, this error will be displayed here.

Adding a terminal and configuring Print roaming

Many YSoft SafeQ features require a terminal that controls the associated printer/MFP. For information about installing and configuring terminals, see Installing and configuring YSoft SafeQ Terminals. (You can also access this information in the YSoft SafeQ Web Interface Help pages.)

About direct printing and forced B/W printing from Windows workstations

Direct printing tracks prints without interfering with the standard workflow for users. At the workstation, the user sends a print job and it is delivered through YSoft SafeQ directly to the printer without any additional delay in processing. Direct printing is the method of printing in YSoft SafeQ that most closely resembles printing in a traditional network printing environment.

In order to implement direct printing, you must first add a printer to YSoft SafeQ and then add it to the Windows workstation.

Adding a printer to YSoft SafeQ

After you install YSoft SafeQ, add a printer to the YSoft SafeQ system as follows:

In the YSoft SafeQ Web Interface, select the Devices tab.
On the top right part of the page, hover your mouse over the Items option; then select Add new device manually.
Proceed through all the device setup pages, selecting settings according to your needs. (Skip the Terminal page settings unless you want to connect a terminal to the system; a terminal is not required for direct printing.)
On the Direct printing page, click Add queue and enter a unique name for the direct printing queue. We recommend a name such as direct-<name of the machine>, for example direct-printer1.
Click Save Device to save the printer.

Adding the printer to a Windows workstation

After you add the printer to YSoft SafeQ, you must also add it to each workstation that will use the printer. Follow these steps to add the printer to a Windows workstation:

In the Windows Add Printer wizard, set the printer port to send print jobs to YSoft SafeQ. This enables you to use YSoft SafeQ to track prints.

LPR is a network protocol for submitting print jobs to a remote printer (the YSoft SafeQ server in this case). This page explains how to configure a printer in Windows to use LPR for printing.

1	Open the Devices and Printers and select Add a printer.
2	Select the printer you want to install from the list or press The printer that I want isn't listed. In the case you have directly selected printer to install from the list, the printer will be automatically installed. In the case you have selected The printer that I want isn't listed, continue with following steps.
3	Choose Add a printer using TCP/IP address or hostname
4	For Hostname or IP address, enter the address of the server; then enter a name for the port.
5	Skip Additional port information required by pressing Next button (optional step)
6	From the list of printer drivers, select the appropriate driver (or select a driver from the disk).
7	Enter a name for the new printer; then wait for the installation process to finish. Select other options according to your needs (sharing, setting the printer as default, test page printing); then finish the wizard.
8	Right-click the new printer; then select the Printer properties option. Select the Ports tab. The port you created should already be selected and highlighted. Click Configure Port.
9	Change the Printer Name or IP Address to the IP address of the YSoft SafeQ server. In the Protocol section, select LPR. On the LPR Settings page, enter the name of the queue that will be used for the printer (for example my-print-queue). If necessary, change other settings on the page (LPR Byte Counting, SNMP status). Note: In the case, you won't be able to edit Port settings, select the printer in Devices and Printers tab > click Print server properties > Ports > Change Port Settings > select the port you created in step 4 and click Configure Port
10	Click OK to save the changes.

Now the workstation is configured to send print jobs to the YSoft SafeQ server.

Configuring roles

The last thing you need to do is to set up access rights and/or restrictions. These rights and restrictions are determined by Roles you define in the YSoft SafeQ system. YSoft SafeQ includes some predefined roles. If you want to create your own role:

In the YSoft SafeQ Web Interface, select Users > Role list > Add new item.
Each user can be assigned one or more roles. To assign a role to a user, edit the user and assign a role to him or her on the Roles page.
After you create a role and assign it to users, select Rules > Access definition.
Create an access definition for the new role: Click Add new item; then select the role and the group of devices where the printer is installed (group Default by default).
Allow or restrict use of the printers in this group by clicking the icons below the print, copy and color options. A green check means that users the role is assigned to are permitted to perform the operation; a red cross means they are not permitted to perform the operation. By default, users are permitted to perform all operations. To force black-and-white printing for all users the role is assigned to, change the color icon to a red cross.
After the settings are complete, click Add.

Basic troubleshooting

YSoft SafeQ installation cannot proceed - Check to make sure the server meets all the prerequisites for YSoft SafeQ installation. If you use the graphical YSoft SafeQ installer, after the preinstallation check is performed, the Warnings and Problems sections provide information about conditions that have not been met.

YSoft SafeQ installation fail - If the installation proceeds but fails, look in the installation log files to see if you can find the possible cause of the failure. All installation log files are in the YSoft SafeQ program folder. The files are:
pginstall.log - contains information about PostgreSQL installation
sqinstall.log - contains information about the entire YSoft SafeQ installation process

Activation issues - If you encounter any issues during the activation process (online/offline), first make sure you are using the correct activation code. Both online and offline activation processes tell you exactly where the fault is, so troubleshooting should be easy.

A print job sent to the printer was not printed - If you sent a job to YSoft SafeQ but it did not print, there can be several causes:

1. In the YSoft SafeQ Web Interface, go to the Job list and check to see if the job is listed there.

If the job is not listed in the Job list, the printer's settings on the Windows workstation may not be correct. Verify that the printer and its port are configured exactly as described in this guide and that the queue to which you send the print job has been created in YSoft SafeQ.
If the job is in the Job list, check the job's details to see why the job was not printed.

2. Other causes of this problem can be incorrect printer settings in YSoft SafeQ (IP address, queue name, etc.) or incorrect access settings for the printer. You can usually find these causes in the details about the job in the Job list.

3. If you cannot find the cause of the issue, contact Y Soft Customer Support Services, who will be glad to help you.