20
Phonak Target 5.0 August 2016 Phonak Target Installation Program 1 Introduction............................................................................................................................................................................................................................................ 2 2 Prerequisites ........................................................................................................................................................................................................................................... 2 3. Target Installer Command Line Parameters ................................................................................................................................................................................. 2 4 Target Service Packs............................................................................................................................................................................................................................. 6 5 SETUP.exe Command Line Parameters (InstallShield Help) ...................................................................................................................................................... 7 6 MSI command line options (InstallShield Help) ......................................................................................................................................................................... 17

Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Embed Size (px)

Citation preview

Page 1: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target 5.0 August 2016

Phonak Target Installation Program

1 Introduction............................................................................................................................................................................................................................................ 2

2 Prerequisites ........................................................................................................................................................................................................................................... 2

3. Target Installer Command Line Parameters ................................................................................................................................................................................. 2

4 Target Service Packs............................................................................................................................................................................................................................. 6

5 SETUP.exe Command Line Parameters (InstallShield Help) ...................................................................................................................................................... 7

6 MSI command line options (InstallShield Help)......................................................................................................................................................................... 17

Page 2: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 2

1 Introduction

The Target installer (InstallShield project type: Basic MSI) basically consists of an MSI and a setup.exe. The latter is responsible for the

check and installation of the prerequisite components which again can be found in a separate directory ‘ISSetupPrerequisites’. Both, the

MSI as well as the setup.exe, react to command line parameters. Therefore, when launching the installer via the setup.exe, one has to

respect a special syntax in order to have the arguments for the MSI passed through to it (-> Chapter 5, /v : pass arguments to Msiexec).

The setup.exe command line parameters are described in chapter 5. The msi command line options are described in chapter 6. In addition,

Target installer package specific properties can be set in order to configure the installation itself. These properties are described in the

chapter 3, together with some examples.

2 Prerequisites

The prerequisites components currently required for Phonak Target are:

ISSetupPrerequisites Subdirectory Installation Program

{72D7E3D1-C9DF-4FA6-9F9B-4E5117AB2919} Microsoft .Net Framework 4.5.2

{3E07EC23-6463-4ACB-AB5C-27284F53F168} Microsoft Visual C++ 2005 SP1 Redistributable

{402E7B27-B303-434A-B4AA-5511C51BE447} Microsoft Visual C++ 2008 SP1 Redistributable

{270b0954-35ca-4324-bbc6-ba5db9072dad} Microsoft Visual C++ 2010 SP1 Redistributable

{7F49B39E-87F3-4E8F-99EF-E310F9C09706} Microsoft Visual C++ 2012 Redistributable

{773AC1E4-5F27-4DF6-A932-7FDDE35C0690} Microsoft SQL Server Compact 4.0 SP1 x86

{78909610-D229-459C-A936-25D92283D3FD} Microsoft SQL Server Compact 4.0 SP1 x64

The prerequisites components can also be installed separately by launching the corresponding installation programs. Once the prerequisites

are installed, it is possible to launch the ‘Phonak Target.msi’ directly to install Phonak Target. The ‘Phonak Target.msi’ checks that the

prerequisites are installed (….but unlike the Setup.exe, it does not trigger the prerequisites installation programs in case of missing

components – it simply informs with a message).

3. Target Installer Command Line Parameters

3.1 Available Properties

The Phonak Target MSI takes the following properties into account:

CHECKOFF <>1: default, checks turned on

1: the following checks are turned off

Page 3: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 3

C_COUNTRY Target country selection. Not all listed countries might be supported at all times.

Please verify the actual availability in the ‘User Settings’ dialog, country drop-down menu.

Algeria

Argentina

Armenia

Australia

Austria

Bahrain

Bangladesh

Belgium

Bolivia

Bosnia-Herzegovina

Brazil

Brunei

Bulgaria

Canada

Chile

China

Colombia

Costa Rica

Croatia

Cyprus

Czech Republic

Denmark

Ecuador

Egypt

El Salvador

Estonia

Finland

France

Germany

Greece

Guatemala

Hong Kong

Hungary

Iceland

India

Indonesia

Ireland

Iran

Iraq

Israel

Italy

Jamaica

Japan

Jordan

Kazakhstan

Kenya

Kuwait

Latvia

Lebanon

Libya

DZ

AR

AM

AU

AT

BH

BD

BE

BO

BA

BR

BN

BG

CA

CL

CN

CO

CR

HR

CY

CZ

DK

EC

EG

SV

EE

FI

FR

DE

GR

GT

HK

HU

IS

IN

ID

IE

