Retain Stubbing Server

Stubbing was a new feature added in GroupWise 8, where a message item may be "stubbed". This is accomplished by removing the message permanently from GroupWise and replacing it with an item (a stub) that connects to Retain to access the message. Effectively, the user has transparent access to the stubbed item from their GroupWise client and the stub behaves largely as if a native GroupWise item was still there.

Before enabling stubbing, make sure you understand the way stubbing works and how that will work in your system because once enabled, you cannot reverse the stubbing process. Plan your system and understand the positive and negative sides to Stubbing before you continue. To use stubbing, it is strongly recommended that the GroupWise system be at least 8.02HP1. Previous versions of GroupWise do not contain critical stability fixes.

How Retain Interacts With GroupWise Stubbing

When GroupWise is set up for stubbing and the Stubbing Server is configured in Retain, the archive job that runs will archive all the items and place in their stead in the GroupWise mailbox a "stub". Since the actual message gets placed into the Retain system, GroupWise replaces the original message with a stub that points to the message residing in Retain. A user's GroupWise mailbox will look the same - the user will see a list of messages; however, the icon is different.

When a user clicks on a stubbed message, the GroupWise POA will send a request to the Retain Stubbing Server for the item. Retain sends the item to the POA and the client displays it; however, this does NOT place the message back into GroupWise. When the user closes the message, the stub is all that remains.

The "Restore" feature in Retain does not actually restore the message into GroupWise. It only restores the stub if the stub is missing (user deletes it).

Why Stubbing Is Good

• Save Disk space. Mail can be removed from the system without being deleted.
• Users have easy access to items stored in Retain
• Transparent access, no need to login to Retain for common tasks.

Why Stubbing May Not Work for Your System

• Stubbing CANNOT be reversed. Once a message is stubbed, it cannot be returned to the same position in the system.
• User training for stubbed items may be necessary due to decreased access speed.
• No method for protecting stubs from deletion in the GroupWise client (re-creation is difficult and complicated).
• Non-mail items should not be stubbed (calendar and appointment items behave erratically when rescheduled).
• Stub items are NOT COMPATIBLE with third party APIs. These applications view the stubs as posted items only, with no text or attachments. Mobile, Web, IMAP, and POP3 clients will only see posted empty items, not actual contents.

Determine the correct option for your system. If you wish to enable Stubbing, you need to install and configure the Stubbing Server as well. If you wish to only stub large items in your mail server, you may set a size threshold. Any item larger than the specified size will be stubbed. If this option is not set, all messages will be stubbed regardless of size.

Configuration

To set up stubbing, you must perform the following tasks:

1. You must be running GroupWise 8.0HP1 Post Office Agent(s). Once enabled, the stubbing process cannot be reversed. Stubbing requires GroupWise 8.0HP1. Previous versions of GroupWise do not contain critical stability fixes.

2. ConsoleOne must be configured as discussed below.

3. Retain job profiles must have Stubbing turned on. (see the Profiles section)

4. Stubbing server must be installed and setup as discussed below.

ConsoleOne GroupWise Settings

For the Retain Server to function, GroupWise must be told where the Stub Server is located. In ConsoleOne, connect to the domain and highlight the domain or GroupWise system.

1. Select Tools | GroupWise System Operations | Trusted Applications

2. Select Retain and click Edit.

3. Select "Allow Access to Archive Server".

4. Put the address or DNS name of the Stub Server and the correct port as shown (48080).

5. Click OK and exit the rest of the windows.

You also need to change the settings in the preferences menu:

1. Connect to the domain and highlight the domain or GroupWise system.

2. Select Tools | GroupWise System Operations | System Preferences.

3. Ensure that Retain is set under the Archive Service Settings as a Trusted Application.

4. Select it if it is not already selected and OK your changes.

5. Highlight the Post Office and enter the properties of it.

6. From the GroupWise tab, select "Post Office Settings".

7. Retain should be listed as the Default Archive Service Trusted Application. If it is not set as the default, override and select Retain.

Retain Stubbing Settings

Job profiles must have stubbing enabled for the Server to function. See the Profiles section for details.

Core Settings

The Stub Server must first be enabled in order to allow access to the bootstrap file required for communications. Set the interval as desired (10 min. is lowest recommended setting. Anything lower may be unnecessary).

If you wish to restrict connections to the Stub Server, input the IP address(es) of all the post offices that the Stub Server will service. Use commas to separate multiple addresses.

Save changes before continuing.

Logging

Log levels higher than Normal are not necessary unless troubleshooting or working with Support. It is strongly recommended to compress and remove logs after a time period to protect system space. Set time to desired level.

Connection

The connection to the Retain Server is very important. This must be set to the address of the Retain Server, and is automatically filled out for you. Verify that the Retain Server is located at the specified address and is accessible. Generally you may leave this section default as the Stub Server should be installed local to the Retain Server. If your Retain Server IP address is assigned by DHCP, change the Host Name to the DNS name or localhost (127.0.0.1).

Bootstrap

When you have finished configuring the Stub Server, Save your changes and select the Bootstrap tab (the Bootstrap tab will not be available unless the Stubbing Server has been enabled and settings saved).

Download and save the bootstrap file.

Stubbing Server Interface

Open a new browser tab or window and go to the Stubbing Server. The Stubbing Server answers to http://[IP address of StubServer]:48080/RetainStubServer (the address is case sensitive).

• Click ‘Browse’ and browse to the location where you saved the bootstrap file.
• Select the “StubConfig.cfg” file and select ‘Open’.
• Select the ‘Upload File’ button. After uploading the configuration file, the Stub Server will alert you that it requires authentication from a user with the “Manage Workers” right. Click ‘Continue’.

You can now login to the Stub Server. You must login with a user that has sufficient rights. See the User Rights section to add or remove rights. The Stub Server Interface is nearly identical to the Worker interface. You may check for updated versions of the Stub Server or manually trigger server polling by selecting the Refresh ‘Configuration now’ button.

Check the Server Connection tab to verify the connection to the Server.

The Status tab gives statistics about up-time and function.

The scheduler tab contains the configuration details sent by the Server. This tab is mainly used for Support.