Silent install of the Ad Hoc Transfer Plug-in for Outlook

This topic shows you how to install the Ad Hoc Transfer Plug-in for Outlook on an end user's computer. This plug-in uses the Ad Hoc Transfer Module that must be already installed on the WS_FTP Server computer. Each end user needs to install the plug-in in order to use Outlook to send files via Ad Hoc Transfer.

To automate installation of the client, you can use silent install. This silent install uses the Microsoft Windows Installer and command line options to execute the installation.

You must first manually install Microsoft redistributable packages if they are not already installed on the user's machine, otherwise the client will not install properly.

You must run the installer as Administrator.

You can also silently install the client remotely on multiple computers via Active Directory Group Policy. See Active Directory Group Policy for more information.

Requirements

Before installing the client:

  1. Make sure that the end user's computer meets the requirements in System Requirements.
  2. (All OS; Outlook plug-in only) If not already installed, choose the appropriate architecture and language for the system and download the Microsoft Visual Studio 2010 Tools for Office Runtime (VSTOR 2010) Redistributable from the Microsoft Download Center. Use these commands for silent installations:
    • 32-bit: vstor40_x86.exe /quiet
    • 64-bit: vstor40_x64.exe /quiet
  3. (Non-English OS; Outlook plug-in only) If not already installed, download and install the appropriate Microsoft Visual Studio 2010 Tools for the Microsoft Office System (Version 4.0 Runtime) Language Pack for your OS. Use these commands for silent installs:
    • 32-bit: vstor40_LP_x86_<lang>.exe /quiet
    • 64-bit: vstor40_LP_x64_<lang>.exe /quiet
  4. Ensure Outlook is closed on the computer.

Using the Silent Install Program

The silent install program installs the client for all user accounts on the end user's computer. It does not allow you to run the installation for only the logged on user.

You must run the installer as Administrator.

Use this syntax to run the installer:

msiexec /i [path+executable].msi /q DEFAULT_HOSTNAME="[Ad Hoc Transfer server address]" DEFAULT_SECURE="TRUE" DEFAULT_PORT="443" DRIVER_NAME="xftWSFTPDriver.dll"

Using the silent install with the command shown above (with configuration properties) will install the client and configure the connection to the WS_FTP Server server to use SSL on port 443 for all users on a computer. There are additional properties you can choose depending on the situation.

The install properties are as follows (follow each option with an equals sign and enclose each of the values in quotes):

Property

Description

INSTALLDIR

(Optional) Use this property to specify the install path. The default path is:
32-bit: \Program Files\Ipswitch\Ad Hoc Transfer Plug-in for Outlook
64-bit: \Program Files (x86)\Ipswitch\Ad Hoc Transfer Plug-in for Outlook
Use this command last.

DEFAULT_HOSTNAME

The address of the server where Ipswitch WS_FTP Server and Ad Hoc Transfer Module are installed.

DEFAULT_SECURE

Specify TRUE to use a secure SSL connection (HTTPS) or FALSE to use an unsecure connection (HTTP). The default is TRUE.

DEFAULT_PORT

The port used to connect to Ad Hoc Transfer. For secure SSL connections, this is typically 443. For unsecure connections, this is typically 80. The default is 443.

DEFAULT_LOGFILE

(Optional) Changes the path where the install log is written. The default path is:
\Users\[Username]\AppData\Roaming

DEFAULT_SUPPCERTERRORS

To secure communications, Ipswitch WS_FTP Server sends a certificate back to your local PC. Specify TRUE to suppress any errors related to the certificate coming back from the file transfer server. The errors will not displayed on your PC. Specify FALSE to display any certificate errors.

DEFAULT_DEBUGLEVEL

Sets the level of information to be reported in the Ad Hoc Transfer log file:

NONE - No information is logged

NORMAL - Logs each Ad Hoc transaction

DEBUG - Provides the connection and transfer information, in addition to the transaction.

DRIVER_NAME

You must include DRIVER_NAME="xftWSFTPDriver.dll" in the silent install command. This indicates the Ad Hoc Transfer plug-in version.

After you run the silent install, the default values in the table above can be found in the following folder on the end user's computer:

C:\ProgramData\Ipswitch\Ad Hoc Transfer Plug-in for Outlook\DefaultClientRepositorySettings.xml.

After you run the silent install, the default values in the table above can be found in the following folder on the end user's computer:

C:\ProgramData\Ipswitch\Ad Hoc Transfer Plug-in for Outlook\DefaultClientRepositorySettings.xml

By default, the installation is for "All Users" on the computer. When an end user launches the client or the MOVEit Connector, the default settings information is copied to that user's settings file, so that each user has a settings file. The name of the currently logged on user is added to the settings file. Each user will need to enter their MOVEit password (and possibly their username) to complete the configuration.

For more information on entering the username and password, see End User Configuration.

Silent Install for a Single Computer and a Single User Account

You can use the silent install, with a slightly different set of properties, to install Ad Hoc Transfer Plug-in for Outlook to a specific user account on the machine. In this case, use this syntax to run the installer:

msiexec /i [path+executable].msi /q CONNECTION_HOSTNAME="[Ad Hoc Transfer server address]" CONNECTION_SECURE="TRUE" CONNECTION_USER="[Ad Hoc Transfer username]" CONNECTION_PASS="[Ad Hoc Transfer password]" CONNECTION_PORT="443" DRIVER_NAME="xftWSFTPDriver.dll"

Using the silent install command as shown above will install the plug-in and configure the connection to the Ipswitch WS_FTP Server to use SSL on port 443. The username and password will also be configured, which makes this appropriate only for a single user account on a single computer.

The install properties are shown below (follow each option with an equals sign and enclose each of the values in quotes):

Property

Description

INSTALLDIR

(Optional) Use this property to specify the install path. The default path is:
32-bit: \Program Files\Ipswitch\Ad Hoc Transfer Plug-in for Outlook
64-bit: \Program Files (x86)\Ipswitch\Ad Hoc Transfer Plug-in for Outlook
Use this command last.

CONNECTION_HOSTNAME

The address of the server where Ipswitch WS_FTP Server and Ad Hoc Transfer Module are installed.

CONNECTION_SECURE

Specify TRUE to use a secure SSL connection (HTTPS) or FALSE to use an unsecure connection (HTTP). The default is TRUE.

CONNECTION_USER

The user's Ad Hoc Transfer user name. This is the same as their Ipswitch WS_FTP Server user name. If this property is left blank, it defaults to the user name of the currently logged on user.

CONNECTION_PASS

The user's Ad Hoc Transfer password. This is the same as their Ipswitch WS_FTP Server password.

CONNECTION_PORT

The port used to connect to Ad Hoc Transfer. For secure SSL connections, this is typically 443. For unsecure connections, this is typically 80. The default is 443.

LOG_NAME

(Optional) Changes the name of the install log. The default is: OUTLOOK_PLUGIN.log

LOG_PATH

(Optional) Changes the path where the install log is written. The default path is:
\Users\[Username]\AppData\Roaming

-lv

(Optional) To enable verbose logging by Windows Installer, add the following to the command line:
-lv c:\install.log (or whatever log path and name you have set)

DRIVER_NAME

You must include DRIVER_NAME="xftWSFTPDriver.dll" in the silent install command. This Indicites the Ad Hoc Transfer plug-in version.