Remote Upgrades - MSI Packages Using SMS - DataArchiver Outlook Add-In


Click on a link below to go to a specific section of the software upgrade:

The procedure on this page describes the steps involved in upgrading the DataArchiver Outlook Add-In component in a non-clustered environment using SMS to remote the MSI upgrade package out to remote clients. The following procedure describes the steps involved in upgrading the DataArchiver Outlook Add-In only.

If you choose to install multiple components simultaneously, refer to the appropriate procedures for installation requirements and steps specific to the component.

Verify that the computer in which you wish to upgrade the software satisfies the minimum requirements specified in the DataArchiver Outlook Add-In Client section of System Requirements - Exchange Mailbox Archiver Agent.

In order to use the DataArchiver Outlook Add-In component, you must install an Exchange Migration Archiver Agent. See Deployment - Exchange Mailbox Archiver Agent or Deployment - Exchange Public Folder Archiver Agent for procedures on installing the Exchange Migration Archiver Agents.

Supported Upgrade Paths

The following table provides a list of supported upgrade paths for the current software version. If the version currently installed on your computer is not listed here, contact your software provider for more information.

Installed Version

Upgrade to Version 8.0.0

Information

     
6.1.0 Supported Perform a direct upgrade to Version 8.0.0.
     
7.0.0 Supported Perform a direct upgrade to Version 8.0.0.

Upgrade Requirements

Review the following before upgrading the software:

General

  • Review the Upgrade Strategy before upgrading the software.
  • Verify that no jobs are in progress or scheduled to occur while the software is being upgraded on the client. If jobs are scheduled, either perform the upgrade at another time or disable all jobs in the client using the Activity Control tab from the Client Computer Properties dialog box in the CommCell Console.

    Once the upgrade is completed, you can enable the jobs from this dialog box.

  • Verify that the CommServe computer is accessible and all services on the CommServe and the MediaAgent in which you wish to perform the upgrade are running.
  • Verify that the SQL Server instance used by the CommServe is running on the CommServe computer.
  • Verify that all applications (CommCell Console, Service Control Manager) are closed.
  • Close all applications and disable any programs that run automatically, including antivirus, screen savers and system utilities. Some programs, including antivirus software, may be running as a service. Stop and disable all non-essential services before you begin. You can re-enable them after the upgrade.
  • The files and folders associated with CommCell components should not be opened by other applications (for example, Windows Explorer, FTP, etc.) on this computer or from other computers during the upgrade.
  • Verify that you have the software installation disc that is appropriate to the destination computer’s operating system.

    Make sure that you have the latest software installation disc before you start to install the software. If you are not sure, contact your software provider.

  • The DataArchiver Outlook Add-In can be remotely upgraded on Outlook clients within your Exchange site using SMS in silent mode. For SMS deployment, you must set up a batch file that contains the upgrade command string for the component and any desired override property parameters. Remote upgrades using SMS are run in silent mode, which requires you to specify the upgrade options ahead of time by selecting the default or override property parameters and including them in the batch file. See Rules and Parameters for more information.

    Once you have set up the batch file, it can be run as a scheduled task on remote machines. This procedure will show you how to set up the batch file for a silent remote upgrade using SMS.

Rules and Parameters

Before setting up a batch file for remotely upgrading this component through SMS, review the rules and parameters listed below to specify the options for installing the upgrade. Note that any previously existing override property parameters must be re-applied as part of the upgrade, because the previous version of the software will be over-written:

Rules:

  • The syntax is PROPERTY="value".
  • The property names must consist of all uppercase letters.
  • The value part of the PROPERTY="value" pair is not case sensitive and should always be enclosed in double quotes.
  • The PROPERTY="value" pairs should not have any white space characters (spaces, tabs) on either side of the "=" character.
  • The PROPERTY="value" pairs should be placed at the end of the command line.
  • If more than one PROPERTY="value" pair is specified, each PROPERTY="value" pair should be separated by at least one space or tab character.

