SharePoint

El conector de SharePoint proporciona acceso de SQL a los servicios y servidores de SharePoint.

Versiones compatibles

Este conector es compatible con Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 y versiones posteriores, y SharePoint Online.

Antes de comenzar

Antes de usar el conector de SharePoint, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura la app de SharePoint en Azure (AD)

Si eliges usar Azure Active Directory (AD) para la edición en línea de SharePoint, sigue estos pasos para configurar la aplicación de SharePoint en Azure AD:

  1. En el portal de Azure AD, selecciona el directorio de tu organización.
  2. En la sección Administrar, haz clic en Registros de apps y, luego, en Nuevo registro.
  3. Completa los detalles de registro para registrar la app en Azure AD:
    1. En Tipos de cuentas compatibles, selecciona Cuentas en este directorio de la organización solo.
    2. En URI de redireccionamiento (opcional), selecciona Web y agrega https://your_connections_host.spo.index.html como el URI para que los usuarios de tus conexiones reciban su respuesta de autenticación.
    3. Haz clic en Register.

      4. Si deseas obtener más información, consulta cómo registrar una aplicación en Azure.

  4. En la página Descripción general de tu app, haz clic en Permisos de API y, luego, en Agregar un permiso.
  5. Configura tu aplicación para acceder a una API web siguiendo estos pasos:
    1. En Request API permissions, selecciona SharePoint en la pestaña Microsoft APIs.
    2. En Permisos delegados, selecciona Leer y escribir archivos de usuario y Leer y escribir elementos en todas las colecciones de sitios.
    3. Haz clic en Agregar permisos.
    4. En la pantalla de permisos de la API configurada, selecciona Otorgar el consentimiento del administrador para your_organizational_directory.
  6. Agrega un URI de redireccionamiento de la app para dispositivos móviles de SharePoint de tu organización:
    1. Haz clic en Autenticación.
    2. En Web, haz clic en Agregar URI y agrega https://your_connections_host/spo/mobile.html como la URL de respuesta para los usuarios de dispositivos móviles.
    3. En Otorgamiento implícito, selecciona Tokens de acceso y Tokens de ID.
    4. Haz clic en Guardar.
  7. Edita el manifiesto de la app de Azure Active Directory para permitir la autenticación abierta que usa la app:
    1. En la página Descripción general de la app, haz clic en la sección Manifiesto.
    2. Cambia el atributo oauth2AllowImplicitFlow a true.
    3. Haz clic en Guardar.
  8. En la página Descripción general de tu app, toma nota del ID de aplicación (cliente). Debes proporcionarlo en la sección de autenticación cuando configuras el conector de SharePoint si eliges el tipo de autenticación de Azure AD.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Entre las regiones admitidas para los conectores, se incluyen las siguientes:

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Connector (Conector): Selecciona SharePoint de la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging. y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    8. De manera opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Selecciona un Tipo de destino. Por ejemplo, la dirección del host es https://xxxxx.sharepoint.com.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si quieres establecer una conexión privada con tus sistemas de backend, Selecciona Adjunto de extremo de la lista y, luego, selecciona el adjunto de extremo requerido. de la lista Adjunto de extremo.

      Si deseas establecer una conexión pública con tus sistemas de backend con seguridad adicional, puedes considera configurar la configuración estática de direcciones IP internas para tus conexiones y, luego, para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de SharePoint admite los siguientes tipos de autenticación:

      • Credenciales de Windows. Selecciona esta opción si usas la edición local de SharePoint.
      • AzureAD. Selecciona esta opción si usas la edición en línea de SharePoint.
      • Credenciales de cliente de OAuth 2.0 con el portador de JWT. Selecciona esta opción si usas credenciales de cliente de OAuth 2.0 con el portador de JWT para la autenticación.
      • Credenciales de cliente de OAuth 2.0 con secreto de cliente. Selecciona esta opción si usas credenciales de cliente de OAuth 2.0 con secreto del cliente para la autenticación.

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haz clic en Siguiente.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Credenciales de Windows
    • Nombre de usuario: Ingresa el nombre de usuario.
    • Contraseña: Selecciona la contraseña.
    • Versión del secreto: Ingresa la versión del secreto.
  • AzureAD
    • ID de cliente: Ingresa el ID de cliente que se usa para solicitar tokens de acceso. Puedes obtener el ID de cliente si configuras la aplicación de SharePoint en Azure AD.
    • Alcances: Ingresa una lista separada por comas de los permisos deseados. Por ejemplo, Sites.FullControl.All
    • Secreto de cliente: Ingresa el secreto que contiene el secreto del cliente para la app conectada que creaste.
    • Versión del secreto: Es la versión del secreto que seleccionaste anteriormente.
    • URL de autorización: La URL de autorización que se genera cuando se crea el cliente Ingresa la URL con el siguiente formato: https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize. Por ejemplo, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize.
  • Credenciales de cliente de OAuth 2.0 con el portador de JWT
    • ID de cliente: Ingresa el ID de cliente que se usa para solicitar tokens de acceso. Esta es la clave de consumidor que proporciona el conector para la app conectada que creaste.
    • Clave privada: Selecciona el Secret de Secret Manager que incluye el contenido del archivo de clave privada en formato PEM. La clave privada debe coincidir con la clave o el certificado públicos que se proporcionan al conector.
    • Versión del secreto: Es la versión del secreto seleccionado anteriormente.
    • Contraseña de clave privada: Selecciona el Secret de Secret Manager que contiene la contraseña (parafrasea) del archivo de claves privadas.
    • Versión del secreto: Es la versión del secreto seleccionado anteriormente.
    • Instancia de Azure: El usuario de Microsoft Online que se usa para acceder a los datos.
  • Credenciales de cliente de OAuth 2.0 con secreto de cliente
    • ID de cliente: Ingresa el ID de cliente que proporciona el conector para la app que creaste.
    • Secreto de cliente: Selecciona el Secret de Secret Manager que contiene el secreto del cliente para la app conectada que creaste.
    • Versión del secreto: Selecciona la versión del secreto del cliente.