IR

IQ

Il

IT

JM

JP

JO

KZ

KE

KW

LV

LB

LY

Lithuania

Luxembourg

Macedonia

Malaysia

Malta

Mexico

Morocco

Namibia

Netherlands

New Zealand

Nicaragua

Norway

Oman

Pakistan

Palestine

Panama

Peru

Philippines

Poland

Portugal

Qatar

Romania

Russia

Saudi Arabia

Serbia

Singapore

Slovakia

Slovenia

South Africa

South Korea

Spain

Sri Lanka

Sudan

Sweden

Switzerland

Syria

Taiwan

Thailand

Trinidad and Tobago

Tunisia

Turkey

United Arab Emirates

Ukraine

United Kingdom

Uruguay

United Staates (USA)

Uzbekistan

Venezuela

Vietnam

Yemen

LT

LU

MK

MY

MT

MX

MA

NA

NL

NZ

NI

NO

OM

PK

PS

PA

PE

PH

PL

PT

QA

RO

RU

SA

RS

SG

SK

SI

ZA

KR

ES

LK

SD

SE

CH

SY

TW

TH

TT

TN

TR

AE

UA

GB

UY

US

UZ

VE

VN

YE

Page 4: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 4

C_LANGUAGE Target language selection. Not all listed languages might be supported at all times.

Please verify the actual availability in the ‘User Settings’ dialog, country drop-down menu.

C_NOAHINSTALLATION 0: standalone installation

1: Noah installation (default setting but not considered if Noah not found)

C_INSTALLATIONKEY default: ‘Phonak’ (case sensitive!)

The installation key can be decorated with one or more feature keys. The parameters have to be separated by a

space (-> pls. see example b). below ).

Currently supported Feature Keys: None

C_INSTALLDIR Target installation directory

Arabic

Bulgarian

Chinese (Simplified)

Chinese (Traditional)

Czech

Danish

English

German

Spanish

Farsi

French

Greek

Indonesian

Italian

Japanese

Korean

Magyar

Dutch

Norwegian

Polish

Portuguese

Russian

Romanian

Serbian

Slovenian

Finnish

Swedish

Thai

Turkish

ar-JO

bg-BG

zh-CN

zh-TW

cs-CZ

da-DK

en-US

de-DE

es-ES

fa-IR

fr-FR

el-GR

id-ID

it-IT

ja-JP

ko-KR

hu-HU

nl-NL

nb-NO

pl-PL

pt-BR

ru-RU

ro-RO

sr-Latn-CS

sl-SL

fi-FI

sv-SE

th-TH

tr-TR

Page 5: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 5

C_SETUPOPTIONS The value of the setup options will have the following format:

<value> := <option> { “,” <option> }

<option> := <setting-id> “=” <setting-value>

<setting-id> := (* an id for the application setting *)

<setting-value> := (* the value for the application setting *)

The complete list of values and their possible values are as follows:

Option Name Possible Option Values Default Value Where in Target are the effects

auto-update true or false true (Setup --> Internet --> Online services -->

Enable online services --> Automatically check

daily for updates)

alps-connection true or false true (Setup --> Internet --> Online services -->

Enable online services --> Enable ALPS

connection)

google-analytics true or false true (Setup --> Internet --> Online services -->

Enable online services --> Enable “Google

analytics”)

visual-effects Maximum or Minimum or Off Maximum (Setup --> General --> Presentation --> Visual

effects)

online-services true or false true (Setup --> Internet --> Online services)

For an example please see the examples below 3.2 example d

C_SCREENSAVER_DE* ≠1: default, not selected for installation

1: selected for installation

C_SCREENSAVER_EN* ≠1: default, not selected for installation

1: selected for installation

C_SCREENSAVER_FR* ≠1: default, not selected for installation

1: selected for installation

*(currently not available)

Page 6: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 6

3.2 Examples

Precondition: Current directory is where the installation program resides.

a) The following command will install Target …

Setup.exe /s /v"/qn /l*v %temp%\TargetInstall.log C_COUNTRY=FR C_LANGUAGE=fr-FR C_NOAHINSTALLATION=1

C_INSTALLDIR=\"C:\Program Files\Phonak\Phonak Target\""

b) The following command will install Target…

Setup.exe /s /v"/qb C_COUNTRY=DE C_LANGUAGE=de-DE C_NOAHINSTALLATION=1 C_INSTALLDIR=\"C:\Program Files\Phonak\Phonak

Target\""

c) The following command will uninstall Phonak Target with a basic user interface and produce a log file C:\TargetUninstall.log

