Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Es ist möglich, das FTAPI-Outlook Add-In (in Form eines .msi-Softwarepakets) mit der Kommandozeile oder entsprechender Verteilungssoftware auszurollen.

 

Nach folgenden Beispielaufrufen können Sie mithilfe der Optionen die Verteilung vornehmen:

Info
titleBeispielaufruf
AddInSetup.msi INSTALLLOCATION="D:\ftapi\outlook" ALLUSERS="Y" SERVER="beispiel.ftapi.com" USEFTAPI="Y" ATTACHSIZE=100 DOMAINS="@ftapi.com;@gmail.com"
Info
titleBeispielaufruf mit msiexec
msiexec /i AddInSetup.msi /l*v "log.log" ATTACHSIZE=100 SERVER=”beispiel.ftapi.com” WARNINGS="Y" NOAUTOLOGIN="Y"

 

Die Optionen, die hierbei verwendet werden können, sind in folgenden Tabellen festgehalten:

  

Installationsparameter für FTAPI:

OptionBedeutungBeispiele
INSTALLLOCATION

Legt den Zielordner für die Installation fest.

TARGETDIR="D:\ftapi"
ALLUSERSLegt fest, ob die Software für alle Nutzer auf diesem System installiert werden soll.

ALLUSERS="Y" (für aktivieren)

ALLUSERS="" (für nicht aktivieren)

SERVER Die Server-URL des FTAPI-SystemsSERVER=”beispiel.ftapi.com”
DEFAULTEXPIRATIONPERIODStandardgültigkeitsdauer in TagenDEFAULTEXPIRATIONPERIOD="85" 
ATTACHSIZE Anhangsgröße, ab der FTAPI verwendet werden soll in MBATTACHSIZE=15
SAVEUSERDATAStandardmäßig die eingegebenen Zugangsdaten speichern

SAVEUSERDATA="Y" (für aktivieren)

SAVEUSERDATA="" (für nicht aktivieren)
USEFTAPI Legt fest, ob FTAPI standardmäßig verwendet werden soll.

USEFTAPI="Y" (für aktivieren)

USEFTAPI="" (für nicht aktivieren)
WARNINGSLegt fest, ob Warnungen immer unterdrückt werden sollen.

WARNINGS="Y" (für aktivieren)

WARNINGS="" (für nicht aktivieren)
SECURITYCHECK

Abfrage für den Nutzer, wenn er mit Dateien im Anhang den regulären "Senden"-Knopf drückt,

ob mit FTAPI versendet werden soll.

SECURITYCHECK="Y" (für aktivieren)

SECURITYCHECK="" (für nicht aktivieren)
DOMAINS

Domänen oder E-Mailadressen, an die immer mit FTAPI versendet werden soll

DOMAINS="@ftapi.com;@gmail.com"
NOAUTOLOGINLegt fest, ob der automatische Login des Add-Ins übersprungen werden soll.

NOAUTOLOGIN="Y" (für aktivieren)

NOAUTOLOGIN="" (für nicht aktivieren)
REMOVESETTINGSLegt fest, ob beim Upgrade einer alten Version die Nutzereinstellungen gelöscht werden sollen.

REMOVESETTINGS="Y" (für aktivieren)

REMOVESETTINGS="" (für nicht aktivieren)
PROXYTYPELegt die Art der Proxykonfiguration fest.

PROXYTYPE="DETECT_AUTOMATICALLY" (für automatische Erkennung)
PROXYTYPE="DIRECT_CONNECTION" (für eine Verbindung ohne Proxy)
PROXYTYPE="MANUAL_SETTINGS" (für manuelle Einstellung)

PROXYSERVERADDRESSDie Adresse des Proxy-Servers

PROXYSERVERADDRESS="proxy.firma.intern"
PROXYSERVERADDRESS="10.110.1.25"

PROXYSERVERPORTDer Port des Proxy-ServersPROXYSERVERPORT="8080"

PROXYAUTHENTICATIONREQUIRED

Legt fest, ob Proxy-Authentifikation verwendet werden soll, oder nicht.

PROXYAUTHENTICATIONREQUIRED="Y" (für aktivieren)
PROXYAUTHENTICATIONREQUIRED="" (für nicht aktivieren)

 

Systemspezifische Optionen für .msi-Pakete:

 OptionParameterBedeutung
/aPackage

Administrative Installation des Pakets.

/xPackage|ProductCode

Deinstalliert die Software.

/L[i|w|e|a|r|u|c|m|o|p|v|x|+|!|*] Logfile

Schreibt Logging-Informationen in eine Protokolldatei im angegeben Pfad. Der Pfad zur Logdatei muss bereits existieren, da der Installer die Ordnerstruktur nicht verändert.

Die Parameter geben an, welche Informationen protokolliert werden sollen. Wenn keine Parameter gesetzt werden, wird standardmäßig 'iwearmo' verwendet.

 

i - Statusmeldungen

w - Nicht schwerwiegende Warnungen

e - Alle Fehlermeldungen

a - Aktionsstart

r - Aktionsspezifische Einträge

u - Nutzeranfragen

c - Initiale Oberflächenparameter

m - Out-of-memory oder schwerwiegende Informationen zum Installationsabbruch

o - Out-of-disk-space Informationen

p - Terminal-Einstellungen

v - ausführliches Logging

x - Debugging-Informationen

+ - An existierende Datei anhängen

! - Jede Zeile ins Log schreiben

* - Wildcard, alle Optionen außer v und x

/qn|b|r|f

Legt das User Interface Level fest.

 

q , qn - kein UI

qb - einfaches UI. Nutzen Sie qb!, um den Abbrechen-Knopf zu verstecken.

qr - eingeschränktes UI ohne modales Dialogfenster am Ende der Installation.

qf - Volles UI mit allen FatalError-, UserExit-, oder Exit-Dialogfenstern.

qn+ - kein UI außer einem modalen Dialogfenster am Ende der Installation.

qb+ - einfaches UI mit einem modalen Dialogfenster am Ende. Dieses Fenster wird nicht angezeigt, wenn der Nutzer die Installation abbricht. Nutzen Sie qb+! um den Abbrechen-Knopf zu verstecken.

qb- - einfaches UI ohne modale Dialogfenster. Nutzen Sie qb-! um den Abbrechen-Knopf zu verstecken.

/? or /h 

Zeigt Copyrightinformationen für den Windows Installer an.

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

 

The following parameters can be set:

Parameter NameValid InputEffectNotes
ALLUSERS"" 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.

INSTALLDIR"" 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
USEFTAPI"" 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.

SAVEUSERDATA"" or "Y"

"": SaveUserData RegKey will not be set

"Y": SaveUserData RegKey will be set to 1

Saves the user data when activated.
SHOWFORMATTINGWARNING"" 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.
SECURITYCHECK"" 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.

NOAUTOLOGIN"" 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.
LOCKSETTINGS"" 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.

SECURITYLEVEL

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.
DEFAULTEXPIRATIONPERIODInteger 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.

ATTACHSIZEInteger 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.

SERVER

"" 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.
RECIPIENTSEXCLUDEDDOMAINS

"" 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.

 

DOMAINS

"" 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.

    

"" 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"file:///[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