Using GroupWise AutoUpdate and SetupIP to Distribute the GroupWise Windows Client

During installation and subsequent updates, the GroupWise® 6.x. Windows client Setup program generally requires user intervention at the workstation to install the client software. By using a configuration file, you can cause installations and updates to occur, simplifying or eliminating the user response during installation. You can also use this configuration file to enable AutoUpdate, which forces updates to take place. This allows you to maintain current versions of the GroupWise software on the network.

NOTE:  This section does not apply to the Cross-Platform client.


Understanding the Configuration File

The use of a configuration file to install GroupWise is often called an administrator-defined setup. The configuration file, setup.cfg, is an ASCII text file that supports extended ASCII characters. The file contains the responses normally provided by the user during the installation of the Windows client files; for example, the path for the client files, whether to complete a workstation or standard installation, and the folder for the GroupWise icon are specified in this file. Information can be added to the configuration file to add predefined LDAP directory service accounts to the Address Book in the client during installation.

When the GroupWise Windows client setup.exe file is executed, it looks in the same directory for a setup.cfg file. If none is found, the installation proceeds, prompting the user for the needed information. If the setup.cfg file is found, the setup program installs the software, using the information outlined in the configuration file. Depending on the entries in the configuration file, the user might or might not be prompted to provide information during the installation.

If you are going to use a configuration file to install Windows client software, users should be given Read and File Scan rights to the software_distribution_directory\client and software_distribution_directory\client\win32 directories. (This does not apply if you are running AutoUpdate over an IP connection.)


Installing with the Configuration File (setup.cfg)

During the installation of GroupWise Administration, the GroupWise client files were copied to the software distribution directory on your server. For example, if you accepted the default z:\grpwise\software as your target, the GroupWise client software was copied to z:\grpwise\software\client\win32.


Installing with a Configuration File (setup.cfg)

  1. Make a backup copy of software_distribution_directory\client\setup.cfg. Using an ASCII text editor, edit the setup.cfg file entries with the values you want. See Modifying the Configuration File for more information.

  2. If you want to add predefined LDAP directory service accounts to the Address Book, follow the procedure in Adding LDAP Directory Service Accounts.

  3. If you want to use AutoUpdate, follow the procedure in Enabling AutoUpdate.

  4. Save setup.cfg > copy the file to the software_distribution_directory\client\win32 directory.

  5. If you want to install additional components on users' workstations, follow the procedure in Modifying the addon.cfg File.

    For information about installing GroupWise Messenger as an additional component by modifying the addon.cfg file, see "Installing the Messenger Windows Client as a GroupWise Windows Client Add-On" in "Managing Messenger Client Users" in the Messenger 1.0 Administration Guide.

If you use several different configuration files, you will need to save them with different names and use the config=setup filename startup switch. See Startup Switches for Administrator-Defined Setup for more information.

To stop setup.exe from using the setup.cfg file, delete setup.cfg from the directory where setup.exe resides.


Setupip.fil File

In previous versions of GroupWise, all language versions of the setupip.fil file, used when running AutoUpdate over an IP connection, were not included on the CD and had to be downloaded from the Novell® Downloads page.

In GroupWise 6.5 Support Pack 1, all non-localized files are included in the setupip.fil file and there is a separate setupip.language_code file for each language (setupip.de, setupip.fr, and so on). All of these files are included in the setupip directory on the GroupWise 6.5 Client CD in Support Pack 1 and do not need to be downloaded separately.

If you did not select all options for Client when you initially created your software distribution directory, you will need to copy the setupip directory from the GroupWise 6.5 Client CD to the software distribution directory. Copy the setupip.fil file and any language-specific setupip.language_code files you want to the HTTP Web server that you will be using for SetupIP. If there are multiple SetupIP files on the Web server, users are prompted for which languages they want to install. For more information, see Enabling AutoUpdate.


Modifying the Configuration File

The configuration file is divided into the following sections. In the configuration file, each section head must be enclosed in brackets [ ] as shown.


