Configuración de DocuWare para Outlook in situ

Prev Next

DocuWare para Outlook in situ vincula una instalación local de DocuWare con Microsoft Outlook.  

Para instalar este complemento, primero registre una aplicación OAuth en Microsoft Entra ID, asigne los permisos necesarios de Graph, y anote los valores de inquilino, client ID y secret. A continuación, añada estos valores al servidor de DocuWare (dwmachine.config) y asegúrese de que el sitio de DocuWare sea accesible a través de HTTPS. Por último, personalice el manifiesto de Outlook con su URL de DocuWare y el client ID, y luego despliegue el manifiesto en los clientes deseados de Outlook.  

Cuando se completen estos pasos, los usuarios podrán archivar correos electrónicos y archivos adjuntos directamente a sus bandejas o archivadores de DocuWare in situ.

Requisitos previos y limitaciones

Requisitos previos:

  • Se requiere una licencia de DocuWare Connect to Outlook para acceder a este complemento y usarlo.

  • La configuración de DocuWare se ha instalado sin errores.

  • El certificado HTTPS se ha creado y asignado al sitio web en IIS, para que todo DocuWare sea accesible a través de https://{{YOUR_DOMAIN}}/DocuWare

Asegúrese de que la llamada a https://{{YOUR_DOMAIN}}/DocuWare/Outlook funciona correctamente.

Limitaciones:

  • No se admite almacenar correos electrónicos desde un buzón compartido en la versión de escritorio (clásica) de Microsoft Outlook.

  • La función de comentarios dentro de la aplicación no está disponible, ya que DocuWare para Outlook in situ no puede conectarse a DocuWare Cloud para enviar comentarios.

Registro de la aplicación OAuth en Entra

Para utilizar DocuWare para Outlook in situ con sus clientes de Outlook, se debe crear un registro de aplicación OAuth en Microsoft Entra.

Vaya a Registro de aplicaciones de Microsoft Entra y cree una nueva aplicación, por ejemplo:

Ya se ha creado la aplicación. En los siguientes pasos, configure la aplicación.

1. Exponer una API

  1. Primero, abra Exponer una API para añadir un nuevo Uri de ID de aplicación aquí.

  1. En el panel de la derecha, añada su URL de DocuWare a la URI de ID de aplicación y luego elija Guardar.

  1. A continuación, añada el ámbito access_as_user y rellene los datos en el panel derecho, por ejemplo:

    • Nombre de ámbito: access_as_user

    • Quién puede consentir: Administradores y usuarios

    • Nombre de visualización del consentimiento del administrador: Acceso de solo lectura a los correos electrónicos y perfiles del usuario.

    • Descripción del consentimiento del administrador: Permitir que DocuWare para Outlook tenga acceso de solo lectura a los correos electrónicos y perfiles de los usuarios.

    • Nombre de visualización del consentimiento del usuario: Acceso de solo lectura a sus correos electrónicos y perfiles.

    • Descripción del consentimiento del usuario: Permitir que DocuWare para Outlook tenga acceso de solo lectura a sus correos electrónicos y perfiles.

    • Estado: Habilitado

4. Haga clic en Añadir una aplicación cliente e introduzca el siguiente ID para autorizar previamente todos los terminales de la aplicación Microsoft Office.

ea5a67f6-b6f3-4338-b240-c655ddc3cc8e

Este ID es válido para todos los terminales de la aplicación Microsoft.

2. Autenticación

URI de redireccionamiento

Cambie a la pestaña Autenticación y añada las siguientes URI de redireccionamiento al registro de aplicación OAuth:

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

Nota: introducir un enlace sin HTTPS

Dependiendo de la versión y la región de Microsoft del administrador, la pestaña Autenticación en Azure podría mostrar una vista diferente. En la nueva vista predeterminada, no es posible añadir brk-multihub://<Your_DocuWare_URL>. En este caso, utilice el enlace Para cambiar a la experiencia antigua, haga clic aquí para introducir la URL brk-multihub://<Your_DocuWare_URL> en la interfaz anterior.  

