SharePoint

Comparación de características

¹ El modo de coedición estricta puede afectar negativamente al parámetro del token de acceso cuando se usa WOPI.

Formatos soportados

Conector oficial:

• Para visualización y edición: DOCM, DOCX, DOTM, DOTX, PDF, POTM, POTX, PPSM, PPSX, PPTM, PPTX, XLSB, XLSM, XLSX, XLTM, XLTX
• Solo para visualización: CSV, DJVU, DOC, DOT, DPS, DPT, EPUB, ET, ETT, FB2, FODP, FODS, FODT, HML, HTM, HTML, HWP, HWPX, KEY, MD, MHT, MHTML, NUMBERS, ODG, ODT, ODP, ODS, OTT, OTP, OXPS, PAGES, POT, PPS, PPT, RTF, STW, SXC, SXI, SXW, TXT, VSDM, VSDX, VSSM, VSSX, VSTM, VSTX, WPS, WPT, XLS, XLT, XML, XPS

WOPI:

• Para visualización y edición: DOCX, XLSX, PPTX, DOCM, XLSM, PPTM, ODT, ODS, ODP, CSV, PDF
• Solo para visualización: DJVU, XPS

Novedades en la versión 3.1.0

Cambios

• Se añadieron nuevos formatos soportados

El registro completo de cambios está disponible aquí.

Requisitos

• ONLYOFFICE Document Server v7.1 (versión servidor o versión en la nube) o superior. La instancia debe ser resoluble y conectable desde SharePoint y cualquier cliente final, y debe poder enviar POST directamente a SharePoint. Consulta la página de documentación oficial para aprender más sobre la instalación de ONLYOFFICE Docs.
• SharePoint 2019
• ONLYOFFICE Connector 3.1.0 para SharePoint

Instalación y configuración

La solución de integración ONLYOFFICE SharePoint es un conector oficial de ONLYOFFICE disponible en la página de GitHub bajo la licencia GNU AGPL v.3.

Para aprender más sobre cómo funciona y cómo compilar la solución, visita nuestra documentación API.

1. Haz clic en Inicio (Start), apunta a Todos los programas (All Programs), luego a Herramientas administrativas (Administrative Tools), y haz clic en Servicios (Services). Asegúrate de que el servicio Administración de SharePoint (SharePoint Administration) esté iniciado.
2. Haz clic en Inicio (Start), abre SharePoint Management Shell y navega al directorio que contiene el archivo .wsp.
3. Ejecuta el script Install.ps1:

   PS> .\Install.ps1

4. Ingresa la dirección de tu sitio SharePoint:

   https://<tusitiosharepoint>

   En lugar de los pasos 3 y 4, puedes escribir el siguiente comando:

   Add-SPSolution -LiteralPath<ruta_solución>/onlyoffice.wsp

   En la página principal de Administración central de SharePoint (SharePoint Central Administration), haz clic en Configuración del sistema → Administración de la granja → Administrar soluciones de la granja (System Settings → Farm Management → Manage farm solutions). En la página de Administración de soluciones (Solution Management), haz clic en onlyoffice.wsp y luego en Implementar solución (Deploy Solution).
5. En la página principal de SharePoint Central Administration (Administración central de SharePoint), bajo Administración de aplicaciones (Application Management), haz clic en Administrar aplicaciones web (Manage web applications).
6. Asegúrate de seleccionar tu sitio y haz clic en el ícono Proveedores de autenticación (Authentication Providers).
7. En la ventana emergente Proveedores de autenticación (Authentication Providers), haz clic en Zona predeterminada (Default zone).
8. Bajo Editar autenticación (Edit Authentication), marca Habilitar acceso anónimo (Enable anonymous access) y haz clic en Guardar (Save).
9. Volviendo a Administración de aplicaciones web (Web Application Management), haz clic en el ícono Política anónima (Anonymous Policy).
10. Bajo Restricciones de acceso anónimo (Anonymous Access Restrictions), selecciona tu Zona (Zone) y establece la política Permisos a Ninguno – No (Permissions to None – No), luego haz clic en Guardar (Save).
11. En SharePoint, abre la página /\_layouts/15/Onlyoffice/Settings.aspx con configuraciones administrativas. Ingresa la siguiente dirección:

    https://<documentserver>/

    Donde documentserver es el nombre del servidor con ONLYOFFICE Docs instalado. La dirección debe ser accesible desde el navegador del usuario y desde el servidor SharePoint. La dirección del servidor SharePoint también debe ser accesible desde ONLYOFFICE Docs para un funcionamiento correcto.

