Page tree
Skip to end of metadata
Go to start of metadata

The installer for the Outlook Addin 4.1 has been written in WixSharp.

 

The following parameters can be set:

Parameter Name
Version
Valid Input
Effect
Notes
ALLUSERS4.1.0"" or "1"

"": User scope install, default

"1": Per machine install

Is ignored when upgrading, as a 
upgrade is only possible when 
keeping the user scope.

INSTALLDIR4.1.0"" or valid path

"": will be installed to default location ("C:\Program Files\FTAPI\FTAPI Outlook AddIn")

"PATH": will be installed to specified PATH

Is ignored when upgrading, as the
installer gets the old install location
USEFTAPI4.1.0"" or "Y"

"": DefaultAlwaysSendWithFTAPI RegKey will not be set

"Y": DefaultAlwaysSendWithFTAPI RegKey will be set to 1

Always send with FTAPI when using the "Send button"
in Outlook instead of the normal Outlook send.

SAVEUSERDATA4.1.0"" or "Y"

"": SaveUserData RegKey will not be set

"Y": SaveUserData RegKey will be set to 1

Saves the user data when activated.
SHOWFORMATTINGWARNING4.1.0"" or "Y"

"": ShowFormattingWarning RegKey will not bet set

"Y": ShowFormattingWarning RegKey will be set to 1

Shows a warning when sending level 4 mails saying that
formatting will be lost during encryption.
SECURITYCHECK4.1.0"" or "Y"

"": SecurityCheck RegKey will not be set

"Y": SecurityCheck RegKey will be set to 1

Warns the user if he clicks the normal Outlook "Send button"
and asks if he wants to send with FTAPI. 

If USEFTAPI is specified, this setting will be ignored.

NOAUTOLOGIN4.1.0"" or "Y"

"": AutoLogin RegKey will be set to 1

"Y": AutoLogin RegKey will be set to 0

When specified, auto login will not be set.
LOCKSETTINGS4.1.0"" or "Y"

"": DisableUserSettings RegKey will not be set

"Y": DisableUserSettings RegKey will be set to 1

Disables the settings form for the user, the user can't
change any settings.

SHOWFTAPIATTACHBUTTON4.1.0"" or "N"

"": ShowFTAPIAttachButton RegKey will be set

"N": ShowFTAPIAttachButton RegKey will be set to 0

By default the FTAPI Attach button is shown. 

SECURITYLEVEL4.1.0

Integer level value or ""

"": SecurityLevel RegKey will not be set

"INTVALUE": SecurityLevel RegKey will be set to INTVALUE

Defines the default security level that is being used.
DEFAULTEXPIRATIONPERIOD4.1.0Integer level value or ""

"": DefaultExpirationPeriod RegKey will not be set

"INTVALUE": DefaultExpirationPeriod RegKey will be set to INTVALUE

Defines the default expiration period of a mail that
is being sent.

ATTACHSIZE4.1.0Integer level value or ""

"": DefaultAttachmentSizeLimit RegKey will not be set

"INTVALUE": DefaultAttachmentSizeLimit RegKey will be set to INTVALUE

Defines the size of the attached files at which FTAPI
will automatically be used to send mails.

If USEFTAPI is specified, this setting will be ignored.

SERVER4.1.0

"" or valid domain, e.g.

"test.com"

"": DefaultServerURL RegKey will not be set

"VALIDDOMAIN": DefaultServerURL RegKey will be set to VALIDDOMAIN

Defines the default server that the user will be logged in to.
RECIPIENTSEXCLUDEDDOMAINS4.1.0

"" or Valid mail domain, e.g.

"test.com" or valid domains

e.g. "@test.com; @test1337.de"

"": RecipientsExcludedDomains RegKey will not be set

"VALIDDOMAINS": RecipientsExcludedDomains RegKey will be set to VALIDDOMAINS

FTAPI is not used when sending a mail to the specified 
recipient domain.

 

DOMAINS4.1.0

"" or Valid mail domain, e.g.

"@test.com" or valid domains

e.g. "@test.com; @test1337.de"

"": RecipientsSpecificDomains RegKey will not be set

"VALIDMAILDOMAINS": RecipientsSpecificDomains RegKey will be set to VALIDMAILDOMAINS

FTAPI is automatically used when sending a mail to the
specified recipient domain.

If USEFTAPI is specified, this setting will be ignored.

SELECTEDLANGUAGE4.1.0

"" or vaild CultureInfo.Name e.g. "en-US"

or "de-DE"

"" SelectedLanguage RegKey will not be set

