オンプレミス環境での DocuWare for Outlook の設定

Prev Next

オンプレミス環境での DocuWare for Outlook は、ローカルの DocuWare インストールと Microsoft Outlook をリンクさせます。  

アドインをインストールするには、最初に Microsoft Entra ID で OAuth アプリケーションを登録し、必要な Graph のアクセス許可を割り当てて、テナント、Client ID、Secret をメモします。 次に、これらの値を DocuWare サーバー (dwmachine.config) に追加し、DocuWare のサイトが HTTPS を介してアクセス可能であることを確認します。 最後に、DocuWare の URL とクライアント ID を用いて Outlook マニフェストをカスタマイズし、必要な Outlook クライアントにマニフェストを展開します。  

上記の手順が完了すると、ユーザーはメールと添付ファイルをオンプレミス環境の DocuWare 文書トレイまたはファイルキャビネットに直接保存できるようになります。

前提条件と制限事項

前提条件:

  • アドインにアクセスして使用するには、DocuWare Outlook 連携のライセンスが必要です。

  • DocuWare Setup がエラーなくインストールされている必要があります。

  • HTTPS の証明書が作成され、IIS 内の Web サイトに割り当てられている必要があります。これにより、DocuWare 全体が https://{{YOUR_DOMAIN}}/DocuWare を介してアクセスできるようになります。

https://{{YOUR_DOMAIN}}/DocuWare/Outlook への呼び出しが正常に完了することをご確認ください

制限事項:

  • 共有メールボックスからのメールの保存は、Microsoft Outlook のデスクトップ版 (従来版) ではサポートされていません。

  • アプリ内のフィードバック機能はご利用いただけません。これは、オンプレミス環境での DocuWare for Outlook がフィードバックの送信を目的として DocuWare Cloud に接続することができないためです。

Entra OAuth アプリの登録

オンプレミス環境での DocuWare for Outlook を Outlook クライアントとともに使用するには、Microsoft Entra で OAuth アプリの登録を作成する必要があります。

"Microsoft Entra アプリの登録" に移動し、以下のようにアプリを作成します。

これでアプリが作成されました。 次の手順では、アプリの構成を行います。

1. API を公開する

  1. 最初に "APIを公開する" を開き、ここで新しいアプリケーション ID URI を追加します。

  1. 右側のパネルでアプリケーション ID URI に DocuWare の URL を追加し、"保存" をクリックします。

  1. 次に、範囲 "access_as_user" を追加し、右側のウィンドウから以下のデータを入力します。

    • 範囲名: access_as_user

    • 同意の対象: 管理者およびユーザー

    • 管理者の同意の表示名: ユーザーのメールおよびプロファイルに対する読み取り専用アクセス権限。

    • 管理者の同意の説明: DocuWare for Outlook がユーザーのメールおよびプロファイルに対する読み取り専用のアクセス権限を保持することを許可します。

    • ユーザーの同意の表示名: あなたのメールおよびプロファイルに対する読み取り専用アクセス権限。

    • ユーザーの同意の説明: DocuWare for Outlook があなたのメールおよびプロファイルに対する読み取り専用のアクセス権限を保持することを許可します。

    • 状態: 有効

4. "クライアントアプリケーションを追加する" を選択して以下の ID を入力し、すべての Microsoft Office アプリケーションのエンドポイントを事前承認します。

ea5a67f6-b6f3-4338-b240-c655ddc3cc8e 

この ID は、Microsoft アプリケーションのすべてのエンドポイントで有効です。

2. 認証

リダイレクト URI

"認証" タブに切り替えて、OAuth アプリケーションの登録に以下のリダイレクト URI を追加します。

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

注: HTTPS を除外したリンクの入力

管理者の Microsoft のバージョンおよびリージョンによっては、Azure の "認証" タブの表示が異なっている可能性があります。 新しいデフォルトのビューでは brk-multihub://<Your_DocuWare_URL> を追加することはできません。 このような場合には、"従来のエクスペリエンスに切り替えるには、こちらをクリックしてください" をクリックし、従来のインターフェースの brk-multihub://<Your_DocuWare_URL> URL を入力してください。  

暗黙の許可とハイブリッドフロー

同じページで、アクセストークンIDトークンが有効化されていることをご確認ください。

3. Client Secret を作成する

DocuWare for Outlook では、ユーザーの Office 365 アカウントに安全に接続するためにもシークレットが必要となります。

このシークレットは後の手順で必要となります。

4. API の範囲

4.1 Microsoft API

"API のアクセス許可" タブに切り替えて、DocuWare for Outlook が必要とする API のアクセス許可を定義します。 これらはすべて Microsoft Graph API のアクセス許可として追加されます。

  • 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 組織が使用する API

"アクセス許可を追加" をもう一度クリックし、"組織が使用する API" に切り替えます。現在作成している OAuth アプリの名前 (例: オンプレミス環境での DocuWare for Outlook) を入力し、結果リストの中の項目をクリックします。

最後に access_as_user にチェックを入れ、"アクセス許可を追加" をクリックします。

5. OAuth アプリに管理者の同意を付与する

次の手順で必要となる以下の値を必ず記録に残してください。

  • Microsoft テナント ID (tenantid)

  • アプリケーションクライアント ID (clientid)  

  • アプリケーション Client Secret  

この操作を完了することで管理者の同意プロセスが終了します。 同意を付与した後は、以下のような確認の画面が表示されるはずです。

この手順は、Microsoft Azure AD のグローバル管理者が実行する必要があります

DocuWare サーバーでの作業

1. dwmachine.config を拡張する

DocuWare がインストールされているサーバーに切り替え、管理者権限を持った状態で DocuWare.Setup.Server.Cmd.exe が存在するフォルダー (例: C:\Program Files (x86)\DocuWare\Setup Components) で PowerShell ターミナルを開きます。

サーバーの dwmachine.config ファイルに必要な値を追加するには、以下のコマンドを実行します。

./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. LocalWebServices および AuthorityAddress に対して HTTPS を有効にする

Outlook を利用する際はアプリケーションを HTTPS を介してホストする必要があるため、URL が機能し、HTTPS として明示されていることが非常に重要となります。

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

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

3. Outlook の Manifest.xml ファイルを作成する

Outlookmanifest.xml ファイル (下記の展開可能なセクションの中にあります) にアクセスし、XML テキストをデスクトップ上のローカルファイルにコピーします。 次の手順では、いくつかのプレースホルダーの値を置き換え、後ほどアップロードする XML を準備する必要があります。

Outlook の manifest.xml ファイル内のプレースホルダーの値を、ご利用の DocuWare システムの実際の値に置き換えます。 具体的には、以下の文字列で検索を行ってください。

  • {{GENERATE_A_UNIQUE_ID}} で検索し、アプリケーション GUID として任意の GUID に置き換えます

  • {{YOUR_DOCUWARE_URL}} で検索し、ご利用の DocuWare システムの URL に置き換えます

  • {{YOUR_CLIENTID}} で検索し、OAuth アプリケーションクライアント ID に置き換えます

PowerShell を使用して新しい GUID を作成する手順を確認する

一意の GUID を生成する必要がある場合には、Microsoft のドキュメントポータルで段階的な手順を確認することができます。

このオプションを展開すると、Outlook の manifest.xml ファイルにアクセスできます。

<?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>

Office 365 ユーザー向けのアドインの展開

これですべての要件が満たされたため、ご利用の DocuWare システムの値を含むマニフェストファイルを使用して Office 365 ユーザー向けのアドインを展開できるようになりました。

設定および展開プロセスについての段階的な手順の解説に従ってください。

サポートされているバージョン: DocuWare on-premises 7.13