Konfiguration von DocuWare für Outlook On-Premises

DocuWare für Outlook On-Premises ist ein Add-in, das Ihre lokale DocuWare Installation mit Microsoft Outlook verbindet.

Um diese Integration zu aktivieren, registrieren und konfigurieren Sie zunächst die Microsoft-Entra-App und führen Sie anschließend eine Reihe von Einrichtungsschritten durch, um eine sichere Verbindung zwischen DocuWare und Outlook herzustellen.

Konfigurieren Sie den DocuWare Server, um die Vorbereitung Ihrer Umgebung abzuschließen.

Sobald diese Schritte abgeschlossen sind, können Benutzer E-Mails und Anhänge ganz einfach direkt in ihren On-Premises DocuWare Ablagefächern oder -Schränken speichern und so die Dokumentverwaltung in ihrem Unternehmen optimieren.

Voraussetzungen

Für den Zugriff und die Verwendung des Add-ins ist eine DocuWare Connect-to-Outlook-Lizenz erforderlich.
Die DocuWare Einrichtung wurde ohne Fehler installiert.
Das HTTPS-Zertifikat wird erstellt und der Website in IIS zugewiesen, sodass DocuWare über https://{{YOUR_DOMAIN}}/DocuWare erreichbar ist

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

Einschränkungen

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

Registrierung der Microsoft-Entra-OAuth-App

Erstellen Sie zunächst einen Eintrag für die OAuth-App in Microsoft Entra in der Microsoft-Entra-App. Beispiel:

Die App ist nun erstellt. In den nächsten Schritten konfigurieren Sie die App.

Achten Sie auf korrekte Groß-/Kleinschreibung der SSO-URL
DocuWare für Outlook, verwenden Sie die bei der Einrichtung konfigurierte Groß-/Kleinschreibung. Jeder Unterschied zwischen Groß- und Kleinbuchstaben kann zum Fehlschlagen der SSO-Verbindung führen.

1. Freigeben einer API

Öffnen Sie zunächst API freigeben, um hier eine neue URI-Anwendungs-ID hinzuzufügen.

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

Fügen Sie anschließend den Scope access_as_user hinzu und geben Sie die Daten im rechten Arbeitsbereich ein, zum Beispiel:

Name des Scopes: Fügen Sie „access_as_user” hinzu.
Wer kann zustimmen: Wählen Sie die Option „Administratoren und Benutzer”.
Anzeigename der Administratorzustimmung: Geben Sie „Lesezugriff auf Benutzer-E-Mails und -profile” ein.
Beschreibung der Administratorzustimmung: Verwenden Sie die Beschreibung „DocuWare für Outlook den Lesezugriff auf Benutzer-E-Mails und -profile gewähren”.
Anzeigename der Benutzerzustimmung: Geben Sie „Lesezugriff auf Ihre E-Mails und Ihr Profil” ein.
Beschreibung der Benutzerzustimmung: Verwenden Sie die Beschreibung „DocuWare für Outlook den Lesezugriff auf Ihre E-Mails und Ihr Profil gewähren”.
Bundesland: Wählen Sie die Option „Aktiviert“.

Klicken Sie auf Client-Anwendung hinzufügen und geben Sie die folgende ID ein, um alle Microsoft-Office-Anwendungsendpunkte vorab zu autorisieren.

ea5a67f6-b6f3-4338-b240-c655ddc3cc8e

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

2. Authentifizierung

Weiterleitungs-URIs

Wechseln Sie zur Registerkarte Authentifizierung und fügen Sie die folgenden Weiterleitungs-URIs zum OAuth-Anwendungsregistrierung hinzu.

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

Hinweis: Link ohne HTTPS eingeben
Je nach Version und Microsoft-Region des Administrators kann die Authentifizierungsregisterkarte in Azure unterschiedlich dargestellt werden. In der neuen Standardansicht ist das Hinzufügen von brk-multihub://<Your_DocuWare_URL> nicht möglich. Verwenden Sie in diesem Fall den Link Um zur alten Version zu wechseln, klicken Sie bitte hier, um die URL brk-multihub://<Your_DocuWare_URL> in die vorherige Benutzeroberfläche einzugeben.

Implizite Einwilligung und hybride Datenströme

Wechseln Sie auf derselben Seite zum Abschnitt Einstellungen und stellen Sie sicher, dass Zugriffstoken und ID-Token aktiviert sind.

3. Erstellen eines Client-Secrets

Für eine sichere Verbindung zu Ihrem Office-365-Konto benötigt DocuWare für Outlook ein Secret, das auch in einem späteren Schritt erforderlich sein wird.

4. API-Scopes

4.1 Konfiguration von Microsoft-APIs

Wechseln Sie zur Registerkarte API , um die von DocuWare für Outlook benötigten API-Berechtigungen festzulegen. Das sind alle, die zu Microsoft-Graph-API-Berechtigungen hinzugefügt werden müssen.

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 und geben Sie den Namen der OAuth-Anwendung ein, die Sie gerade erstellen, z. B. „DocuWare für Outlook On-Premises”. Klicken Sie dann auf den Eintrag in der Ergebnisliste.

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

5. Gewähren der Einwilligung des Administrators für die OAuth-App.

Achten Sie darauf, dass Sie die folgenden Werte speichern, die zu Beginn der Konfiguration generiert wurden, als Sie den OAuth-App-Eintrag für das DocuWare On-Premises-System in Microsoft Entra erstellt haben. Sie benötigen diese in den nächsten Schritten:

Microsoft-Mandanten-ID (tenantid)
Client-ID der Anwendung (clientid)
Client-Secret der Anwendung

Mit dieser Aktion wird der Prozess zur Einwilligung des Administrators abgeschlossen. Nachdem Sie Ihre Zustimmung gegeben haben, sollte ein Bestätigungsbildschirm wie der unten abgebildete angezeigt werden.

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

Auf dem DocuWare Server

1. Erweiterung von dwmachine.config

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. etup.Server.Cmd.exe befindet (z  B. C:\Program Files (x86)\DocuWare\Setup Components).

Führen Sie diese Befehle aus, um die erforderlichen Werte zur Datei „dwmachine.config“ auf Ihrem Server 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. Aktivierung von HTTPS für LocalWebServices und AuthorityAddress

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

<Setting Key="LocalWebServices" Value="<https://{{YOUR_DOCUWARE_URL}}/DocuWare/>" Encrypted="false" />

<Setting Key="AuthorityAddress" Value="<https://{{YOUR_DOCUWARE_URL}}/DocuWare/>" Encrypted="false" />

3. Erstellen der Datei „Outlook Manifest.xml“

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

Ersetzen Sie die Platzhalterwerte in der Datei „manifest.xml“ von Outlook durch die tatsächlichen Werte Ihres DocuWare Systems. Insbesondere sollten Sie nach Folgendem suchen:

{{GENERATE_A_UNIQUE_ID}} – ersetzen Sie es durch eine beliebige GUID als Anwendungs-GUID.
{{YOUR_DOCUWARE_URL}} – ersetzen Sie es durch die URL Ihres DocuWare-Systems.
{{YOUR_CLIENTID}} – ersetzen Sie es durch Ihre OAuth-Anwendungs-Client-ID.

Finden Sie Anweisungen zum Erstellen einer neuen GUID mit PowerShell
Wenn Sie eine eindeutige GUID generieren müssen, finden Sie Schritt-für-Schritt-Anweisungen dazu auf dem Microsoft-Dokumentationsportal.

Erweitern Sie diese Option, um auf die Datei manifest.xml von Outlook 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>