[GroupWiseSetup]


Version=

This must match the version being installed; otherwise, the setup program will not use setup.cfg. The default is 6.


StandardInstall=

Specify the type of installation desired. Specify No for a workstation installation, which allows the user to run GroupWise from the network. Specify Yes for a standard installation, which allows the user to run GroupWise from the computer's hard drive. A standard installation is required to use Caching mode and Remote mode. The default is No.


Path=

This is the path where you want GroupWise to be installed during a standard installation. The default path is c:\novell\groupwise\.


Folder=

This will create and install the GroupWise icons to the specified folder. The default folder is GroupWise.


LaunchMessenger=

This optional entry specifies whether GroupWise Notify should be launched when GroupWise starts.


DefaultIPAddress=

This optional entry specifies the default IP address for the client to use the first time it is started.


DefaultIPPort=

This optional entry specifies the default IP port for the client to use the first time it is started.


[ShowDialogs]


HideAllDialogs=

Specify No to display dialog boxes during the installation. Specify Yes to hide the dialog boxes. A progress indicator will be displayed to inform the user of the installation status. The default is No.

If an entry is missing from the setup.cfg file and HideAllDialogs=Yes, the setup program will select the default setting. If HideAllDialogs=No, the setup program will prompt the user for a selection.


Welcome=

Specify Yes to display the Welcome dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SetupOptions=

Specify Yes to display the Setup Options dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


DestinationDirectory=

Specify Yes to display the Destination Directory dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SelectOptionalComponents=

Specify Yes to display the Select Optional Components dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SelectProgramFolder=

Specify Yes to display the Select Program Folder dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SelectStartUpFolderSoftware=

Specify Yes to display the Select Startup Folder Software dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


LanguageSelection=

Specify Yes to display the Language Selection dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SoftwareIntegrations=

Specify Yes to display the Software Integrations dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


StartCopyingFiles=

Specify Yes to display the Start Copying Files dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


SetupComplete=

Specify Yes to display the Setup Complete dialog box during the installation. Specify No to hide this dialog box. The default is Yes.


[AutoUpdate]

When an update to the GroupWise software is available, users are prompted if they want to install the new software when they start GroupWise. For complete instructions on enabling AutoUpdate, see Enabling AutoUpdate.


Enabled=

Specify Yes if you want users to be prompted to update their GroupWise client software as soon as a newer version is available. Specify No if you want to disable the AutoUpdate feature. The ForceUpdate= entry is then ignored. This can be useful if you intend to distribute the client software using a different method such as ZENworks® Application Launcher, or if you want to disable AutoUpdates at the post office level during a migration to a newer version of GroupWise. The default is Yes.


SetupIPEnabled=

The default is No. Specify Yes if you want to run AutoUpdate over an IP connection to a software distribution directory that resides on an HTTP web server.


ForceUpdate=

When this entry is set to Yes, GroupWise automatically updates the users' software. The default is No.

Users can still click Cancel to cancel out of the update; however, they cannot run the client software and access their mailboxes until they update the software.


GraceLoginCount=

Specify the number of grace logins allowed before you will require the users to update their client software. If ForceUpdate is set to No, this entry is ignored.


PromptUntilUpdated=

When PromptUntilUpdated= is set to Yes, the user will be prompted to update the client each time the GroupWise client starts. The user can choose not to install the new software when prompted and still run the currently installed version of the client. The AutoUpdate reminder will appear the next time the user starts the client. The default is No.


[Startup]


Notify=

If you specify Yes, the setup program will place Notify in the Startup folder to be started automatically when the computer starts. The default is No.


[GWTIP]

The Tip of the Day introduces what's new in the GroupWise client, as well as displaying a variety of hints about using GroupWise. A new tip is displayed each time GroupWise is started.


Default=

If you specify No, Tip of the Day will not be installed. If you specify Yes, Tip of the Day will be installed. The default is Yes.


Hide=

