Transcription

1 What: Last Modified: LS_HSI.msi Partner Installation Requirements 4/25/ :57:00 AM Forward: This document applies to LightScribe 1.6 and newer. We have seen some examples recently of updates provide to end users that did not provide a silent install experience. The LightScribe software installer is designed as a silent installer. Please assure that all installs, both original installs and updates provided to end users, use the command line switches described below to affect a silent install. In order to have a silent install of LightScribe (LS_HSI.msi), you must follow these guidelines. Since the LS_HSI.msi installer will be used by a number of partners, we have provided a simple API that all partners can use. This API consists of setting command-line properties to pass information to the windows installer. We have also seen some updates that don t set the TRANSFORMS property called out below. This will result in the user getting English strings in the start menu and autoplay dialogs even if they have a localized install for all other content. Please be sure to set the TRANSFORMS property in all updates that are delivered to users. New Features: The command line property SOURCELIST is no longer required. The LightScribe System Software installer now supports a number of languages in addition to English. You will need to supply an additional property on the command line to tell the installer in what language the start menu program group labels should be installed. The property is named TRANSFORMS and the possible values it can take are listed at the end of this document. Please read this document carefully to assure you affect a correct installation of the LightScribe System Software (refered to in the remainder of this document as LSS). It is important that you use the TRANSFORMS file that matches the system language of the target system. Use the list below to determine this. The Primary Language should be used (e.g. any sublanguage of Spanish will use the Spanish transforms file) How To: There are two properties that must be supplied on the command line for a successful install. They are UPDATE_SHELL_COMMAND and TRANSFORMS. If the last property is missing the labels in the start menu program group will be in English even though the delivered content (e.g. the Getting Started page) will be in the language of the target system. There are three properties that are optional and control the creation of the Getting Started items. The Getting Started items include a LightScribe desktop icon, launch target of this desktop icon and a LightScribe start menu program group. By default, the desktop icon and start menu group are created on a new install or an update if the end customer or integrator has not removed them, or not installed by the following properties. To opt-out of creating the desktop icon with a new install set SHOW_DESKTOP_ICON to 0. To opt-out of creating the start menu program group with a new install, set SHOW_START_MENU to 0. Examples of how to use these command line properties are shown below. The third property, LS_LAUNCHER_COMMAND, is used to modify the default launch target of the desktop icon. If this property is not set, the desktop icon will launch a Getting Started page, which is included and installed with this package. If an integrator sets this property, the desktop icon will launch what this property specifies. This property can contain a fully qualified local file, either static file or application, or a fully qualified URL. Primary Contacts:

2 Technical Contact Requirements: Launch conditions (checked by install package) Supported Operating Systems o Windows 2000 (Win2K) o Windows XP (32 and 64) o Windows MCE o Windows Vista (32 and 64) User Rights o Administrator rights required on Windows 2000, Windows XP, Windows MCE and Vista Hardware (not checked by install package) Intel Pentium 128 MB RAM (higher is recommended) Windows Installer (checked by Windows O.S.) Windows Installer Version 2.0 or later must be installed prior to running an installation of LS_HSI.msi from the command line (using the msi file), or the installation will fail. General Notes: Installing LS_HSI.msi from the command line can be very straightforward. However, the command-line syntax is very exact with regard to spaces and quotation marks. Command-line parameters are passed in the form of PROPERTY=VALUE pairs. PROPERTY=VALUE pairs are used to set Windows Installer properties. The section titled Command Line Specification for Installing LS_HSI.msi explains how to use this form. The user has no choice on the install location of the core LightScribe files. The destination for the core is %CommonProgramFiles%\LightScribe. On English systems, %CommonProgramFiles% usually expands to C:\Program Files\Common Files\. Command Line Invocation for Installing LS_HSI.msi How to Call the MSI Installer with LS_HSI.msi The lines below should have no carriage returns nor line feeds. If a line is wrapped due to the document width limitation please be sure to remove any returns/linefeeds when using these command line examples For a silent install: Call the install as: ( The square brackets indicate the argument is optional and the brackets are not part of the argument string) Please note, on Vista you will either need to turn off UAC during this install OR use /qb+ instead of /qn. The option /qb+ will allow a few dialogs to be displayed, but will require some user interaction during the install. If the UAC is not turned off during the install and the /qn option is used, the install will silently fail as Vista will be asking for permission to continue, but the silent option will hide this dialog so the installer will silently exit. So, the recommended method on vista for those needing a completely silent install is to turn off UAC during the install and then turning UAC back on after the install. TRANSFORMS= <xxxx.mst> [SHOW_DESKTOP_ICON= 0 ] [SHOW_START_MENU= 0 ] [LS_LAUNCHER_COMMAND= <your_launcher_command_string> ] Here is an example for a Spanish system: (you must use your own update string. Do not use as your string, it is just an example string. Please see the LS Host Software Delivery Informative for details on the use of this UPDATE_SHELL_COMMAND property. msiexec.exe /I LS_HSI.msi /qn UPDATE_SHELL_COMMAND= TRANSFORMS= 1031.mst Page 2 of 5

3 This will hide all install dialogs and set the update registry setting to You must check that the HKLM/Software/LightScribe/Update registry setting exists with your string to verify that the UpdateShellCommand has been set correctly. This command line will also install a desktop icon and a start menu group if these items have not been deleted or opted-out in a previous installation. The start menu items for LightScribe Direct Disc Labeling will be in Spanish and the Getting Started page will be in Spanish. For a silent install with no desktop icon: Call the install as: TRANSFORMS= <xxxx.mst> [SHOW_DESKTOP_ICON= 0 ] For a silent install with no start menu group: Call the install as: TRANSFORMS= <xxxx.mst> [SHOW_START_MENU= 0 ] For a silent install with your own launcher command: Call the install as: TRANSFORMS= <xxxx.mst> LS_LAUNCHER_COMMAND= For a silent install with a log file: For troubleshooting during configuration testing, append /L*! filename as in this example: /L*! C:\theLog.txt TRANSFORMS= <xxxx.mst> This will create a log file named thelog.txt at C:\. It also hides all install dialogs. Note that msiexec.exe is usually located in C:\WINNT\system32 on Win2k type OS s Version Management: LS_HSI.msi will not allow an older version to be installed over a newer installed version. In this scenario, the installer will not install any files nor will it update the UPDATE_SHELL_COMMAND registry setting.. LS_HSI.msi will not prompt a user to upgrade but will proceed silently. If the install is newer than the currently installed product, it will use Windows Installer technology to upgrade the product. Any upgrade will be placed in the same location as the current installation. Opt-Out options: Starting with versions newer than of the LS_HSI.msi, it contains the Getting Started features of which an integrator can choose to opt-out from. These features include a LightScribe desktop icon and a LightScribe start menu program group. These items are intended to make the use of LightScribe more visible to end customers and it is strongly encouraged that integrators allow these items to be installed. If there is some compelling reason why either of these should not be installed an integrator can opt-out of these items by following the command line options explained above in this document. Configuring LsLauncher: The LS_HSI.msi package creates a desktop icon (shortcut) and a few start menu items. The desktop shortcut and the LightScribe->LightScribe start menu item will launch LsLauncher.exe. LsLauncher.exe first looks in the Page 3 of 5

4 registry to determine what action to take. If the registry entry is not present, or if the registry entry is not valid then LsLauncher takes a default, built-in action (currently opening a local htm page). In order to configure LsLauncher to launch an executable or open a document, you must create or reset the LSLauncher entry in HKLM/Software/LightScribe with your string. To check that your setting is correct, double click the desktop icon (shortcut) or select the Lightscribe->Lightscribe start menu item. If you don t see the action you expected then the registry item points to a non-existing file or the executable is not working as expected. Try launching your executable in a command prompt window to see if it can launch correctly. Possible installation scenarios of LS_HSI.msi There are several installation scenarios using the LS_HSI.msi: 1. Default install of the LS_HSI.msi resulting in: b. LightScribe desktop icon launching LightScribe default HTML page c. LightScribe start menu program group 2. Install LS_HSI.msi with command line option (LS_LAUNCHER_COMMAND) resulting in: b. LightScribe desktop icon launching integrator specified target (local file, local app or website) c. LightScribe start menu program group 3. Install LS_HSI.msi with command line option to opt-out of the desktop icon (SHOW_DESKTOP_ICON= 0 ) resulting in: b. LightScribe start menu program group 4. Install LS_HSI.msi with command line option to opt-out of the start menu program group (SHOW_START_MENU= 0 ) resulting in: b. LightScribe desktop icon 5. Install LS_HSI.msi with command line options to opt-out of all Getting Started items (SHOW_DESKTOP_ICON= 0 & SHOW_START_MENU= 0 ) resulting in: List of Supported LanguageID s: LSS Installer can be installed in any of these Primary Languages and supports sub languages by installing the related Primary Language. Please note, setting the TRANSFORMS property to one of the values below only controls the language of the labels in the start menu and the autoplay dialogs. The language for the remaining content of the installation is determined internally to the installer by the System Language. Primary Language Arabic Simplified Chinese Traditional Chinese Czech Transform Name 1025.mst 2052.mst 1028.mst 1029.mst Page 4 of 5

5 Danish German Greek English Spanish Finnish French Hebrew Italian Japanese Korean Dutch Norwegian Polish Portuguese-Brazilian Portuguese-Portugal Russian Slovak Swedish Turkish 1030.mst 1031.mst 1032.mst 1033.mst 1034.mst 1035.mst 1036.mst 1037.mst 1040.mst 1041.mst 1042.mst 1043.mst 1044.mst 1045.mst 1046.mst 2070.mst 1049.mst 1051.mst 1053.mst 1055.mst Manual uninstall: If necessary, starting with release the LS_HSI.msi package can be uninstalled using msiexec.exe. This only applies to systems where previous permanent versions of the LS_HSI.msi have not been installed. Use the following command line: msiexec.exe /x LS_HSI.msi Page 5 of 5