Si tienes subsitios configurados en SharePoint, necesitarás configurar adicionalmente la conexión de ONLYOFFICE Docs con cada uno de ellos. Ve a la configuración de cada subsitio e ingresa la dirección de Docs en el campo correspondiente.

A partir de ONLYOFFICE Docs v7.2, JWT está habilitado por defecto y la clave secreta se genera automáticamente. Debes habilitarlo también en el lado de SharePoint: encuentra tu clave secreta en el archivo de configuración de ONLYOFFICE Docs y luego especifica la misma clave secreta en la configuración administrativa de SharePoint. Para más detalles, consulta la sección Habilitar JWT a continuación.

Si la protección JWT está habilitada, es necesario especificar un nombre de encabezado personalizado, ya que la política de seguridad de SharePoint bloquea los encabezados externos 'Authorization'. Este encabezado también debe especificarse en la configuración de firma de ONLYOFFICE Docs (más información disponible aquí).

Compilando la solución

Hay dos maneras de compilar la solución de integración ONLYOFFICE para SharePoint (ONLYOFFICE SharePoint integration):

• Usando MS Visual Studio:
  1. Ingresa al servidor SharePoint (SharePoint server) y abre este proyecto en Visual Studio.
  2. En el Explorador de soluciones (Solution Explorer), abre el menú contextual del proyecto y elige Publicar (Publish).
  3. En el cuadro de diálogo Publicar (Publish), selecciona la opción Publicar en el sistema de archivos (Publish to File System).
  4. Haz clic en el botón Publicar (Publish). Cuando termine el proceso, se creará el archivo .wsp de la solución.
  5. Copia el archivo resultante a la carpeta que contiene el archivo Install.ps1 (por defecto la carpeta BuildAndInstall).
• Usando el archivo build.bat:
  1. Ve a la carpeta BuildAndInstall.
  2. Ejecuta el archivo build.bat.
  3. El archivo .wsp de la solución se creará y colocará en la carpeta BuildAndInstall.

Cómo funciona

La integración de ONLYOFFICE sigue la API documentada aquí.

1. El usuario navega a un documento dentro de SharePoint y selecciona la acción Editar en ONLYOFFICE en el menú contextual o en la cinta.
2. SharePoint realiza una solicitud a la página del editor (URL del tipo: /\_layouts/15/Onlyoffice/editorPage.aspx?SPListItemId={ItemId}&SPListURLDir={ListUrlDir}&action=track).
3. SharePoint prepara un objeto JSON con las siguientes propiedades:
   • url — la URL que ONLYOFFICE Docs usa para descargar el documento;
   • callbackUrl — la URL a la que ONLYOFFICE Docs informa sobre el estado de la edición del documento;
   • DocumentSeverHost — la URL a la que el cliente debe responder al ONLYOFFICE Document Server (puede configurarse en la página de ajustes);
   • Key — el identificador del archivo desde SharePoint;
   • FileName — el título (nombre) del documento;
   • CurrentUserId — el identificador del usuario;
   • CurrentUserName — el nombre de usuario.