If you specify No, Tip of the Day will appear in the Select Components dialog box. The default is No.

The Hide= entry allows the system administrator to force the user to install or not install a particular component. If Hide=Yes, then the component will not be listed in the Select Components dialog and the Default= entry will determine if the component is going to be installed. For example, if Hide=Yes and Default=Yes, then the component will always be installed. However, if Hide=Yes and Default=No, then the component will never be installed.


Workstation=

If you specify No, Tip of the Day will not be available for a workstation installation. If you specify Yes, Tip of the Day will be available for a workstation installation. The default is Yes.


[GWMAILTO]

This section enables Internet Browser Mail Integration, which makes the GroupWise client the default e-mail program in the user's browser. Whenever a user clicks an e-mail link on a Web page or chooses Mail in the browser, the GroupWise client opens.


Default=

If you specify No, Internet Browser Mail Integration will not be installed. If you specify Yes, Internet Browser Mail Integration will be installed. The default is Yes.


Hide=

If you specify No, Internet Browser Mail Integration will appear in the Select Components dialog box. The default is No.

The Hide= entry allows the system administrator to force the user to install or not install a particular component. If Hide=Yes, then the component will not be listed in the Select Components dialog and the Default= entry will determine if the component is going to be installed. For example, if Hide=Yes and Default=Yes, then the component will always be installed. However, if Hide=Yes and Default=No, then the component will never be installed.


Workstation=

If you specify No, Internet Browser Mail Integration will not be available for a workstation installation. If you specify Yes, Internet Browser Mail Integration will be available for a workstation installation. The default is Yes.


[GWCHECK]

This section installs and enables GroupWise Check (also called GWCheck). GroupWise Check is a tool that performs maintenance and repair tasks to keep GroupWise operating efficiently. It is essentially a standalone version of the Mailbox/Library Maintenance feature available in GroupWise Administration in ConsoleOne. GWCheck will check and repair GroupWise user, message, library, and resource databases without having ConsoleOne® and the GroupWise snap-in loaded. In addition to checking post office, user, and library databases, it will also check remote and archive databases.


InstallGWCheck=

Specify Yes to install GWCheck files to the workstation. Specify No to not install GWCheck. The default is Yes.


GWCheckEnabled=

Specify Yes to install the files to the same directory as the GroupWise client, which will result in the Repair Mailbox option being enabled under the Tools menu in the client. Specify No to install the files in a GWCheck subdirectory below the GroupWise client directory, which disables the Repair Mailbox option until the files are manually copied into the GroupWise directory. The default is No.


[IntegrationApps]

GroupWise will install integration for the following applications, if found, unless the entry is set to No.

  • Lotus Word Pro
  • Microsoft Binder
  • Microsoft Excel (versions higher than 7.0)
  • Microsoft Excel 7.0
  • Microsoft Word (versions higher than 7.0)
  • Microsoft Word 7.0
  • Microsoft PowerPoint
  • Corel Presentations
  • Corel Quattro Pro
  • Corel WordPerfect 7.0
  • Corel WordPerfect 8.0
  • Corel WordPerfect 9.0
  • Corel WordPerfect 10.0


[Languages]

The default language is set to English, and all other languages are set to No, meaning they will not be installed. See the setup.cfg file for a listing of the different languages. The GroupWise client might not yet be available in all listed languages.


Adding LDAP Directory Service Accounts

LDAP directory service accounts provide users with the ability to search directory services such as Bigfoot* for names of people. Each search can check potentially millions of names. After locating a name through a directory service search, users can add those names to their personal address books.

You can add predefined LDAP directory service accounts to the Address Book by adding information to setup.cfg. This information can be added even after the initial installation. After the accounts are added, this information does not have to be removed from setup.cfg. During subsequent installations, GroupWise will add any new accounts listed but will not update or duplicate existing LDAP accounts.

The user can also choose to add LDAP directory service accounts after the GroupWise client is installed.

To add an LDAP account during installation, add the following lines to the setup.cfg file, providing information that is specific to the account:

[LDAP Account 1] 
Description=Ldap Server1
Server=ldap.server1.com
Port=389
SearchRoot=c=us
Login=TRUE

You can add multiple accounts:

[LDAP Account 2] 
Description=Ldap Server2
Server=ldap.server2.com
Port=389
SearchRoot=0=widget, c=us
Login=FALSE
Parameter Description
Description=

The name that displays in the list of LDAP directory services in the Address Book.

Server=

The LDAP server name or IP address.

Port=

The LDAP directory service's port number. The number is usually 389.

SearchRoot=

The base or root of the LDAP directory service where the user will search for names. For example, the base could be a country, organization, or other type of grouping. This is not required for all LDAP directory services. If a search root is required, the LDAP directory service will provide the information.

Login=

TRUE means users are prompted for a username and password when they use that LDAP directory service.


Enabling AutoUpdate

AutoUpdate can occur whether users have a mapped drive or IP connection to the software distribution directory. If users have a mapped drive to the software distribution directory, make sure they have Read and Scan rights to the software_distribution_directory\client and software_distribution_directory\client\win32 directories.

IMPORTANT:  To install the GroupWise client using AutoUpdate, you must first make sure GroupWise 6.x Administration and GroupWise 6.x agents have been installed, and that administration, agent, and client software has been updated.

IMPORTANT:  If you did not select all options for Client when you initially created your software distribution directory, you will need to copy the setupip directory from the GroupWise 6.5 Client CD to the software distribution directory. If you are going to use AutoUpdate over an IP connection, copy setupip\setupip.fil to an HTTP web server, or copy the entire client directory to the HTTP web server.

For information about the location of setupip.fil, see Setupip.fil File.

In the following procedure, steps 1-4 apply only if you will be using an IP connection for AutoUpdate.

  1. Run software_distribution_directory\setupip\writeip.exe.

    Specify an IP location for setupip.fil (or the IP location of the software distribution client subdirectory). For example, you can specify:

    http://151.155.135.122/gw65/client

    or

    http://intranet.company.com/software/gw65/gwclient

    You can include proxy and port information, for example:

    http://name.mycompany.com/software/gw65/client;proxy.place.mycompany:1690

    You can specify up to five locations. During AutoUpdate, each location is checked, in order, until a connection is made.

    If you select Choose IP Address at Random, the order in which the locations are checked is selected randomly when AutoUpdate occurs. This will balance the load on the web server.

  2. Specify other options, such as the location for downloading the client installation files (setupip.fil or the client subdirectory files).

    You can have files downloaded to a temporary or specific directory.

    If you select Allow the User to Change the Download Directory, the user is prompted for the location of the download directory and can change the default location.

  3. Click OK.

    The setupip.exe file is created. The writeip.ini file is also created, which stores the options you selected in writeip.exe.

  4. Copy setupip.exe to the software_distribution_directory\client\win32 directory.

  5. Make a backup copy of software_distribution_directory\client\setup.cfg.

  6. Using an ASCII text editor, edit the setup.cfg file entries with the values you want.

    1. Under the [AutoUpdate] heading, specify

      Enabled=Yes
    2. Specify

      ForceUpdate=Yes

      if you want GroupWise to automatically update the users' client software

      or

      ForceUpdate=No

      if you want users to be prompted to update their client software.

    3. Specify the number of grace logins you want to allow a user before forcing an AutoUpdate, for example:

      GraceLoginCount=2

      This entry is ignored if ForceUpdate=No.

    4. If you will be using an IP connection for AutoUpdate, specify

      SetupIPEnabled=Yes
  7. Save the file as setup.cfg. Copy setup.cfg from software_distribution_directory\client to software_distribution_directory\client\win32.

  8. If necessary, modify addon.cfg files with the values you want. See Modifying the addon.cfg File for more information.

  9. Log in to ConsoleOne as an Admin equivalent.

  10. Click Tools > GroupWise System Operations.

  11. Double-click Software Directory Management.

  12. Click the software distribution directory > Update.

  13. Select Force Auto-Update Check by GroupWise Components.

    This causes the GroupWise client to check for a new version. If a new version is found, the next time a user starts the GroupWise client, he or she is prompted to update the client software. If you have set ForceUpdate=Yes, the user will not be prompted before installation begins. If a mapped drive to the software distribution directory is found, the client software is installed from the mapped drive. If a mapped drive to the software distribution directory is not found, GroupWise looks at the IP locations you specified in writeip.ini and installs the client software.

    In the event that no connection to the software distribution directory can be made, the file setupip.err is created in c:\windows of the user's workstation. This file explains why none of the connections could be made.


