Saltar al contenido

Detalles de Conexión en Microsoft Excel Online

Introducción

Versión del conector

Esta documentación se basa en la versión 21.0.8361 del conector.

Empezando

Compatibilidad con la versión en línea de Excel

El conector modela hojas de cálculo y rangos como tablas bidireccionales que se pueden consultar con SQL.

Establecer una Conexión

Conexión a un Libro de Trabajo

Puede conectarse a un libro proporcionando autenticación a Excel Online y luego configurando las siguientes propiedades:

  • Workbook: Establecido en el nombre o ID del libro de trabajo. Si desea ver una lista de información sobre los libros de trabajo disponibles, ejecute una consultar en la vista Libros de trabajo después de autenticarse.

  • Drive: Si bien es opcional, Drive reducirá aún más qué libro de trabajo usar. Un libro de trabajo solo se puede recuperar proporcionando tanto el ID de la unidad como el ID del libro de trabajo. Si Drive no se especifica, Jitterbit Connector for Excel Online intentará buscar automáticamente la unidad adecuada en segundo plano.

  • UseSandbox: Establézcalo en verdadero si se está conectando a un libro de trabajo en una cuenta de espacio aislado. De lo contrario, déjelo en blanco para conectarse a una cuenta de producción.

Autenticación en Excel Online

Hay dos métodos de autenticación disponibles para conectarse a la fuente de datos de Excel Online, los métodos de autenticación OAuth 2.0 (AzureAD) y MSI.

Autenticarse Mediante Autenticación OAuth (azuread)

Para autenticarse mediante OAuth, puede dejar las credenciales de OAuth en blanco para usar la aplicación integrada del conector.

Alternativamente, puede crear una aplicación personalizada para obtener OAuthClientId, OAuthClientSecret para usar credenciales OAuth personalizadas. Además de esas propiedades, establezca CallbackURL. Consulte Uso de la autenticación OAuth para más información.

  • AuthScheme: Establézcalo en AzureAD.
Autenticación Mediante Azure Service Principal

Azure Service Principal es un tipo de conexión que pasa por OAuth. Establecer su AuthScheme a AzureServicePrincipal y consulte Uso de la autenticación principal de servicio de Azure para obtener una guía de autenticación.

Autenticación Mediante Autenticación MSI

Si ejecuta Excel Online en una máquina virtual de Azure, puede aprovechar las credenciales de Managed Service Identity (MSI) para conectarse:

  • AuthScheme: Establézcalo en AzureMSI.

Las credenciales de MSI se obtendrán automáticamente para la autenticación.

Ejecutar SQL a Datos de la Hoja de Trabajo

Consulte lo siguiente para ejecutar SQL de manipulación de datos en hojas de cálculo y rangos:

Ver Modelo de datos para obtener más información sobre cómo el conector modela hojas de trabajo y celdas como tablas y columnas.

Uso de la Autenticación OAuth

OAuth requiere que el usuario que se autentica interactúe con Excel Online mediante el navegador. El conector facilita esto de varias maneras, como se describe a continuación.

Credenciales Integradas

Consulte Credenciales integradas para conectarse con las credenciales incrustadas del conector y omitir la creación de una aplicación OAuth personalizada.

Credenciales Personalizadas

En lugar de conectarse con las credenciales integradas del conector, puede registrar una aplicación con Credenciales personalizadas para obtener el OAuthClientId y OAuthClientSecret.

Cuándo Crear una Aplicación OAuth Personalizada

La creación de una aplicación OAuth personalizada es opcional, ya que el conector ya está registrado en Excel Online y puede conectarse con sus credenciales incrustadas. Es posible que desee crear una aplicación de OAuth personalizada para cambiar la información que se muestra cuando los usuarios inician sesión en el extremo de OAuth de Excel Online para otorgar permisos al conector.

Creación de una Aplicación OAuth Personalizada

Consulte Crear una aplicación OAuth personalizada para un procedimiento.

Credenciales Integradas

Autenticarse con las Credenciales de OAuth Integradas
Autenticación de Escritorio con la Aplicación OAuth Integrada

Puede conectarse sin configurar ninguna propiedad de conexión para sus credenciales de usuario.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth.

  1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
  2. Obtiene un nuevo token de acceso cuando caduca el antiguo.
  3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Credenciales Personalizadas

Hay dos tipos de autenticación de aplicaciones disponibles: usar un secreto de cliente y usar un certificado. Puede usar cualquiera de ellos dependiendo de la autenticación de la aplicación configurada.

Autenticación de Escritorio con Su Aplicación OAuth

Siga los pasos a continuación para autenticarse con las credenciales de una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada.

Obtenga un Token de Acceso OAuth

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

  1. Authenticating using a Client Secret
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
    • CallbackURL: establezca esto en la URL de redireccionamiento en la configuración de su aplicación.
    • AuthScheme: establezca esto en "AzureAD" en la configuración de su aplicación.
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken..
  2. Authenticating using a Certificate
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
    • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.
    • CallbackURL: establezca esto en la URL de redireccionamiento en la configuración de su aplicación.
    • AuthScheme: establezca esto en "AzureAD" en la configuración de su aplicación.
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken..

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth:

  1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
  2. Obtiene un nuevo token de acceso cuando caduca el antiguo.
  3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Máquinas Sin Cabeza

Uso de OAuth en una Máquina Sin Cabeza

Para crear fuentes de datos de Excel Online en servidores autónomos u otras máquinas en las que el conector no puede abrir un explorador, debe autenticarse desde otra máquina. La autenticación es un proceso de dos pasos.

  1. En lugar de instalar el conector en otra máquina, puede seguir los pasos a continuación para obtener el OAuthVerifier valor. O bien, puede instalar el conector en otra máquina y transferir los valores de autenticación de OAuth, después de autenticarse a través del flujo habitual basado en el navegador.
  2. A continuación, puede configurar el conector para actualizar automáticamente el token de acceso desde la máquina sin periféricos.

Puede seguir el flujo de autenticación de OAuth sin cabeza usando las credenciales de OAuth integradas del conector o usando las credenciales de OAuth para su aplicación de OAuth personalizada.

Uso de las Credenciales para una Aplicación OAuth Personalizada

Cree una aplicación OAuth personalizada

Consulte Crear una aplicación OAuth personalizada para un procedimiento. Luego puede seguir los procedimientos a continuación para autenticarse y conectarse a los datos.

Obtenga un código verificador

En la máquina sin periféricos, configure uno de los siguientes grupos de propiedades según el tipo de autenticación:

  1. Authenticating using a Client Secret
    • InitiateOAuth: Ajústelo a APAGADO.
    • OAuthClientId: establezca esto en la ID de la aplicación en la configuración de su aplicación.
    • OAuthClientSecret: establezca esto en el secreto de la aplicación en la configuración de su aplicación.
  2. Authenticating using a Certificate
    • InitiateOAuth: Ajústelo a APAGADO.
    • OAuthClientId: establezca esto en la ID de la aplicación en la configuración de su aplicación.
    • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
    • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

Luego puede seguir los pasos a continuación para autenticarse desde otra máquina y obtener el OAuthVerifier propiedad de conexión.

  1. Llame a GetOAuthAuthorizationURL procedimiento almacenado* con el parámetro de entrada CallbackURL establecido en el URI de redirección exacto que especificó en la configuración de su aplicación.
  2. Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirigirá a la URL de devolución de llamada. La página web indicará que no se pudo acceder al sitio.
  3. Inspeccione la URL de la página de este sitio y busque code valor. Estará presente en la URL en la forma code=XXXXXX (terminado con &, que denota el siguiente parámetro de URL ) El valor después de "code=" es el código verificador.
  4. Guarde el valor del código verificador. Establecerá esto en el OAuthVerifier propiedad de conexión.

En la máquina sin periféricos, configure uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación para obtener los valores de autenticación de OAuth:

  • OAuthClientId: establezca esto en la clave de consumidor en la configuración de su aplicación.
  • OAuthClientSecret: establezca esto en el secreto del consumidor en la configuración de su aplicación.
  • OAuthVerifier: Establézcalo en el código del verificador.
  • OAuthSettingsLocation: configure esto para conservar los valores de autenticación OAuth cifrados en el archivo especificado.
  • InitiateOAuth: Establézcalo en ACTUALIZAR.

Conectarse a datos

Después de generar el archivo de configuración de OAuth, configure las siguientes propiedades para conectarse a los datos:

  • OAuthSettingsLocation: Establézcalo en el archivo que contiene los valores de autenticación de OAuth cifrados. Asegúrese de que este archivo otorgue permisos de lectura y escritura al proveedor para habilitar la actualización automática del token de acceso.
  • InitiateOAuth: Establézcalo en ACTUALIZAR.

Transferir configuración de OAuth

Siga los pasos a continuación para instalar el conector en otra máquina, autenticar y luego transferir los valores de OAuth resultantes.

En una segunda máquina, instale el conector y conéctese con uno de los siguientes grupos de propiedades según el tipo de autenticación:

  1. Authenticating using a Client Secret
    • OAuthSettingsLocation: establezca esto en un archivo de texto grabable.
    • InitiateOAuth: Establézcalo en GETANDREFRESH.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
    • CallbackURL: establezca esto en la URL de devolución de llamada en la configuración de su aplicación.
  2. Authenticating using a Certificate
    • OAuthSettingsLocation: establezca esto en un archivo de texto grabable.
    • InitiateOAuth: Establézcalo en GETANDREFRESH.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
    • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.
    • CallbackURL: establezca esto en la URL de devolución de llamada en la configuración de su aplicación.