Para el tipo de autenticación Authorization code, después de crear la conexión, puedes debe realizar algunos pasos adicionales para configurar la autenticación. Para obtener más información, consulta Pasos adicionales después de la creación de la conexión.

Muestras de configuración de conexión

Esta sección enumera los valores de muestra para los diversos que configuras cuando creas la conexión.

Tipo de conexión web

Nombre del campo Detalles
Región us-central1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-gcp-con
Cuenta de servicio ********@*******.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50 (Nota: Depende de tus pruebas)
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
Autenticación AzureAD
ID de cliente eda*****-****-****-****-*******2797
Permisos Sites.FullControl.All
Secreto del cliente *************
Versión del Secret 1
URL de autorización https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

Tipo de conexión de PSC

Nombre del campo Detalles
Región us-central1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-stagging-psc
Cuenta de servicio ******@*******.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50 (Nota: Depende de tus pruebas)
Tipo de destino Dirección del host
host 1 http://10.***.0.**
puerto 1 ****
Autenticación Credenciales de Windows
Nombre de usuario *************
Contraseña *************
Versión del Secret 1

Tipo de conexión de credenciales de cliente

Nombre del campo Detalles
Región europe-west1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-client-credentials
Cuenta de servicio ******@*******.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50 (Nota: Depende de tus pruebas)
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con secreto del cliente
ID de cliente 83ca***********
Secreto del cliente *************
Versión del Secret 1

Tipo de conexión del certificado del portador de JWT

Nombre del campo Detalles
Región europe-west1
Conector SharePoint
Versión del conector 1
Nombre de la conexión sharepoint-jwt-certificate
Cuenta de servicio ******@*******.gserviceaccount.com
Cantidad mínima de nodos 2
Cantidad máxima de nodos 50 (Nota: Depende de tus pruebas)
Tipo de destino Dirección del host
host 1 http://z8**.sharepoint.com
puerto 1 ****
Autenticación Credenciales de cliente de OAuth 2.0 con portador de JWT
ID de cliente de OAuth e34d***********
Clave privada *************
Versión del Secret 1
Contraseña de clave privada *************
Versión del Secret 1
Usuario de Azure 9b25************

Pasos adicionales después de la creación de la conexión

Si seleccionaste OAuth 2.0 - Authorization code para la autenticación, debes seguir estos pasos adicionales después de crear la conexión:

  1. En la página Conexiones, busca la conexión recién creada.

    Ten en cuenta que el Status del conector nuevo será Authorization required (Autorización requerida).

  2. Haz clic en Se requiere autorización.

    Se mostrará el panel Editar autorización.

  3. Copia el valor del URI de redireccionamiento en tu aplicación externa.
  4. Verifica los detalles de la autorización.
  5. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la Página Conexiones.

Agrega la URL de redireccionamiento

Si usas el tipo de autenticación de Azure AD, agrega la URL de redireccionamiento con el portal de Azure.
  1. En el portal de Azure, haz clic en Registros de aplicaciones, debajo de los servicios de Azure.
  2. Haz clic en el nombre de tu aplicación.
  3. Haz clic en Agregar URI de redireccionamiento.
  4. Haz clic en Agregar una plataforma.
  5. En el diálogo Web, pega el URI de redireccionamiento que copiaste cuando autorizaste la conexión en Google Cloud.

