DocuWare für Outlook on-premises einrichten

DocuWare für Outlook On-premises verbindet DocuWare on-premises mit Microsoft Outlook.

Um das Add-In zu installieren, registrieren Sie zunächst eine OAuth-Anwendung in Microsoft Entra ID und weisen die erforderlichen Graph-Berechtigungen zu. Dann notieren Sie sich den Mandanten, die Client-ID und das Secret. Fügen Sie anschließend diese Werte dem DocuWare Server (dwmachine.config) hinzu und stellen Sie sicher, dass die DocuWare Site über HTTPS erreichbar ist. Passen Sie abschließend das Outlook-Manifest mit Ihrer DocuWare-URL und der Client-ID an und stellen Sie das Manifest auf den gewünschten Outlook-Clients bereit.

Wenn diese Schritte abgeschlossen sind, können Benutzer von einem DocuWare On-premises-System, E-Mails und Anhänge direkt in ihre Briefkörbe oder Archive ablegen.

Voraussetzungen und Einschränkungen

Voraussetzungen:

Für den Zugriff auf das Add-in und dessen Nutzung ist eine DocuWare Connect to Outlook-Lizenz erforderlich.
Das DocuWare-Setup wurde ohne Fehler installiert.
Das HTTPS-Zertifikat wird erstellt und der Website im IIS zugeordnet, so dass die gesamte DocuWare über https://{{YOUR_DOMAIN}}/DocuWare zugänglich ist.

Stellen Sie sicher, dass der Aufruf von https://{{YOUR_DOMAIN}}/DocuWare/Outlook erfolgreich ist.

Einschränkungen:

Das Speichern von E-Mails aus einem geteilten Postfach wird in der Desktop-Version (Classic) von Microsoft Outlook nicht unterstützt.
Die In-App-Feedback-Funktion ist nicht verfügbar, da DocuWare für Outlook On-Premises keine Verbindung zur DocuWare Cloud herstellen kann, um Feedback zu übermitteln.

Registrierung der Entra OAuth-App

Um DocuWare für Outlook On-premises mit Ihren Outlook-Clients verwenden zu können, muss eine OAuth-App-Registrierung in Microsoft Entra erstellt werden.

Wechseln Sie zur Registrierung von Microsoft Entra App und erstellen Sie eine neue App, z. B.:

Nun wird die App erstellt. In den nächsten Schritten konfigurieren Sie die App.

1. Bereitstellen einer API

Öffnen Sie zunächst API verfügbar machen , um hier einen neuen Anwendungs-ID-URI hinzuzufügen.

Fügen Sie im rechten Fensterbereich Ihre DocuWare URL zur Anwendungs-ID-URI hinzu und speichern Sie.

Fügen Sie als Nächstes den access_as_user Bereich hinzu, und füllen Sie die Daten im rechten Fensterbereich aus, zum Beispiel:
- Scope name: access_as_user
- Who can consent: Administratoren und Benutzer
- Admin consent display name: Schreibgeschützter Zugriff auf Benutzer-E-Mails und -Profile.
- Admin consent description: DocuWare für Outlook darf schreibgeschützten Zugriff auf die E-Mails und Profile der Benutzer erhalten.
- User consent display name: Schreibgeschützter Zugriff auf Ihre E-Mails und Ihr Profil.
- User consent description: Erlauben Sie DocuWare für Outlook, schreibgeschützten Zugriff auf Ihre E-Mails und Profile zu erhalten.
- State: Aktiviert

4. Klicken Sie auf Clientanwendung hinzufügen, und geben Sie die folgende ID ein, um alle Microsoft Office-Anwendungsendpunkte im voraus zu autorisieren.

ea5a67f6-b6f3-4338-b240-c655ddc3cc8e

Diese ID ist für alle Microsoft-Anwendungsendpunkte gültig.

2. Authentifizierung

Redirect Uris

Wechseln Sie zur Registerkarte Authentifizierung , und fügen Sie der OAuth-Anwendungsregistrierung die folgenden Umleitungs-Uris hinzu:

https://YOUR_DOCUWARE_URL/DocuWare/Outlook-Frontend/
https://YOUR_DOCUWARE_URL/DocuWare/Outlook-Frontend/auth
https://YOUR_DOCUWARE_URL/DocuWare/Outlook-Frontend/login
https://YOUR_DOCUWARE_URL/DocuWare/Outlook-Frontend/adminConsentResult.html
brk-multihub://YOUR_DOCUWARE_URL