Pruebe la conexión para autenticarse. Los valores de autenticación resultantes se escriben, se cifran, en la ruta especificada por OAuthSettingsLocation. Una vez que haya probado con éxito la conexión, copie el archivo de configuración de OAuth en su máquina sin periféricos. En la máquina sin periféricos, configure las siguientes propiedades de conexión para conectarse a los datos:

  • InitiateOAuth: Establézcalo en ACTUALIZAR.
  • OAuthSettingsLocation: establezca esto en la ruta a su archivo de configuración de OAuth. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.

Creación de una Aplicación OAuth Personalizada

Cuándo Crear una Aplicación OAuth Personalizada

La creación de una aplicación OAuth personalizada es opcional, ya que el conector ya está registrado en Excel Online y puede conectarse con sus credenciales incrustadas.

Es posible que desee crear una aplicación de OAuth personalizada para cambiar la información que se muestra cuando los usuarios inician sesión en el extremo de OAuth de Excel Online para otorgar permisos al conector.

Siga los pasos a continuación para crear una aplicación OAuth personalizada y obtener las propiedades de conexión en un flujo de autenticación OAuth específico.

Pasos para Crear una Aplicación OAuth Personalizada

Siga los pasos a continuación para obtener los valores de OAuth para su aplicación, el OAuthClientId y OAuthClientSecret.

  1. Inicie sesión en https://portal.azure.com.
  2. En el panel de navegación de la izquierda, seleccione Azure Active Directory, luego Registros de aplicaciones y haga clic en el botón Nuevo registro.
  3. Ingrese un nombre de aplicación y configure el botón de opción para la configuración de inquilino deseada. Al crear una aplicación OAuth personalizada en Azure Active Directory, puede definir si la aplicación es de un solo inquilino o de varios inquilinos. Si selecciona la opción predeterminada de "Cuentas solo en este directorio organizacional", deberá configurar AzureTenant propiedad de conexión al Id. del arrendatario de Azure AD al establecer una conexión con Jitterbit Connector para Excel Online. De lo contrario, el intento de autenticación fallará con un error. Si su aplicación es solo para uso privado, "Solo cuentas en el directorio de esta organización" debería ser suficiente. De lo contrario, si desea distribuir su aplicación, elija una de las opciones de múltiples inquilinos.
  4. Luego configure la URL de redireccionamiento a algo como http://localhost:33333, el valor predeterminado del conector. O configure un puerto diferente de su elección y configure CallbackURL a la URL de respuesta exacta que definiste.
  5. Defina el tipo de autenticación de la aplicación en la sección Certificados y secretos. Hay dos tipos de autenticación disponibles: usando un secreto de cliente y usando un certificado. El método de autenticación recomendado es a través de un certificado, pero también puede crear un secreto de aplicación.
    • Option 1 - Upload a certificate: En la sección Certificados y secretos, seleccione Cargar certificado y seleccione el certificado para cargar desde su máquina local.
    • Option 2 - Create a new application secret: En la sección Certificados y secretos, seleccione Nuevo secreto de cliente para la aplicación y seleccione su duración. Después de guardar el secreto del cliente, se muestra el valor de la clave. Copie este valor ya que se muestra solo una vez y se usa como OAuthClientSecret.
  6. Seleccione Permisos de API y luego haga clic en Agregar. Si planea que su aplicación se conecte sin un contexto de usuario, seleccione los Permisos de la aplicación (OAuthGrantType = CLIENTE). De lo contrario, al seleccionar permisos, utilice los permisos Delegados.
  7. Agregue los siguientes permisos de aplicación: Sites.Read.All, Files.Read, Files.Read.All, Files.Read.Selected, Files.ReadWrite, Files.ReadWrite.All, Files.ReadWrite.AppFolder, Files.ReadWrite. Seleccionado y offline_access.
  8. Guarde sus cambios.
  9. Si ha seleccionado usar permisos que requieren el consentimiento del administrador (como los Permisos de la aplicación), puede otorgarlos desde el arrendatario actual en la página Permisos de la API. De lo contrario, siga los pasos en Consentimiento del administrador.

Consentimiento del Administrador

El consentimiento del administrador se refiere a cuando el administrador de un arrendatario de Azure Active Directory otorga permisos a una aplicación que requiere que un administrador dé su consentimiento para el caso de uso. La aplicación integrada dentro de Jitterbit Connector para Excel Online no contiene permisos que requieran el consentimiento del administrador. Por lo tanto, esta información se aplica solo a las aplicaciones personalizadas.

Al crear una nueva aplicación de OAuth en Azure Portal, debe especificar qué permisos requerirá la aplicación. Algunos permisos pueden estar marcados como "Consentimiento del administrador requerido". Por ejemplo, todos los permisos de Grupos requieren el consentimiento del administrador. Si su aplicación requiere el consentimiento del administrador, hay varias formas de hacerlo.

La forma más fácil de otorgar el consentimiento del administrador es simplemente hacer que un administrador inicie sesión en portal.azure.com y navegue hasta la aplicación que ha creado en Registros de aplicaciones. En Permisos de API, habrá un botón para Otorgar consentimiento. Puede dar su consentimiento aquí para que su aplicación tenga permisos en el arrendatario bajo el que se creó.

Si su organización tiene varios inquilinos o es necesario otorgar permisos a la aplicación para otros inquilinos fuera de su organización, GetAdminConsentURL se puede utilizar para generar la URL de autorización del administrador. A diferencia de GetOAuthAuthorizationURL, no se devolverá información importante desde este extremo. Si otorga acceso, simplemente devolverá un valor booleano que indica que se otorgaron los permisos.

Una vez que un administrador otorga el consentimiento, la autenticación se puede realizar normalmente.

Credenciales del Cliente

Las credenciales del cliente hacen referencia a un flujo en OAuth en el que no se lleva a cabo una autenticación directa del usuario. En cambio, las credenciales se crean solo para la aplicación en sí. Todas las tareas realizadas por la aplicación se realizan sin un contexto de usuario predeterminado. Esto hace que el flujo de autenticación sea un poco diferente al estándar.

Flujo de OAuth del Cliente

Todos los permisos relacionados con el flujo de autenticación del cliente requieren el consentimiento del administrador. Esto significa que la aplicación integrada con Jitterbit Connector para Excel Online no se puede usar en el flujo de autenticación del cliente. Debe crear su propia aplicación OAuth para usar las credenciales del cliente. Consulte Crear una aplicación OAuth personalizada para más detalles.

En su Registro de aplicaciones en portal.azure.com, vaya a Permisos de API y seleccione los permisos de Microsoft Graph. Hay dos conjuntos distintos de permisos: permisos delegados y de aplicación. Los permisos utilizados durante la autenticación de credenciales del cliente se encuentran en Permisos de la aplicación. Seleccione los permisos aplicables que necesita para su integración.

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

  1. Authenticating using a Client Secret
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
    • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
    • OAuthGrantType: Establézcalo en CLIENTE.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
  2. Authenticating using a Certificate
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
    • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
    • OAuthGrantType: Establézcalo en CLIENTE.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
    • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

La autenticación con las credenciales del cliente se realizará automáticamente como cualquier otra conexión, excepto que no se abrirá ninguna ventana que pregunte al usuario. Debido a que no hay un contexto de usuario, no hay necesidad de una ventana emergente en el navegador. Las conexiones se llevarán a cabo y se manejarán internamente.

Uso de la Autenticación Principal de Servicio de Azure

La autenticación como entidad principal de servicio de Azure se gestiona a través del flujo de credenciales de cliente de OAuth y no implica la autenticación directa del usuario. En cambio, las credenciales se crean solo para la aplicación en sí. Todas las tareas realizadas por la aplicación se realizan sin un contexto de usuario predeterminado, pero en función de los roles asignados. El acceso de la aplicación a los recursos se controla a través de los permisos de los roles asignados.

Credenciales Personalizadas

Deberá registrar una aplicación de OAuth para obtener los valores de propiedad de OAuth antes de conectarse a la fuente de datos de Excel Online. Puede comprobar las Credenciales personalizadas guía sobre cómo configurar las propiedades de OAuth.

Creación de una Aplicación OAuth Personalizada

Consulte Crear una aplicación OAuth personalizada para un procedimiento.

Creación de una Aplicación OAuth Personalizada

Es necesario crear una aplicación de OAuth personalizada y una entidad de servicio que pueda acceder a los recursos necesarios cuando se autentica mediante una entidad de servicio de Azure.

Siga los pasos a continuación para crear una aplicación OAuth personalizada y obtener las propiedades de conexión para la autenticación de la entidad de servicio de Azure.

Pasos para Crear una Aplicación OAuth Personalizada

