Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

InstallShield

Applies to: v10

The InstallShield scripts, .INI keys and registry paths described here belong to the WG 3.x installer. Nothing in the v10 sources examined establishes how a v10 add-on is packaged or registered: unverified. (wgserver.exe /regserver is used in the developer deploy loop; chapter 29, section 29.3.)

Applies to: WG3.x

Editor's note: this chapter is new in the WG3 layer. It is from section 5 ("InstallShield V5.1") of the Developer's Addendum for Worldgroup 3.12 (wg312dev; the earlier 3.10 edition, devad3, is the same text apart from "3.10" for "3.12", BC5 for BC50, InstallShield V5.0 for V5.1 and spelling). The addendum has no figures. Prose is unrewritten; "Header check" notes record where the printed text disagrees with the WG3.2 headers. It replaces the add-on install-utility description in chapter 3 (.MDF Install) for WG3.x.

New Features

Uninstall

Now any program installed with InstallShield will have the ability to uninstall itself. This was not implemented in the previous version given to ISVs.

Registry

The registry was 100% re-done, following Microsofts guide lines. "\SOFTWARE\*Company*\*Product*\CurrentVersion" will now be where all registry options shall be put, this includes add-ons. The install program will maintain serial number (activation code, if used will be under products registry), and directories (under server directory). It will also pay attention to version numbers of product and server. If installing an Add-on for the Server version 3.12 and Server version 4.0 is installed it will inform the user that the software being installed is for an older version of the software. If installing an Add-on version 4 and Add-on version 5 is already installed it will again notify the user.

Media

You now have the ability to create "Disk", "CD", "FromTheWeb" installs.

Modifiable MSG Files

You can now ask users MSG file options and they can answer that as part of the installation program. The install program will ask the question just as it is in the MSG file, *note* if there is no help, the install program will bomb complaining about it! There is an option to automatically force MSG options to be set, increased, or decreased as the program needs. The user will not see anything when forcing message files to be set. The option will be saved in the registry, so that it will not let the option be modified twice.

Run Executable

The ability to open up a box showing a message like "Merging files" can be done with show message, followed by running an executable to do the merging and then calling a hide message.

Activation Codes

The ability to place activation codes in MSG files is done directly from the install program.

Folders

Any installation program may now insert links into a folder group. When reading the options for "ASK PATH", if it finds the option "Folder=", the install program will read the file and add or remove items from the selected folder group.

INI file

The ini file has been enhanced quite a bit. Unfortunately InstallShield has done away with their command line building utilities for the moment, they have informed us that they will be releasing the next product with them. Before loading InstallShield5 the ini file will need to be placed in the appropriate directory, or after opening InstallShield5 edited via the GUI before attempting to create a build.

Requirements

InstallShield Professional Version 5.1 must be purchased by each ISV.

Applies to: WG3.x

Editor's note: the earlier 3.10 edition of the addendum (devad3) names InstallShield V5.0 ("InstallShield Version 5.0 must be purchased") and uses DisplayVersion=v3.10 in the example. The .INI keywords and registry paths in this chapter cannot be checked against any header.

InstallFromTheWeb is required if you want to allow anyone to download your software in pieces or install directly from the web.

Example

*NOTE* - a semi-colon denotes that the option is not going to be used. Placing the semi-colon in front of any option will cause the install program to ignore that option.

[ChangeOption]
;File=WGSMAJOR.MSG
;Option1=GROUP1
;Adjust1=SPX
;Registry1=WG310

• File - File to open.

• Option# - Message option to change.

• Adjust# - Sets Text, Binary, and String options or increases/decreases Numbers, Longs, and Hex options.

• Registry# - Used for upgrading purposes (with this you never have to remove the option, makes upgrading easier).

[Install For]
Company=Galacticomm
Product=Worldgroup Server
VersionMajor=3
VersionMinor=10

• [Install For] is a requirement and explains which program it will be installing for.

• Company will be used with the registry to retrieve where the product was installed. Must always be "Galacticomm".

• Products will also be used with the registry, and a few questions. Currently we are using "Worldgroup Server", "WebCast ProServer", and "ActiBase Server". Please note that the registry is case sensitive, so these must be placed in exactly as shown.

• VersionMajor will contain the major revision number of the product, in hex, in this case it shall be "3" for Worldgroup Server, "2" for WebCast ProServer, and "1" for ActiBase Server.

