YSoft SafeQ FlexiSpooler Installation

Please make sure that Y Soft certificates are installed in a Windows environment. Especially before using a silent installation. See Installing Security Certificates for details.

Installation

The YSoft SafeQ client installer installs the YSoft SafeQ client components: FlexiSpooler, Universal Print Driver, and Desktop Interface. It is distributed as a single executable file which runs the installation process.

  1. Language selection – Select your language for the installation. The language selected is valid only during the installation. After the installation, the client components applications use the language of your environment.

  2. Introduction – Click Next to continue.

  3. License Agreement – Read and click I Agree to continue.

  4. Depending on the result of the preinstallation check, you will see one of these:

    1. Installation readiness – Click Next to continue with the installation process.


      images/download/attachments/160481143/3a.png

    2. Requirements not fulfilled – In case of temporary issues (e.g., port blocked), it is possible to continue with the installation. In case of a blocking one (e.g., .NET framework not installed), it is necessary to remove the obstacles before continuing the installation.


      images/download/attachments/160481143/3b.png

  5. Choose install location – Select the destination folder, and click Next to continue.

  6. Controller and printer setup – Enter the data (all fields are required), and click Install to install the YSoft SafeQ client.

    • Controller host: The IP or FQDN of the server where YSoft SafeQ Spooler Controller is installed.

    • Enable spooling: When enabled, print jobs are stored locally on the machine, otherwise, the jobs are forwarded to the server.

    • Default print layout: The default printer layout selection used by the YSoft SafeQ universal driver. The available options are A4 and Letter. If the customer uses Letter size paper rather than A4 paper, set Default print layout configuration variable to 'Letter'.


      images/download/attachments/160481143/5.png

    If any mandatory information is missing, an error screen is shown. Enter the missing information and try again. When the Controller host is not entered in the expected format or the host given is not reachable, a warning is shown. It is possible to continue with the current (currently unreachable) host or to edit the value.

  7. Installing – Please wait until the installation is complete. You can display the details by clicking the Show details button.

  8. Confirmation – Click Finish to finish the installation.

After installation

  • The secure print queue Ysoft SafeQ is created (for more information, see section About drivers).

  • The installation log files are located in the YSoft SafeQ client components installation folder.

    • spooler-install.log – contains information about the YSoft SafeQ client components installation process.

  • FlexiSpooler connects to YSoft SafeQ Spooler Controller and downloads the configuration.

  • If the parameter deviceUpdate is enabled in the management interface, FlexiSpooler regularly checks direct queue settings in the management interface according to the parameter deviceUpdateIntervalMinutes a nd installs or updates direct queues. The names of the direct queues consist of names set in the devices module of the management interface: Device name(Direct_queue).

  • As it starts, FlexiSpooler service (whether after restart, during installation or update) attempts to launch Desktop Interfaces for all the logged in users, see section Automatic launching of Desktop Interfaces from FlexiSpooler service at start.

About the Drivers

YSoft Printer Driver PCL

Ysoft SafeQ secure print queue uses these drivers:

  • Windows 8, Windows 10, Windows Server 2012, and newer: YSoft Printer Driver PCL is automatically installed during FlexiSpooler installation

  • Windows 7 and Windows Server 2008: YSoft Universal Print Driver is not supported, and FlexiSpooler expects the HP Driver is already installed (HP Driver is a standard part of these systems – HP Color LaserJet 2700 Series PCL6).

Creating a Direct or Secure Print Queue Using a Vendor Driver

If you want to create print queue with vendor driver and you want print jobs to be handled and managed by YSoft SafeQ, you can but do not use ports that are automatically created by FlexiSpooler (IP_local for secure queue, SafeQPort-direct_queue_name for direct queues), but create your own TCP/IP port that is directed to IP where FlexiSpooler is installed (usually 127.0.0.1).

  • For secure printing, use protocol LPR with port 515 and queue name secure.

  • For direct printing, set correct Direct queue name up on a device in the management interface. See picture below:

images/download/attachments/160481143/image2017-4-18_13_59_44.png

Uninstallation

  1. Language selection – Select your language for the uninstallation.

  2. Confirmation – The screen shows the application path from where it will be uninstalled. Click Uninstall to continue.

  3. Uninstalling – Please wait until the uninstallation is complete. You can display the details by clicking the Show details button.

  4. Finish – In the case of the need of a restart, the options Restart now and Restart later are provided. Otherwise, click Finish to quit the installation application.

Silent uninstallation

c:\SafeQ6\FSP\uninstall.exe /S

Update

The update can be performed using the new version of the YSoft SafeQ client installer. You can use either the GUI wizard or a silent (unattended) installation.

The minimum version to the upgrade is defined by each new version (e.g., in version 6.0.0.1, upgrading from version 5.8.x.x is not supported, the minimum version is "6.0.0.1"). The FlexiSpooler version must be the same version as Spooler Controller version.