Setup.exe /s /x /v"/qr /l*v %temp%\TargetUninstall.log"

(Note: when the setup.exe is called and no log file defined, a log file %temp%\PhonakInstall.log is automatically created.)

d) The following command will install Target…

Setup.exe /s /v"/qb C_COUNTRY=DE C_LANGUAGE=de-DE C_NOAHINSTALLATION=1 C_INSTALLDIR=\"C:\Program Files\Phonak\Phonak

Target\" C_SETUPOPTIONS=auto-update=true,alps-connection=false,google-analytics=true,visual-effects=Maximum,online-services=true"

4 Target Service Packs

4.1 Unattended Installation

Service Packs can be made available for Target. In order to install a Service Pack unattended, please proceed as follows:

The Service Packs are distributed as .exe files. For an unattended installation, the .msp file is required. In a first step we therefore retrieve

the .msp file from the .exe:

a) clean the TEMP directory (%temp%)

b) launch the Service Pack executable (.exe) and wait until you see the Welcome dialog. Leave it open.

Page 7: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 7

c) browse to the TEMP directory

d) you will find two newly created directories with GUID names (Note: these GUIDs change with every installation)

e) in one of these two directories, there is a file called PatchPackage.msp

f) launch it to make sure it is the Target Service Pack (…you should see the same dialog as in step b) ), then cancel

and close the installation

g) copy the PatchPackage.msp e.g. to C:\

h) cancel and close the installation launched through the .exe

Finally launch the Service Pack for an unattended installation:

msiexec /p C:\PatchPackage.msp REINSTALL=ALL REINSTALLMODE=omus /qn

(use …/qr or /qb instead of /qn to see how the installation proceeds)

5 SETUP.exe Command Line Parameters (InstallShield Help)

InstallShield 2010

Like your compiled .msi file, Setup.exe can accept a number of Command Line Parameters. Update.exe (available only for Basic MSI and

InstallScript MSI projects) accepts nearly all of the same Command Line Parameters. Using these parameters, end users can specify such

data as the language that the installation should run in and whether to launch Setup.exe silently. End users can also pass parameters

through Setup.exe to the included .msi file.

(Note: Command Line options that require a parameter must be specified with no space between the option and its parameter. For

example, Setup.exe /v"ALLUSERS=2" is valid, while Setup.exe /v "ALLUSERS=2" is not.)

Quotation marks around an option’s parameter are required only if the parameter contains spaces. If a path within a parameter contains

spaces, you may need to use quotation marks within quotation marks, as in the following example:

Setup.exe /v"INSTALLDIR=\"c:\My Files\""

Project

Some of the Command Line options apply to only certain project types. Project-specific limitations are listed for each option.

5.1 Built-In Command Line Parameters

This section describes valid Command Line Parameters for Setup.exe. The parameters are organized into the following categories:

Page 9: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 9

5.1.2 Special Installation Modes

The /a parameter does not work with Update.exe. Update.exe launches a

patch that accesses and modifies an existing cached .msi file on the system,

and an administrative installation does not cache the .msi file.

This parameter does not apply to InstallScript MSI projects in which the

InstallScript UI style is the new style (which uses the InstallScript engine as

an embedded UI handler). To learn more, see Using the InstallScript Engine

as an External vs. Embedded UI Handler for InstallScript MSI Installations.

Page 10: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 10

5.1.3 Passing Data to the Installation

Page 11: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 11

5.1.4 Download and Cache Locations (Basic MSI and InstallScript MSI Projects)

Page 12: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 12

5.1.5 Debugging

1. Copy the InstallScript Debugger executable file ISDbg.exe (located in the

System folder of your InstallShield distribution) to the test system, and

register it by launching the executable with the /REGSERVER Command

Line option.

2. Copy Setup.dbg to the test system.

3. Run Setup.exe with the command Setup.exe /d"<path>", where path is

the directory containing Setup.dbg.

Page 13: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 13

5.1.6 SMS Data

Page 14: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 14

5.1.7 Miscellaneous

For InstallScript MSI installations: If you include a splash screen, the

installation automatically switches to the small progress dialog, and the

Page 15: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 15

splash screen is shown only during the time that the progress dialog is

displayed. Note that this is true even if /hide_progress is specified. Therefore,

it is recommended that you avoid using /hide_progress with a splash screen

in InstallScript MSI installations.

Page 16: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 16

Page 17: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 17

5.2 User-Defined Command Line Parameters (InstallScript Projects)

Along with the Command Line switches listed above, -bd, -f, and -zi are Command Line switches reserved by InstallShield. User