"SELECTEDLANGUAGE". SelectedLanguage RegKey will be set to specified STRINGVALUE

The Culture of the FTAPI Add-In (and all its text) is set to

the specified language (if supported).

This decides the language of the text displayed Add-In and

the initially selected Default Download Button Language.

DEFAULTDOWNLOADBUTTONLANGUAGE4.1.0

"" or vaild CultureInfo.Name e.g. "en-US"

or "de-DE"

"" DefaultDownloadButtonLanguage will not be set

"DEFAULTDOWNLOADBUTTONLANGUAGE". DefaultDownloadButtonLanguage RegKey will be set to specified STRINGVALUE

The default language of the Inserted "Download" button for is set to the specified language (if supported).

This decides the default language of the Download Button,

Attachments and Encryption text sent with FTAPI Emails.

DEFAULTDOWNLOADBUTTONLOCATION4.1.0

"" or "Top", "Middle" or "Bottom"

"" DefaultDownloadButtonLocation RegKey will not be set (The Outlook Add-in will default to "Middle" in user config upon first launch). DefaultDownloadButtonLocation RegKey will be set to specified STRINGVALUE.

The "Middle" setting will try to insert the Download Button (if not manually inserted by the user) above the Signature or at the end for Reply or Forward composition. This code can be slow for some Outlook users so "Top" and "Bottom" can also set instead to insert the Download button at those positions in the email respectively. 

DEFAULTDOWNLOADDIRECTORY4.1.0"" or a valid writable directory on the installation computer

"" DefaultDownloadDirectory RegKey will not be set (The Outlook Add-in will default to using the users "C:\users\[USER NAME]\Downloads" directory)

"DEFAULTDOWNLOADDIRECTORY". DefaultDownloadDirectory RegKey will be set to specified STRINGVALUE.

 
ENABLESSO4.1.0"" or "Y"

"" EnableSSO RegKey will not be set.

"Y": EnableSSO RegKey will be set to 1

When set to yes, the Outlook add-in will attempt to connect using the users Windows credentials to log into the FTAPI Server.
HIDEINSERTDOWNLOADBUTTON4.1.0"" or "Y"

"" HideInsertDownloadButton will not be set

"Y" HideInsertDownloadButton will be set to 1

If set the user will not be abled to see the "Download button" (that allows them to manually place the Download Link) in the UI. The Download Button will will be inserted automatically using the DefaultDownloadButtonLocation setting.
ARCHIVEUPLOADEDATTACHMENTMAXSIZEMB4.1.0Integer level value or ""

"": ArchiveUploadedAttachmentMaxSizeMB RegKey will not be set

"INTVALUE": ArchiveUploadedAttachmentMaxSizeMB RegKey will be set to INTVALUE

When set to a value of 1 (MB) or greater, any attachments sent via FTAPI whose total size is less that set value will be reattached unencrypted to the Sent Email for Archiving purposes.

E.g. If you set this value to "5" (MB) and you send two attachments via an FTAPI Mail of sizes 3 MB and 1 MB, after the FTAPI email has been sent, those attachments will be reattached to the sent mail in your Sent Mail folder.

ARCHIVEDOWNLOADEDATTACHMENTMAXSIZEMB4.1.0Integer level value or ""

"": ArchiveDownloadedAttachmentMaxSizeMB RegKey will not be set

"INTVALUE": ArchiveDownloadedAttachmentMaxSizeMB RegKey will be set to INTVALUE

When set to a value of 1 (MB) or greater, any attachments downloaded using "Download" in the Ribbon bar for Sent Mails, whose total size is less that set value, will be attached unencrypted to the Received Email for Archiving purposes.

E.g. If you set this value to "5" (MB) and you download an FTAPI Mail Attachment of 4 MB, those download attachment/attachments will be attached to that Received Mail in your inbox.

REQUESTTIMEOUTSECS4.1.0Integer level value or ""

"": RequestTimeoutSecs RegKey will not be set

"INTVALUE": RequestTimeoutSecs RegKey will be set to INTVALUE

If not set, each Http Request the Outlook Add-in makes will be set to timeout using the .Net default of 100 seconds.

You ONLY need to set this value to something higher if you are on a particually slow connection and are finding that you are getting "TaskCancelled" exceptions when Uploading or Downloading via the FTAPI Outlook Add-in.

UNENCRYPTEDSEGMENTSIZEBYTES4.1.3Integer value or ""

"": UnencryptedSegmentSizeBytes will not be set

"INTVALUE": UnencryptedSegmentSizeBytes RegKey will be set to INTVALUE