Hinweis zum Eingeben eines LInks ohne HTTPS
Je nach Microsoft-Version und Region des Administrators kann die Registerkarte „Authentifizierung“ in Azure unterschiedlich dargestellt werden. In der neuen Standardansicht ist es nicht möglich, den Link brk-multihub://<Ihre_DocuWare_URL> hinzuzufügen. Verwenden Sie in diesem Fall den Link Um zur alten Ansicht zu wechseln, klicken Sie bitte hier, um die URL brk-multihub://<Ihre_DocuWare_URL> in der vorherigen Oberfläche einzugeben.

Implizite Berechtigungen und hybride Abläufe

Stellen Sie auf derselben Seite sicher, dass Access tokens und ID-Tokens aktiviert sind.

3. Client secret erstellen

DocuWare für Outlook benötigt außerdem ein Secret, um eine sichere Verbindung zum Office 365-Konto des Benutzers herzustellen.

Dieses Secret wird in einem späteren Schritt benötigt.

4. API scopes

4.1 Microsoft-APIs

Wechseln Sie auf die Registerkarte API-Berechtigungen, um die API-Berechtigungen zu definieren, die DocuWare für Outlook benötigt. Diese müssen alle als Microsoft Graph-API-Berechtigungen hinzugefügt werden.

email
offline_access
openid
profile
Contacts.Read
Contacts.Read.Shared
MailboxSettings.Read
MailboxSettings.ReadWrite
Mail.Read
Mail.ReadWrite
Mail.ReadWrite.Shared
User.Read

4.2 APIs, die Ihre Organisation verwendet

Klicken Sie erneut auf Berechtigung hinzufügen, wechseln Sie zu APIs, die meine Organisation verwendet, geben Sie den Namen der OAuth-App ein, die Sie gerade erstellen (z. B. DocuWare für Outlook on-premises) und klicken Sie auf den Eintrag in der Ergebnisliste.

Aktivieren Sie abschließend access_as_user und klicken Sie auf Berechtigung hinzufügen.

5. Erteilen der Administrator-Einwilligung für die OAuth-App

Dieser Schritt muss vom globalen Administrator von Microsoft Azure AD durchgeführt werden.

Notieren Sie sich die folgenden Werte. Sie benötigen diese in den nächsten Schritten.

Microsoft Tenant ID (tenantid)
Application Client ID (clientid)
Application Client Secret

Dies ist der letzte Schritt für die Administrator-Einwilligung. Nachdem Sie die Einwilligung erteilt haben, muss der Bildschirm aussehen wie unten gezeigt.

Notieren Sie sich Ihre Microsoft-Mandanten-ID (tenantid), die Client-ID (clientid) der Anwendung und das Client Secret der Anwendung, die Sie in den nächsten Schritten benötigen.

Auf dem DocuWare Server

1. dwmachine.config erweitern

Wechseln Sie zu dem Server, auf dem DocuWare installiert ist, und öffnen Sie ein PowerShell-Terminal mit Administratorrechten für den Ordner, in dem sich DocuWare.Setup.Server.Cmd.exe befindet (z. B. C:\Program Files (x86)\DocuWare\Setup Components).

Führen Sie diese Befehle aus, um der Datei dwmachine.config des Servers die erforderlichen Werte hinzuzufügen.

./DocuWare.Setup.Server.Cmd.exe configureMachine --key="D4O.TenantId" --value="theTenantGuid"

./DocuWare.Setup.Server.Cmd.exe configureMachine --key="D4O.OfficeClientId" --value="theClientId"

./DocuWare.Setup.Server.Cmd.exe configureMachine --key="D4O.OfficeClientSecret" --value="theClientSecret" --encrypted

2. HTTPS für LocalWebServices und AuthorityAddress aktivieren

Da Outlook erfordert, dass Ihre Anwendung über HTTPS gehostet wird, ist es wichtig, dass die URL funktioniert und als HTTPS angegeben wird.

<Einstellung key="LocalWebServices" value="<https://{{YOUR_DOCUWARE_URL}}/DocuWare/>" Encrypted="false" />

<Einstellung key="AuthorityAddress" value="<https://{{YOUR_DOCUWARE_URL}}/DocuWare/>" Encrypted="false" />

3. Outlook-Manifest.xml-Datei erstellen

Greifen Sie auf die Outlook-manifest.xml-Datei zu (verfügbar im erweiterbaren Abschnitt unten) und kopieren Sie den XML-Text in eine lokale Datei auf Ihrem Desktop. Im nächsten Schritt sollten Sie einige Platzhalterwerte ersetzen und den XML-Code für den späteren Upload vorbereiten.