4. SharePoint construye una página, rellenando todos esos valores para que el navegador del cliente pueda cargar el editor.
5. El navegador del cliente hace una solicitud a la biblioteca JavaScript de ONLYOFFICE Docs y envía a ONLYOFFICE Docs la configuración DocEditor con las propiedades mencionadas.
6. Luego ONLYOFFICE Docs descarga el documento desde SharePoint y el usuario comienza a editar.
7. Cuando todos los usuarios y navegadores clientes terminan de editar, cierran la ventana de edición.
8. Después de 10 segundos de inactividad, ONLYOFFICE Docs envía un POST a callbackUrl informando a la solución ONLYOFFICE de SharePoint que los clientes han terminado de editar el documento y lo han cerrado.
9. SharePoint descarga una nueva versión del documento, reemplazando la antigua.

Para aprender más sobre los problemas más comunes y cómo resolverlos, visita nuestra guía de solución de problemas.

Habilitar JWT

Para proteger los documentos del acceso no autorizado, los editores ONLYOFFICE usan JSON Web Token (JWT). El token se añade en la configuración cuando se inicializa el Editor de documentos y durante el intercambio de comandos entre los servicios internos de ONLYOFFICE Docs. La clave secreta se usa para firmar el token JSON web y validar el token al hacer la solicitud a ONLYOFFICE Docs.

A partir de ONLYOFFICE Docs v7.2, JWT está habilitado por defecto y la clave secreta se genera automáticamente. Debes encontrar tu clave secreta en el archivo de configuración de ONLYOFFICE Docs y luego especificar la misma clave secreta en la configuración del conector.

Paso 1: Encuentra tu clave secreta en el archivo de configuración de ONLYOFFICE Docs

1. Abre el archivo local.json con cualquier editor de texto disponible:
   • Para Linux: /etc/onlyoffice/documentserver/local.json
   • Para Windows: %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Para Docker: entra al contenedor de ONLYOFFICE Docs usando docker exec -it <containerID> bash y abre /etc/onlyoffice/documentserver/local.json. Alternativamente, ejecuta:

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   El archivo local.json debería verse así:

   {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}

2. El valor true está especificado en tres secciones, lo que significa que la validación del token está habilitada:
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. La clave secreta generada automáticamente está especificada en tres secciones. Puedes reemplazar el valor predeterminado con tu propia clave, que debe ser la misma en las tres secciones:
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Si realizas cambios, guárdalos y reinicia los servicios:

   supervisorctl restart all

Paso 2: Especifica la misma clave secreta en la configuración del conector

En la configuración del conector, especifica la misma clave en el campo Clave secreta y guarda los ajustes.

Limitaciones

Conectar ONLYOFFICE Docs mediante WOPI carece de algunas funciones debido a la arquitectura de WOPI:

• No hay soporte para la función Historial de versiones.
• No se soporta insertar una imagen desde el almacenamiento.
• No se soporta comparar documentos.
• No hay soporte para los siguientes formatos: DOC, XLS, PPT.

Requisitos

• ONLYOFFICE Document Server v7.1 o superior con WOPI habilitado. Sigue esta instrucción para habilitar WOPI.
• SharePoint 2019

Conexión mediante WOPI

1. Abre tu servidor SharePoint (SharePoint server). Ejecuta la consola SharePoint Management Shell y configura la zona WOPI necesaria:

   Set-SPWOPIZone -Zone "external-http"

   El documentserver usa el parámetro external-http por defecto.
2. Verifica si existen enlaces WOPI a otros tipos de documentos en la granja actual:

   Get-SPWOPIBinding

   Elimina estos enlaces, si hay alguno:

   Remove-SPWOPIBinding -All:$true

3. Crea nuevos enlaces para las acciones predeterminadas según los tipos de archivo.

   Para crear enlaces para todos los tipos de archivo a la vez:

   New-SPWOPIBinding -ServerName ip_or_domain.com:port

   Para crear enlaces solo para tipos de archivo específicos:

   New-SPWOPIBinding -ServerName ip_or_domain.com:port -Extension DOCX

   Si no usas SSL, añade -AllowHTTP al final del comando.

Habilitar el encabezado de autorización