Volver a autorizar para el código de autorización

Si usas el tipo de autenticación Authorization code y realizaste cambios de configuración en tu aplicación de SharePoint, debes volver a autorizar tu conexión de SharePoint. Para volver a autorizar una conexión, sigue estos pasos:

  1. Haz clic en la conexión requerida en la página Conexiones.

    Se abrirá la página de detalles de la conexión.

  2. Haz clic en Editar para editar los detalles de la conexión.
  3. Verifica los detalles de OAuth 2.0: Código de autorización en la sección Autenticación.

    Si es necesario, realiza los cambios necesarios.

  4. Haz clic en Guardar. Esta acción te llevará a la página de detalles de la conexión.
  5. Haz clic en Editar autorización en la sección Autenticación. Esto muestra el panel Authorize.
  6. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones operaciones no aparecen en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran algunas de las acciones que admite el conector. Para entender cómo configurar el consulta Ejemplos de acciones.

Acción DeleteAttachment

Esta acción borra un archivo adjunto.

Parámetros de entrada de la acción DeleteAttachment

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle String Sí Es el título del elemento de la lista.
ItemId String Sí Es el ID del elemento de la lista.
Nombre del archivo String Sí Es el nombre del archivo que se borrará de la biblioteca de documentos.

Para comprender cómo configurar la acción DeleteAttachment, consulta Ejemplos de acciones.

Acción CheckInDocument

Esta acción te permite registrar un documento.

Parámetros de entrada de la acción CheckInDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Es el nombre del archivo que se revisará.
Comentar String No Un mensaje de registro opcional.

Para comprender cómo configurar la acción CheckInDocument, consulta Ejemplos de acciones.

Acción CheckOutDocument

Esta acción te permite consultar un archivo.

Parámetros de entrada de la acción CheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Nombre del archivo que se va a comprobar.

Para comprender cómo configurar la acción CheckOutDocument, consulta Ejemplos de acciones.

Acción DismissCheckOutDocument

Esta acción te permite deshacer la extracción de un archivo.

Parámetros de entrada de la acción DismissCheckOutDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
DocumentName String Sí Nombre del archivo para el que se debe deshacer la confirmación de la compra.

Para comprender cómo configurar la acción DiscardCheckOutDocument, consulta Ejemplos de acciones.

Acción CopyDocument

Esta acción te permite copiar un archivo de una ubicación a otra.

Parámetros de entrada de la acción CopyDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
SourceFileRelativeUrl String Sí Es la URL relativa del archivo de origen.
DestFileRelativeUrl String Sí Es la URL relativa del archivo de destino.

Para comprender cómo configurar la acción CopyDocument, consulta Ejemplos de acciones.

Acción UploadDocument

Esta acción te permite subir un archivo.

Parámetros de entrada de la acción UploadDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
Nombre del archivo String Sí Es el nombre del archivo que se subirá.
RelativeUrl String Sí Es la URL relativa de la carpeta.
Contenido String No Es el contenido que se subirá como un archivo.
ContentBytes String No Contenido de bytes (como una cadena Base64) para subir como un archivo. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se subirá es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción UploadDocument, consulta Ejemplos de acciones.

Acción DownloadDocument

Esta acción te permite descargar un archivo.

Parámetros de entrada de la acción DownloadDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile String Sí URL completa del archivo que se descargará.
Biblioteca String Sí Es el nombre de la biblioteca en el servidor de SharePoint.
HasBytes Booleano No Especifica si el contenido se debe descargar como bytes. El valor predeterminado es false.

Para comprender cómo configurar la acción DownloadDocument, consulta Ejemplos de acciones.

Acción MoveAttachmentOrDocument

Esta acción te permite mover un archivo de una carpeta a otra.

Parámetros de entrada de la acción MoveAttachmentOrDocument

Nombre del parámetro Tipo de datos Obligatorio Descripción
SourceFileURL String Sí Es la URL del archivo de origen que se debe mover.
DestinationFolderURL String Sí Es la URL de la carpeta de destino.

Para comprender cómo configurar la acción MoveAttachmentOrDocument, consulta Ejemplos de acciones.

Acción CreateFolder

Esta acción te permite crear una carpeta.

Parámetros de entrada de la acción CreateFolder

Nombre del parámetro Tipo de datos Obligatorio Descripción
RelativeURL String Sí Es la URL relativa de la carpeta.
FolderName String Sí Nombre de la carpeta que se creará.

Para comprender cómo configurar la acción CreateFolder, consulta Ejemplos de acciones.

Acción AddAttachments

Esta acción te permite agregar un archivo adjunto.

