LetterMark 5.x autoconfiguration of new users

From wiki
Jump to: navigation, search

Preface

The LetterMark installer contains several command line options to facilitate automatic installation using various and automation systems, systems managements systems and scripting techonologies.

Note: This entry relates to the LetterMark 5.4 or newer. It does not apply to older versions, older versions of LetterMark are not supported.

The LetterMark software must be installed by an administrator as it requires access to the HKEY_LOCAL_MACHINE registry keys for storing its own global settings as well as configuring itself as an Outlook plugin. The software will run as a standard user as long as it has access to write to HKEY_CURRENT_USER\Software\LetterMark and to the users profile directory (%USERPROFILE%\Application Data\LetterMark\).

Command Line Options

The following command line options are available in the LetterMark installer:

/? or /HELP Display help (this message). If this argument is specified, the installer will display the help message and exit, regardless of any other flags. No other actions will occur.
/S Silent or unattended install, do not display any dialogs to the user and defaults will be used for all user options. This MUST be the first argument on the command line.
/Upgrade Used during a silent install to upgrade versions which have already been installed to the new version. If this flag is not specified and the software is already installed, the installation will exit without performing the upgrade. This option prevents removal of existing user settings during the install process. This option also implies /NoRemoveRegKeys.
/Reinstall Used during a silent install to force a reinstall of the software if the version being installed is the same as the currently installed version, or if the version being installed is older than the currently installed version. If this flag is not specified and the version being installed is the same or older than the currently installed version, the install will exit without performing any operations. This option also implies /NoRemoveRegKeys.
/NoRemoveRegKeys Do not remove configuration registry keys during the install or uninstall process. This will prevent the removal of registry keys in HKEY_LOCAL_MACHINE\SOFTWARE\LetterMark. Some values are always reset when the software is installed to ensure they have proper values and repair any possible problems from old installations, so values may change even with this key set. They will not be removed during the uninstall process however. Values in HKEY_CURRENT_USER\Software\LetterMark are never removed.
/CompanyKey=<CompanyKey> Sets the company license key for automatic configuration. This value should be 6 characters and contain only letters A through Z. All users within your company will have the same company key, which is the first 6 characters of each users license key. If this value is set and the users profile has the ntlogin field completed in their profile on www.lettermark.net, the client will automatically configure itself for the user without them providing their license key.
/HideFirstRunDialog Hide the first run license key dialog if a license key is specified with /CompanyKey.
/DefaultTemplate Set the name of the template which will be used as the default for first time users. Users may customize this setting for themselves and override the default using the LetterMark tab in the options dialog after starting Outlook.
/DisablePreviewer Disable the previewer which is normally displayed before sending a message. If the previewer is disable, the message will be sent with the users default template when the user clicks send in the message composer window.
/NoDHTMLCheck Disable the check for and installation of the DHTML component fix required for Windows Vista, Windows 7, and Windows Server 2008. This option causes the installer to completely skip the DHTML portion so no checks or changes will be made relating to the DHTML component during the installation process. Note: Windows Vista, Windows 7, and Windows Server 2008 require the DHTML patch to be installed in order for the LetterMark client software to work properly. Without the DHTML fix, you will not be able to use the LetterMark preview window as well as other errors which result from the missing component. (Available in 5.4.8 and newer only)
/D=<DirectoryName> Specify the directory to install, any argument after the /D= will be considered part of the path and quotes are not required. Because of this, this argument MUST be the last argument passed to the installer.

Note: Changing the install directory is not recommended. The install directory should always be on a local drive, not a network share.

Example

Example:

This example is useful for a Terminal Server/Citrix enviroment, or when used with SMS, Winstall, or Group Policy installations when you do not want the user to have any interaction with the setup process. The executable can be placed on a share that is accessable by all hosts that will have the software installed and then called using a script, Group Policies, System Management Server, Novell ZenWorks or any other technology you wish to use for automated installation. This example assumes your company key is ZZZZZZ, and you have a template named Standard_Template that you wish to be selected by default for all users:

LetterMark_Setup.exe /S /Upgrade /Reinstall /CompanyKey=ZZZZZZ /HideFirstRunDialog /DefaultTemplate=Standard_Template 

In general, when performing unattended installation or upgrades, the /S /UPGRADE and /REINSTALL options should always be used on the command line when calling the installer, this will ensure that the software is installed and will avoid any problems with version conflicts.

It is important to note that the installer should be run without Outlook, or any other MAPI applications open. If these applications are running the installer will uninstall the existing software, but will not be able to remove the existing files. If the installer detects these conditions and is running with the /S option, it will exit without installing the new version of the software. After which, the PC must be rebooted and you must re-run the Installer to complete the upgrade.

Verifying the Install

You can confirm that you the installer was successful by checking for a return value of 0 from the installer process, if the value is not 0 than the installer could not complete successfully. You may also check the registry keys for the installer. This is generally not needed, but included here for those who wish to verify the installation remotely or as part of a software inventory management system. If the following keys exist, and their version numbers match up, the installer has completed successfully and you are using the indicated version:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\LetterMark\MajorVersion
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\LetterMark\MinorVersion
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\LetterMark\PatchLevel
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\LetterMark\Build

For example, at the time of writing this information is as follows:

MajorVersion: 5
Minor Version: 4
PatchLevel: 7
Build: 429

Uninstalling LetterMark

Uninstalling LetterMark should be done using the uninstall.exe that is placed in the LetterMark installation directory at the time it was installed. The uninstaller will cleanup the LetterMark installation and remove the files associated with LetterMark. The uninstaller supports the following command line options:

/? or /HELP Display help (this message). If this argument is specified, the installer will display the help message and exit, regardless of any other flags. No other actions will occur.
/S Silent or unattended install, do not display any dialogs to the user and defaults will be used for all user options. This MUST be the first argument on the command line.
/Upgrade Used during a silent install to upgrade versions which have already been installed to a newer version. If this flag is not specified certain LetterMark settings will be deleted during the process. This option also implies /NoRemoveRegKeys.
/Reinstall Used during a silent install to force a reinstall of the software if the version being installed is the same as the currently installed version, or if the version being installed is older than the currently installed version. If this flag is not specified certain LetterMark settings will be deleted during the process. This option also implies /NoRemoveRegKeys.
/NoRemoveRegKeys Do not remove configuration registry keys during the uninstall process. This will prevent the removal of registry keys in HKEY_LOCAL_MACHINE\SOFTWARE\LetterMark. Some values are always reset when the software is installed to ensure they have proper values and repair any possible problems from old installations, so values may change even with this key set. They will not be removed during the uninstall process however. Values in HKEY_CURRENT_USER\Software\LetterMark are never removed.