Configuring Install Options

You must configure this file so your end users can successfully install your library.

When you initially deploy your library content to your end users, they install a version of the NXT 4 product along with your library content. However, in order for your end users to successfully install the respective product and your library, you must configure the InstallOpt.ini file. By configuring the InstallOpt.ini file, you can customize your end users' library installations in the following ways:

Specifying the install directory and whether it is modifiable by the end user
Dictating the look and feel of the install
Designating the company and product names to appear in the background or in the install dialogs
Running an executable program after installation is complete
Installing a custom set of site interface templates
Indicating which libraries to install and where
Including relevant license files and authentication key (only for NXT Intranet and Offline Publishers)
Determining applicable languages to install
Including relevant customer support information
Adding an option for users to view the readme file at the conclusion of the installation

Note: InstallShield does not allow to modify GUID after the beginning of the installation process. That is why it is impossible to specify GUID in *.ini files that are handled by the installer. The only way to modify GUID is to run the installation package with a command line parameter, for example: setup.exe /ig{FD2A56D2-6BC8-4A98-8AF0-958A171EE7A0}

The InstallOpt.ini file is one of the redistributable install files that resides at the root of the install. The following is an example of this configurable file.

[]
CD Content=
InstallPath=
BackGround=
Dialog=
Executable=
Templates=
AddLibraries=
Languages=
SupportInfo= [CD
Content]
CopyToHD=No
[InstallPath]
Path=C:\Program
Files\Rocket\NXT
4\Intranet
Publisher
AllowEdit=

Yes [BackGround]
FullScreenMode=yes

;Possible
colors are blue, magenta,
pink,

yellow,
green,
orange or red Color=pink Branding= [BackGround|Branding] CompanyNameB=Rocket ProductNameB=NXT 4� Intranet Publisher�
Server
[Dialog]

CompanyNameD=Rocket Software
ProductNameD=NXT
4 Intranet Publisher Server [Executable]

Program=
CmdLine=
Hide= no [Templates] Copy=no Source=

[Languages]
;DEU=
German,ENG=English
UK,

ENU=
English
US,

ESP=Spanish,
FRA= French, FRC= French Canadian, NLD= Nederlands , PTB= Portuguese, JPN=Japanese
Install=DEU;ENG;ENU;ESP;FRA;FRC;NLD;PTB;JPN

;[AddLibraries]
;Library1=
;Library2=

;[AddLibraries|Library1]
;LibraryName=lib1
;SourcePath=%SRCDISK%\ebooks
;LocalLibraryPath=%TARGETDIR%\Content
;AllowLLPathEdit=yes
;SDFPath=
;ViewID=
;DownLoadSourceLibrary=
;Silent=No

;[AddLicenses]
;License1=%SRCDISK%\license1.publc
;License2=%SRCDISK%\license2.publc

;[Authentication]
;Key=jD8dfj5#h$(dLFh34jfhush#hfajHJF

[SupportInfo]
Publisher=Rocket
Contact=Customer Support Department
HelpLink=http://my.website.com/help
HelpTelephone=1-617-614-4323
URLUpdateInfo=http://my.website.com/urlupdate

[ReadMeFile]
Display=Yes|No
FileName=<filename.htm>
Message=<text to prompt the user>

The InstallOpt.ini file has these options:

Item Description

CD Content Used when a mediainfo.pid file is present. The user is asked if they wish to copy the files to the hard drive or run them from the CD. The dialog presents two options as radio buttons: "Use from CD" or "Copy to my hard drive." This setting allows you to specify the option that is enabled as the default option.

Set CopyToHD=No to set "Use from CD" as the default
Set CopyToHD=Yes" to set "Copy to my hard drive" as the default

InstallPath

Contains settings to designate the default installation path and whether the your user can modify this directory.

Path

Indicates the default path for the installation. The default location is the following depending on the type of installation you are configuring:

NXT Intranet Publisher: C:\Program Files\Rocket\NXT Intranet Publisher
NXT Offline Publisher: C:\Program Files\Rocket\NXT Offline Publisher
NXT Solo: C:\Program Files\Rocket\NXT Solo

If the directory does not exist on the user's system, the install routine will create it during the installation.

AllowEdit

Specifies whether your end user can change the install location. If your templates or other supporting files have hard-coded locations in them based on the Path= option, set this option to No. The default for this setting is Yes.

BackGround

Contains settings that determine the look and feel of the installation process to your end users.

`FullScreenMode`	Determines whether the install uses the full screen or just the dialogs. The default for this setting is `yes` for full screen install. Set this to `no` to only show the dialogs during install.
`Color`	Specifies the background color of the installation in full screen mode. The colors you can choose from are: blue, magenta, pink, yellow, green, orange, or red

BackGround|Branding

Contains options for branding the installation process with your company name and product name on the background when in full screen mode.

`CompanyNameB`	Specifies the company name you want to appear on the background. Leave it blank if you do not want to display a company name. The default for this is Rocket.
`ProductNameB`	Specifies the product name you want to appear on the background. Leave it blank if you do not want to display a product name. The default for this is NXT 4^TM Intranet Publisher^TM Server, NXT 4^TM Offline Publisher^TM Client, or NXT 4^TM Solo^TM Client.

Dialog

Contains options for branding the installation dialogs.

CompanyNameD Specifies the company name you want to display in the installation dialogs. Leave it blank if you do not want to display a company name. The default for this is Rocket.

ProductNameD

Specifies the product name you want to display in the installation dialogs. This needs to be set to correctly identify the publisher product name. The default for this is NXT 4^TM Intranet Publisher^TM Server, NXT 4^TM Offline Publisher^TM Client, or NXT 4^TM Solo^TM Client.

Note: If your customers have two libraries with the same ProductNameD setting, then only one LibInst.Gui will only appear in the Windows tray for the first one and automatic updates will not be available for the second one.

Executable

Contains options for running an executable at the end of the install.

`Program`	Specifies the full path, including the executable file name and extension, to the program you want to run. You can either hard code the path to a program or you can use any of the install shield replacement tags to dynamically resolve the correct directory.
`CmdLine`	Specifies any command line options needed by your program.
`Hide`	Indicates the visibility of the executed program. Set this option to `yes` if you want your program to run hidden or `no` to show your program.

Templates

Contains options to copy your own set of templates from the install media to the appropriate location in the end user's installation directory. This enables you to brand the end user's site for viewing your library content instead of the default templates.

Copy Indicates whether or not to copy the template files to the end user's machine. Set this option to yes to copy your own templates or no to use the default templates.

Source Specifies the full path to the directory on your distribution media that contains your templates. All files and subdirectories in the directory specified will be copied to the target installation templates directory.

You can hard code the paths to your source files on your distribution media, or you can use %SRCDIR% and %SRCDISK% InstallShield replacement variables to dynamically resolve this path.

Note: On some Windows 98 systems, the path to the Templates directory is case sensitive. To avoid problems, use a capital 'T' in the name of your Templates directory. For example, %SRCDIR%\Templates.

Languages

Specifies the language dictionaries that you want to install.

Install

DEU  (German)
ENG  (English UK)
ENU  (English US)
ESP  (Spanish)
FRA  (French)
FRC  (French Canadian)
NLD  (Nederlands)
PTB  (Portuguese)
JPN  (Japanese) (Applies to Solo and Offline Publisher only)

AddLibraries Contains a list of libraries you want to install on an end user's machine. Separate subsections contain the settings for each library to be installed. You can name the libraries in this section as you desire. Remove the ";" character to "uncomment" the necessary entries.

The order of the separate AddLibraries subsections must follow the order of this list.

AddLibraries|Library1

Contains the settings for a library to be installed. You must match the library name that follows AddLibraries| in this subsection with the library name in the AddLibraries section list above. Library1 is the default library name that you can modify as needed.