Override Property Parameters:

  • DESTINATION_PATH Overrides the default value used for the upgrade folder. The default value for the upgrade folder is as follows:
    • If you are upgrading the software from 7.0.x to 8.0.x, the default is the previous software installation path.
    • If you are upgrading the software from 6.1.x to 8.0.x, the default is <local path>\Program Files\<default software installation path>  where the <local path> is set by Windows Installer to the path or drive letter containing the Program Files folder. Set this property to either a fully qualified directory or UNC path.
  • DISABLE_AUTO_ARCHIVE_PST
    Overrides the default value used to determine the enabling or disabling of Outlook's AutoArchive and Personal Storage features. Messages that are archived into Personal Storage (.pst) files will not be archived by the Exchange Mailbox Archiver Agent. The default setting of this option is "no", however it is recommended that this property be set to "yes" to disable Outlook's AutoArchive and Personal Storage features. Set this property to either "yes" or "no". This option is only supported for use with the Exchange Mailbox Archiver Agent.
    During the plug-in installation process, the option can be set to disable the use of AutoArchive and PST folders on that client machine. This option sets the disablePST key within the Microsoft Outlook client registry as per the guidance provided in "How to disable the AutoArchive feature and the Personal Folders file feature in Outlook" (http://support.microsoft.com/default.aspx?scid=kb;en-us;258277).
    When PST files are disabled, the user can still mount the existing PST files; however, the user cannot create new PST files under this scenario.
    If the organization plans to engage sharing between Outlook 2003/SharePoint 2003, disabling the PST can cause issues due to the use of a local PST file to support that relationship. See "Microsoft Outlook 2003 Integration with SharePoint Products and Technologies" (http://www.microsoft.com/technet/prodtechnol/sppt/reskit/c4061881x.mspx).
  • MESSAGE_RECOVERY_PROMPT
    Overrides the default value used to determine whether or not users will be prompted before message/item recovery. The default setting of this option is "no". Set this property to either "yes" or "no". This property can be enabled on the client by changing the value of the UIOptions registry key.
  • SELECTIVE_MESSAGE_ARCHIVING
    Overrides the default value used to determine whether or not users will be allowed to select/deselect messages or items for migration archiving operations. The default setting of this option is "yes". Set this property to either "yes" or "no". This property can be enabled on the client by changing the value of the UIOptions registry key.
  • RECOVERY_OPTION
    Overrides the default value for the recovery mode. Set this property to either "overwrite" or "append". The default setting of this option is "overwrite". If Overwrite mode is selected it will cause the stub to be overwritten with a copy of the original message during the recall process. That recalled item may then re-qualify for migration at a future time based on the rules. If Append mode is selected the recalled message will be appended as a new copy to the folder location and the stub will be preserved. If the user deletes the message object they can also recall another copy if the stub still exists.
  • RECOVER_TO_RECOVERED_ITEMS_FOLDER
    Overrides the default value used to determine whether stubs from PST files are recovered to the "Recovered Items" folder. The default setting of this option is "yes".
  • CONNECTION_TYPE
    Overrides the default value for the connection type to communicate with Exchange. Set this property to either "direct" or "https". The default setting of this option is "direct" if Outlook version 11.0 is installed; otherwise the default setting is "https". The "direct" connection type sets the RPC direct mode 8401 and 8402 ports. The "https" connection type is applicable only when the DataArchiver WebProxy Agent for Exchange is installed on an IIS server in the network.
    Also, the 'https" connection type sets the Add-In to support a new RPC over HTTP connection modes for Outlook 2003 to Exchange 2003 over port 443. The Windows .NET framework 1.1 must be loaded on the local client. The .NET Framework version 1.1 is a component of the Microsoft Windows operating system used to build and run Windows-based applications. To determine whether you have this component installed, navigate to and click the Add or Remove Programs icon and scroll through the list of applications. If you see Microsoft .Net Framework 1.1 listed, the latest version is already installed, and you need not install it again. See http://msdn.microsoft.com/netframework/downloads/framework1_1/#sectiondd.
  • CONNECTION_URL
    Specifies the URL to communicate with Exchange. This option is only used when CONNECTION_TYPE is set to "https". Default is <URL>/dmproxy. See Install the DataArchiver WebProxy Agent for Exchange for the appropriate installation procedure.
  • CONNECTION_PORT
    Overrides the default value for the port number used to communicate with Exchange. This option is only used when CONNECTION_TYPE is set to "https". The default setting of this option is 443.
    This port is required for the https or RPC/HTTP Outlook connection mode. Stub recovery is performed through a single, encrypted and authenticated SSL (Secure Sockets Layer) port.
  • SEARCH_ARCHIVED_MESSAGES
    Overrides the default value used to determine whether or not users will be allowed to browse and search archived copies of their messages and folders. The default setting of this option is "yes". This option is supported for use with the Exchange Mailbox Archiver Agent and the Exchange Compliance Archiver Agent, and must be set to "yes" for Exchange Compliance Archiver to support Compliance Searches from Outlook Add-In. This property can be enabled on the client by changing the value of the UIOptions registry key.
  • ERASE_ARCHIVED_MESSAGES
    Overrides the default value used to determine whether or not users will be allowed to erase archived copies of their messages and folders. The default setting of this option is "no". Keep in mind that an Erase Data feature license must be available in the CommServe if this property is set to "yes". This option is only supported for use with the Exchange Mailbox Archiver Agent. This property can be enabled on the client by changing the value of the UIOptions registry key.
  • EVMGRC_PORT
    Overrides the default value for the port number used to communicate with the Client Event Manager (EvMgrC) Service on the Exchange Server.
  • OFFLINE_ARCHIVE
    Overrides the default value used to determine whether or not users will be allowed to archive messages to a local PST file on their computer. The default setting of this option is "no". Set this property to either "yes" or "no".
  • OFFLINE_ARCHIVE_FREQUENCY
    Overrides the default value used to determine the interval of how often the Offline Archive job will execute, in terms of days. This option is only used when OFFLINE_ARCHIVE is set to "yes". Set this property to a number between 1 and 30. The default setting of this option is 1.
  • OFFLINE_ARCHIVE_RUNTIME
    Overrides the default value used to determine the time of day when the Offline Archive job will execute, in terms of whole hours. This option is only used when OFFLINE_ARCHIVE is set to "yes". Set this property to a number between 0 and 23. The default setting of this option is 20 (8:00PM +/- 1 hour).

If you are upgrading the software from 6.1.0 to 8.0.0

  • If you have previously installed an MSI package from a disc, you must upgrade the software using the software installation disc from the current release. Conversely, if you have previously installed an MSI package remotely, you must upgrade the software remotely using the MSI package for the current release.

  • If you have a previous version of the DataArchiver Outlook Add-In installed on the computer and it is version 6.1 or later, then you have the option of either, first uninstalling the existing version before installing the newer version, or install the new version as an upgrade over the existing version.

    To uninstall the DataArchiver Outlook Add-In set up a batch file that contains the following uninstall command and then run it as a scheduled task on remote Outlook clients:

    msiexec.exe /x {ProductCode GUID} /qn /L*v "%TEMP%\Exchange_DM_Client_Uninstall.log"

    Replace {ProductCode GUID} with one of the following appropriate ProductCode GUIDs.

    Version 6.1.0 {4E283D71-097F-4857-A42C-34EC19678362}

    Please contact your software vendor for ProductCode GUIDs for versions later than those listed above.

    Note that the /L*v "%TEMP%\Exchange_DM_Client_Uninstall.log" portion of the above command line is optional and is only used for generating a detailed log file of the uninstallation process.

    In the event that the uninstallation process does not complete successfully, add the following to the end of the above command, to bypass QUninstaller.exe, which may leave unused registry entries under "HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\...":

    EXECUTEQUNINSTALLER="FALSE"

Agent Specific

Before You Begin

  • Log on to a workstation, as local Administrator or as a member of the Administrators group, that is connected to the Outlook clients to be remote installed.

Upgrade Procedure

1. To perform a silent remote upgrade through SMS, set up a batch file that contains the following command strings and any desired override property parameters:

"msiexec.exe" /qn /i "Exchange_DM_Client.msi" PROPERTY="value" /L*v "%TEMP%\Exchange_DM_Client_Install.log"

NOTES:

  • The /L*v "%TEMP%\Exchange_DM_Client_install.log" portion of the above command line is optional and is only used for generating a detailed log file of the installation process in the TEMP folder on the client computer.
  • Replace the PROPERTY="value" portion of the above command line with any desired override property parameters, if you plan on overriding one or more of the default values. See Rules and Parameters for more information.
2. From SMS, run the upgrade installation batch file you set up in the previous step. Once the upgrade has completed, continue on to Post-Upgrade Considerations.

Post-Upgrade Considerations

General

  • Install post-release updates or Service Packs that may have been released after the release of the software. If you are installing a Service Pack, verify and ensure that it is the same version as the one installed in the CommServe Server. Alternatively, you can enable Automatic Updates for quick and easy installation of updates in the CommCell component.

Agent Specific

  • After upgrading the DataArchiver Outlook Add-In, if you set up your install batch file to generate a log of the upgrade installation process, you may want to review the log now to make sure that the upgrade completed successfully.
  • Before using the Outlook Add-In, ensure that the Organizational Forms Library has been set up and configured for special forms. See OFL Configuration for more information.
  • Before using the Outlook Add-In, ensure that the port number used by the Client Event Manager Service is properly configured. Typically, the install program configures this automatically; however, when using custom port numbers you will need to make sure that the port number configured on the Exchange Server under the nEVMGRCPORT registry key matches the port number configured on the Outlook client under registry key nEvMgrCPortNumber. This requirement also applies to multi-instance installs, in which case, you will need to locate the nEVMGRCPORT registry key under the appropriate instance on the Exchange Server. For general information on port number requirements, see Network TCP Port Requirements.

  • We strongly recommend upgrading the Outlook Add-In, and any agents that support it, to the same release version as the CommServe. Otherwise, the Outlook Add-In functionality will be limited or unavailable. For more information, see Backward Compatibility - DataArchiver Outlook Add-In.