• VersionMinor will be the minor revision number of the product, in hex, in this case "10" for Worldgroup Server means ".10", "2" for WebCast ProServer means ".02", and "0" for ActiBase Server means ".00".

[Install Information]
Company=Galacticomm
Product=Lan Option
VersionMajor=3
VersionMinor=10
DisplayName=Lan Option
DisplayVersion=v3.12
SETHKEY=HKEY_LOCAL_MACHINE
Publisher=Galacticomm, Inc.
OperationsSupport=0115
HelpTelephone=(954) 583-5990
URLUpdateInfo=http://www.gcomm.com/updates.htm
URLInfoAbout=http://www.gcomm.com
CheckServer=TRUE
;CheckODBC=
;FinishApp=
;FinishAppCommandLine=
;HelpLink=

• [Install Information] is a requirement and explains which program it will be installing.

• Company will be used with the registry to retrieve where the product was installed, this will be your company.

• Products will also be used with the registry, and a few questions. Please note that the registry is case sensitive, so be sure to put the exact case in each time.

• VersionMajor will be the major revision number of your product.

• VersionMinor will be the minor revision number of your product.

• DisplayName is not a requirement, and is not directly used by Galacticomm.

• DisplayVersion is not a requirement, and is not directly used by Galacticomm.

• SETHKEY is a requirement that will advise the install program which registry it should use. Normally under add-on installations you will be using "HKEY_LOCAL_MACHINE", if you are doing something that is user related you would use "HKEY_CURRENT_USER".

• Publisher is not a requirement, and is not directly used by Galacticomm.

• OperationsSupport is not a requirement, and is not directly used by Galacticomm. This is noted as a build number.

• HelpTelephone is not a requirement, and is not directly used by Galacticomm. This option is most notably used in about screens of offline utilities.

• URLUpdateInfo is not a requirement, and is not directly used by Galacticomm. This option is most notably used in about screens of offline utilities. This should also load up a browser if clicked.

• URLInfoAbout is not a requirement, and is not directly used by Galacticomm. This option is most notably used in about screens of offline utilities. This should also load up a browser if clicked.

• CheckServer will make sure the server and offline utilities are not running before beginning its install, and will also make calls to run WGSINT.

• CheckODBC makes sure ODBC version 3.0 is installed.

• FinishApp will launch a program at the end of the install program.

• FinishAppCommandLine is its command line.

• HelpLink is a link to the help file.

[Initialize Installation]
BitmapFile=GCOMM.BMP
BitmapPlace=LOWER_LEFT
BitmapHDist=50
BitmapVDist=50
Type=WELCOME
Next=License File
;NoTitle=
;TitleText=
;TitleSize=
;TitleColor=

• [Initialize Installation] is a requirement and begins the install program.

• BitmapFile is not required, but is the name of a file you would like shown on the install screen.

• BitmapPlace is not required, but can be set to LOWER_LEFT, LOWER_RIGHT, UPPER_LEFT, UPPER_RIGHT, and CENTERED. The install will default to CENTERED.

• BitmapHDist is not required, but is the horizontal distance from the corner chosen. This option can not be used with CENTERED.

• BitmapVDist is not required, but is the vertical distance from the corner chosen. This option can not be used with CENTERED.

• Type is a required field, there are currently eleven (11) options to choose from, DONE, WELCOME, WELCOME BMP, PICK OPTION, ASK PATH, SHOW MESSAGE, LICENSE, REGISTER, HIDE MESSAGE, RUN APP, and MESSAGE OPTION. (see definitions for explanations)

• Next is a required field. This will bring you from [Initialize Installation] to [License File], or what ever option is specified.

• NoTitle is for those who wish not to have any text on the main screen.

• TitleText is for those who wish to change the text from something other than "*Product* Installation"

• TitleSize is for those who wish to change it from 36 pitch font.

• TitleColor is for those who want something other than WHITE to show up.

