Table of contents
TOC
Collapse the table of content
Expand the table of content
Última actualización: 20/06/2018

Información general sobre los controladores de archivos de Office 365

Se aplica a: Office 365

Los controladores de archivos son un nuevo tipo de complemento de Office que integran en Office 365 tipos de archivos que no sean de Microsoft del mismo modo que si se tratara de archivos de Office.

Con los controladores de archivos, puede habilitar las siguientes experiencias de usuario para tipos de archivos que no sean de Microsoft:

  • iconos de archivo personalizados
  • crear nuevos archivos en el explorador
  • vista previa del archivo
  • gran capacidad de visualización/edición

Qué contiene un controlador de archivos de Office 365

Un controlador de archivos se compone de lo siguiente:

  • Extremo de controlador de archivos. Una aplicación hospedada en la nube que proporciona opcionalmente funciones de creación, vista previa y edición para nuevos tipos de archivos compatibles con el controlador de archivos.
  • Icono del archivo. La imagen que representa el tipo de archivo en Office 365.

Aplicación de control de archivos

La aplicación de control de archivos es una aplicación hospedada en la nube que contiene la lógica funcional para crear, mostrar una vista previa, abrir y guardar archivos del tipo que controle. Puede hospedarse en cualquier pila, incluidas las que no sean de Microsoft. Los controladores de archivos usan Azure AD para obtener acceso autorizado a los recursos de Office 365, con lo que la aplicación debe registrarse con Azure AD. Para obtener más información sobre cómo registrar una aplicación con Azure AD, consulte: Usar Visual Studio para registrar su aplicación y agregar las API de Office 365 y Registrar manualmente su aplicación con Azure AD para que pueda acceder a las API de Office 365.

Consulte Crear controladores de archivos en Office 365 para ver un tutorial de los pasos que se usan en Visual Studio para crear, implementar y registrar un controlador de archivos básico.

Para ver un ejemplo de un controlador de archivos más complejo, consulte el GPX-FileHandler en GitHub.

Controladores de archivos en tiempo de ejecución

El controlador de archivos se invoca con la URL newFileUrl, openUrl o previewUrl que se especifica en la propiedad addIns del manifiesto de la aplicación de Azure AD. Para comprender lo que sucede, echemos un vistazo al escenario en que un usuario hace clic en los puntos suspensivos (...) para abrir el globo del archivo. Si hay un controlador de archivos registrado para ese tipo de archivo, Office 365 invoca la aplicación de control de archivos mediante una solicitud POST a la URL especificada en la previewUrl del manifiesto de la aplicación, y pasa la ubicación del archivo, junto con otros detalles de la solicitud. La previewUrl indica un método en la aplicación de control de archivos que recuperará una secuencia de archivo para el archivo y que luego utilizará dicha secuencia para mostrar una vista previa del archivo en el explorador.

Se aplica el mismo enfoque a la funcionalidad abierta. En el escenario donde el usuario hace clic en Editar en el explorador, o directamente en el título del documento en la biblioteca, Office 365 hace una solicitud POST a la URL openUrl. Este extremo carga la secuencia de archivo en un editor apropiado, lo que permite al usuario editar el archivo. La aplicación también debe permitir al usuario guardar el archivo pasando la secuencia de archivo actualizada de vuelta a la ubicación del archivo, que se especifica en el parámetro de activación filePut.

Cuando un usuario hace clic en Archivo nuevo, Office 365 envía una solicitud POST al newFileUrl. Este extremo abre el editor apropiado para que el usuario pueda agregar contenido al nuevo archivo. La aplicación debe permitir al usuario guardarlo en la ubicación del archivo que se especifica en el parámetro de activación filePut.

Parámetros de activación

En escenarios con acciones de crear nuevo, abrir o mostrar una vista previa, su aplicación requiere ciertos detalles, llamados parámetros de activación, sobre el archivo, la cuenta empresarial, el cliente de Office 365, etc. para poder trabajar con el archivo. Office 365 incluye esos detalles como datos de formulario enviados en la solicitud POST inicial a los métodos de abrir o mostrar vista previa.

Tabla 1. Descripciones de los parámetros de activación que envía Office 365 cuando se inicia el controlador de archivos.

ParámetroDescripción
ClientEl cliente de Office 365 desde el que se abre el archivo o se muestra una vista previa suya; por ejemplo, "SharePoint".
CultureNameEl nombre de la referencia cultural del hilo actual, usado para la localización.
FileGetLa URL completa del extremo REST al que su aplicación llama para recuperar el archivo desde Office 365. Su aplicación debe hacer esa llamada usando el método HTTP GET.
FilePutLa URL completa del extremo REST al que su aplicación llama para guardar el archivo de nuevo en Office 365. Su aplicación debe hacer esa llamada usando el método HTTP POST.
ResourceIdLa URL de la cuenta empresarial de Office 365 usada para obtener el token de acceso desde Azure AD.
FileIdLa id. de documento para un documento específico; permite que su aplicación abra más de un documento al mismo tiempo.

Acceda a estos valores desde el cuerpo de la solicitud, mediante la colección Request.Form. Por ejemplo:

Request.Form["FileId"];

La aplicación debe almacenar estos valores en la caché tan pronto como se invoque el controlador de archivos, porque la aplicación no tiene un token de acceso la primera vez que se invoca para un usuario, con lo que se redireccionará a Azure AD, lo que activará el flujo del código de autorización de OAuth. Almacenarlos de inmediato en la caché los hace disponibles tras completarse la autorización de Azure AD, y el explorador se redirige de vuelta al controlador de archivos. Puede ver un ejemplo de uso de un objeto de modelo de datos y un método del controlador para almacenar el parámetro de activación en una cookie de la caché. Véalo en la muestra de GPX-FileHandler; específicamente, ActivationParameters.cs y FileHandlerController.cs.

Manifiesto de la aplicación y la propiedad addIns

Los detalles del controlador de archivos se especifican en la propiedad addIns en el manifiesto de la aplicación. La propiedad addIns detalla los controladores de archivos contenidos en una aplicación y las propiedades asociadas. Esos detalles se usan para configurar un controlador de archivos para una extensión con Office 365, especificando el comportamiento para dicha extensión de las acciones de archivo nuevo, abrir y vista previa.

La sintaxis del manifiesto es:

{
    "addIns": [
        {
            "id": "unique guid",
            "type": "FileHandler",
            "properties": [
                {
                    "key": "extension",
                    "value": "List of file extensions separated by semicolons"
                },
                {
                    "key": "fileIcon",
                    "value": "URL of icon for the file type"
                },
                {
                    "key": "newFileUrl",
                    "value": "URL for the new file function"
                },
                {
                    "key": "openUrl",
                    "value": "URL for the file open function"
                },
                {
                    "key": "previewUrl",
                    "value": "URL for the file preview function"
                }
            ]
        }
    ]
}

Para configurar el controlador de archivos, debe actualizar el manifiesto de la aplicación en Azure AD. Actualmente, no existe una interfaz de usuario en el portal de administración de Azure que permita hacer eso, por lo que tiene que realizarlo mediante consultas a Graph API de Azure AD. Para más información, consulte Configurar y actualizar controladores de archivos en Office 365.

Disponibilidad del controlador de archivos

En la siguiente tabla se muestra una lista de los servicios de Office 365 que admiten controladores de archivos.

Nombre del servicioDisponibilidad
SharePoint OnlineDisponible de manera generalizada (GA)
OneDrive para la EmpresaDisponible en general
Outlook Web AppDisponible en general

En esta sección

© 2018 Microsoft