Modifying the addon.cfg File

The addon.cfg file is an ASCII text file that supports extended ASCII characters. The GroupWise client setup program uses the addon.cfg file to install additional components on users' workstations. The components might include software not shipped with GroupWise. The addon.cfg is specific to each program being installed. The required program files and the associated addon.cfg file must be copied to a subdirectory under software_distribution_directory\client\win32\addons.

During the client installation, the GroupWise setup program will search the subdirectories under the \addons directory for any addon.cfg files. The setup program will then execute the installation program for that component using the settings specified in the addon.cfg. If an entry is missing in the addon.cfg file, the installation program will prompt the user for the required information.

The addon.cfg files for Internet Browser Mail Integration and GroupWise Tip of the Day are included in the corresponding subdirectories under \addons, but the basic control for installing these two components is in the [GWMAILTO] and [GWCHECK] sections of setup.cfg.

For information about installing GroupWise Messenger as an additional component by modifying the addon.cfg file, see "Installing the Messenger Windows Client as a GroupWise Windows Client Add-On" in "Managing Messenger Client Users" in the Messenger 1.0 Administration Guide.

When creating an addon.cfg file for a different component, you must include at least the following section headings and associated entries. If the installation program requires additional information, you can include that information as additional entries. The required entries are as follows:


[GroupWiseAddon]

This section head must be included with the following entries.

Entry Example

Install=add-on's_setup_program_filename

Install=setup.exe

Parameters=parameters_to_be_passed_on_to_the_add-on's_setup_program

Parameters=/install

Silent=parameters_to_append_to_administrator-defined_setup

Silent=/s

Size=installed_size_of_add-on_in_kilobytes

Size=100


[Name]

Under this section head, specify the two-letter language code for the language being installed, followed by the name of the add-on. This name appears in the components listing.

Example: US=GroupWise Tip of the Day


[Description]

Under this section head, specify the two-letter language code followed by a short description of the add-on. This description appears in the Description field when the component is highlighted in the component listing.

Example: US=GroupWise Tip of the Day introduces new features and provides tips for using the GroupWise client.


Error Log File

If an error occurs during the installation and ShowDialogs=No, the error message is logged in gwsetup.err in the user's \windows directory. If ErrorMessage=error_text has been added as the last entry under the [GroupWiseSetup] section, the error text will be displayed. Otherwise, a generic error message will be displayed notifying the user to contact the system administrator. The log file is an ASCII text file.


Startup Switches for Administrator-Defined Setup

The following startup switches can be used in conjunction with an administrator-defined setup. These switches can be used individually or in combination.


config=setup_filename

This runs the setup program using a configuration file other than setup.cfg. The other configuration file must be located in the software distribution directory. This switch does not apply when the GroupWise Windows client setup program is executed by AutoUpdate.

Syntax: config=setup_filename

Example: setup config=test.cfg


noconfig

This runs the setup without using the configuration file, even if one exists.

Syntax: noconfig

Example: setup noconfig


record

This option runs the setup program, displaying all installation dialog boxes, and records the installation responses as they are selected. No installation files are copied and no changes are made to your workstation. After setup finishes, a corresponding setup.cfg file is created in the \windows directory of your workstation.

Syntax: record

Example: setup record