[License File]
Type=LICENSE
LicenseFile=Gcomm Add-On.Lic
Next=Register
[Register Program]
Type=REGISTER
MessageLine1=Please enter the activation code for the "Lan Option".
Next=Ask for Path
[Ask for Path]
Type=ASK PATH
MessageLine1=Please enter the location for Worldgroup Server. Lan Option will install itself, and other needed components.
Reference=GALSPX.DLL
Next=Install Lan Channels
[Install Lan Channels]
Type=PICK OPTION
Option1=Channel Grouping #1
Option2=Channel Grouping #2
Option3=Channel Grouping #3
Next=Channel Grouping #1
[Channel Grouping #1]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=GROUP1
Next=Starting Channel #1
[Starting Channel #1]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=START1
Next=Number of Channels #1
[Number of Channels #1]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=NUMBR1
Next=Server Name #1
[Server Name #1]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=SAPNAM1
Next=Finish Script
[Channel Grouping #2]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=GROUP2
Next=Starting Channel #2
[Starting Channel #2]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=START2
Next=Number of Channels #2
[Number of Channels #2]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=NUMBR2
Next=Server Name #2
[Server Name #2]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=SAPNAM2
Next=Finish Script
[Channel Grouping #3]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=GROUP3
Next=Starting Channel #3
[Starting Channel #3]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=START3
Next=Number of Channels #3
[Number of Channels #3]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=NUMBR3
Next=Server Name #3
[Server Name #3]
Type=MESSAGE OPTION
File=WGSMAJOR.MSG
Option=SAPNAM3
Next=Finish Script
[Finish Script]
Type=DONE
FirstMessage1=Setup has finished installing the Lan Option. Please read the release notes for additional information.
ReadMe=LAN.RLN

*Type* Definitions:

ASK PATH

• Title - Enter the title of the dialog box (optional)

• default - Location of REGPRODUCT

• MessageLine# - Enter the Beginning Message for the dialog box (optional)

• default - Set By InstallShield

• Reference - File that will be referenced for uninstall

• FolderFile - File that will be referenced for adding folders (optional)

• RegistryFile - File that will be referenced for adding registry options (optional)

• RenameFile - File that will be referenced for renaming files (optional)

• CopyFile - File that will be referenced for copying files to a temporary DIR, then back after installing, as not to overwrite files in the directory (optional)

• DeleteFile - File that will be referenced for deleting files (optional)

DONE

• Title - Enter the title of the dialog box (optional)

• default - Finished

• FirstMessage# - Enter the Beginning Message for the dialog box (optional)

• default - Set By InstallShield

• LastMessage# - Enter the Ending Message for the dialog box (optional)

• default - Set By InstallShield

• ReadMe - Enter a read me file or release notes for product (optional)

• RunMe - Enter an optional program a user may select here (optional)

• CommandLine - Command line if needed by RunMe (optional)

HIDE MESSAGE

Removes Message Box

-- See SHOW MESSAGE

LICENSE

• Title - Enter the title of the dialog box (optional)

• default - *Product* License Agreement

• FirstMessage# - Enter the Beginning Message for the dialog box (optional)

• default - Set by InstallShield

• LastMessage# - Enter the Ending Message for the dialog box (optional)

• default - Set by InstallShield

• LicenseFile - Enter the license file to be included with the project

MESSAGE OPTION

• File - File used to retrieve message option from

• Option - Option to get and set

PICK OPTION

• Title - Enter the title of the dialog box (optional)

• default - Pick an option

• Message# - Enter the Message for the dialog box (optional)

• default - Please select the option you wish to modify

• Option# - Enter the options you wish for the user to select

REGISTER

• Title - Enter the title of the dialog box (optional)

• default - Register *Product*

• MessageLine# -Enter the Beginning Message for the dialog box (optional)

• default - Set by InstallShield

RUN APP

• RunApp - Enter the application to run

• Directory - Enter the directory the application will be in

• TARGETDIR - Install Directory

• WINDIR - Windows Directory

• WINSYSDIR - Windows System Directory

• SRCDIR - Install Source Directory

• SUPPORTDIR - Temporary Directory

• default - TARGETDIR

• CommandLine - Enter the command line for RunApp (optional)

• Wait - If you wish the program not return access until it has finished insert WAIT=TRUE. This will pause InstallShield till the task is complete

SHOW MESSAGE

• FirstMessage# - Enter the Message to be displayed

• -- This is normally before running a program that doesn't show any information

WELCOME

• Title - Enter the title of the dialog box (optional)

• default - Welcome

• MessageLine# - Enter the Beginning Message for the dialog box (optional)

• default - Set by InstallShield

WELCOME BMP

• Title - Enter the title of the dialog box (optional)

• default - Welcome

• WelcomeBmp - BMP file to show