Siga los pasos a continuación para obtener los valores de OAuth para su aplicación.

  1. Inicie sesión en <https://portal.azure.com>.
  2. En el panel de navegación de la izquierda, seleccione Azure Active Directory, luego Registros de aplicaciones y haga clic en el botón Nuevo registro.
  3. Ingrese un nombre de aplicación y configure el botón de opción para "Cualquier directorio de Azure AD - Multiusuario". Luego configure la URL de redireccionamiento a algo como http://localhost:33333, el valor predeterminado del conector.
  4. Copie el valor de ID de la aplicación (cliente) que se muestra en la sección Descripción general después de crear la aplicación, ya que este valor se usa como OAuthClientId
  5. Defina el tipo de autenticación de la aplicación en la sección Certificados y secretos. Hay dos tipos de autenticación disponibles: usando un secreto de cliente y usando un certificado. El método de autenticación recomendado es a través de un certificado, pero también puede crear un secreto de aplicación.
    • Option 1 - Upload a certificate: En la sección Certificados y secretos, seleccione Cargar certificado y seleccione el certificado para cargar desde su máquina local.
    • Option 2 - Create a new application secret: En la sección Certificados y secretos, seleccione Nuevo secreto de cliente para la aplicación y seleccione su duración. Después de guardar el secreto del cliente, se muestra el valor de la clave. Copie este valor ya que se muestra solo una vez y se usa como OAuthClientSecret.
  6. En la pestaña Autenticación, asegúrese de marcar la opción: Tokens de acceso (utilizados para flujos implícitos).
  7. Abra la página Suscripciones buscando y seleccionando el servicio Suscripciones en la barra de búsqueda.
  8. Seleccione la suscripción particular para asignar la aplicación, luego abra la sección Control de acceso (IAM) y haga clic en el botón Agregar asignación de rol.
  9. Seleccione Propietario como el rol para asignar a su aplicación OAuth creada.

Credenciales Personalizadas

Siga los pasos a continuación para autenticarse con las credenciales de una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada.

Autenticación con Su Aplicación OAuth

Hay dos tipos de autenticación de aplicaciones disponibles: usar un secreto de cliente y usar un certificado. Puede usar cualquiera de ellos dependiendo de la autenticación de la aplicación configurada.

Obtenga un Token de Acceso OAuth

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión según el tipo de autenticación.

  1. Authenticating using a Client Secret
    • AuthScheme: establezca esto en "AzureServicePrincipal" en la configuración de su aplicación.
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
    • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
  2. Authenticating using a Certificate
    • AuthScheme: establezca esto en "AzureServicePrincipal" en la configuración de su aplicación.
    • InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
    • AzureTenant: Configure esto para el arrendatario al que desea conectarse.
    • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
    • OAuthJWTCert: establezca esto en el almacén de certificados JWT.
    • OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

Selección de Datos en Línea de Excel

Las siguientes propiedades de conexión le permiten ejecutar consultas SELECT que se asemejan mucho a cómo está organizada su hoja.

Selección de Encabezados de Columna

Si su hoja de trabajo tiene encabezados de columna, puede configurar Header propiedad para usar nombres de columna definidos en una fila de encabezado. Entonces puedes consultar así:

SELECT Id, Name, Item, Quantity, Amount FROM Test_xlsx_Sheet1 WHERE Amount = 50

La consultar anterior asume que la primera fila de la hoja de trabajo tiene los nombres de columna Id, Nombre, Cantidad y Monto. La hoja de cálculo puede tener más columnas de las que se seleccionaron y pueden estar en cualquier orden.

Selección de Columnas Alfabéticas

Si un libro de trabajo no tiene encabezados, o si desea ignorar los encabezados, puede configurar Header propiedad a falso. En este caso, cada columna está representada por nombres alfabéticos. Por ejemplo:

SELECT A, B, C, D FROM Test_xlsx_Sheet1 WHERE D = 50

Selección de Rangos

En lugar de trabajar con la hoja de cálculo como una sola tabla, puede trabajar con rangos como tablas. Algunos ejemplos: en un libro de trabajo disperso, puede usar rangos para seleccionar datos sin las filas vacías. O bien, en una hoja de trabajo que no está alineada en la parte superior izquierda, puede usar un rango para seleccionar datos en el medio de la hoja.

Para seleccionar un rango de datos en la hoja de cálculo, agregue el rango al nombre de la tabla con el carácter #. Por ejemplo, el siguiente comando seleccionará el rango de celdas entre A1 y E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Para asignar un nombre de tabla a un rango y evitar especificar el rango repetidamente, consulte Tables propiedad.

Insertar Datos de Excel Online

Puede ejecutar instrucciones INSERT cuando trabaje con hojas de trabajo como tablas. Puede especificar los nombres de columna detectados desde una fila de encabezado o especificar los nombres de columna alfabéticos en Excel Online. También puede configurar cómo el conector analiza los valores de entrada en formatos de celda de Excel Online.

Selecciona el Header propiedad para configurar los nombres de las columnas. Colocar ValueInputOption para configurar el análisis de entrada.

Tenga en cuenta que no se admite la inserción en rangos. Utilice inserciones por lotes o tablas temporales en su lugar.

Insertar con Encabezados

Cuando el Header propiedad se establece en verdadero, puede especificar celdas en una fila de encabezado como nombres de columna.

INSERT INTO Test_xlsx_Sheet1(Name, Amount) VALUES ('Test', 10)

Insertar Sin Encabezados

Cuando el Header la propiedad se establece en falso, proporcione los nombres de las columnas en orden alfabético.

INSERT INTO Test_xlsx_Sheet1(A, B) VALUES ('Test', 10)

Configuración del Análisis de Entrada

De forma predeterminada, el conector analiza todos los valores que ingresa en la instrucción SQL de la misma manera que si hubiera ingresado la entrada en la interfaz de usuario de Excel Online. Por ejemplo, las cadenas se pueden convertir en números, fechas, etc.

Para deshabilitar el análisis de los valores de entrada, configure ValueInputOption. Además, consulte Uso de fórmulas para configurar la evaluación de fórmulas.

Ejemplo: Inserciones Masivas Utilizando Tablas Temporales

Si usa tablas temporales, deben definirse e insertarse dentro de la misma conexión. Cerrar la conexión borrará cualquier tabla temporal en la memoria.

Creación de Tablas Temporales

Inserte las filas que necesita en una tabla temporal. Luego inserte todas las filas de esa tabla temporal en la tabla real.

Ejemplo de Código

A continuación se muestra el código completo para insertar 2 filas en Test_xlsx_Sheet1:

Connection conn = DriverManager.getConnection("jdbc:excelonline:InitiateOAuth=GETANDREFRESH;");
Statement stat = conn.createStatement();

stat.executeUpdate("INSERT INTO [Prueba_xlsx_Hoja1#TEMP] (Column1, Column2) VALUES ('value1', 'value2')");
stat.executeUpdate("INSERT INTO [Prueba_xlsx_Hoja1#TEMP] (Column1, Column2) VALUES ('value3', 'value4')");

stat.executeUpdate("INSERT INTO [Prueba_xlsx_Hoja1] (Column1, Column2) SELECT Column1, Column2 FROM [Test_xlsx_Sheet1#TEMP]");

stat.close();

Actualización de Datos en Línea de Excel

En las instrucciones UPDATE, puede especificar los nombres de columna detectados desde una fila de encabezado o especificar los nombres de columna alfabéticos en Excel Online. También puede configurar cómo el conector analiza los valores de entrada en formatos de celda de Excel Online.

Selecciona el Header propiedad para configurar los nombres de las columnas. La clave principal es el número de fila; especifique la clave principal con la columna ID. Colocar ValueInputOption para configurar el análisis de entrada.

Actualización con Encabezados

Cuando el Header la propiedad se establece en verdadero, actualiza las columnas especificando los nombres de las columnas detectadas.

UPDATE Customers SET Col1='value' WHERE Id=7

Actualización Sin Encabezados

Cuando el Header se establece en falso, proporcione los nombres de las columnas en orden alfabético:

UPDATE Customers SET H='value' WHERE Id=7

Actualización de Rangos

Establezca las columnas correspondientes al rango y especifique el número de fila como Id:

UPDATE [Clientes#A15:C15] SET A='Ana Trujilo', B='Northwind, Inc.', C='100,000' WHERE Id='15'

Configuración del Análisis de Entrada

De forma predeterminada, el conector analiza todos los valores que ingresa en la instrucción SQL de la misma manera que si hubiera ingresado la entrada en la interfaz de usuario de Excel Online. Por ejemplo, las cadenas se pueden convertir en números, fechas, etc.

Para deshabilitar el análisis de los valores de entrada, configure ValueInputOption. Además, consulte Uso de fórmulas para configurar la evaluación de fórmulas.

Eliminación de Datos de Excel Online

Al eliminar una fila completa de datos, deberá asegurarse de actualizar los datos de la tabla. Esto se debe a que los ID se asignan en función de la fila. Por ejemplo, si hay cinco filas, con los Id. del 1 al 5, y elimina la fila 3, la fila 4 se convertirá en 3 y la 5 se convertirá en 4.

Uso de Fórmulas

Establezca las siguientes propiedades para configurar la evaluación de fórmulas al ejecutar instrucciones SELECT, INSERT y UPDATE.

Selección de Fórmulas

El conector puede devolver el resultado de la fórmula o la fórmula misma; configure este comportamiento con ValueRenderOption propiedad de conexión.

Insertar y Actualizar Fórmulas

Colocar AllowFormula a verdadero para insertar fórmulas (predeterminado). De lo contrario, todos los valores utilizados en las inserciones y actualizaciones se insertan como literales de cadena.

Por ejemplo, con AllowFormula establecido en verdadero, lo siguiente insertará una fórmula en la columna B que sumará las celdas B1: B5:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Nota: Si AllowFormula se establece en verdadero, cada columna que contenga una fórmula se expondrá como tipo Cadena independientemente del conjunto TypeDetectionScheme.

Notas Importantes

Procedimientos Almacenados

  • Las funciones de procedimientos almacenados descritas en esta documentación no se admiten actualmente.
  • Debido a que los procedimientos almacenados no se admiten actualmente, cualquier característica que dependa de los procedimientos almacenados tampoco se admite actualmente.

Archivos de Configuración y Sus Rutas

  • Todas las referencias a la adición de archivos de configuración y sus rutas se refieren a archivos y ubicaciones en Harmony Agente donde está instalado el conector. Estas rutas deben ajustarse según corresponda según el agente y el sistema operativo. Si se utilizan varios agentes en un grupo de agentes, se requerirán archivos idénticos en cada agente.

Características Avanzadas

Esta sección detalla una selección de características avanzadas del conector de Excel Online.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario

El conector Jitterbit para Excel Online le permite definir una tabla virtual cuyo contenido se decide mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

  • Cree un archivo de configuración con formato JSON que defina las vistas que desea.
  • Declaraciones DDL.

Definición de Vistas Usando un Archivo de Configuración

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

  • Cada elemento raíz define el nombre de una vista.
  • Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Test_xlsx_Sheet1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Vistas Definidas por el Usuario

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL

Personalización de la Configuración SSL

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos

Libros de trabajo como tablas

El conector modela las hojas de trabajo y los rangos en sus libros de trabajo como tablas bidireccionales. Cuando se conecta, el conector recupera los metadatos de Excel Online y refleja cualquier cambio en los esquemas de la tabla.

Consulte la sección Primeros pasos para obtener inicios rápidos para ejecutar SQL en las tablas. Esta sección proporciona detalles adicionales sobre el comportamiento del conector.

Mesas

Esta sección proporciona más detalles sobre cómo el conector modela las Tablas. Vea Columnas para obtener detalles sobre el descubrimiento de columnas.

Procedimientos almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Además de trabajar con los datos del libro de trabajo, puede utilizar los procedimientos almacenados* para acceder a la funcionalidad en la API de Excel Online que no está modelada como declaraciones SELECT, INSERT, UPDATE o DELETE; por ejemplo, AddWorksheet procedimiento almacenado.

Tablas de sistema

Consulte las Tablas del sistema disponibles para acceder a los metadatos del conector disponibles, incluida la información del esquema.

Mejores prácticas

1) Si actualmente tiene muchos libros de trabajo u hojas en su cuenta, puede llevar mucho tiempo recuperar inicialmente todos los datos. Puede acortar este tiempo agregando Workbook propiedad de conexión a su cadena de conexión.

2) Si ejecutará una operación SELECCIONAR después de INSERTAR o INSERTAR LOTE, asegúrese de esperar de 3 a 5 segundos antes de ejecutarla. La API tarda unos segundos en registrar todos los datos que está agregando a la base de datos, por lo que es necesario esperar para evitar resultados parciales.

Mesas

El conector le permite representar una hoja de trabajo orientada a la parte superior izquierda o un rango especificado por el usuario como una tabla de base de datos.

Hojas de Trabajo Orientadas Arriba a la Izquierda

Puede usar el conector para comenzar a trabajar de inmediato con hojas de trabajo orientadas a la parte superior izquierda:

  • El nombre de la tabla para una hoja de trabajo orientada hacia la parte superior izquierda es el nombre de la hoja de trabajo.
  • Por defecto, el conector devolverá todas las filas hasta la primera fila vacía. Nota: una fila vacía entre los datos evitará que se devuelvan más datos.
  • La primera fila de datos en la hoja de trabajo puede contener los nombres de las columnas. Vea Columnas para más información.

Rangos Especificados por el Usuario

La notación de rango solo está disponible en una instrucción SELECT o UPDATE. Los rangos no son compatibles con los comandos DELETE e INSERT.

Puede ejecutar comandos SELECCIONAR o ACTUALIZAR contra un rango dado con una referencia en el siguiente formato: HOJA DE TRABAJO#RANGO. También puede configurar el Tables propiedad para asignar un nombre de tabla a un rango.

Por ejemplo, el siguiente comando seleccionará el rango de celdas entre A1 y E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Acceso a Documentos Compartidos Como una Tabla de Base de Datos

Puedes usar la propiedad de conexión ShowSharedDocuments para enumerar libros de Excel compartidos como tablas de base de datos. Las tablas se enumerarán junto con los libros de trabajo propiedad del usuario.

Ejecutar SQL a Datos de la Hoja de Trabajo

Consulte lo siguiente para ejecutar SQL de manipulación de datos en hojas de cálculo y rangos:

Columnas

Cuando se conecta, el conector descubre las columnas disponibles y refleja tanto los cambios en Excel Online como los cambios de configuración que realiza con las siguientes propiedades de conexión. Consulte las siguientes secciones para configurar aspectos de la detección de columnas específicos de Excel Online.

Configuración de la Detección de Nombres de Columnas

Puede establecer Header para detectar nombres de columna en una fila de encabezado o puede hacer referencia a las columnas alfabéticamente.

Encabezado=Verdadero (predeterminado)

A continuación hay más detalles sobre cómo el conector detecta los nombres de columna de una fila de encabezado cuando Header se establece en verdadero.

  • El conector determina las columnas de la primera fila de la hoja de trabajo. Si no se proporciona ningún valor para la primera fila de la hoja de trabajo, el conector crea nombres de columna alfabéticos únicos que están disponibles solo dentro del alcance de esa solicitud.
  • Los encabezados no deben contener caracteres especiales.
  • Debido a una limitación de la API de Excel Online, todos los encabezados de columna no deben estar vacíos.
Encabezado=Falso

Cuando Header se establece en falso, los nombres de las columnas alfabéticas se asignarán dinámicamente.

Clave Primaria

El conector notifica el número de fila como clave principal. La columna ID de cada fila representa el número de fila desde la parte superior de la hoja.

Por ejemplo, si especifica un rango A3:E6, se devolverán las filas 3, 4, 5 y 6.

Configuración del Análisis de Valores de Columna

El ValueRenderOption y ValueInputOption Las propiedades de conexión se pueden usar para configurar cómo el conector analiza los formatos de celda de Excel Online en las operaciones SELECCIONAR, INSERTAR y ACTUALIZAR.

Opciones de Representación de Valor para Operaciones SELECT

Selecciona el ValueRenderOption para configurar cómo el conector representa los valores en la salida de una operación SELECT. Las opciones de representación de valor disponibles son las siguientes.

  • FormattedValue: Los valores se calcularán y formatearán en la salida de acuerdo con el formato de la celda. El formato se basa en la configuración regional del libro de trabajo, no en la configuración regional del usuario solicitante. Este es el predeterminado ValueRenderOption.
  • UnformattedValue: Los valores se calcularán pero no se formatearán en la salida.
  • Formula: Los valores no se calcularán y, en su lugar, la salida incluirá las fórmulas. Por esta razón, cada columna que contenga una fórmula se expondrá como tipo String independientemente del conjunto TypeDetectionScheme.
Opciones de Entrada de Valores para las Operaciones INSERTAR y ACTUALIZAR

Selecciona el ValueInputOption para configurar cómo el conector analiza los valores que el usuario envía a la fuente de Excel Online para las operaciones INSERTAR y ACTUALIZAR. Las opciones de entrada de valor disponibles son las siguientes.

  • UserEntered: Los valores se analizarán como si el usuario los hubiera escrito en la interfaz de usuario. Los números permanecerán como números, pero las cadenas se pueden convertir en números, fechas, etc., siguiendo las mismas reglas que se aplican al ingresar texto en una celda a través de la interfaz de usuario de Excel Online. Este es el predeterminado ValueInputOption.
  • Raw: Los valores que el usuario ha ingresado no se analizarán y se almacenarán tal cual.

Configuración de la Detección de Tipos de Datos

Selecciona el TypeDetectionScheme para configurar el método de detección del tipo de datos. Los esquemas de detección de tipos disponibles son los siguientes.

  • RowScan: El conector escaneará filas para determinar heurísticamente el tipo de datos. El número de filas que escaneará el conector se puede determinar mediante RowScanDepth propiedad. Este es el predeterminado TypeDetectionScheme.
  • ColumnFormat: El conector informará el tipo de datos según el formato de celda de la columna. Esta opción es aplicable solo para 'UnformattedValue' y 'Fórmula' ValueRenderOption-s. Si el ValueRenderOption se establece en 'FormattedValue', todas las columnas se expondrán como tipos String.
  • None: El conector devolverá todas las columnas como tipo de cadena.

Puntos de Vista

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas en Línea de Excel

Nombre Descripción
Drives Recuperar una lista de objetos de la unidad.
SharedDocuments Recupere la lista de todos los documentos compartidos. No todos los elementos enumerados por esta vista se pueden usar como un libro de trabajo, ya que el controlador filtrará los archivos que no sean de Excel. Consulte las vistas Libro de trabajo y Hojas de trabajo para obtener más información.
SharePointSites Recupere la lista de todos los sitios en su cuenta de SharePoint.
Workbooks Recuperar una lista de objetos del libro de trabajo.
Worksheets Recuperar una lista de objetos de la hoja de cálculo. Si enumera hojas en un libro de trabajo que no pertenecen a la unidad del usuario, especifique la identificación de la unidad usando la propiedad de conexión de la unidad.

Unidades

Recuperar una lista de objetos de la unidad.

Seleccionar

La siguiente consultar de ejemplo devolverá las unidades con el Id. de sitio de SharePoint especificado.