El parámetro wopi.sendAuthorizationHeader añade el encabezado Authorization: Bearer <access_token> a las solicitudes WOPI. Es opcional según la especificación WOPI, pero obligatorio según la versión de SharePoint:

• SharePoint Subscription Edition: este parámetro debe estar habilitado. Sin él, ocurre un error de Token de acceso inválido y falla la edición del documento.
• SharePoint 2019: este parámetro es opcional. La conexión funciona con el token pasado en la URI, pero habilitar el encabezado no causa problemas.

Para habilitar wopi.sendAuthorizationHeader, usa una de las siguientes opciones:

• Edita el archivo de configuración /etc/onlyoffice/documentserver/default.json, o añade lo siguiente a /etc/onlyoffice/documentserver/local.json para preservar los cambios tras actualizaciones:

  {
      "wopi": {
          "sendAuthorizationHeader": true
      }
  }

  Después de hacer cambios, reinicia los servicios:

  supervisorctl restart all

• En las versiones comerciales, este parámetro también puede configurarse mediante el Panel de administración.

Crear nuevos documentos

Para poder crear nuevos documentos, configura los parámetros descritos a continuación. Este ejemplo es para archivos DOCX, pero puedes añadir archivos XLSX, PPTX y otros de forma similar.

1. Habilita la opción Permitir la administración de tipos de contenido (Allow management of content types): ve a Documentos → Configuración de biblioteca → Configuración avanzada (Documents → Library settings → Advanced settings). En la sección Permitir la administración de tipos de contenido (Allow management of content types), selecciona Sí (Yes) y haz clic en Aceptar.
   
2. En la biblioteca Documentos (Documents), ve a Contenido del sitio → Configuración del sitio → Tipos de contenido del sitio (Site contents → Site Settings → Site content types). Haz clic en Crear (Create). Completa el formulario: Nombre (Nuevo documento (New document)), Descripción. En Tipo de contenido principal (Parent Content type), elige Tipos de contenido de documento (Document content types), Documento (Document). En Grupo existente (Existing group), selecciona Tipos de contenido personalizados (Custom Content Types) y haz clic en Aceptar.
   
3. En la biblioteca Documentos (Documents), ve a Contenido del sitio → Configuración del sitio → Tipos de contenido del sitio (Site contents → Site Settings → Site content types). Selecciona el Nuevo documento (New document) añadido recientemente. Ve a Configuración avanzada → Plantilla de documento → Cargar una nueva plantilla de documento (Advanced settings → Document Template → Upload a new document template). Haz clic en el botón Elegir archivo (Choose File), sube el documento necesario y haz clic en Aceptar.
   
4. Ve a la biblioteca Documentos → Configuración de biblioteca (Documents library → Library settings). En la sección Tipos de contenido (Content Types), selecciona Agregar desde tipos de contenido del sitio existentes (Add from existing site content types). En la lista Seleccionar tipos de contenido del sitio desde (Select site content types from), elige Tipos de contenido personalizados (Custom content types). En el campo Tipos de contenido del sitio disponibles (Available Site Content Types), selecciona Nuevo documento (New document). Haz clic en el botón Agregar > (Add), luego en Aceptar.
   
5. En la biblioteca Documentos (Documents), actualiza la página y presiona el botón Nuevo (New).
   
6. El tipo de contenido Documento (Document) se añadirá automáticamente como tipo principal. Debe estar oculto: ve a la biblioteca Documentos → Configuración de biblioteca (Documents library → Library settings). En la sección Tipos de contenido (Content Types), selecciona Cambiar el orden del botón nuevo y el tipo de contenido predeterminado (Change new button order and default content type).
   
   En la columna Visible (Visible), desmarca la casilla para el tipo de contenido Documento (Document) y haz clic en Aceptar.
   
7. En la biblioteca Documentos (Documents), actualiza la página y presiona el botón Nuevo (New) — solo estará disponible el elemento de menú Nuevo documento (New document).