Ersetzen Sie die Platzhalterwerte in der Outlook-manifest.xml-Datei durch die tatsächlichen Werte aus Ihrem DocuWare-System. Genauer gesagt sollten Sie suchen nach:

{{GENERATE_A_UNIQUE_ID}} und ersetzen Sie sie durch eine beliebige GUID als Anwendungs-GUID
{{YOUR_DOCUWARE_URL}} und ersetzen Sie diese durch die URL Ihres DocuWare-Systems
{{YOUR_CLIENTID}} und ersetzen Sie sie durch die Client-ID Ihrer OAuth-Anwendung.

Hilfe zur Erstellung einer neuen GUID mit PowerShell
Wenn Sie eine eindeutige GUID erstellen müssen, finden Sie eine Schritt für Schritt-anleitung in der Dokumentation von Microsoft.

Erweitern Sie diese Option, um auf die Outlook-manifest.xml-Datei zuzugreifen.

<?xml version="1.0" encoding="UTF-8"?>

<OfficeApp
	xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0"
	xmlns:mailappor="http://schemas.microsoft.com/office/mailappversionoverrides/1.0"
	xsi:type="MailApp">
	<Id>{{GENERATE_A_UNIQUE_ID}}</Id>

	<Version>3.0</Version>
	<ProviderName>DocuWare</ProviderName>
	<DefaultLocale>en-US</DefaultLocale>
	<DisplayName DefaultValue="DocuWare" />
	<Description DefaultValue="DocuWare for Outlook" />
	<IconUrl DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/assets/docuware-64.png" />
	<HighResolutionIconUrl DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/assets/docuware-128.png" />
	<SupportUrl DefaultValue="https://support.docuware.com/en-US/" />

	<AppDomains>
		<AppDomain>https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend</AppDomain>
		<AppDomain>https://login.microsoftonline.com</AppDomain>
	</AppDomains>

	<Hosts>
		<Host Name="Mailbox" />
	</Hosts>
	<Requirements>
		<Sets>
			<Set Name="Mailbox" MinVersion="1.1" />
		</Sets>
	</Requirements>
	<FormSettings>
		<Form xsi:type="ItemRead">
			<DesktopSettings>
				<SourceLocation DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/" />
				<RequestedHeight>250</RequestedHeight>
			</DesktopSettings>
		</Form>
	</FormSettings>

	<Permissions>ReadWriteMailbox</Permissions>
	<Rule xsi:type="RuleCollection" Mode="Or">
		<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
	</Rule>
	<DisableEntityHighlighting>false</DisableEntityHighlighting>

	<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
		<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1"
		                  xsi:type="VersionOverridesV1_1">
			<Requirements>
				<bt:Sets DefaultMinVersion="1.5">
					<bt:Set Name="Mailbox" />
				</bt:Sets>
			</Requirements>

			<Hosts>
				<Host xsi:type="MailHost">
					<Runtimes>
						<Runtime resid="LaunchEventMainPage">
							<Override type="javascript" resid="ClassicRuntimeScript"/>
						</Runtime>
					</Runtimes>
					<DesktopFormFactor>
						<SupportsSharedFolders>true</SupportsSharedFolders>
						<FunctionFile resid="MainPage" />
						<ExtensionPoint xsi:type="MessageReadCommandSurface">
							<OfficeTab id="TabDefault">
								<Group id="docuwareGroupId">
									<Label resid="paneTitle" />
									<Control xsi:type="Button" id="msgReadOpenPaneButton">
										<Label resid="paneTitle" />
										<Supertip>
											<Title resid="paneTitle" />
											<Description resid="paneDescription" />
										</Supertip>
										<Icon>
											<bt:Image size="16" resid="icon16" />
											<bt:Image size="32" resid="icon32" />
											<bt:Image size="80" resid="icon80" />
										</Icon>
										<Action xsi:type="ShowTaskpane">
											<SourceLocation resid="MainPage" />
											<SupportsPinning>true</SupportsPinning>
										</Action>
									</Control>
								</Group>
							</OfficeTab>
						</ExtensionPoint>
						<ExtensionPoint xsi:type="MessageComposeCommandSurface">
							<OfficeTab id="TabDefault2">
								<Group id="composeGroup">
									<Label resid="paneTitle" />
									<Control xsi:type="Button" id="msgComposeOpenPaneButton">
										<Label resid="paneTitle" />
										<Supertip>
											<Title resid="paneTitle" />
											<Description resid="paneDescription" />
										</Supertip>
										<Icon>
											<bt:Image size="16" resid="icon16" />
											<bt:Image size="32" resid="icon32" />
											<bt:Image size="80" resid="icon80" />
										</Icon>
										<Action xsi:type="ShowTaskpane">
											<SourceLocation resid="MainPage" />
											<SupportsPinning>true</SupportsPinning>
										</Action>
									</Control>
								</Group>
							</OfficeTab>
						</ExtensionPoint>
						<ExtensionPoint xsi:type="LaunchEvent">
							<LaunchEvents>
								<LaunchEvent Type="OnNewMessageCompose" FunctionName="onNewMessageCompose"/>
								<LaunchEvent Type="OnMessageSend" FunctionName="onMessageSendHandler" SendMode="SoftBlock" />
							</LaunchEvents>
							<SourceLocation resid="LaunchEventMainPage"/>
						</ExtensionPoint>
					</DesktopFormFactor>
					<MobileFormFactor>
						<ExtensionPoint xsi:type="MobileMessageReadCommandSurface">
							<Group id="mobileMsgRead">
								<Label resid="paneTitle" />
								<Control xsi:type="MobileButton" id="mblRestPaneButton">
									<Label resid="paneTitle" />
									<Icon xsi:type="bt:MobileIconList">
										<bt:Image size="25" resid="icon16" scale="1"/>
										<bt:Image size="32" resid="icon32" scale="1"/>
										<bt:Image size="48" resid="icon80" scale="1"/>
										<bt:Image size="25" resid="icon16" scale="2"/>
										<bt:Image size="32" resid="icon32" scale="2"/>
										<bt:Image size="48" resid="icon80" scale="2"/>
										<bt:Image size="25" resid="icon16" scale="3"/>
										<bt:Image size="32" resid="icon32" scale="3"/>
										<bt:Image size="48" resid="icon80" scale="3"/>
									</Icon>
									<Action xsi:type="ShowTaskpane">
										<SourceLocation resid="MainPage" />
									</Action>
								</Control>
							</Group>
						</ExtensionPoint>
					</MobileFormFactor>
				</Host>
			</Hosts>

			<Resources>
				<bt:Images>
					<bt:Image id="icon16" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/assets/docuware-16.png" />
					<bt:Image id="icon32" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/assets/docuware-32.png" />
					<bt:Image id="icon80" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/assets/docuware-80.png" />
				</bt:Images>
				<bt:Urls>
					<bt:Url id="MainPage" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/" />
					<bt:Url id="LaunchEventMainPage" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/" />
					<bt:Url id="ClassicRuntimeScript" DefaultValue="https://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/classic-outlook.runtime.js" />
				</bt:Urls>
				<bt:ShortStrings>
					<bt:String id="paneTitle" DefaultValue="DocuWare" />
				</bt:ShortStrings>
				<bt:LongStrings>
					<bt:String id="paneDescription" DefaultValue="DocuWare - the ultimate add-in for integrating emails and their attachment into business processes.">
						<bt:Override Locale="de" Value="DocuWare - Das ultimative Add-In zur Integration von E-Mails und ihren Anhängen in Geschäftsprozesse." />
						<bt:Override Locale="fr" Value="DocuWare - Le module idéal pour intégrer des e-mails et de leurs pièces jointes dans les processus opérationnel." />
						<bt:Override Locale="es" Value="DocuWare - El complemento definitivo para integrar correos electrónicos y sus archivos adjuntos en los procesos." />
						<bt:Override Locale="ja" Value="DocuWare - 電子メールとその添付ファイルをビジネスプロセスに統合するための高度なアドイン。" />
					</bt:String>
				</bt:LongStrings>
			</Resources>
			<WebApplicationInfo>
				<Id>{{YOUR_CLIENTID}}</Id>
				<Resource>api://{{YOUR_DOCUWARE_URL}}/DocuWare/Outlook-Frontend/{{YOUR_CLIENTID}}</Resource>
				<Scopes>
					<Scope>openid</Scope>
					<Scope>profile</Scope>
					<Scope>offline_access</Scope>
					<Scope>email</Scope>
					<Scope>User.Read</Scope>
					<Scope>Mail.ReadWrite</Scope>
					<Scope>Mail.ReadWrite.Shared</Scope>
					<Scope>MailboxSettings.ReadWrite</Scope>
				</Scopes>
			</WebApplicationInfo>
		</VersionOverrides>
	</VersionOverrides>
</OfficeApp>

Add-In für Office 365-Benutzer ausrollen

Nachdem nun alle Voraussetzungen erfüllt sind, kann die Manifest-Datei mit Ihren DocuWare Systemwerten für den Rollout an Office 365-Benutzer verwendet werden.

Folgen Sie der Schritt-für-Schritt-Beschreibung des Einrichtungs- und Rollout-Prozesses.