Preconfiguration and unattended installation of ThinPrint Client

Preconfiguration and unattended
installation of ThinPrint Client Windows
ThinPrint versions 9.0 and 10
Technical Information
ThinPrint GmbH
Alt-Moabit 91 a
10559 Berlin
Germany / Alemania
Cortado, Inc.
7600 Grandview Avenue
Suite 200
Denver, Colorado 80002
USA / EEUU
Cortado Pty. Ltd.
Level 20, The Zenith Centre,
Tower A
821 Pacific Highway
Chatswood, NSW 2067
Australia
E-Mail: [email protected]
Web: www.thinprint.com
Issued: April 9, 2015 (v51)
Notes
© Copyright
This document is the intellectual property of ThinPrint GmbH. This document may be copied in whole or
in part, provided this Copyright notice is included in every copy.
® Registered trade marks
All hardware and software names mentioned in this document are the registered trademarks of their
respective companies or should be regarded as such.
Safety warning
All ThinPrint products are pure software solutions. Please note the safety warnings in the technical documentation from your hardware vendor and from the manufacturer of each device and component.
Before beginning installation, we recommend closing all windows and applications and deactivating any
virus scanner.
© ThinPrint GmbH 2015
2
Technical information
Contents
Foreword ...................................................................................................................... 4
Why preconfiguration? .................................................................................................... 4
Unpacking the .msi File .................................................................................................. 4
Process ......................................................................................................................... 5
Preparing to install ......................................................................................................... 5
Unattended installation without preconfiguration
....................................... 5
Alternative 1: Setup.exe .................................................................................................. 5
Alternative 2: .msi file ..................................................................................................... 6
Examples with parameters ............................................................................................... 6
Naming an installation directory ..................................................................................
Installation of a certain language version ......................................................................
Installation with path to Citrix ICA Client for the ICA type of ThinPrint Client Windows .......
Installation of ThinPrint Client Service Windows ............................................................
Unattended installation with preconfiguration
6
7
7
7
............................................. 8
Creating a transformation file ........................................................................................... 8
Parameters .................................................................................................................. 11
Parameters of ThinPrint Clients Windows’s installer ..................................................... 11
Parameters for setting registry entries of ThinPrint Client Windows ................................ 12
Additional parameters/registry entries of ThinPrint Client Windows ................................ 13
Rolling out the preconfigured client ................................................................................. 14
Appendix .................................................................................................................... 15
Customer service and technical support .......................................................................... 15
Uninstalling ThinPrint Client .......................................................................................... 15
Attended uninstallation ............................................................................................. 15
Unattended uninstallation ......................................................................................... 15
© ThinPrint GmbH 2015
Additional sources ........................................................................................................ 15
Technical information
3
Foreword
Foreword
ThinPrint is a software solution for comfortable print management. It comprises two
main components: the server component ThinPrint Engine and the client component
ThinPrint Client; both will be installed with setup routines. To simplify installation in
large networks, ThinPrint also allows the unattended installation and therefore easy
distribution of both components.
This technical information describes two possibilities of unattended installation of
ThinPrint Client under Windows: with and without preconfiguration. You can also
make unattended changes to the configuration later on.
When you install the ThinPrint Client without preconfiguration (Page 5), the
default settings will be used for the ThinPrint Clients (see Page 11 as well as the
“ThinPrint Client Windows” manual). If you decide to install with preconfiguration, a
Windows Installer transformation is necessary (Page 8). Transformation files can be
used to perform an unattended installation of the ThinPrint Client with a .msi file
including pre-settings. Transformation files end with the file extension .mst.
Why preconfiguration?
The objective of unattended installation is to roll out and to use ThinPrint Client
immediately without user interaction. In most cases, the default settings are sufficient: The print data of ThinPrint Engine will be decompressed by ThinPrint Client.
The client printers will be created or mapped into a terminal or a virtual desktop session, while default printer will be retained.
If these settings are not sufficient, a preconfiguration can make sense – instead of
local or remote configuration of each ThinPrint Client. A couple of ThinPrint Client
parameters can be set with its installation using the .msi file. For all further settings,
one should use a tool for generating .mst files. This tool is able to preconfigure all of
the ThinPrint Client settings – you can even set further values in the Windows Registry which are not changeable with ThinPrint Client Manager user interface.
Preconfiguration can also be useful when Connection Service shall be used,
because specific settings on ThinPrint Client are necessary. Or if you want to print
with encryption (SSL/TLS), the name of the imported client certificate can be set
here. More information can be found in the section Unattended installation with preconfiguration (Page 8).
Unpacking the .msi File
ThinPrint offers a Setup.exe file for the installation of ThinPrint Client Windows. The
file can be downloaded at www.thinprint.com→ RESOURCES & SUPPORT→ SOFTWARE→ THINPRINT CLIENTS & TOOLS. The unattended installation can be performed
using the Setup.exe or using the .msi installer. To extract the .msi file copy the
Setup.exe to a local directory and run the following command in this directory:
Version 10 of ThinPrint Client Windows can be installed on Windows machines running from Windows XP/2003 with Service Pack 2 or Service Pack 3 (for XP x86) and
Microsoft XML Paper Specification Essentials Pack (XPSEP). Version 9.0 can be used
4
Technical information
silent_e.fm
© ThinPrint GmbH 2015
setup.exe /a
Unattended installation without preconfiguration
on Windows Vista machines. For older Windows versions the ThinPrint Client version
7.0 can be used; for unattended installation of this version a different technical information is available.
Process
ThinPrint Client Windows can be installed with or without preconfiguration. The settings can also be changed later on unattended.
Installation without preconfiguration
If you want to run an installation of ThinPrint Client Windows without preconfiguration, simply copy the relevant .msi installation file (see above) to the client machines
and start unattended installation from the command prompt or with a batch file.
Therefore, you can use different Windows or ThinPrint parameters (see Page 6).
Installation with
preconfiguration
If you want to run an installation of ThinPrint Client Windows with preconfiguration,
the process is as follows:
1. Creation of a Windows Installer transformation file (with the file extension .mst)
using an appropriate tool (including saving the selected installation options in
the transformation file).
2. Software distribution/installation
Copying the .msi, the .mst, and the .bat files (if desired) to the client machines
and starting unattended installation.
Preparing to install
For installation of ThinPrint Client Windows, you need the .msi installation file (see
above) in a local directory. Administrator permissions are required.
If the ICA type of ThinPrint Client Windows shall be installed you should know the
path to the Citrix ICA client on the target machines.
Installation of a preconfigured file requires uninstallation of all (old or recent) ThinPrint Clients on client machines. This can also be done unattended, as described on
Page 15. The values of ThinPrint Client in the Windows Registry will not be deleted.
A list of Registry values can be found in the client manual.
Unattended installation without preconfiguration
© ThinPrint GmbH 2015
Unattended installation without preconfiguration means that ThinPrint Client Windows will be rolled out to client machines with default settings. An appropriate
administration tool is used for distributing ThinPrint Client through the network,
e.g. Microsoft System Center Configuration Manager.
Alternative 1: Setup.exe
1. Copy the ThinPrint Client Windows installation software Setup.exe to a directory of the target computer.
silent_e.fm
Technical information
5
Unattended installation without preconfiguration
2. Run the Command Prompt, and change to the directory the Setup.exe has been
copied to.
3. Start the unattended installation e.g. with the following command:
Setup.exe /s /v"/qb"
Example:
Setup.exe /s /v"/qb adminonly=1 certname=\"ThinPrint
GmbH\" addlocal=TCPAPP"
After /v always a quotation mark (") follows. If a parameter necessitate another quotation mark (here for certname) then a backslash (\) is necessary before it (here:
\"ThinPrint GmbH\"). A parameter description can be found on Page 11.
Alternative 2: .msi file
1. Copy the unpacked .msi file including its subdirectories (see above) to a directory on the target computer.
Note! As an alternative to copying the ThinPrint installation files to the clients,
you can also leave them on the server and map the relevant drives on the clients.
2. Start the ThinPrint Client installation routine with:
<system directory>\msiexec /qb /i <path to .msi file>
Example:
c:\Windows\System32\msiexec /qb /i "c:\install\ThinPrint Client Windows 10.msi"
Examples with parameters
In contrast to unattended installation with preconfiguration, here you can use specific
parameters in the command line call-up of the ThinPrint Clients. The following shows
the use of both Windows Installer parameters and ThinPrint parameters.
The parameters you can use with both Setup.exe (parameter /v) and .msi file
installation.
Windows Installer
parameters
Naming an installation directory
<system directory>\msiexec /qb /i <path to .msi file> INSTALLDIR=<installation path>
6
Technical information
silent_e.fm
© ThinPrint GmbH 2015
If you want to name an installation directory for the unattended installation of
ThinPrint Client Windows, start the ThinPrint Client installation routine with:
Unattended installation without preconfiguration
Example:
c:\Windows\System32\msiexec /qb /i "c:\install\ThinPrint Client Windows 10.msi" INSTALLDIR="C:\Program
Files\ThinPrint Client"
Further parameters can be found on Page 11.
ThinPrint parameters
Installation of a certain language version
To install ThinPrint Clients Windows in a certain language start the installation routine with:
<system directory>\msiexec /qb /i <path to .msi file> LANG=<language>
Example:
c:\Windows\System32\msiexec /qb /i "c:\install\ThinPrint Client Windows 10.msi" LANG="esn"
Further parameters can be found on Page 11.
Installation with path to Citrix ICA Client for the ICA type of ThinPrint Client Windows
If multiple Citrix ICA Clients are installed on the target computer (e.g. general or web
client) or if problems occur during automatic path detection, you can run unattended
installation for the ICA type of ThinPrint Client Windows with input of the path to the
desired Citrix ICA Client. Start the installation routine with:
<system directory>\msiexec /qb /i <path to .msi file> ADDLOCAL="ICA" CITRIXCLIENTDIR=<path to citrix ica client>
Example:
c:\Windows\System32\msiexec /qb /i "c:\install\ThinPrint Client Windows 10.msi" ADDLOCAL="ICA" CITRIXCLIENTDIR="C:\Program Files\Citrix\ICA Client"
Further parameters can be found on Page 11.
Installation of ThinPrint Client Service Windows
Under certain conditions the installation of ThinPrint Client as a Windows service
require input of a user (with administrator permissions) and password. This information can be entered at the start of the unattended installation as follows:
© ThinPrint GmbH 2015
<system directory>\msiexec /qb /i <path to .msi file> ADDLOCAL="TCPSRV" SRVUSER=<user name> SRVPASS=<password>
Example:
c:\Windows\System32\msiexec /qb /i “c:\install\ThinPrint Client Windows 10.msi” ADDLOCAL="TCPSRV"
SRVUSER="admin" SRVPASS="xxxx"
silent_e.fm
Technical information
7
Unattended installation with preconfiguration
If the account (SRVUSER + SRVPASS) has been omitted the NETWORK SERVICE account
will be used. To specify more ThinPrint specific preconfigurations, we recommend
use of a transformation file (see Page 8). Further parameters can be found on
Page 11.
Unattended installation with preconfiguration
An appropriate tool (e.g. Orca or InstEd) lets you create a sample configuration for a
selected ThinPrint Client Windows type as a Windows Installer transformation (.mst)
file. The tool’s user interface offers you the option of making several configuration settings for ThinPrint Client Windows and these settings may be saved to an .mst file.
By installing the selected .msi file using this .mst file, you can install a preconfigured
ThinPrint Client Windows on the target computers – attended or unattended.
Creating a transformation file
Create an .mst file for the ThinPrint Engine’s .msi file. To do so, use a (free) transformation tool – e.g. Orca (from Microsoft) or InstEd (www.instedit.com). Here is an
example for InstEd:
1. Run InstEd.
2. Select FILE→ OPEN, mark the installation software of ThinPrint Client (here:
ThinPrint Client Windows 9.0.msi), and click OPEN to confirm. The window in
Illus. 1 will appear.
Illus. 1
8
InstEd: Adding a transform file
Technical information
© ThinPrint GmbH 2015
Illus. 1
silent_e.fm
Unattended installation with preconfiguration
3. Select TRANSFORM→ NEW TRANSFORM, and enter a file name for the .mst (transform) file (Illus. 2). The names of .mst and of .msi file should match.
Illus. 2
Illus. 2
InstEd: Entering a file name for the transform file
4. Under PROPERTY (left in Illus. 3) select ADD ROW in the context menu for each
parameter (right in Illus. 3). In each case enter a parameter’s name (Page 11)
as well as its value (Illus. 4).
Illus. 3
InstEd: Adding a parameter
© ThinPrint GmbH 2015
Illus. 3
silent_e.fm
Technical information
9
Unattended installation with preconfiguration
Illus. 4
Illus. 4
InstEd: Entering a parameter’s name and value (example)
5. In this way add all required parameters (see Page 11). The result is shown in
Illus. 5.
Illus. 5
Illus. 5
InstEd: Parameters configured (example for ThinPrint Client Service Windows)
6. Save the .mst file. Afterwards you can distribute the .msi file of ThinPrint Client
together with its .mst file to the target computers.
10
Technical information
silent_e.fm
© ThinPrint GmbH 2015
Note! There are many possibilities for software distributing, for example from
the command prompt, using a batch file, the Active Directory (see Microsoft
knowledge-base article 302430), or third-party solutions as ASDIS or Microsoft System Center Configuration Manager.
Unattended installation with preconfiguration
Parameters
Parameters of ThinPrint Clients Windows’s installer
Description
/s
Doesn’t show the initial dialog
/v
Setup.exe: All following characters will be assigned as
parameters to MsiExec.exe (see below).
INSTALLDIR
ThinPrint Client installation directory
ADDLOCAL
ThinPrint Client types
RDP
default
ICA
TCPAPP TCP/IP as an application
TCPSRV TCP/IP as a Windows service
SRVUSER
Administrator account for ADDLOCAL = TCPSRV
SRVPASS
Administrator password for ADDLOCAL = TCPSRV
CITRIXCLIENTDIR
Full path of Citrix ICA Client installation
for ADDLOCAL = ICA
LANG
ThinPrint Client language versions
enu
English (default)
deu
German
fra
French
esn
Spanish
LANG has priority over /L.
/L
Setup.exe: Language ID
1031 = German (Germany)
1033 = English (United States, default)
1036 = French
3082 = Spanish
FORCELANG
1 = hkey_local_machine\software\ThinPrint\Lang will be
overridden with LANG property value.
/a
Setup.exe: Extracting the .msi file
© ThinPrint GmbH 2015
Parameter
silent_e.fm
Technical information
11
Unattended installation with preconfiguration
Parameters for setting registry entries of ThinPrint Client Windows
The installer can create the following registry entries parametrically in:
hkey_local_machine\software\ThinPrint\client
Parameter
(= Reg-value)
Menu item
in ThinPrint Client
AdminOnly
ADMINISTRATORS
ONLY
Restricts client configuration to administrators only
Bandwidth
BANDWIDTH
Client-side bandwidth setting (bit/s or
bps)
ConnMode
USE CONNECTION
SERVICE
0 = Receiving print jobs without Connection Service (Listen Mode)
3 = Using Connection Service
1 = both modes at the same time
(0 + 3)
ConnPort
TCP PORT
(CONNECTION SERVICE)
TCP port for communication with the
Connection Service; be sure: same TCP
port number as Connection Service’s
“ClientPort”
ConnServer
CONNECTION SERVER
IP address of the computer on which
Connection Service is running
ADDRESS
ConnWait
CONNECTION RETRY
INTERVAL
Wait time for connection retries if Connection Service is not reachable (in seconds)
DefaultState
DEFAULT AT SERVER
AutoConnect defines current printer as
default printer at server
DefPrintState
RELOAD (printers)
New printers in ThinPrint Client are
checked immediately
Port
TCP PORT
(ADVANCED)
TCP-Port for communication with the
ThinPrint Engine; must be the same as
ThinPrint Engine “port” with a normal
ThinPrint port
Send
Properties
ENABLE SENDING
AutoConnect option for sending printer
properties
UseWDefault
INHERIT CLIENT’S
PROPERTIES
DEFAULT PRINTER
—
Technical information
Set to use local Windows default printer
as CURRENT PRINTER
Observes the printer folder and
refreshes printers in ThinPrint Client
immediately. Enabling/disabling
depends on “Enable sending properties”.
silent_e.fm
© ThinPrint GmbH 2015
WatchPrinters
12
Description
Unattended installation with preconfiguration
Additional parameters/registry entries of ThinPrint Client Windows
The installer can also create the following registry entries parametrically in:
hkey_local_machine\software\ThinPrint\client
© ThinPrint GmbH 2015
MsiExec.exe
silent_e.fm
Parameter
(= Reg-value)
Description
CertName
Name of the imported SSL/TLS certificate; Page 5
CertStore
0 = use the user’s certificate store
1 = use the computer’s certificate store
Note: Permissions has to be assigned to the certificate (see the
technical information “Creating SSL certificates for printing with
ThinPrint”).
HKCU
1= ThinPrint Client configuration is user specific saved under:
hkey_current_user\software\thinprint\client
NewID
Specifies the starting value for printer ID assignment
PreviewPrinter
Specifies whether a preview should be displayed on the client
computer when using ThinPrint Output Gateway,
RmtConf
IP address of the administration machine from which the ThinPrint Client remote configuration is allowed (it is possible to
enter more than one address)
SetIDList
Specifies whether changes in the ThinPrint Client (new printers,
classes, etc.) should be applied when client is restarted
1 = changes are applied (printer list is updated)
0 = changes are reset
Note: The „Reload printers“ function has a higher priority than
these settings.
StartDelay
Specifies whether and how long (in seconds) ThinPrint Client
startup should be delayed after user login (applies only to ThinPrint Client Windows TCP/IP)
Extract of parameters for MsiExec.exe:
Parameter
Description
/i
Installation
/x
Uninstallation
/qn
Silent installation (q), no user interface (n)
/qb
Silent installation (q), basic user interface (b)
Technical information
13
Unattended installation with preconfiguration
See also the Windows Installer Command-Line options at:
http://msdn.microsoft.com/en-us/library/aa367988(VS.85).aspx
or
http://technet.microsoft.com/en-us/library/cc759262%28v=WS.10%29.aspx
Rolling out the preconfigured client
The transformation tool has now created a Windows Installer transformation file
(.mst file). The file is found in the same directory as the .msi file. To roll out the configured ThinPrint Clients, you will need both .msi file and .mst file – and a batch file,
if desired.
There are many possibilities for software distributing, for example from the command prompt, using a batch file, the Active Directory (see Microsoft knowledge-base
article 302430), or third-party solutions as ASDIS or Microsoft System Center Configuration Manager.
When installing the .msi file via the command prompt you can also specify the
.mst file:
<system directory>\msiexec /qb /i <path to .msi file> TRANSFORMS=@<name .mst file>
Example:
c:\Windows\System32\msiexec /qb /i "c:\install\ThinPrint Client Windows 10.msi" TRANSFORMS=@"ThinPrint
Client Windows 10.mst"
© ThinPrint GmbH 2015
14
Technical information
silent_e.fm
Appendix
Appendix
Customer service and technical support
Customer Service
www.thinprint.com/→ RESOURCES & SUPPORT
www.thinprint.com/en-us/resourcessupport/supportrequest.aspx
Uninstalling ThinPrint Client
Attended uninstallation
– Select CONTROL PANELPROGRAMS AND FEATURES, then select THINPRINT CLIENT
WINDOWS and click UNINSTALL (Illus. 6).
Illus. 6
Illus. 6
Removing ThinPrint Client Windows (Example)
Unattended uninstallation
An unattended uninstallation can also be performed for the ThinPrint Client. Enter
the following in the command line:
<system directory>\msiexec /qb /x <path to .msi file>
Example:
c:\Windows\System32\msiexec /qb /x "c:\install\ThinPrint Client Windows 10.msi"
Additional sources
© ThinPrint GmbH 2015
Further information about ThinPrint can be downloaded from our website. The following manuals and technical information are – amongst other – available at
www.thinprint.com/manuals:
• ThinPrint Client Windows
• ThinPrint Engine for print servers
• ThinPrint Engine for terminal servers
silent_e.fm
Technical information
15
Appendix
•
•
•
•
•
ThinPrint RDP Engine
ThinPrint Desktop Engine
Connection Service
Management Center
Creating SSL certificates for printing with ThinPrint
© ThinPrint GmbH 2015
16
Technical information
silent_e.fm