SELECT * FROM Drives WHERE SiteId='rssbus.onmicrosoft.com,988a3-343a-4064-996a-d2a30559f,4233d-dfcd-4910-b7f0-71f1dc03a'
Columnas
Nombre Tipo Referencias Descripción
Id [KEY] String El identificador único de la unidad.
SiteId String SharePointSitios.Id El identificador del sitio o subsitio de SharePoint al que pertenece esta unidad.
Name String El nombre de la unidad.
Description String La descripción de la unidad.
CreatedByName String El nombre para mostrar de la identidad.
CreatedById String Identificador único para la identidad.
CreatedDateTime Datetime Fecha y hora en que se creó la unidad.
LastModifiedDateTime Datetime Fecha y hora en que se modificó por última vez la unidad.
WebUrl String URL que muestra el recurso en el navegador.

Documentos Compartidos

Recupere la lista de todos los documentos compartidos. No todos los elementos enumerados por esta vista se pueden usar como un libro de trabajo, ya que el controlador filtrará los archivos que no sean de Excel. Consulte las vistas Libro de trabajo y Hojas de trabajo para obtener más información.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] String El ID del documento compartido
SharedFileId String El ID de archivo compartido del documento.
DriveId String El ID de la unidad donde reside este documento.
Name String El nombre del documento compartido.
Size String El tamaño del documento compartido.
SharedByUserName String El nombre del usuario que compartió este documento.
SharedDateTime String La fecha y hora en que se compartió este documento.
CreatedDateTime Datetime La fecha y hora en que se creó este documento.
LastModifiedDateTime Datetime La fecha y hora en que se modificó por última vez este documento.
WebUrl String La URL web de este documento compartido.

SharePointSitios

Recupere la lista de todos los sitios en su cuenta de SharePoint.

Información Específica de la Tabla

A diferencia de casi todas las demás tablas y vistas expuestas, esta vista no implementa ningún extremo de Microsoft Graph, sino el extremo "/ consultar /búsqueda" de la API de REST de SharePoint. Por este motivo, en la mayoría de los casos deberá especificar el SharepointURL propiedad de conexión antes de iniciar el flujo de OAuth. Durante el flujo de autorización, el conector obtendrá los permisos necesarios para utilizar sus recursos de SharePoint.

Seleccionar

El conector usará la API REST de SharePoint para procesar las condiciones de la cláusula WHERE creadas con casi todas las columnas, excepto Id, y solo para el operador EQUALS (=). El resto del filtro se ejecuta del lado del cliente dentro del conector.

La siguiente consultar de ejemplo devolverá el sitio de SharePoint con el SiteId y el WebId especificados.

SELECT SiteId, SiteName, Title, SiteDescription FROM SharePointSites WHERE SiteId='9839b8a3-343a-4064-996a-d2a300bc559f' AND WebId='427d733d-dfcd-4910-b7f0-771f1d4cc03a'
Restricciones

Para consultar esta vista usando 'AzureAD' AuthScheme con el cliente' OAuthGrantType, o usando 'AzureServicePrincipal' AuthScheme, debe especificar el OAuthJWTCert en vez de OAuthClientSecret propiedad de conexión. La restricción la impone la API REST de SharePoint, que no acepta OAuthAccessToken recuperado al especificar un OAuthClientSecret para los flujos de autenticación antes mencionados.

Para obtener una guía sobre cómo autenticar mediante un certificado para los AuthSchemes 'AzureAD' y 'AzureServicePrincipal', puede consultar las Credenciales del cliente o las Credenciales personalizadas sección.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] String El identificador completo del sitio.
SiteId String El identificador único de la colección de sitios.
WebId String El Web ID del sitio.
SiteName String El nombre del sitio.
Title String El título del sitio.
SiteDescription String La descripción del sitio.
Description String La descripción del artículo.
CreatedDateTime Datetime Fecha y hora en que se creó el sitio.
LastModifiedDateTime Datetime Fecha y hora en que se modificó el sitio por última vez.
SPWebUrl String URL que muestra el recurso en el navegador.
Author String El autor del sitio.
DocumentSignature String La firma del documento del sitio.
FileExtension String La extensión del archivo del sitio.
SecondaryFileExtension String La extensión secundaria del archivo del sitio.
FileType String El tipo de archivo del sitio.
DocId Long El identificador único del sitio dentro de una ubicación geográfica.
GeoLocationSource String La ubicación geográfica del sitio.
HitHighlightedSummary String El resumen elevado del sitio.
Importance Long La importancia del sitio.
IsContainer Bool Especifica si el sitio es una carpeta.
IsDocument Bool Especifica si el sitio es un documento.
OriginalPath String La ruta del sitio original.
Path String La ruta del sitio actual.
Rank Double El rango del sitio.
RenderTemplateId String El nombre de la modelo de procesamiento de control del sitio.
SiteLogo String El URI del logo del sitio.
ViewsLifeTime Long El recuento total de vistas desde que se creó el sitio.
ViewsRecent Long El recuento total de vistas del sitio en los últimos 14 días.
WebTemplate String El templo web desde el que se crea el sitio.

Libros de Trabajo

Recuperar una lista de objetos del libro de trabajo.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] String El identificador único del elemento dentro de Drive.
Name String El nombre del artículo.
CreatedByName String El nombre para mostrar de la identidad.
CreatedById String Identificador único para la identidad.
CreatedDateTime Datetime Fecha y hora en que se creó el elemento.
LastModifiedDateTime Datetime Fecha y hora en que se modificó por última vez el elemento.
Size Long Tamaño del elemento en bytes.
WebUrl String URL que muestra el recurso en el navegador.

Hojas de Trabajo

Recuperar una lista de objetos de la hoja de cálculo. Si enumera hojas en un libro de trabajo que no pertenecen a la unidad del usuario, especifique la identificación de la unidad usando la propiedad de conexión de la unidad.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] String Devuelve un valor que identifica de forma única la hoja de trabajo en un libro de trabajo determinado. El valor del identificador sigue siendo el mismo incluso cuando se cambia el nombre o se mueve la hoja de cálculo.
WorkbookId String Libros de trabajo.Id El ID del libro de trabajo que contiene esta hoja de trabajo.
Name String El nombre para mostrar de la hoja de cálculo.
Position Integer La posición de base cero de la hoja de trabajo dentro del libro de trabajo.
Visibility String La visibilidad de la hoja de cálculo. Los valores posibles son: Visible, Oculto, MuyOculto.

Procedimientos Almacenados

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Jitterbit Connector para Procedimientos Almacenados en Línea de Excel

Nombre Descripción
AddWorksheet Agregue una hoja de cálculo a un libro de Excel Online existente.
CreateSchema Crea un archivo de esquema para la tabla o vista especificada.
GetAdminConsentURL Obtiene la URL de consentimiento del administrador que un administrador de un dominio determinado debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita cuando se usan credenciales de OAuth personalizadas.
GetOAuthAccessToken Obtiene el token de acceso de OAuth de Excel Online.
GetOAuthAuthorizationURL Obtiene la URL de autorización de Excel Online. Acceda a la URL devuelta en la salida en un navegador web. Esto solicita el token de acceso que se puede usar como parte de la cadena de conexión a Excel Online.
RefreshOAuthAccessToken Actualiza el token de acceso de OAuth que se usa para la autenticación con Excel Online.

Agregar Hoja de Cálculo

Agregue una hoja de cálculo a un libro de Excel Online existente.

Aporte
Nombre Tipo Descripción
WorkbookId String El ID del libro de trabajo.
Title String El nombre de la hoja de cálculo.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Success String Este valor muestra si la operación fue exitosa o no.

CrearEsquema

Crea un archivo de esquema para la tabla o vista especificada.

Aporte
Nombre Tipo Descripción
TableName String El nombre de la tabla o vista.
FileName String La ruta completa del archivo y el nombre del esquema a generar. Ej: 'C:\Users\User\Desktop\SmartSheet\sheet.rsd'
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
Result String Devuelve éxito o fracaso.

GetAdminConsentURL

Obtiene la URL de consentimiento del administrador que un administrador de un dominio determinado debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita cuando se usan credenciales de OAuth personalizadas.

Aporte
Nombre Tipo Descripción
CallbackUrl String La URL a la que se redirigirá al usuario después de autorizar su aplicación. Este valor debe coincidir con la URL de respuesta en la configuración de la aplicación de Azure AD.
State String El mismo valor para el estado que envió cuando solicitó el código de autorización.
Scope String Una lista de ámbitos separados por espacios para solicitar al administrador. Consulte la documentación de la API de Microsoft Graph para obtener una lista de los permisos disponibles.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
URL String La URL de autorización, ingresada en un navegador web por el administrador para otorgar permisos para su aplicación.

Obtener Token de Acceso de OAuth

Obtiene el token de acceso de OAuth de Excel Online.

Aporte
Nombre Tipo Descripción
AuthMode String El tipo de modo de autenticación a utilizar. Los valores permitidos son APP, WEB.
Verifier String El token del verificador devuelto por Excel Online después de usar la URL obtenida con GetOAuthAuthorizationURL. Requerido solo para Web AuthMode.
CallbackUrl String La URL a la que se redirigirá al usuario después de autorizar su aplicación.
Scope String Una lista de ámbitos separados por espacios para solicitar al usuario cuando OAuthGrantType='CODE'. Consulte la documentación de la API de Microsoft Graph para obtener una lista de los permisos disponibles. Cuando OAuthGrantType='CLIENT', un ámbito de 'https://graph.microsoft.com/.default' se usa '/.default' recoge los permisos que ya tiene su aplicación.
State String Un valor incluido en la solicitud que también se devolverá en la respuesta del token. Puede ser una cadena de cualquier contenido que desee.
Prompt String El valor predeterminado es 'select_account', que solicita al usuario que seleccione la cuenta durante la autenticación. Establézcalo en 'Ninguno', para no solicitar, 'iniciar sesión' para obligar al usuario a ingresar sus credenciales o 'consentimiento' para activar el cuadro de diálogo de consentimiento de OAuth después de que el usuario inicie sesión, pidiéndole que otorgue permisos a la aplicación.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Excel Online.
OAuthRefreshToken String Un token que puede usarse para obtener un nuevo token de acceso.
ExpiresIn String El tiempo de vida restante para el token de acceso en segundos.