Parámetros de entrada de la acción AddAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
ListTitle String Sí Nombre de la lista de archivos adjuntos.
Nombre del archivo String Sí Nombre del archivo adjunto.
ItemId String Sí ID del adjunto que se agregará.
Contenido String Sí Contenido del archivo adjunto.
ContentBytes String No Contenido de bytes (como una cadena Base64) para subir como archivo adjunto. Úsalo para subir datos binarios.
HasBytes Booleano No Especifica si el contenido que se subirá es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción AddAttachments, consulta Ejemplos de acciones.

Acción DownloadAttachments

Esta acción te permite descargar archivos adjuntos.

Parámetros de entrada de la acción DownloadAttachments

Nombre del parámetro Tipo de datos Obligatorio Descripción
RemoteFile String Sí Es la URL relativa del archivo.
HasBytes Booleano No Especifica si el contenido que se descargará es binario. El valor predeterminado es false.

Para comprender cómo configurar la acción DownloadAttachments, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: Borra un archivo adjunto

En este ejemplo, se borra el archivo especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteAttachment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DeleteAttachment tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Revisar un documento

Este ejemplo verifica un documento.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CheckInDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CheckInDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Revisa un archivo

En este ejemplo, se revisa un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CheckOutDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CheckOutDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Descartar un pago

En este ejemplo, se revierte el check out de un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DiscardCheckOutDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DiscardCheckOutDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: copia un archivo

En este ejemplo, se copia un archivo de una ubicación a otra.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CopyDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CopyDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: sube un archivo de texto

En este ejemplo, se sube un archivo de texto a la ubicación especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: sube un archivo binario

En este ejemplo, se sube un archivo binario a la ubicación especificada. Cuando subes un objeto binario , especifica el contenido que se subirá como una cadena codificada en Base64.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea UploadDocument tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: descarga un archivo

En este ejemplo, se descarga un archivo.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

    [{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: Descarga un archivo binario

En este ejemplo, se descarga un archivo binario.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"  
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadDocument tendrá un valor similar al siguiente:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Ejemplo: Mover un archivo adjunto

En este ejemplo, se mueve un adjunto de una ubicación a otra.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción MoveAttachmentOrDocument y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea MoveAttachmentOrDocument tendrá un valor similar al siguiente:

    [{
"Result": "Success"
}]

Ejemplo: crea una carpeta

En este ejemplo, se crea una carpeta en la ubicación especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CreateFolder y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea CreateFolder tendrá un valor similar al siguiente:

    [{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

Ejemplo: Agrega un archivo adjunto

En este ejemplo, se agrega un archivo adjunto a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

Ejemplo: agrega un archivo adjunto de objeto binario

En este ejemplo, se agrega un adjunto binario a la lista especificada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",  
"ItemId": "1"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea AddAttachments tendrá un valor similar al siguiente:

    [{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

Ejemplo: Cómo descargar un archivo adjunto

En este ejemplo, se descarga un archivo adjunto.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.txt"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

    [{
"Success": "True",
"Content": "Test File",
}]

Ejemplo: descarga un archivo adjunto de objeto binario

En este ejemplo, se descarga un archivo adjunto binario.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachments y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}

    4. Si la acción tiene éxito, el Respuesta connectorOutputPayload de la tarea DownloadAttachments tendrá un valor similar al siguiente:

    [{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: enumera todos los archivos

En este ejemplo, se enumeran todos los archivos de la entidad Files.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Files de la lista Entity.
  3. Selecciona la operación List y, luego, haz clic en Listo.
  4. De manera opcional, en la sección Entrada de tarea de la tarea Conectores, puedes realizar lo siguiente: filtrar tu conjunto de resultados especificando una cláusula de filtro. Tú también puede especificar varias condiciones de filtro con los operadores lógicos.

Ejemplo: obtén una lista

En este ejemplo, se obtiene una lista con el ID especificado de la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists en la lista Entity.
  3. Selecciona la operación Get y, luego, haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId. Luego, ingresa 3 en el campo Valor predeterminado.

    Aquí, 3 es un valor de clave primaria en la entidad My Lists.

Ejemplo: crea un registro

En este ejemplo, se crea un registro en la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"AuthorId": 11.0, 
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}

    Si la integración se realiza correctamente, el campo connectorOutputPayload de tu tarea de conector tendrá una valor similar al siguiente:

    [{
"ID": 3.0
}]

Ejemplo: Borra un registro

En este ejemplo, se borra el registro con el ID especificado en la entidad My Lists.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona My Lists en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 2 en el campo Valor predeterminado.

Usa la conexión de SharePoint en una integración

Después de que crees la conexión, estará disponible en Apigee Integration y Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?