66.1 Using GroupWise AutoUpdate and SetupIP to Distribute the GroupWise Windows Client

During installation and subsequent updates, the GroupWise® 7.x Windows client Setup program (setup.exe) by default requires user intervention at the workstation in order to install the client software. However, by using a setup configuration file (setup.cfg), you can simplify or eliminate the user responses during installation, and you can cause installations and updates to occur at specific times.

With AutoUpdate enabled, users are prompted to update their Windows client software, but they are not required to update and they can turn off the update prompt. If you want, you can force users to update their client software immediately, or you can allow them a specified number of grace logins to the existing version before you force them to update. This allows you to maintain current versions of the Windows client software on the network.

By default, AutoUpdate requires user workstations to have a mapped drive to the client\win32 directory in the software distribution directory. However, with SetupIP enabled, users can install the Windows client software by way of a TCP/IP connection to a Web server and a mapped drive is not necessary

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

66.1.1 Preparing to Use AutoUpdate

Your preparation for implementing AutoUpdate depends on whether users install the Windows client software from a mapped drive or a TCP/IP connection.

Verifying the Windows Client Software in the Software Distribution Directory

In order for AutoUpdate to function correctly, the Windows client software must be available in the client subdirectory of the software distribution directory that is assigned to each post office on the Post Office Settings property page of each Post Office object.

Post Office Settings page

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

Depending on the size of your GroupWise system, you might have created additional software distribution directories after your initial installation, as described in Section 4.9, Software Directory Management. Before you enable AutoUpdate, ensure that all software distribution directories contain the Windows client software that you want to distribute to users.

Accessing the Windows Client Software from a Mapped Drive

If you want to use AutoUpdate to install the Windows client software from a software distribution directory on a mapped drive, users must be given Read and File Scan rights to the following directories:

software_distribution_directory\client
software_distribution_directory\client\win32

In addition, when AutoUpdate runs, user workstations must have a drive mapped to the following directory:

software_distribution_directory\client\win32

Skip to Section 66.1.2, Using the Setup Configuration File.

Accessing the Windows Client Software from a TCP/IP Connection to a Web Server

If you want to enable SetupIP so that users do not need a mapped drive to the software distribution directory, you must configure your Web server to provide the Windows client software to users. You can make the Windows client software available on as many as five Web servers. This section walks you through setting up and testing the first Web server. Repeat the procedure as needed for additional Web servers.

  1. Create a subdirectory in the documents directory of your Web server for the Windows client software:

    Web Server

    Documents Directory

    Apache 2 on NetWare® 6.5

    sys:\apache2\htdocs
    

    Apache 1.3 on NetWare 6

    sys:\apache\nwdocs
    

    Netscape Enterprise Server for NetWare on NetWare 6

    sys:\novonyx\suitespot\docs
    

    Apache 2.2 on Linux

    /srv/www/htdocs
    

    Microsoft Internet Information Server (IIS) 5 on Windows Server 2000/2003/2003 R2

    \inetpub\wwwroot
    

    For example, you could create a subdirectory named gw7client in the documents directory of your Web server.

  2. In the new client directory, create a win32 directory.

  3. Browse to the following directory:

    software_distribution_directory\admin\utility\setupip
    
  4. In the setupip directory, run writeip.exe.

    WriteIP dialog box
    1. In the IP Addresses list, specify the location of the client directory you created in Step 1 above.

      For example, you could specify:

      http://172.16.5.18/gw7client
      

      or

      http://intranet.corporate.net/gw7client
      

      You can include proxy and port information, for example:

      http://intranet.corporate.net/gw7client;proxy.corporate:1690
      

      When you set up multiple Web servers, each location is checked in order during AutoUpdate, 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 balances the load on each Web server.

    2. Select other download options as desired to control how the Windows client downloads the software from the Web server.

      Download to a Temporary Directory: Select this option if you want the Windows client to download the updated software, install it, then delete the temporary location so that no trace is left on each user’s workstation.

      Download to a Specific Directory: Select this option if you want to control the directory on each user’s workstation where the Windows client software is downloaded. This option allows you to choose whether the installation image remains on each user’s workstation, the quantity of files to download, and whether each user can choose the location for the installation image. If you allow users to choose the location, users are prompted for the download directory.

    3. Click OK.

      The writeip.exe program now creates a customized setupip.exe program. In addition, it creates a writeip.ini file that stores the options you selected when you ran writeip.exe.

    4. If you are installing in a multilingual environment and you want to suppress the language prompt during installation, add a section similar to the following to the writeip.ini file:

      [Language]
      ShowLanguageDialog=No
      Language=Yes
      

      where Language is on of the languages listed in the setup.cfg file. Add a Language line for each language that you want installed on each user’s workstation. Without this section in the writeip.ini file, users are prompted to choose among the available languages.

  5. From the setupip directory, copy the new setupip.exe file to the software_distribution_directory\client\win32 directory.

  6. Copy the setupip.fil file from the setupip directory to the new client directory you created on the Web server in Step 1.

    The setupip.fil file contains all of the Windows client software files that are language independent.

  7. To support the languages in use by Windows client users, copy setupip.xx files from the setupip directory to the client directory you created on the Web server in Step 1.

    The setupip.xx files (where xx represents a two-letter language code) contain all of the Windows client software files that are language specific.

  8. Continue with Using the Setup Configuration File.