Obtener URL de Autorización de OAuth

Obtiene la URL de autorización de Excel Online. Acceda a la URL devuelta en la salida en un navegador web. Esto solicita el token de acceso que se puede usar como parte de la cadena de conexión a Excel Online.

Aporte
Nombre Tipo Descripción
CallbackUrl String La URL a la que regresará Excel Online después de que el usuario haya autorizado su aplicación.
Scope String Una lista de ámbitos separados por espacios para solicitar al usuario cuando OAuthGrantType='CODE'. Consulte la documentación de la API de Microsoft Graph para obtener una lista de los permisos disponibles. Cuando OAuthGrantType='CLIENT', un ámbito de 'https://graph.microsoft.com/.default' se usa '/.default' recoge los permisos que ya tiene su aplicación.
Prompt String El valor predeterminado es 'select_account', que solicita al usuario que seleccione la cuenta durante la autenticación. Establézcalo en 'Ninguno', para no solicitar, 'iniciar sesión' para obligar al usuario a ingresar sus credenciales o 'consentimiento' para activar el cuadro de diálogo de consentimiento de OAuth después de que el usuario inicie sesión, pidiéndole que otorgue permisos a la aplicación.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
URL String La URL que se ingresará en un navegador web para obtener el token verificador y autorizar al proveedor de datos.

RefreshOAuthAccessToken

Actualiza el token de acceso de OAuth que se usa para la autenticación con Excel Online.

Aporte
Nombre Tipo Descripción
OAuthRefreshToken String El antiguo token que se actualizará.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Excel Online.
ExpiresIn String El tiempo de vida restante en el token de acceso.

Tablas del Sistema

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema

Las siguientes tablas devuelven metadatos de la base de datos para Excel Online:

Tablas de Fuentes de Datos

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

  • sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
  • sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consulta

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos, incluidas las operaciones lote:

  • identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.
SchemaName String El nombre del esquema.

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista.
TableType String El tipo de tabla (tabla o vista).
Description String Una descripción de la tabla o vista.
IsUpdateable Boolean Si la tabla se puede actualizar.

Sys_tablecolumns

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Test_xlsx_Sheet1:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Test_xlsx_Sheet1' 
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista que contiene la columna.
ColumnName String El nombre de la columna.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El tamaño de almacenamiento de la columna.
DisplaySize Int32 El ancho máximo normal de la columna designada en caracteres.
NumericPrecision Int32 El número máximo de dígitos en datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 La escala de columna o número de dígitos a la derecha del punto decimal.
IsNullable Boolean Si la columna puede contener nulo.
Description String Una breve descripción de la columna.
Ordinal Int32 El número de secuencia de la columna.
IsAutoIncrement String Si el valor de la columna se asigna en incrementos fijos.
IsGeneratedColumn String Si se genera la columna.
IsHidden Boolean Si la columna está oculta.
IsArray Boolean Si la columna es una matriz.

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene el procedimiento almacenado.
SchemaName String El esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado.
Description String Una descripción del procedimiento almacenado.
ProcedureType String El tipo de procedimiento, como PROCEDIMIENTO o FUNCIÓN.

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado AddWorksheet:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddWorksheet' AND Direction=1 OR Direction=2
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el procedimiento almacenado.
SchemaName String El nombre del esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado* que contiene el parámetro.
ColumnName String El nombre del procedimiento almacenado* parámetro.
Direction Int32 Un número entero correspondiente al tipo de parámetro: entrada (1), entrada/salida (2) o salida (4). Los parámetros de tipo de entrada/salida pueden ser tanto parámetros de entrada como de salida.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El número de caracteres permitidos para los datos de caracteres. El número de dígitos permitidos para datos numéricos.
NumericPrecision Int32 La máxima precisión para datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 El número de dígitos a la derecha del punto decimal en datos numéricos.
IsNullable Boolean Si el parámetro puede contener nulo.
IsRequired Boolean Si el parámetro es necesario para la ejecución del procedimiento.
IsArray Boolean Si el parámetro es una matriz.
Description String La descripción del parámetro.
Ordinal Int32 El índice del parámetro.

Sys_keycolumns

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Test_xlsx_Sheet1:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Test_xlsx_Sheet1'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
IsKey Boolean Si la columna es una clave principal en la tabla a la que se hace referencia en el campo TableName.
IsForeignKey Boolean Si la columna es una clave externa a la que se hace referencia en el campo TableName.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.

Sys_foreignkeys

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.
ForeignKeyType String Designa si la clave externa es una clave de importación (apunta a otras tablas) o de exportación (hace referencia desde otras tablas).

Sys_indexes

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el índice.
SchemaName String El nombre del esquema que contiene el índice.
TableName String El nombre de la tabla que contiene el índice.
IndexName String El nombre del índice.
ColumnName String El nombre de la columna asociada con el índice.
IsUnique Boolean True si el índice es único. Falso en caso contrario.
IsPrimary Boolean True si el índice es una clave principal. Falso en caso contrario.
Type Int16 Un valor entero correspondiente al tipo de índice: estadística (0), agrupado (1), hash (2) u otro (3).
SortOrder String El orden de clasificación: A para ascender o D para descender.
OrdinalPosition Int16 El número de secuencia de la columna en el índice.

Sys_connection_props

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:excelonline:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columnas
Nombre Tipo Descripción
Name String El nombre de la propiedad de conexión.
ShortDescription String Una breve descripción.
Type String El tipo de datos de la propiedad de conexión.
Default String El valor predeterminado si no se establece uno explícitamente.
Values String Una lista separada por comas de valores posibles. Se lanza un error de validación si se especifica otro valor.
Value String El valor que establezca o un valor predeterminado preconfigurado.
Required Boolean Si la propiedad es necesaria para conectarse.
Category String La categoría de la propiedad de conexión.
IsSessionProperty String Si la propiedad es una propiedad de sesión, utilizada para guardar información sobre la conexión actual.
Sensitivity String El nivel de sensibilidad de la propiedad. Esto informa si la propiedad está ofuscada en los formularios de registro y autenticación.
PropertyName String Una forma truncada en mayúsculas y minúsculas del nombre de la propiedad de conexión.
Ordinal Int32 El índice del parámetro.
CatOrdinal Int32 El índice de la categoría de parámetro.
Hierarchy String Muestra las propiedades dependientes asociadas que deben configurarse junto con esta.
Visible Boolean Informa si la propiedad está visible en la interfaz de usuario de la conexión.
ETC String Diversa información miscelánea sobre la propiedad.

Sys_sqlinfo

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

Nombre Descripción Valores posibles
AGGREGATE_FUNCTIONS Funciones de agregación admitidas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Si se admite la función COUNT. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR El carácter de apertura utilizado para escapar de un identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR El carácter de cierre utilizado para escapar de un identificador. ]
SUPPORTED_OPERATORS Una lista de operadores de SQL admitidos. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Si se admite GROUP BY y, de ser así, el grado de compatibilidad. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funciones de cadena admitidas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funciones numéricas compatibles. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funciones de fecha/hora admitidas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tablas omitidas durante la replicación.
REPLICATION_TIMECHECK_COLUMNS Una matriz de cadenas que contiene una lista de columnas que se usarán para verificar (en el orden dado) para usar como una columna modificada durante la replicación.
IDENTIFIER_PATTERN Valor de cadena que indica qué cadena es válida para un identificador.
SUPPORT_TRANSACTION Indica si el proveedor admite transacciones como compromiso y reversión. YES, NO
DIALECT Indica el dialecto SQL a usar.
KEY_PROPERTIES Indica las propiedades que identifican la base de datos uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica si pueden existir varios esquemas para el proveedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica si pueden existir varios catálogos para el proveedor. YES, NO
DATASYNCVERSION La versión de sincronización de datos necesaria para acceder a este controlador. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY La categoría Sincronización de datos de este controlador. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Si se admite la funcionalidad de SQL mejorada más allá de lo que ofrece la API. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Si se admiten las operaciones lote. YES, NO
SQL_CAP Todas las funciones de SQL admitidas para este controlador. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Un valor de cadena especifica las cacheOptions preferidas.
ENABLE_EF_ADVANCED_QUERY Indica si el controlador admite directamente consultas avanzadas provenientes de Entity Framework. De lo contrario, las consultas se manejarán del lado del cliente. YES, NO
PSEUDO_COLUMNS Una matriz de cadenas que indica las pseudocolumnas disponibles.
MERGE_ALWAYS Si el valor es verdadero, el modo de combinación se ejecuta a la fuerza en la sincronización de datos. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Una consultar de selección para devolver la fecha y hora de inicio de la réplica.
REPLICATION_MIN_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un min del lado del servidor.
REPLICATION_START_DATE Permite que un proveedor especifique una fecha de inicio de réplica.
REPLICATION_MAX_DATE_QUERY Una consultar de selección para devolver la fecha y hora de finalización de la réplica.
REPLICATION_MAX_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un máx. del lado del servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Una lista de tablas que omitirán dividir la réplica en fragmentos en la réplica inicial.
CHECKCACHE_USE_PARENTID Indica si la instrucción CheckCache debe realizarse en la columna de clave principal. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimientos almacenados* que se puede utilizar para generar archivos de esquema.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas
Nombre Tipo Descripción
NAME String Un componente de la sintaxis SQL o una capacidad que se puede procesar en el servidor.
VALUE String Detalles sobre el SQL o la sintaxis de SQL admitidos.

