Winscribe MSI and Automatic Script Installation 4.2 Copyright 2013, Winscribe Inc. All rights reserved. Publication Date: October 2013
Copyright 2013 Winscribe Inc. All Rights Reserved. Portions of the software described in this document Copyright Microsoft Corporation. All Rights Reserved. Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of those agreements. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means electronic or mechanical or photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Winscribe Inc. Winscribe is a registered trademark of Winscribe Inc. in New Zealand and other countries. Microsoft is a registered trademark, Windows NT and Windows is a trademark of Microsoft Corporation. Dragon NaturallySpeaking is a trademark of Nuance, Inc. and is used here under license. Other brands and their products are the trademarks or registered trademarks of their respective holder and should be noted as such. Winscribe Inc. P.O. Box 33-178 Takapuna Auckland New Zealand Email: support@winscribe.com Visit our web page: http://www.winscribe.com 2
Contents Contents Client Deployment Guidance... 4 Overview... 4 Client Installers... 4 Installer privileges... 4 Automatic Updates... 4 Command Line... 4 Examples... 4 Passing Installer Properties... 5 Configuring Client Installer Properties... 5 Configuring Features... 5 Removing Multiple Features... 5 Client Optional Features... 5 Installer Properties... 6 Server URL... 6 Install Location... 7 User Working Directory... 7 Silent Install... 7 Recording Audio Quality... 8 Logging... 8 Automatic Installer Logs... 8 Inspecting Verbose Windows Installer Logs... 9 Setting Installation Parameters... 10 Client... 10 Author/Internet Author... 12 Importer... 12 Automatic Deployment of Scripts... 14 Example Scripts for the "Logged On" Event... 15 Author/Client Grid Layout... 18 3
Winscribe MSI and Automatic Script Installation Client Deployment Guidance Overview Client Installers There are three client installers: Winscribe Author.msi Winscribe Internet Author.msi Winscribe Client.msi Installer privileges The client installers currently require administrative privileges. Automatic Updates Once the user logs in, the client will automatically check to see if a new version is available on the server. If the current user does not have administrative privileges, then the update check will be canceled, avoiding the scenario of launching the installer when the user cannot run it. The client will compare the product version of the client executable to the MSI product version number on the server. This automatic update procedure will only occur if an MSI exists in the appropriate folder. If an MSI does not exist, the update check will be canceled. If an update is found, the client application will prompt the user, asking if they want to install the available update. Command Line You can set installer parameters from the command line. Installers are run by the Windows Installer executable, called msiexec.exe. Full details on the command line arguments and options for Windows Installer are available at msdn.microsoft.com (http://msdn.microsoft.com/en-us/library/aa367988(v=vs.85).aspx) Examples Installing an MSI msiexec /i "Winscribe Client.msi" Uninstalling a product msiexec /x "Winscribe Client.msi" Silent installation You can do a silent installation that does not present any user interface or interaction by using the /quiet option. Note that the quiet option will also not show any error messages, and it is not readily clear if and when the installation has run and finished. 4
Client Deployment Guidance msiexec /quiet /i "Winscribe Client.msi" An automated installation that does not involve any user interaction but provides a progress interface is called unattended mode, using the /passive option: msiexec /passive /i "Winscribe Client.msi" If you wish to have more control over how the Windows Installer interface behaves, you can read about the /q option in the Windows Installer documentation. Passing Installer Properties You can customize installation defaults and behavior by passing in values for known properties. You pass in a property value by specifying the name (in all uppercase) and its value: msiexec /i "Winscribe Client.msi" PROPERTYNAME=Value As with command-line arguments, if an argument contains whitespace, you must enclose the value in quotation marks: msiexec /i "Winscribe Client.msi" PROPERTYNAME="Value with whitespace" Configuring Client Installer Properties Configuring Features You can configure what features to install or exclude by combining the ADDLOCAL and REMOVE properties. NOTE: If you are selecting features, always use ADDLOCAL=ALL, and then selectively specify any unwanted features by adding them to the REMOVE property. NOTE: The Author and Internet Author products only have one feature, therefore their features cannot be configured. Example The following example will install all features except for the Olympus hardware support: msiexec /i "Winscribe Client.msi" ADDLOCAL=ALL REMOVE=Olympus Removing Multiple Features If you wish to exclude multiple features, you can separate them by a comma. No spaces are allowed in the REMOVE property, and you should not enclose the value in quotation marks. Example The following example will install all features except for the VEC Hardware support, and the Open Office Document Manager: msiexec /i "Winscribe Client.msi" ADDLOCAL=ALL REMOVE=VEC,OpenOfficeDocumentManager Client Optional Features By default, the Client will install all available features. The following table lists the optional features you can configure, and the folder they are installed to (relative to the Client installation directory). 5
Winscribe MSI and Automatic Script Installation Feature Name Description Folder MobileWebServiceImporter Importer Add-In AddIns\MobileWebServiceImporter MicrosoftWordBasic OpenOfficeDocumentManager Document Manager for Microsoft Word Document Manager for Open Office AddIns\MicrosoftWordBasic AddIns\OpenOfficeDocumentManager FolderTemplateManager Template Manager AddIns\FolderTemplateManager VirtualChannelFeature Virtual Channel support (Citrix/Terminal Services) AddIns\VirtualChannel GrundigFeature Grundig hardware support AddIns\Grundig Olympus Olympus hardware support AddIns\Olympus Philips Philips hardware support AddIns\Philips VEC VEC hardware support AddIns\VEC Installer Properties The following properties can be over-ridden in several ways. When doing automatic deployment of client applications, it is recommended you pass Install Properties, using the highest-priority one available, to ensure your desired configuration is deployed correctly to all workstations. Server URL This defines the URL of the Winscribe Dictation Server. Default value: http://servername/winscribe NOTE: Because the default value is not valid, the installer will prompt for a proper value if no value was supplied by any way listed in the table below. Ways to set this value, in order of precedence (highest to lowest): Name/Location Set From Priority SERVERURL Installer Property Highest WSURL EDITA1 HKLM\Winscribe\General@WinScribeURL Installer Property Installer Property Registry HKCU\Winscribe\General@WinScribeURL Registry Lowest As an example from the table above, the SERVERURL property, if set from the command line, will set the URL regardless of what's in the registry. Example msiexec SERVERURL=http://server1/winscribe WSURL=http://server2/winscribe /i "Winscribe Client.msi" The server URL will be set to http://server1/winscribe, as SERVERURL takes precedence over WSURL. 6
Client Deployment Guidance Install Location This configures where the application is installed to. Default value: %Program Files%\Winscribe\<Product Name> Overrides, in order of precedence (highest to lowest): Name/Location Set From Priority WSINSTALLDIR Installer Property Highest INSTALLLOCATION HKLM\Software\Winscribe\<Product Name>@InstallLocation HKCU\Software\Winscribe\<Product Name>@InstallLocation Installer Property Registry Registry APPLICATIONFOLDER Installer Property Lowest Install Location troubleshooting You cannot install two or more client applications to the same folder. If you try to do so, you will receive an error notification in the installer. The error message will be similar to "<Product Name> is already installed at <Install Location>". User Working Directory This sets the location of the user working directory. Default value: %ProgramData%\Winscribe\Users Where %ProgramData% refers to the path of the All Users profile. Name/Location Set From Priority WSUSERDIR Installer Property Highest HKLM\Software\WinScribe\General@UserWorkingDirectory HKCU\Software\WinScribe\General@UserWorkingDirectory Registry Registry USERWORKINGDIRECTORY Installer Property Lowest Silent Install This property enables a "silent install". This property is generally passed when launching the installer from the Web Component installer pages. Default value: Not set Name/Location WSWEB Set From Installer Property Old behavior Previously, the property reduced the number of dialogs in the installer. 7
Winscribe MSI and Automatic Script Installation New behavior If specified in the client installers, this will simply disable the Options button in the installer that allows a user to configure the install properties. If the Server URL has not been passed to the installer and cannot be found in the registry, then the installer will fail with the error: "Silent install is not supported if the server url cannot be found". If you wish to achieve a complete silent or non-interactive install, please consult the Silent Installation section. Recording Audio Quality You can set the audio quality for recording by setting this property. Default value: medium Available values: low, medium, high Name/Location Set From Priority WSAUDIOQUAL Installer Property Highest HKLM\Software\WinScribe\General@VirtualChannelAudioQuality Registry HKCU\Software\WinScribe\General@VirtualChannelAudioQuality Registry Lowest Logging You can generate a log of the installation process by passing the /l argument and a path and filename to the log file you wish to produce. The /l*v argument is recommended. The wildcard specifies all logging options except for verbose and extra debugging messages. Adding the v to the wildcard also includes the verbose logging. Example Create a log of the Winscribe Client installation, called "C:\Client.log": msiexec /l*v C:\Client.log /i "Winscribe Client.msi" Automatic Installer Logs For cases where you are not manually running Windows Installer from the command line, you can set a registry setting to ensure Windows Installer creates a log whenever it runs. Each time Windows Installer runs, it will create a log in the %TEMP% directory with a name in the format MSI<random>.log, where <random> is a random combination of letters and numbers. 1. Create a HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Windows\Installer registry key if it doesn't exist. 2. Create a Logging String value if it doesn't exist. 3. Set the Logging value to the logging levels you wish e.g. voicewarmup for all verbose logging values, except for extra debugging information. More information is available at: How to enable Windows Installer logging at support.microsoft.com 8
Client Deployment Guidance Inspecting Verbose Windows Installer Logs Windows Installer logs require a good understanding of Windows Installer to be interpreted fully, but helpful information can still be found for someone troubleshooting an installation. Windows Installer logs are in plain text and can be read in any text editor. Windows Installer Verbose Log Analyzer This utility is available in the Windows SDK, called WiLogUtl.exe. Documentation is available at http://msdn.microsoft.com/en-us/library/aa372811(v=vs.85).aspx You can browse to select a Windows Installer log: Clicking Analyze gives you additional information, and allows you to easily browse any errors found in the log file, with possible solutions. The analyzer can also generate a colorized HTML version of the log that can be more easily read and browsed than the plain text log. 9
Winscribe MSI and Automatic Script Installation Setting Installation Parameters If required, you can set the installation parameters for Winscribe client applications using a command line argument. This prevents the user performing the installation from having to manually enter the parameters. Note: Parameters are case sensitive. Example At the command prompt or in the Run box, type in the following command, replacing the file paths with those appropriate to your system: msiexec /quiet /i "C:\Winscribe\Winscribe Client.msi" SERVERURL="http://webserver/Winscribe" INSTALLLOCATION="c:\Program Files\Winscribe" USERWORKINGDIRECTORY="c:\Winscribe\Users" The breakdown of this command is as follows: msiexec /quiet The Windows installer executable that executes msi files. This performs a silent install without any user prompting /i <msi name and path> Installs the msi file specified after the /i SERVERURL INSTALLLOCATION USERWORKINGDIRECTORY Winscribe URL replace with the path to your Winscribe URL Install Directory replace with the path to your installation directory User Directory replace with the path to your Winscribe user directory Note: Winscribe Client has additional options that allow you to define which features and device support are installed. Troubleshooting the Installer: You can create a verbose log by passing the /l*v argument to msiexec: msiexec /i "Winscribe Client.msi" /l*v C:\WinscribeClient.Install.log Client Admin & Web Components Properties These properties can be set from the msiexec command-line, or passed to the msi using the Web Components installer. Property Name Description Example SERVERURL The WinScribe server URL http://servername/winscribe INSTALLLOCATION The place where WinScribe will be installed C:\WinScribe USERWORKINGDIRECTORY Place for the user working directories C:\WinScribe\Users 10
Setting Installation Parameters Example Example of setting these properties from the command line: msiexec /i "WinScribe Client.msi" SERVERURL=http://devserver40/winscribe INSTALLLOCATION=C:\WinScribe USERWORKINGDIRECTORY=C:\WinScribe\Users Specifying features to install on the command-line for unattended installs To do a silent install, you can use the /quiet msiexec option, which will install silently. You can alternatively use /passive, which will also be an unattended install but will show a progress UI when installing. You can specify which features of the product to install on the commandline: msiexec /i "WinScribe Client.msi" ADDLOCAL=[Feature1,Feature2,Feature3] <additional options> You can specify one or more features to install, separated by commas. Currently available features: Id Title Description Notes ProductFeature WinScribe Client The WinScribe Client Base product (required) VirtualChannelFeature Terminal Services and Citrix Server Support Supports hardware devices and audio file import when installing onto a Windows Terminal Services or Citrix server. DevicesFeature Hardware Devices Installs support for foot pedals from various manufacturers GrundigFeature Grundig Foot Pedals Supports Grundig foot pedals Olympus Olympus Foot Pedals Supports Olympus foot pedals Philips VEC Philips SpeechMikes and Foot Pedals Infinity / VEC / WinScribe Foot Pedal Supports Philips foot pedals & SpeechMike devices Supports the WinScribe foot pedal made by Infinity/VEC Installs all device support. You can also specifically install certain devices by specifying the nested features below. Developers: The list of features are in the Product.wxs file in the WinScribe.Client.Setup project, defined by <Feature> elements. They can be nested. Examples Silently install the base product, and virtual channel support, for the server in a Citrix or Terminal Services environment: msiexec /i "WinScribe Client.msi" ADDLOCAL=ProductFeature,VirtualChannelFeature /quiet Unattended install of the product, showing install progress UI, with support just for Philips devices: msiexec /i "WinScribe Client.msi" ADDLOCAL=ProductFeature,PhilipsFeature /passive Silently install the base product, with support for all hardware devices: 11
Winscribe MSI and Automatic Script Installation msiexec /i "WinScribe Client.msi" ADDLOCAL=ProductFeature,DevicesFeature /quiet Silently install the base product, with no hardware support: msiexec /i "WinScribe Client.msi" ADDLOCAL=ProductFeature /quiet Author/Internet Author WSINSTALLDIR: The directory the application is installed to, for example, C:\Program Files\Winscribe WSUSERDIR: The location of the user working folder. This is set in HKLM. For example, C:\Winscribe\Users WSURL: The URL location of the web components server. This is set in HKLM (Note that if there a current value in HKCU that will remain unchanged and will take priority over the one in HKLM). For example, http://mywebserver/winscribe WSAUDIOQUAL: This sets the audio quality for recording. Importer INSTALLLOCATION: Valid options are: medium, low, high The directory the application is installed to, for example, C:\importer WSAPPTYPE: Decides if the importer is installed as a service or an application. WinApp Installing Silently Valid options are: WinService, All MSIs have the ability to be installed silently, without any user interface or interaction. MSIs are usually either wrapped inside an exe, or deployed openly (as is the case with Winscribe apps). When you have a raw MSI file it needs to be executed with msiexec.exe. Msiexec has several parameters, but the one we are interested in is the silent install which is what we talk about here. The basic format is: msiexec /Option <Required Parameter> [Optional Parameter] The option to make it a silent install is: /quiet or /q[n b r f] Quiet mode, no user interaction Sets user interface level n - No UI b - Basic UI r - Reduced UI f - Full UI (default) (/qn is the same as /quiet) The next parameter to set is to tell it to install: 12
Setting Installation Parameters /package or /i <Product.msi> Installs or configures a product, for example: /i "C:\winscribe\my installer.msi" Finally, you can set any required installation parameters, for example: WSAPPTYPE=WinService Example The following is an example of a complete, silent install line for installing the Winscribe Importer as a service: Msiexec.exe /qn /i "C:\installers\Winscribe Importer.msi" INSTALLLOCATION="C:\Program Files\Winscribe\Importer" WSAPPTYPE=WinService Note: When installing silently, make sure you have read/write permissions to and from where you are installing. A silent install is literally silent and does not give you a message advising whether the installation has failed or completed successfully. 13
Winscribe MSI and Automatic Script Installation Automatic Deployment of Scripts If scripts are placed in the Upgrades folder of the Winscribe Server, the scripts are automatically downloaded to the PCs of authors and typists when they log on. This feature allows any new authors or typists to inherit Options permissions in the same way they inherit hardware settings. When a new author or typist logs on, their Options permissions will be created based on the last logged on author or typist. This is the same way that the hardware settings are set for new users. If they are the first user to log on to the PC, then the Winscribe default options will apply. When an existing author or typist logs on, a "Logged On" event script can run that writes to the Options settings in the registry of the user. These Options registry settings are then loaded immediately and are applied to that user's session. The scripts override any current user's Options settings. No other registry setting changes will be applied. Downloaded scripts will be applied immediately during the current user session and the "Logged On" event will be run again for each script that is downloaded. This could result in the "Logged On" event running several times for a user. New Authors For new Authors only, the scripts placed in the Upgrades folder can be named the following: Script Name AuthorScriptsFacility.xml AuthorScriptsDeptXX.xml AuthorScriptsAuthorXX.xml Description Will apply to all new Authors in this Facility XX is the Dept ID that this script will apply to, e.g. AuthorScriptsDept1.xml will apply to all new Department 1 Authors only and will override the AuthorScriptsFacility.xml script. XX is the Author Id that this script will apply to, e.g. AuthorScriptsAuthor1000.xml will apply only to Author 1000 and will override the AuthorScriptsDeptXX.xml script. Current Authors For current Authors only (which will overwrite any scripts currently using), the scripts placed in the Upgrades folder can be named the following: Script Name AuthorScriptsOverwriteFacility.xml Description Will apply to all Authors in this Facility. Note: Each facility has its own Upgrades folder. The script file must be added to the Upgrades folder for each facility you want it to apply to. AuthorScriptsOverwriteDeptXX.xml AuthorScriptsOverwriteAuthorXX.xml XX is the Dept ID that this script will apply to, e.g. AuthorScriptsOverwriteDept1.xml will apply to all Department 1 Authors only and will override the AuthorScriptsOverwriteFacility.xml script. XX is the Author Id that this script will apply to, e.g. AuthorScriptsOverwriteAuthor1000.xml will apply only to Author 1000 and will override the AuthorScriptsOverwriteDeptXX.xml script. Typist Scripts These same script names can be used for the Typist (change the Author part to Typist) as well. 14
Automatic Deployment of Scripts Note: These scripts are applied such that the Author (or Typist) script overrides the department script and the department script overrides the facility script. Example Scripts for the "Logged On" Event The following example "Logged On" event scripts are used to set the Options permissions for authors or typists. 15
Winscribe MSI and Automatic Script Installation Example Author Script: const HKEY_LOCAL_MACHINE = &H80000002 const HKEY_CURRENT_USER = &H80000001 Sub main() strcomputer = "." Set oreg=getobject("winmgmts:{impersonationlevel=impersonate}!\\" & strcomputer & "\root\default:stdregprov") strkeypath = "Software\Winscribe\Users\" & Right("000000" & objauthor.userid, 6) strvaluename = "AskForDepartment" strvaluename = "AskForJobtype" strvaluename = "AutostartNewJob" strvaluename = "ConfirmEndJobCommands" strvaluename = "JobRecordsAutoRefresh" strvaluename = "JobRecordsDownloadDays" strvalue = "7" strvaluename = "JobRecordsRefreshInterval" strvalue = "15" strvaluename = "ReuseKeyfield" strvaluename = "WindowsAlwaysOnTop" strvalue = "True" end sub Example Typist Script: const HKEY_LOCAL_MACHINE = &H80000002 const HKEY_CURRENT_USER = &H80000001 Sub main() strcomputer = "." Set oreg=getobject("winmgmts:{impersonationlevel=impersonate}!\\" & strcomputer & "\root\default:stdregprov") strkeypath = "Software\Winscribe\Users\" & Right("000000" & objtypist.userid, 6) strvaluename = "ConfirmEndJobCommands" strvaluename = "SyncSRText" strvaluename = "AutoRefresh" 16
Automatic Deployment of Scripts end sub strvaluename = "NewWorkNotification" strvaluename = "RefreshInterval" strvalue = "60" 17
Winscribe MSI and Automatic Script Installation Author/Client Grid Layout Adminstrators may push out grid-layout definition files that order the columns displayed in Winscribe Author and in Winscribe Client. To make changes, the administrator: 1. Custom-creates a desired layout in Author or Client 1, on his or her machine. 2. Looks in their profile folder, in the user working directory, for the file: GridLayout.xml 3. Copies this file to the Upgrades folder on the server, changing the filename to one in the following tables, depending on the application and the desired action. 4. When authors/typists next log on to the server, the xml file (if it is applicable to them) will be downloaded to their machine and their application grid layout updated. Making changes to Client grid layouts: New Typists For new Typists only, the GridLayout.xml placed in the Upgrades folder can be named the following: Script Name TypistGridLayoutFacility.xml TypistGridLayoutTypistXX.xml Description Will be copied to the user's working directory as TypistGridLayout.xml and will apply to all Typists in this Facility. Will be copied to the user's working directory as TypistGridLayoutAuthorXX.xml where the XX is the Typist Id that this grid layout will apply to, e.g. TypistGridLayoutAuthor1000.xml will apply only to Typist 1000 and will override the TypistGridLayoutDeptXX.xml grid layout. Current Typists For current Typists only (which will overwrite any grid layouts they are currently using), the grid layouts placed in the Upgrades folder can be named the following: Script Name TypistGridLayoutOverwriteFacility.xml Description Will be copied to the user's working directory as TypistGridLayoutOverwrite.xml and will apply to all Typists in this Facility. Note: Each facility has its own Upgrades folder. The grid layout file must be added to the Upgrades folder for each facility you want it to apply to. TypistGridLayoutOverwriteTypistXX.xm l Will be copied to the user's working directory as TypistGridLayoutOverwriteTypistXX.xml, where the XX is the Typist Id that this grid layout will apply to, e.g. TypistGridLayoutOverwriteTypist3000.xml will apply only to Typist 3000 and will override the TypistGridLayoutOverwriteDeptXX.xml grid layout. Making changes to Author grid layouts: New Authors For new Authors only, the grid layouts placed in the Upgrades folder can be named the following: Script Name AuthorGridLayoutFacility.xml Description Will apply to all new Authors in this Facility 18
Author/Client Grid Layout AuthorGridLayoutDeptXX.xml AuthorGridLayoutAuthorXX.xml XX is the Dept ID that this grid layout will apply to, e.g. AuthorGridLayoutDept1.xml will apply to all new Department 1 Authors only and will override the AuthorGridLayoutFacility.xml grid layout. XX is the Author Id that this grid layout will apply to, e.g. AuthorGridLayoutAuthor1000.xml will apply only to Author 1000 and will override the AuthorGridLayoutDeptXX.xml grid layout. Current Authors For current Authors only (which will overwrite any grid layouts they are currently using), the grid layouts placed in the Upgrades folder can be named the following: Script Name Description AuthorGridLayoutOverwriteFacility.xml Will apply to all Authors in this Facility. Note: Each facility has its own Upgrades folder. The grid layout file must be added to the Upgrades folder for each facility you want it to apply to. AuthorGridLayoutOverwriteDeptXX.xm l AuthorGridLayoutOverwriteAuthorXX.x ml XX is the Dept ID that this grid layout will apply to, e.g. AuthorGridLayoutOverwriteDept1.xml will apply to all Department 1 Authors only and will override the AuthorGridLayoutOverwriteFacility.xml grid layout. XX is the Author Id that this grid layout will apply to, e.g. AuthorGridLayoutOverwriteAuthor1000.xml will apply only to Author 1000 and will override the AuthorGridLayoutOverwriteDeptXX.xml grid layout. 19