66.1.2 Using the Setup Configuration File

The setup configuration file (setup.cfg) is an ASCII text file that supports extended ASCII characters. Its default location is the following directory:

software_distribution_directory\client

This is not the same directory where the Windows client Setup program (setup.exe) is located:

software_distribution_directory\client\win32

Therefore, by default, when a user runs the Setup program, the user must respond to the prompts that the Setup program displays, because the setup configuration file is not available.

The setup configuration file contains the responses normally provided by the user during the installation of the Windows client software. For example, the path for the client files, the folder for the GroupWise icons, and whether to automatically launch Notify are specified in this file. In addition, information can be added to the setup configuration file to add predefined LDAP directory service accounts to the Address Book in the client during installation.

If you modify the default setup configuration file and copy it to the same directory where the Setup program is located (that is, to the win32 directory), the Setup program reads the setup configuration file and performs the installation according to the entries in the file. Depending on the entries in the setup configuration file, the user might or might not be prompted to provide information during the Windows client installation.

66.1.3 Modifying the Setup Configuration File

The setup configuration file (setup.cfg) is divided into the sections listed below. In the setup configuration file, each section head must be enclosed in brackets [ ] as shown in the list.

Make a backup copy of the setup configuration file, then modify the file as needed so that the Setup program (setup.exe) performs the Windows client software installation the way you want it to, when you enable AutoUpdate.

[GroupWiseSetup]

Version=

Specifies the GroupWise version being installed. It must match the actual version being installed; otherwise, the Setup program does not use the setup configuration file. The default is 7.0.

Path=

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

Folder=

Specifies the Windows folder where GroupWise icons are created. The default is Novell GroupWise.

On the Windows Start menu, icons are provided for the GroupWise client, Notify, and the GroupWise Address Book.

LaunchMessenger=

Specifies whether GroupWise Messenger should be launched when GroupWise starts. The default is No.

LaunchNotify=

Specifies whether GroupWise Notify should be launched when GroupWise starts. The default is No.

OutlookFirewallException=

Specifies whether Outlook should be added to the Windows XP Firewall exceptions list. The default is Yes, which adds Outlook to the exceptions list.

IPAddress=

Optionally specifies the IP address for the client to always use (as opposed to the first time it starts). Use this setting to set the IP address per post office when using multiple post offices.

IPPort=

Optionally specifies the port for the client to always use (as opposed to the first time it starts)

DefaultIPAddress=

Optionally specifies the default IP address for the client to use the first time it starts. This should be an IP address that everyone on the system has access to (for example, ngwnameserver).

DefaultIPPort=

Optionally specifies the default port for the client to use the first time it starts.

StopService=

Optional stops a service and restarts the service after installation is complete. This is helpful when a particular service is preventing the installation from functioning properly.

[ShowDialogs]

ShowDialogs=

Specify No to hide dialog boxes during the installation. Specify Yes to show the dialog boxes. The default is Yes.