Sys_identidad

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity
Columnas
Nombre Tipo Descripción
Id String El ID generado por la base de datos devuelto de una operación de modificación de datos.
Batch String Un identificador para el lote. 1 para una sola operación.
Operation String El resultado de la operación en el lote: INSERTADO, ACTUALIZADO o ELIMINADO.
Message String ÉXITO o un mensaje de error si falla la actualización en el lote.

Propiedades de Configuraciones Avanzadas

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

Autenticación

Propiedad Descripción
AuthScheme El tipo de autenticación que se usará al conectarse a Excel Online.
UseSandbox Un valor booleano que indica si está utilizando una cuenta de espacio aislado. El proveedor realiza solicitudes al ambiente de producción de forma predeterminada.

Conexión

Propiedad Descripción
DefineTables Asigne nombres de tabla a rangos.
Workbook El nombre o ID del libro de trabajo.
Drive El ID de la unidad.
IncludeSharePointSites Si recuperar unidades para todos los sitios de SharePoint al consultar la vista Unidades. Si es 'verdadero', el proveedor recuperará todos los ID de sitio de forma recursiva y para cada uno de ellos emitirá una llamada por separado para obtener sus unidades. Por lo tanto, tenga en cuenta que establecer esta propiedad en "verdadero" puede disminuir el rendimiento de la vista Unidades.

Autenticación de Azure

Propiedad Descripción
AzureTenant El inquilino de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se utilizará su tentant predeterminado.
AzureEnvironment El ambiente de Azure que se usará al establecer una conexión.

OAuth

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
OAuthGrantType El tipo de concesión para el flujo de OAuth.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

SSL

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Esquema

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Misceláneas

Propiedad Descripción
AllowFormula Si tratar o no los valores que comienzan con un signo igual (=) como fórmulas durante las inserciones y actualizaciones.
Header Indica si el proveedor debe o no detectar los nombres de columna de la primera fila.
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
Pagesize El número máximo de resultados por página de Excel Online cuando UsePagination es True.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
RowScanDepth El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.
SharepointURL La URL base de su servidor Sharepoint.
ShowSharedDocuments Mostrar o no los documentos compartidos.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
TypeDetectionScheme Determina cómo determinar los tipos de datos de las columnas.
UsePagination Si el proveedor ADO.NET para Excel Online debe o no usar la paginación del lado del cliente.
UseSimpleNames Booleano que determina si se deben usar nombres simples para tablas y columnas.
ValueInputOption Determina cómo analiza el proveedor los valores que el usuario envía a Excel Online.
ValueRenderOption Determina cómo el proveedor representa los valores en la salida.

Autenticación

Esta sección proporciona una lista completa de las propiedades de autenticación que puede configurar.

Propiedad Descripción
AuthScheme El tipo de autenticación que se usará al conectarse a Excel Online.
UseSandbox Un valor booleano que indica si está utilizando una cuenta de espacio aislado. El proveedor realiza solicitudes al ambiente de producción de forma predeterminada.

AuthScheme

El tipo de autenticación que se usará al conectarse a Excel Online.

Valores Posibles

AzureAD, AzureMSI, AzureServicePrincipal

Tipo de Datos

string

Valor por Defecto

"AzureAD"

Observaciones
  • AzureAD: configure esto para realizar la autenticación OAuth de Azure Active Directory.
  • AzureMSI: configure esto para obtener automáticamente las credenciales de identidad de servicio administrado cuando se ejecuta en una máquina virtual de Azure.
  • AzureServicePrincipal: configure esto para autenticarse como una entidad de servicio de Azure.

UsarSandbox

Un valor booleano que indica si está utilizando una cuenta de espacio aislado. El proveedor realiza solicitudes al ambiente de producción de forma predeterminada.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Si está utilizando una cuenta de producción, esta propiedad se puede dejar en blanco. Si está utilizando una cuenta de prueba de desarrollador, establezca esto en verdadero.

Conexión

Esta sección proporciona una lista completa de las propiedades de conexión que puede configurar.

Propiedad Descripción
DefineTables Asigne nombres de tabla a rangos.
Workbook El nombre o ID del libro de trabajo.
Drive El ID de la unidad.
IncludeSharePointSites Si recuperar unidades para todos los sitios de SharePoint al consultar la vista Unidades. Si es 'verdadero', el proveedor recuperará todos los ID de sitio de forma recursiva y para cada uno de ellos emitirá una llamada por separado para obtener sus unidades. Por lo tanto, tenga en cuenta que establecer esta propiedad en "verdadero" puede disminuir el rendimiento de la vista Unidades.

DefinirTablas

Asigne nombres de tabla a rangos.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta propiedad se usa para definir los rangos dentro de una hoja de cálculo que aparecerán como tablas. El valor es una lista separada por punto y coma de pares de nombre-valor en la forma [Table Name]=[Workbook Name]_[Worksheet Name]![Range].

Aquí hay un ejemplo de valor de DefineTables:

DefineTables="Table1=Test_xlsx_Sheet1!A1:N25,Table2=Spreadsheet1_Sheet2!C3:M53,Table4=xIsPcLs2-bF3AavQcSLCfzs3kGc_Sheet4!C20:N60"

Después de configurar DefineTables, luego puede emitir consultas que hagan referencia al nombre de la tabla especificada. Tenga en cuenta que también puede usar la sintaxis de rango directamente en la instrucción SQL: agregue el rango al nombre de la hoja de cálculo con el carácter #.

Por ejemplo, el siguiente comando seleccionará el rango de celdas entre A1 y E5:

SELECT * FROM Test_xlsx_Sheet1#A1:E5

Libro de Trabajo

El nombre o ID del libro de trabajo.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifica el nombre o ID del libro de trabajo. Una lista de todos los libros de trabajo está disponible en la vista Libros de trabajo.

Conducir

El ID de la unidad.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifica el ID de la unidad. Una lista de todas las unidades está disponible en la vista Unidades.

Incluir Sitios de SharePoint

Si recuperar unidades para todos los sitios de SharePoint al consultar la vista Unidades. Si es 'verdadero', el proveedor recuperará todos los ID de sitio de forma recursiva y para cada uno de ellos emitirá una llamada por separado para obtener sus unidades. Por lo tanto, tenga en cuenta que establecer esta propiedad en "verdadero" puede disminuir el rendimiento de la vista Unidades.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Esta propiedad solo afecta a las vistas de Drives.

Autenticación de Azure

Esta sección proporciona una lista completa de las propiedades de autenticación de Azure que puede configurar.

Propiedad Descripción
AzureTenant El inquilino de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se utilizará su tentant predeterminado.
AzureEnvironment El ambiente de Azure que se usará al establecer una conexión.

AzureInquilino

El inquilino de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se utilizará su tentant predeterminado.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El inquilino de Microsoft Online que se usa para acceder a los datos. Por ejemplo, contoso.onmicrosoft.com. Como alternativa, especifique el Id. de arrendatario. Este valor es el ID de directorio en Azure Portal > Active Directory de Azure > Propiedades.

Por lo general, no es necesario especificar el Arrendatario. Microsoft puede determinar esto automáticamente cuando se utiliza el OAuthGrantType establecido en CÓDIGO (predeterminado). Sin embargo, puede fallar en el caso de que el usuario pertenezca a varios inquilinos. Por ejemplo, si un administrador del dominio A invita a un usuario del dominio B a ser un usuario invitado. El usuario ahora pertenecerá a ambos inquilinos. Es una buena práctica especificar el Tenant, aunque en general las cosas normalmente deberían funcionar sin tener que especificarlo.

El AzureTenant es necesario cuando se configura OAuthGrantType al CLIENTE. Cuando se usan credenciales de cliente, no hay contexto de usuario. Las credenciales se toman del contexto de la propia aplicación. Si bien Microsoft todavía permite obtener las credenciales de los clientes sin especificar qué arrendatario, tiene una probabilidad mucho menor de elegir el arrendatario específico con el que desea trabajar. Por esta razón, requerimos AzureTenant debe indicarse explícitamente para todas las conexiones de credenciales de clientes para garantizar que obtenga las credenciales que se aplican al dominio al que desea conectarse.

AzureAmbiente

El ambiente de Azure que se usará al establecer una conexión.

Valores Posibles

GLOBAL, CHINA, GERMANY, USGOVT, USGOVTDOD

Tipo de Datos

string

Valor por Defecto

"GLOBAL"

Observaciones

En la mayoría de los casos, funcionará dejar el ambiente establecido en global. Sin embargo, si su cuenta de Azure se ha agregado a un ambiente diferente, el AzureEnvironment se puede utilizar para especificar qué ambiente. Los valores disponibles son GLOBAL, CHINA, GERMANY, USGOVT y USGOVTDOD.

OAuth

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
OAuthGrantType El tipo de concesión para el flujo de OAuth.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Iniciar OAuth

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles

OFF, GETANDREFRESH, REFRESH

Tipo de Datos

string

Valor por Defecto

"OFF"

Observaciones

Las siguientes opciones están disponibles:

  1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
  2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
  3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth

El token de acceso para conectarse mediante OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

URL de Devolución de Llamada

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

OAuthGrantType

El tipo de concesión para el flujo de OAuth.

Valores Posibles

CODE, CLIENT, PASSWORD

Tipo de Datos

string

Valor por Defecto

"CLIENT"

Observaciones

El tipo de concesión para el flujo de OAuth. Las siguientes opciones están disponibles: CÓDIGO, CLIENTE, CONTRASEÑA

OAuthVerifier

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

SSL

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

SSLServerCert

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Descripción Ejemplo
Un certificado PEM completo (ejemplo abreviado por brevedad) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Una ruta a un archivo local que contiene el certificado C:\cert.cer
La clave pública (ejemplo abreviado por brevedad) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
La huella digital MD5 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) ecadbdda5a1529c58a1e9e09828d70e4
La huella digital SHA1 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Ubicación

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos

string

Valor por Defecto

"%APPDATA%\\\ExcelOnline Data Provider\\Schema"

Observaciones

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\ExcelOnline Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Plataforma %APPDATA%
Windows El valor de la variable de ambiente APPDATA
Mac ~/Biblioteca/Soporte de aplicaciones
Linux ~/.config

Esquemas Navegables

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Propiedad Descripción
AllowFormula Si tratar o no los valores que comienzan con un signo igual (=) como fórmulas durante las inserciones y actualizaciones.
Header Indica si el proveedor debe o no detectar los nombres de columna de la primera fila.
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
Pagesize El número máximo de resultados por página de Excel Online cuando UsePagination es True.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
RowScanDepth El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.
SharepointURL La URL base de su servidor Sharepoint.
ShowSharedDocuments Mostrar o no los documentos compartidos.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
TypeDetectionScheme Determina cómo determinar los tipos de datos de las columnas.
UsePagination Si el proveedor ADO.NET para Excel Online debe o no usar la paginación del lado del cliente.
UseSimpleNames Booleano que determina si se deben usar nombres simples para tablas y columnas.
ValueInputOption Determina cómo analiza el proveedor los valores que el usuario envía a Excel Online.
ValueRenderOption Determina cómo el proveedor representa los valores en la salida.

Permitir Fórmula

Si tratar o no los valores que comienzan con un signo igual (=) como fórmulas durante las inserciones y actualizaciones.

Tipo de Datos

bool

Valor por Defecto

true

Observaciones

Establezca este valor en verdadero para tratar los valores que comienzan con un signo igual (=) como fórmulas en inserciones y actualizaciones. Establezca el valor en falso para tratar todos los valores utilizados en inserciones y actualizaciones como cadenas.

Por ejemplo, con AllowFormula establecido en verdadero, lo siguiente insertará una fórmula en la columna B que sumará las celdas B1: B5:

INSERT INTO Excel_Sheet (A, B) VALUES ('Bill', '=SUM(B1:B5)')

Nota: Si es Verdadero, cada columna que contenga una fórmula se expondrá como tipo String independientemente del TypeDetectionScheme.

Encabezamiento

Indica si el proveedor debe o no detectar los nombres de columna de la primera fila.

Tipo de Datos

bool

Valor por Defecto

true

Observaciones

Si es verdadero, la primera fila se usará como encabezado de columna. De lo contrario, se utilizarán los nombres de las pseudocolumnas A, B, C, etc.

El conector seguirá las especificaciones adicionales a continuación para detectar encabezados de columna:

  • Los encabezados no deben contener caracteres especiales.
  • Debido a una limitación de la API de Excel Online, todos los encabezados de columna no deben estar vacíos.

Filas Máximas

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos

int

Valor por Defecto

-1

Observaciones

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo
Propiedad Descripción
DefaultColumnSize Establece la longitud predeterminada de los campos de cadena cuando la fuente de datos no proporciona la longitud de columna en los metadatos. El valor predeterminado es 2000.
ConvertDateTimeToGMT Determina si se convierten los valores de fecha y hora a GMT, en lugar de la hora local de la máquina.
RecordToFile=filename Registra la transferencia de datos del socket subyacente al archivo especificado.

Tamaño de Página

El número máximo de resultados por página de Excel Online cuando UsePagination es True.

Tipo de Datos

int

Valor por Defecto

-1

Observaciones

El Pagesize la propiedad afecta la cantidad máxima de resultados a devolver por página de Excel Online. Establecer un valor más alto puede resultar en un mejor rendimiento a costa de memoria adicional consumida por página consumida. Un valor de -1 indica el tamaño de página máximo posible para el controlador.

Pseudocolumnas

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

FilaExploraciónProfundidad

El número máximo de filas para escanear para buscar las columnas disponibles en una tabla.

Tipo de Datos

int

Valor por Defecto

50

Observaciones

Las columnas de una tabla deben determinarse escaneando las filas de la tabla. Este valor determina el número máximo de filas que se escanearán.

Establecer un valor alto puede disminuir el rendimiento. Establecer un valor bajo puede evitar que el tipo de datos se determine correctamente, especialmente cuando hay datos nulos.

SharepointURL

La URL base de su servidor Sharepoint.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Para consultar SharePointSites, se debe especificar esta URL base de su servidor Sharepoint.

Por ejemplo: https://SomeTenantName.sharepoint.com.

Mostrar Documentos Compartidos

Mostrar o no los documentos compartidos.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Mostrar o no los documentos compartidos. Si se establece en verdadero, los documentos compartidos se enumerarán junto con los libros de trabajo propiedad del usuario como tablas de base de datos. En última instancia, los archivos específicos deberían tener acceso directo o compartirse explícitamente con el usuario autenticado.

Se Acabó el Tiempo

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos

int

Valor por Defecto

60

Observaciones

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.

TipoDetecciónEsquema

Determina cómo determinar los tipos de datos de las columnas.

Valores Posibles

None, RowScan, ColumnFormat

Tipo de Datos

string

Valor por Defecto

"RowScan"

Observaciones

El conector puede detectar tipos de datos con el formato de celda (número, moneda, fecha, etc.) o escaneando filas.

Propiedad Descripción
None Configuración TypeDetectionScheme a Ninguno devolverá todas las columnas como el tipo de cadena.
RowScan Configuración TypeDetectionScheme to RowScan escaneará filas para determinar heurísticamente el tipo de datos. El RowScanDepth determina el número de filas que escaneará el conector.
ColumnFormat Configuración TypeDetectionScheme a ColumnFormat informará el tipo de datos según el formato de celda de la columna. Nota: Esta opción es aplicable solo para 'UnformattedValue' y 'Formula' ValueRenderOption-s. Si ValueRenderOption se establece en 'FormattedValue', todas las columnas se expondrán como tipos String.

UsePagination

Si el proveedor ADO.NET para Excel Online debe o no usar la paginación del lado del cliente.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Si Jitterbit Connector para Excel Online debe o no usar la paginación del lado del cliente. Le sugerimos que establezca esto en verdadero en caso de un gran conjunto de datos.

UsarNombresSimples

Booleano que determina si se deben usar nombres simples para tablas y columnas.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Las tablas y columnas de Excel Online pueden usar caracteres especiales en los nombres que normalmente no se permiten en las bases de datos estándar. UseSimpleNames hace que el conector sea más fácil de usar con las herramientas de bases de datos tradicionales.

Configuración UseSimpleNames a verdadero simplificará los nombres de las tablas y columnas devueltas. Aplicará un esquema de nomenclatura tal que solo los caracteres alfanuméricos y el guión bajo sean válidos para los nombres de las tablas y columnas que se muestran. Cualquier carácter no alfanumérico se convertirá en un guión bajo.

Opción de Entrada de Valor

Determina cómo analiza el proveedor los valores que el usuario envía a Excel Online.

Valores Posibles

UserEntered, Raw

Tipo de Datos

string

Valor por Defecto

"UserEntered"

Observaciones

Determina cómo analiza el conector los valores que el usuario envía a Excel Online.

Propiedad Descripción
Raw Los valores que el usuario ha ingresado no se analizarán y se almacenarán tal cual.
UserEntered Los valores se analizarán como si el usuario los hubiera escrito en la interfaz de usuario. Los números permanecerán como números, pero las cadenas se pueden convertir en números, fechas, etc., siguiendo las mismas reglas que se aplican al ingresar texto en una celda a través de la interfaz de usuario de Excel Online.

ValueRenderOption

Determina cómo el proveedor representa los valores en la salida.

Valores Posibles

FormattedValue, UnformattedValue, Formula

Tipo de Datos

string

Valor por Defecto

"FormattedValue"

Observaciones

Determina cómo el conector representa los valores en la salida.

Propiedad Descripción
FormattedValue Los valores se calcularán y formatearán en la respuesta de acuerdo con el formato de la celda. El formato se basa en la configuración regional del libro de trabajo, no en la configuración regional del usuario solicitante. Por ejemplo, si A1 es 1,23 y A2 es "=A1" y tiene el formato de moneda, entonces A2 devolvería "$1,23".
UnformattedValue Los valores se calcularán pero no se formatearán en la respuesta. Por ejemplo, si A1 es 1,23 y A2 es "=A1" y tiene el formato de moneda, A2 devolverá el número 1,23.
Formula Los valores no se calcularán y en su lugar la respuesta incluirá las fórmulas. Por ejemplo, si A1 es 1,23 y A2 es "=A1" y tiene el formato de moneda, entonces A2 devolvería "=A1". Por esta razón, cada columna que contenga una fórmula se expondrá como tipo String independientemente del TypeDetectionScheme.