redefinition of these Command Line switches, either uppercase or lowercase, can cause errors.

You can define your own Command Line arguments, which are copied to the system variable CMDLINE at run time. Like predefined

Command Line switches, you can pass these arguments directly to Setup.exe, place them in Setup.ini, or (for testing purposes while you

are using the InstallShield IDE) place them in the Set-tings dialog box, which is displayed when you click Settings on the Build menu in

InstallShield.

(Note: Setup.exe initializes correctly even on systems with more than 256 MB of memory and always stays in memory until the setup is

complete. Due to the nature of DOS, when you launch Setup.exe from the command line, a DOS prompt is quickly returned although

Setup.exe is still in memory.)

See Also

InstallShield Help Library

4 June 2009

Copyright Information | Contact Acresso Software

6 MSI command line options (InstallShield Help)

The executable program that interprets packages and installs products is Msiexec.exe. Note that Msiexec also sets an error level on return

that corresponds to system error codes. Command Line options are case-insensitive.

The Command Line options in the following table are available with Windows Installer 3.0 and earlier versions. The Standard Installer

Command Line Options are also available beginning with Windows Installer 3.0.

Option Parameters Meaning

/I Package|ProductCode

/f [p|o|e|d|c|a|u|m|s|v]

Package|ProductCode

/a Package

/x Package|ProductCode Uninstalls a product.

/j [u|m]Package

Page 20: Phonak Target 5 - Phonak NHS - Life is on | Phonak NHS ... Target Installer.pdfPhonak Target 5.0 August 2016 Phonak Target Installation Program 1

Phonak Target | Phonak Target Installation Program 20

The options /i, /x, /f[p|o|e|d|c|a|u|m|s|v], /j[u|m], /a, /p, /y and /z should not be used together. The one exception to this rule is that

patching an administrative installation requires using both /p and /a. The options /t, /c and /g should only be used with /j. The options /l

and /q can be used with /i, /x, /f[p|o|e|d|c|a|u|m|s|v], /j[u|m], /a, and /p. The option /n can be used with /i, /f, /x and /p.

To install a product from A:\Example.msi, install the product as follows:

msiexec /i A:\Example.msi

Only public properties can be modified using the command line. All property names on the command line are interpreted as uppercase but

the value retains case sensitivity. If you enter MyProperty at a command line, the installer overrides the value of MYPROPERTY and not

the value of MyProperty in the Property table. For more information, see About Properties.

To install a product with PROPERTY set to VALUE, use the following syntax on the command line. You can put the property anywhere

except between an option and its argument.

Correct syntax:

msiexec /i A:\Example.msi PROPERTY=VALUE

Incorrect syntax:

msiexec /i PROPERTY=VALUE A:\Example.msi

Property values that are literal strings must be enclosed in quotation marks. Include any white spaces in the string between the marks.

msiexec /i A:\Example.msi PROPERTY="Embedded White Space"

To clear a public property by using the command line, set its value to an empty string.

msiexec /i A:\Example.msi PROPERTY=""

For sections of text set apart by literal quotation marks, enclose the section with a second pair of quotation marks.

msiexec /i A:\Example.msi PROPERTY="Embedded ""Quotes"" White Space"

The following example shows a complicated command line.

msiexec /i testdb.msi INSTALLLEVEL=3 /l* msi.log COMPANYNAME="Acme ""Widgets"" and ""Gizmos."""

The following example shows advertisement options. Note that switches are not case-sensitive.

msiexec /JM msisample.msi /T transform.mst /LIME logfile.txt

The following example shows you how to install a new instance of a product to be advertised. This product is authored to support multiple

instance transforms.

msiexec /JM msisample.msi /T :instance1.mst;customization.mst /c /LIME logfile.txt

The following example shows how to patch an instance of a product that is installed using multiple instance transforms.

msiexec /p msipatch.msp;msipatch2.msp /n {00000001-0002-0000-0000-624474736554} /qb

When you apply patches to a specific product, the /i and /p options cannot be specified together in a command line. In this case, you can

apply patches to a product as follows.

msiexec /i A:\Example.msi PATCH=msipatch.msp;msipatch2.msp /qb

The PATCH property cannot be set in a command line, when /p option is used. If the PATCH property is set when the /p option is used, the

value of PATCH property is ignored and overwritten.

Build date: 5/22/2008 © 2008 Microsoft Corporation. All rights reserved.

Phonak AG

Laubisrütistrasse 28

CH-8712 Stäfa

Switzerland

CE mark applied 2016

V1.0

0/2016-2.0

© P

honak A

G A

ll r

ights r

eserved