If an entry is missing from the setup configuration file and ShowDialogs=Yes, the Setup program selects the default setting. If ShowDialogs=No, the Setup program prompts the user for a selection.

ShowProgress=

Specify Yes to show the progress indicator during the installation. Specify No to hide the progress indicator during installation. The default is Yes.

Show Finish=

Specify Yes to display the Finish 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 Section 66.1.6, Enabling AutoUpdate.

Enabled=

Specify Yes if you want users to be prompted to update their Windows client software as soon as a newer version is available. Specify No if you want to disable the AutoUpdate feature. The default is Yes.

If you specify No, the ForceUpdate= entry below is ignored. This can be useful if you intend to distribute the client software by using a different method, such as ZENworks® Desktop Management, or if you want to disable AutoUpdate at the post office level during a migration to a newer version of GroupWise.

SetupIPEnabled=

Specify Yes if you want AutoUpdate to obtain the Windows client software from a Web server, as described in Accessing the Windows Client Software from a TCP/IP Connection to a Web Server. The default is No, which means that AutoUpdate needs a mapped drive by default.

ForceUpdate=

Select Yes if you want GroupWise to automatically update the users’ software. The default is No.

Users can still click Cancel to cancel the update. However, they cannot run the GroupWise client and access their mailboxes until they do update the client software.

GraceLoginCount=

Specify the number of grace logins allowed before you require the users to update their client software. The default is 0 (zero).

If ForceUpdate is set to No above, this entry is ignored.

PromptUntilUpdated=

Specify Yes if you want GroupWise to prompt the user to update the client each time the GroupWise client starts, until the user does update the client software. The default is No, which means that, if the user chooses not to update the client software, the user is allowed to continue running the current version indefinitely.

[Startup]

Notify=

Specify Yes to place Notify in the Windows Startup folder so that it starts automatically when the computer starts. The default is No.

In the GroupWise client, users can configure GroupWise to start Notify automatically by using Tools > Options > Environment > Launch Notify on Startup.