If not set Level 1 and 2 attachments will be uploaded in the default 25MB segments.

 

ENCRYPTEDSEGMENTSIZEBYTES4.1.3Integer value or ""

"": EncryptedSegmentSizeBytes will not be set

"INTVALUE": EncryptedSegmentSizeBytes RegKey will be set to INTVALUE

If not set Level 3 and 4 attachments will be uploaded in the default 25MB segments.

"" equals not set at all.
Parameters which are not valid will result in the Installation to be aborted. This will be logged in the MSI installation log, i.e.:

RECIPIENTSEXCLUDEDDOMAINS Property was set wrong. Please refer to the manual. Not a valid domain or mail. Canceling Install!
CustomAction ValidateParameters returned actual error code 1603 (note this may not be 100% accurate if translation happened inside sandbox)

will appear NEAR the bottom of the install log.

The following default MSI parameters have been tested:

Parameter NameExample in command promptUseNotes
/qInstaller.msi /qperforms a silent install

Dependencies will NOT be installed 
due to MSI restrictions

 

The following registry keys (leave alone the parameters registry keys as described above):

When user installation, HKEY_CURRENT_USER is being used.
When computer installation, HKEY_LOCAL_MACHINE is being used.
The parameter reg keys are being created in SOFTWARE\FTAPI\Outlook Plug-in

In 64-Bit Computers both keys will be created, in WOW6432Node (32bit-registry) and the normal one.

Registry KeyValueCondition
SOFTWARE\Microsoft\Office\Outlook\Addins\FTAPI Outlook Add-In\Description"FTAPI Outlook Add-In"always
SOFTWARE\Microsoft\Office\Outlook\Addins\FTAPI Outlook Add-In\FriendlyName"FTAPI Outlook Add-In"always
SOFTWARE\Microsoft\Office\Outlook\Addins\FTAPI Outlook Add-In\LoadBehavior

3

for custom values, see https://msdn.microsoft.com/de-de/library/bb386106.aspx#LoadBehavior

always
SOFTWARE\Microsoft\Office\Outlook\Addins\FTAPI Outlook Add-In\Manifest"[INSTALLDIR]FTAPIOutlookAddin2013.vsto|vstolocal"always
SOFTWARE\FTAPI\InstallInfo\INSTALLDIRPath of installalways

Upgrade behavior

When you are upgrading an no parameters are specified, the installer keeps the old settings.
When you are upgrading and parameters are set, the old config file will be deleted and the new settings will be applied.

Installing to network shares

When selecting a UNC Adress (e.g. \\server\share) as installation path, make sure the share is being trusted by the administrator else the add-in is not going to launch and an entry in the Windows Event Viewer from "VSTO 4.0" will be generated.
See https://msdn.microsoft.com/en-US/library/bb772087.aspx for further information and https://support.office.com/en-us/article/add-remove-or-change-a-trusted-location-7ee1cdc2-483e-4cbb-bcb3-4e7c67147fb4?ocmsassetID=HA010031999&CorrelationId=83b2fc04-4f05-4354-9879-6fcca99535c8&ui=en-US&rs=en-US&ad=US on support on how to add your share/network drive to the trusted sites.

Basic example

CommandEffects
Installer.msi SERVER="test.com" ALLUSERS="1" USEFTAPI="Y" ATTACHSIZE="42" /qQuiet install with the specified parameters


Creation of Transform files (.mst)

  1. In order to create transform files you may use SuperOrca (http://www.pantaray.com/msi_super_orca.html).

  2. Install SuperOrca and open it.
  3. Create a copy of the .msi installer with da different name, e.g. "FTAPIOutlookAddInInstallerSmall_de-DE-MODIFIED.msi", so that you have the same installer twice in the same folder
  4. Open up the Modified .msi in SuperOrca by going to File→Open
  5. Navigate to "Property" on the left side
  6. Do a right click on the big field where the properties are listed and click "Add Row..."
  7. Enter the Property name that you want to specify and it's corresponding value. 
    See the possible property names and values in the table on the top. It could look like this:

    Hit OK.
  8. Do this for every property you want to add.
  9. When finished, go to Tools→Compare MSI files and select the original .msi file as "MSI File2"
  10. Assure that all your changes are right. and close the window.
  11. Go to Tools→Transform two files
  12. For the Base MSI file, select the original MSI.
  13. For the Modified MSI file, select the copied MSI.
  14. Hit "Create Transform" and select the location on where you want to save the transform to
  15. You have successfully created your transform!

 

 

  • No labels