`LibraryName`	Specifies a unique name for the library to be installed. This is required. This name is of your choosing.
`SourcePath`	Specifies the source directory on the distribution media of your library content. This is required. You can hard code the paths to the source library directory on your distribution media, or you can use `%SRCDIR%` and `%SRCDISK%` install sheild replacement variables to dynamically resolve this path.
`LocalLibraryPath`	Specifies the target library directory where libraries you have deployed reside or where you want the library files to reside on the end user's machine. This is required. The installation will place the library install file, collections, and all update files in this directory. You can hard code this path to a specific directory on the end user's machine, or you can use the `%TARGETDIR%` and `%TARGETDISK%` replacement variables. This path must be on writable media.
`AllowLLPathEdit`	Indicates whether your end users can change the library install directory during installation. Set this option to `yes` if you want to allow the user to edit the installation location of the library, `no` if you do not. If you set this option to `yes` for one library, it applies to all libraries, regardless of their individual settings.
`SDFPath`	Specifies the path and file name of the Site Definition File (SDF) you want install this library into. This is optional. If you do not specify this path, the default is the `Publish.sdf` in the `...\bin` directory. You can hard code this path to a specific directory on the end user's machine, or you can use the `%TARGETDIR%` replacement variable to resolve this directory.
`ViewID`	Specifies the view to which your installed library will belong. This is optional. This setting is the `ViewId` for the site. If you do not specify this value, the default `ViewID` is `10.1048/Enu`.
`DownloadSourceLibrary`	Indicates whether to download content collections from an update server specified in your library install file. Set this option to `yes` if you do not include the collections or updates in the `SourcePath` directory of your distribution media. Set this option to `No` if the distribution media includes all content collection and update files. The default for this setting is `no`.
Silent	Specifies whether to show library installation progression status to your end users. Set this option to `yes` if you want to display only error messages to your end user during the library installation process. Set this option to `No` to display progress and status messages to your end users. The default for this option is `no`.

AddLicenses

Contains a list of licenses you want to install to protect your library content and enable your end users to access specific library content. The names of your licenses are of your choosing. Remove the ";" character to "uncomment" the necessary entries.

This section is only applicable if you are configuring the install for NXT Intranet Publisher Server, or NXT Offline Publisher Client.

License1 Specifies the location on the distribution media (source) of the license (.publc) files. This is required. You can hard code this path to a specific directory on the end user's machine, or you can use the %SRCDIR% and %SRCDISK% replacement variables to resolve this directory. You can specify any name for the license, it does not have to be "license1."

Authentication

Specifies the respective Publisher Authentication Token for the libraries in this install.

This section is required and only applicable if you are configuring the install for NXT Intranet Publisher Server, or NXT Offline Publisher Client.

Key Specifies the secure/encrypted version of your Publisher Authentication Token for the libraries involved in this install. The following is an example of this value: jD8dfj5#h$(dLFh34jfhush#hfajHJF (your key will be different)

This is required.

SupportInfo

Contains the information that you want to display in the Add/Remove programs Support Information link.

`Publisher`	(Optional) Specifies the Publisher Name.
`Contact`	(Optional) Specifies the Support contact name.
`HelpLink`	(Optional) Specifies the URL to contact Support.
`HelpTelephone`	(Optional) Specifies the Support telephone number.
`URLUpdateInfo`	(Optional) Specifies the URL for update information.

ReadMeFile

Allows you to choose whether to display the Readme file at the conclusion of the install. In this implementation, the readme file must be .htm format. File names must be valid Windows file names (and ,thus, cannot have invalid file name characters). The file must be copied to the <TARGETDIR> using the CopyFile.ini file.

`Display`	Indicates whether to display the option.
`FileName`	Specifies which file to display.
`Message`	The message that is displayed on the dialog to prompt the user to open the file. The message will appear to the right of a checkbox. Only one message is allowed, and it must be 128 characters or fewer. For example: “Open the readme file.” or “View additional release notes.”