[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 is not installed. If you specify Yes, Tip of the Day is installed. The default is Yes.

Hide=

If you specify No, Tip of the Day appears 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 is not listed in the Select Components dialog box and the Default= entry determines if the component is going to be installed. For example, if Hide=Yes and Default=Yes, then the component always is installed. However, if Hide=Yes and Default=No, then the component is never installed.

[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 appears in the Select Components dialog box. The default is No.

Hide=

If you specify No, Internet Browser Mail Integration appears 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 is not listed in the Select Components dialog box and the Default= entry determines if the component is going to be installed. For example, if Hide=Yes and Default=Yes, then the component is always installed. However, if Hide=Yes and Default=No, then the component is never installed.

[PDAConnect]

This section installs PDA Connect, which makes it possible to synchronize GroupWise with a PDA device.

Default=

If you specify No, PDA Connect is not installed. If you specify Yes, PDA Connect is installed. The default is No.

Hide=

If you specify No, the user sees the PDA Connect installation dialog boxes. If you specify Yes, the user does not see the PDA Connect dialog boxes. 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 is not listed in the Select Components dialog box and the Default= entry determines if the component is going to be installed. For example, if Hide=Yes and Default=Yes, then the component is always installed. However, if Hide=Yes and Default=No, then the component is never installed.

Silent=

If you specify No, the PDA Connect install runs normally. If you specify Yes, the PDA Connect install runs without user interaction and installs the translators for the device that is detected (Palm*, Pocket PC, or both). This setting also exists under \client\win32\addons\pdaconnect\addon.cfg. The default is No.

PDA Connect is not an install option unless the user has either Palm Desktop or ActiveSync* installed.

[GWCheck]

This section installs and enables GroupWise Check (GWCheck). GWCheck is a tool that performs maintenance and repair tasks on GroupWise databases in order to keep GroupWise running smoothly.

GWCheck is a standalone version of the Mailbox/Library Maintenance feature available in ConsoleOne®. GWCheck checks and repairs 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 can also check remote and archive databases that cannot be accessed by ConsoleOne because they are not available on the network.

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 (grpwise.exe), which results 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 installs integrations for the following applications, if found, unless the entry is set to No.

  • Microsoft Excel

  • Microsoft Word

  • Microsoft PowerPoint

  • Corel* Presentations*

  • Corel Quattro Pro*

  • Corel WordPerfect*

[Languages]

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

66.1.4 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 the setup configuration file. This information can be added even after the initial installation. After the accounts are added, this information does not need to be removed from setup configuration file. During subsequent installations, GroupWise adds any new accounts listed but does 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 configuration 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

Table 66-1 LDAP Account Parameters

Parameter

Description

Description=

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

Server=

The LDAP server DNS hostname or IP address.

Port=

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

SearchRoot=

The base or root of the LDAP directory service where the user searches 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 provides the information.

Login=

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

66.1.5 Testing Your AutoUpdate Configuration

Before you enable AutoUpdate for client users, you should test the modifications you have made to the setup configuration file.

  1. Copy the modified setup.cfg file from the client directory to the win32 directory in the software distribution directory.

  2. On your own workstation or a test workstation, run setup.exe in the win32 directory.

  3. If the Windows client installation goes as planned, continue with Step 5 if you are using SetupIP.

    or

    If client workstations will be updated from the same software distribution directory where you just tested the setup.exe program, skip to Section 66.1.6, Enabling AutoUpdate.

  4. If the Windows client installation does not go as planned, review your modifications to the setup.cfg file, as described in Section 66.1.3, Modifying the Setup Configuration File, then return to Step 1 repeat the test.

  5. After you can install successfully from the software distribution directory, copy the modified setup.cfg file from the client directory to the win32 directory on the Web server.

  6. E-mail the setupip.exe file to yourself.

  7. On your own workstation or a test workstation:

    1. Make sure you are connected to the Internet, so that you can access the Web server where the Windows client software is located.

    2. Run setupip.exe.

      Because you have already tested your setup configuration file, installation from the Internet should also run as expected.

  8. If you encounter problems with setting up AutoUpdate and SetupIP, more detailed background information and instructions are provided in:

    Although these documents reference earlier versions of GroupWise, the AutoUpdate and SetupIP strategies still apply.

  9. When testing is successful, continue with Enabling AutoUpdate.

66.1.6 Enabling AutoUpdate

After you have customized the setup configuration file (setup.cfg) and tested it, you are ready to enable AutoUpdate. After AutoUpdate is enabled, Windows client users start experiencing client software updates the next time they start the Windows client. They might or might not be prompted and they might or might not see information displayed during the update, depending on your customized entries in the setup configuration file.

  1. In ConsoleOne, click Tools > GroupWise System Operations > Software Directory Management.

    Software Distribution Directory Management dialog box
  2. Select the software distribution directory, then click Update.

    Update Software Distribution Directory dialog box
  3. Select Force Auto-Update Check by GroupWise Components.

    This causes the GroupWise client to check for a new version each time it starts. If a new version is found, the user is prompted to update the client software, unless you set ForceUpdate=Yes in the setup configuration file.

    If a mapped drive to the software distribution directory is found on the user’s workstation, the client software is installed from the mapped drive. If a mapped drive to the software distribution directory is not found on the user’s workstation, GroupWise checks the Web server locations you specified using writeip.exe and installs the client software from one of those locations.

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

  4. Repeat Step 1 through Step 3 for each software distribution directory where you have updated the software and modified the setup configuration file.

66.1.7 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 searches the subdirectories under the \addons directory for any addon.cfg files. The setup program then executes the installation program for that component by using the settings specified in addon.cfg. If an entry is missing in the addon.cfg file, the installation program prompts the user for the required information.

The addon.cfg files for Internet Browser Mail Integration, PDA Connect, 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], [PDAConnect], and [GWTip] 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 Novell Messenger 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.

Table 66-2 GroupWise Add-On Parameters

Entry

Example

Install=add-on_setup_program_filename

Install=setup.exe

Parameters=parameters_for_add-on_setup_program

Parameters=/install

Silent=parameters_for_administrator-defined_setup

Silent=/s

Size=installed_add-on_size_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 selected in the component listing.

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

66.1.8 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 is displayed. Otherwise, a generic error message is displayed notifying the user to contact the system administrator. The log file is an ASCII text file.