Concesión implícita y flujos híbridos

En la misma página, asegúrese de que Tokens de acceso y Tokens de ID estén activados.

3. Crear un client secret

DocuWare para Outlook también requiere un secret para conectarse de forma segura a la cuenta de Office 365 del usuario.

Este secret será necesario en un paso posterior.

4. Ámbitos de API

4.1 API de Microsoft

Cambie a la pestaña permisos de API para definir los permisos de API requeridos por DocuWare para Outlook. Todos ellos se añadirán como permisos de API de Microsoft Graph.

  • correo electrónico

  • offline_access

  • openid

  • perfil

  • Contacts.Read

  • Contacts.Read.Shared

  • MailboxSettings.Read

  • MailboxSettings.ReadWrite

  • Mail.Read

  • Mail.ReadWrite

  • Mail.ReadWrite.Shared

  • User.Read

4.2 Las API que utiliza su organización

Haga clic de nuevo en Añadir un permiso, cambie a Las API que utiliza mi organización, escriba el nombre de la aplicación OAuth que está creando ahora (por ejemplo, DocuWare para Outlook in situ), y haga clic en la entrada en la lista de resultados.

Por último, marque access_as_user y haga clic en Añadir permiso.

5. Conceder consentimiento de administrador a la aplicación OAuth

Asegúrese de registrar los siguientes valores, que necesitará en los siguientes pasos:

  • ID de Microsoft Tenant (tenantid)

  • Application Client ID (clientid)  

  • Application Client Secret  

Completar esta acción finaliza el proceso de consentimiento del administrador. Tras conceder el consentimiento, debería ver una pantalla de confirmación como la que se muestra a continuación.

Este paso lo debe realizar el administrador global de Microsoft Azure AD.

En el servidor de DocuWare

1. Ampliar dwmachine.config

Cambie al servidor donde está instalado DocuWare y abra un terminal de PowerShell con derechos de administrador en la carpeta donde se ubica DocuWare.Setup.Server.Cmd.exe (es decir, C:\Program Files (x86)\DocuWare\Setup Components).

Ejecutar estos comandos para añadir los valores requeridos al archivo dwmachine.config de su servidor.

./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. Habilitar HTTPS en LocalWebServices y AuthorityAddress

Como Outlook requiere tener su aplicación alojada a través de https, es crucial tener la URL funcionando & declarada como HTTPS.

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

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

3. Crear archivo Manifest.xml de Outlook

Acceda al archivo manifest.xml de Outlook (disponible en la sección ampliable de abajo) y copie el texto XML en un archivo local en su escritorio. En el siguiente paso, debería reemplazar algunos valores de marcador de posición y preparar el XML para su posterior carga.

Reemplace los valores de marcador de posición en el archivo manifest.xml de Outlook con los valores reales de su sistema DocuWare. Más específicamente, debería buscar:

  • {{GENERATE_A_UNIQUE_ID}} y reemplazarlo por cualquier GUID como GUID de aplicación

  • {{YOUR_DOCUWARE_URL}} y reemplazarlo por la URL de su sistema DocuWare

  • {{YOUR_CLIENTID}} y reemplazarlo por su client ID de la aplicación OAuth

Puede encontrar las instrucciones para crear un nuevo GUID usando PowerShell

Si necesita generar un GUID único, puede encontrar las instrucciones paso a paso en el portal de documentación de Microsoft.

Amplíe esta opción para acceder al archivo manifest.xml de Outlook. 

<?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 sus correos electrónicos y 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>

Implementación del complemento en usuarios de Office 365

Ahora que se han establecido todos los requisitos, se puede utilizar el archivo de manifiesto con los valores de su sistema de DocuWare para implementarse en los usuarios de Office 365.

Solo tiene que seguir la descripción paso a paso del proceso de configuración e implementación.

Versiones compatibles: DocuWare on-premises 7.13