Performing a GUI Wizard Update

When running the installer, it will detect the last installed version during the preinstallation check. You can continue the update using the latest version installer. All configurations stay the same and will not be changed by the update. The update will not affect print jobs that have already been sent.

images/download/attachments/160483134/image2016-11-22_12-56-39.png

Performing a Silent (Unattended) Update

Please make sure that the current valid certificates are installed in the Windows environment before performing a silent installation/update.

  • VeriSign Universal Root Certification Authority(vsign-universal-root.cer) and Thawte Primary Root CA (thawte-root.cer) for troubleshooting trust errors (for more information see Installing Security Certificates section Troubleshooting trust errors).

  • Thawte SHA256 Code Signing CA (thawte-codesigningCA.cer)

  • Y Soft Corporation, a.s. codesigning CA (ysoft-codesigning.cer) for automated (silent) installation (for more information see Installing Security Certificates section Automated (Silent) Installation).

To run a silent installation of the client installer, run this command. Run it in the folder where you have downloaded ysq-client-install.exe

ysq-client-install.exe /S

After Updating

Installation log files are located in the YSoft SafeQ client components installation folder.

  • spooler-install.log – contains information about the YSoft SafeQ client components installation process.

As it starts, FlexiSpooler service (whether after restart, during installation or update) attempts to launch Desktop Interfaces for all the logged in users, see YSoft SafeQ FlexiSpooler Installation, section Automatic launching of Desktop Interfaces from FlexiSpooler service at start.

Silent Installation

The installer (downloaded file ysq-client-install.exe) supports the installation of a client installer from the command line interface or through a script. For running a silent installation, run this command with the filled in values of the parameters. Run it in the folder where you have downloaded ysq-client-install.exe

Examples:

FSP Client in spooling mode - The default page size for a printer queue is A4.
ysq-client-install.exe /S /CFG:controllerHost=<controller IP or hostname> /CFG:defaultPrintLayout=A4
FSP Client in spooling mode - The default page size for a printer queue is A4. DHCP Options 9 is disabled
ysq-client-install.exe /S /CFG:controllerHost=<controller IP or hostname> /CFG:defaultPrintLayout=A4 /CFG:noServerDiscovery

FSP Client in nonspooling mode - The default page size for a printer queue is A4.
ysq-client-install.exe /S /CFG:controllerHost=<FSP server IP or hostname> /CFG:noSpooling /CFG:defaultPrintLayout=A4

For a full list of possible silent installation parameters, see Silent Flexispooler installation parameters.

Automatic launching of Desktop Interfaces from FlexiSpooler service at start

As it starts, FlexiSpooler service (whether after restart, during installation or update) attempts to launch Desktop Interfaces for all the logged in users (once for each interactive session, i.e. logged in user).

  • This feature can be configured via two options (configurable from Management Service and locally overridable):

    • uiLaunchAttemptTimeoutSeconds

    • uiLaunchAttempts

  • The FlexiSpooler service detects logged in users by obtaining list of interactive sessions by enumerating all running explorer.exe processes (there is at least one running for each interactive session)

  • For each session (from which there is no Desktop Interface connected to FlexiSpooler) it conducts number of attempts to start Desktop Interface (in parallel per user), specified by uiLaunchAttempts:

    • If the Desktop Interface process is not running it launches it

    • Either way the FSP waits for a connection from Desktop Interface for the session (identified by domain\username) until timeout specified in uiLaunchAttemptTimeoutSeconds is reached

These attempts to launch Desktop Interfaces are only conducted as the service is starting (result of the whole endeavour is logged)

Impact on installation/update of FlexiSpooler

  • There is no need to restart the target workstation after FlexiSpooler is installed to start desktop interface for all users of the workstation

  • Users that log in after FlexiSpooler service is started have their Desktop Interface started based on the appropriate entry in Windows Registry

Desktop Interface can run only once per logged in user on one workstation

  • One user cannot have multiple instances of Desktop Interface running at the same time on single workstation (the second instance will shutdown as soon as it detects the previously started one).

    • This is achieved by using lock file located at <USER_PROFILE>\.safeq6\YSoftSafeQDesktopInterface.lock, which only one instance per user can acquire

    • This lock file is automatically deleted by OS after the original Desktop Interface process is terminated, a special system flag is used when this file is created to achieve this

Troubleshooting the Installation Process

If an error occurs 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 client components installation folder.

  • spooler-install.log – contains information about the YSoft SafeQ client components installation process.

  • spooler.log – contains information about the entire service running.

  • desktopinterface.log – contains information about the entire "Desktop interface" running. (e.g., billing codes window, authentication window, etc.)

If the installer failed before the installation began, check sqci-install.log located in AppData\local\Temp\ of the currently logged user.