Detalles de Conexión de Microsoft OneNote

Introducción

Versión del conector

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

Empezando

Compatibilidad con la versión de Microsoft OneNote

Todas las versiones alojadas de Microsoft OneNote son compatibles a través de Microsoft Graph API v1.0. Incluye información a la que se puede acceder desde los blocs de notas, las secciones y las páginas de OneNote de un usuario en una cuenta personal o de organización.

Establecer una Conexión

Autenticación en Microsoft OneNote

Microsoft OneNote usa el estándar de autenticación OAuth. Para autenticarse mediante OAuth, deberá crear una aplicación para obtener el OAuthClientId, OAuthClientSecret, y CallbackURL propiedades de conexión.

Azure AD

Azure AD es un tipo de conexión que aprovecha OAuth para la autenticación. OAuth requiere que el usuario que se autentica interactúe con Microsoft OneNote mediante un navegador de Internet. El conector facilita esto de varias maneras, como se describe a continuación. Establecer su AuthScheme a AzureAD. Todos los flujos de Microsoft Entra ID asumen que lo ha hecho.

Aplicaciones de Escritorio

proporciona una aplicación OAuth integrada que simplifica la autenticación de escritorio OAuth. Como alternativa, puede crear una aplicación OAuth personalizada. Consulte Creación de una aplicación Microsoft Entra ID personalizada para obtener información sobre la creación de aplicaciones personalizadas y las razones para hacerlo.

Para la autenticación, la única diferencia entre los dos métodos es que debe establecer dos propiedades de conexión adicionales al usar aplicaciones OAuth personalizadas.

Después de configurar las siguientes propiedades de conexión, está listo para conectarse:

• InitiateOAuth: Establézcalo en GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
• OAuthClientId: (solo aplicaciones personalizadas) Establezca esto en la ID del cliente en la configuración de su aplicación.
• OAuthClientSecret: (solo aplicaciones personalizadas) Establezca esto en el secreto del cliente en la configuración de su aplicación.
• CallbackURL: establezca esto en la URL de redirección en la configuración de su aplicación.

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 anterior.
3. Guarda los valores de OAuth en OAuthSettingsLocation que persisten a través de las conexiones.

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 Microsoft OneNote no contiene permisos que requieran el consentimiento del administrador. Por lo tanto, esta información se aplica solo a las aplicaciones personalizadas.

Permisos de consentimiento de administrador

Al crear una nueva aplicación Microsoft Entra ID 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, haga clic en Grant Consent para que su aplicación tenga permisos en el arrendatario bajo el cual se creó.

Si su organización tiene varios inquilinos o necesita otorgar permisos de aplicación para otros inquilinos fuera de su organización, use GetAdminConsentURL procedimiento almacenado* para generar la URL de autorización del administrador. A diferencia de GetOAuthAuthorizationURL, no se devolverá información importante desde este extremo. Una vez que la aplicación de OAuth se autoriza correctamente, devuelve un valor booleano que indica que se han concedido los permisos.

Una vez que el administrador haya aprobado la aplicación OAuth, puede continuar con la autenticación.

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 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 Microsoft OneNote 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 Creación de una aplicación Microsoft Entra ID personalizada para más detalles.

En tu App Registro en portal.azure.com, vaya a Permisos de API y seleccione Microsoft Graph permissions. 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 que necesita para su integración.

Está listo para conectarse después de configurar uno de los 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 CLIENT.
   • OAuthClientId: establezca esto en la identificación 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 identificación 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 realiza automáticamente como cualquier otra conexión, excepto que no se abre 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.

Entidad de Servicio de Azure

Azure Service Principal es un tipo de conexión que pasa por OAuth. Establecer su AuthScheme a AzureServicePrincipal. 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.

Nota: Debe crear una aplicación personalizada antes de asignar una rol. Consulte Creación de una aplicación Microsoft Entra ID personalizada para más información.

Al autenticarse con una entidad de servicio de Azure, debe registrar una aplicación con un arrendatario de Azure AD. Siga los pasos a continuación para crear una nueva entidad de servicio que se pueda usar con el control de acceso basado en roles.

Asignar un Rol a la Aplicación

Para acceder a los recursos de su suscripción, debe asignar un rol a la aplicación.

1. Abra el Subscriptions página buscando y seleccionando el servicio Suscripciones en la barra de búsqueda.
2. Seleccione la suscripción particular a la que asignar la aplicación.
3. Abra el Access control (IAM) y seleccione Add > Add role assignment para abrir el Add role assignment página.
4. Seleccione Owner como el rol para asignar a su aplicación de Azure AD creada.

Complete la Autenticación

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión, según la autenticación de la aplicación configurada (secreto de cliente o certificado).

En ambos métodos

Antes de elegir el secreto del cliente o la autenticación de certificado, siga estos pasos y luego continúe con la sección correspondiente a continuación:

1. AuthScheme: Establézcalo en AzureServicePrincipal en la configuración de su aplicación.
2. InitiateOAuth: Establézcalo en GETANDREFRESH. Puedes usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
3. AzureTenant: Configure esto para el arrendatario al que desea conectarse.
4. OAuthClientId: establezca esto en la identificación del cliente en la configuración de su aplicación.

Autenticación usando un secreto de cliente

Continúe con lo siguiente:

1. OAuthClientId: establezca esto en la identificación del cliente en la configuración de su aplicación.
2. OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.

Autenticación usando un Certificado

Continúe con lo siguiente:

1. OAuthJWTCert: establezca esto en el almacén de certificados JWT.
2. OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

MSI

Si está ejecutando Microsoft OneNote en una máquina virtual de Azure, puede aprovechar las credenciales de identidad de servicio administrado (MSI) para conectarse:

• AuthScheme: Establézcalo en AzureMSI.

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

Creación de una Aplicación Microsoft Entra ID Personalizada

Hay dos tipos de aplicaciones personalizadas de Microsoft Entra ID: Microsoft Entra ID y Microsoft Entra ID con una entidad de servicio de Azure. Ambos están basados en OAuth.

Cuándo Crear una Aplicación Personalizada

incorpora Credenciales de aplicación OAuth con marca que se puede usar cuando se conecta a través de una aplicación de escritorio o desde una máquina sin cabeza.

Puede optar por utilizar sus propias Credenciales de aplicación de Microsoft Entra ID cuando desee

• controlar la marca del diálogo de autenticación
• controlar el URI de redireccionamiento al que la aplicación redirige al usuario después de que el usuario se autentica
• personalizar los permisos que está solicitando al usuario

Aplicaciones Personalizadas de Microsoft Entra ID

Puede usar una aplicación Microsoft Entra ID personalizada para autenticar una cuenta de servicio o una cuenta de usuario. Siempre puede crear una aplicación Microsoft Entra ID personalizada, pero tenga en cuenta que las conexiones de escritorio y sin cabeza admiten OAuth integrado, lo que simplifica el proceso de autenticación. Consulte "Establecimiento de una conexión" para obtener información sobre el uso de la aplicación OAuth integrada.

Crear una Aplicación Microsoft Entra ID Personalizada

Siga los pasos a continuación para obtener los valores de Microsoft Entra ID 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, entonces applicationRegistrations y haga clic en New registration.
3. Ingrese un nombre de aplicación y seleccione la configuración de inquilino deseada. Al crear una aplicación personalizada de Microsoft Entra ID 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, "Solo cuentas en este directorio organizacional", debe configurar AzureTenant propiedad de conexión al ID del arrendatario de Azure AD al establecer una conexión con Jitterbit Connector para Microsoft OneNote. De lo contrario, el intento de autenticación falla con un error. Si su aplicación es solo para uso privado, "Cuentas en el directorio de esta organización solamente" debería ser suficiente. De lo contrario, si desea distribuir su aplicación, elija una de las opciones de múltiples inquilinos.
4. Establezca la URL de redirección en http://localhost:33333, el valor predeterminado del conector. O bien, especifique un puerto diferente y configure CallbackURL a la URL de respuesta exacta que definiste.
5. Haga clic en Register para registrar la nueva aplicación. Esto abre una pantalla de administración de aplicaciones. Tenga en cuenta el valor en Application (client) ID como el OAuthClientId y el Directory (tenant) ID como el AzureTenant.
6. Navegue hasta "Certificados y secretos" y defina el tipo de autenticación de la aplicación. Hay dos tipos de autenticación disponibles: secreto de cliente o certificado. El método de autenticación recomendado es mediante un certificado.
   • Opción 1: Cargar un certificado: En "Certificados y secretos", seleccione Upload certificate y el certificado para cargar desde su máquina local.
   • Opción 2: Crear un nuevo secreto de aplicación: En "Certificados y secretos", seleccione New Client Secret para la aplicación y especificar su duración. Después de guardar el secreto del cliente, se muestra el valor de la clave. Copie este valor ya que solo se muestra una vez. Lo necesitará como OAuthClientSecret.
7. Seleccione API Permissions > Add > Delegated permissions.
8. Seleccione la API de Microsoft Graph y los siguientes permisos delegados permiten el acceso a la funcionalidad completa del controlador:
   • Leer y escribir todos los Cuadernos, Secciones, Grupos de Sección y Páginas.
   • Leer todos los usuarios.
   • Leer todos los grupos.
9. Guarde sus cambios.
10. 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 de "Consentimiento del administrador".

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.

Cree una Aplicación de Microsoft Entra ID y una Entidad de Servicio de Azure

Al autenticarse con una entidad de servicio de Azure, debe registrar una aplicación con un arrendatario de Azure AD.

Asignar un Rol a la Aplicación

Para acceder a los recursos de su suscripción, debe asignar un rol a la aplicación.

1. Abra el Subscriptions página buscando y seleccionando el servicio Suscripciones en la barra de búsqueda.
2. Seleccione la suscripción particular a la que asignar la aplicación.
3. Abra el Access control (IAM) y seleccione Add > Add role assignment para abrir el Add role assignment página.
4. Seleccione Owner como el rol para asignar a su aplicación de Azure AD creada.

Complete la Autenticación

Está listo para conectarse después de configurar uno de los siguientes grupos de propiedades de conexión, según la autenticación de la aplicación configurada (secreto de cliente o certificado).

En ambos métodos

Antes de elegir el secreto del cliente o la autenticación de certificado, siga estos pasos y luego continúe con la sección correspondiente a continuación:

1. AuthScheme: Establézcalo en AzureServicePrincipal en la configuración de su aplicación.
2. InitiateOAuth: Establézcalo en GETANDREFRESH. Puedes usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.
3. AzureTenant: Configure esto para el arrendatario al que desea conectarse.
4. OAuthClientId: establezca esto en la identificación del cliente en la configuración de su aplicación.

Autenticación usando un secreto de cliente

Continúe con lo siguiente:

1. OAuthClientId: establezca esto en la identificación del cliente en la configuración de su aplicación.
2. OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.

Autenticación usando un Certificado

Continúe con lo siguiente:

1. OAuthJWTCert: establezca esto en el almacén de certificados JWT.
2. OAuthJWTCertType: establezca esto en el tipo de almacén de certificados especificado por OAuthJWTCert.

Tareas Administrativas

El conector Jitterbit para Microsoft OneNote se puede utilizar para realizar tareas administrativas. Esto se puede hacer especificando la columna UserId para ejecutar operaciones CUD.

La Columna de ID de Usuario

Muchas tablas exponen una columna de ID de usuario especial. Esto está diseñado para ser utilizado por un administrador para modificar registros en la cuenta de otro usuario. Si no es administrador o no desea este comportamiento, no especifique el ID de usuario cuando realice una operación INSERTAR/ACTUALIZAR/ELIMINAR. Por ejemplo, ejecutar lo siguiente insertará un cuaderno para otro usuario:

INSERT INTO Notebooks (displayName, UserId) VALUES ('Test Notebook', '12345')

La solicitud anterior tendrá el efecto general de intentar agregar un cuaderno en el recurso en /users/12345/notebooks. Cuando no se especifica UserId, los recursos afectados se modificarán en /users/me/notebooks. En general, si no es administrador, solo puede afectar o ver registros en /usuarios/yo, por lo que no se recomienda configurar el ID de usuario cuando no es administrador.

Características Avanzadas

Esta sección detalla una selección de características avanzadas del conector de Microsoft OneNote.

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.

Procesamiento de consultas

El conector descarga la mayor cantidad posible del procesamiento de la declaración SELECT en Microsoft OneNote y luego procesa el resto de la consultar en la memoria (lado del cliente).

Consulte Procesamiento de consultas para más información.

Vistas Definidas por el Usuario

Jitterbit Connector para Microsoft OneNote 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 Utilizando 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 Notebooks 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"

Definición de Vistas Usando Sentencias DDL

El conector también es capaz de crear y modificar el esquema a través de instrucciones DDL como CREATE LOCAL VIEW, ALTER LOCAL VIEW y DROP LOCAL VIEW.

Crear una Vista

Para crear una nueva vista usando declaraciones DDL, proporcione el nombre de la vista y la consultar de la siguiente manera:

CREATE LOCAL VIEW [MiNombre de vista] AS SELECT * FROM Customers LIMIT 20;

Si no existe ningún archivo JSON, el código anterior crea uno. Luego, la vista se crea en el archivo de configuración JSON y ahora se puede detectar. La ubicación del archivo JSON se especifica mediante UserDefinedViews propiedad de conexión.

Modificar una Vista

Para modificar una vista existente, proporcione el nombre de una vista existente junto con la nueva consultar que le gustaría usar en su lugar:

ALTER LOCAL VIEW [MiNombre de Vista] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Luego, la vista se actualiza en el archivo de configuración JSON.

Suelta una Vista

Para descartar una vista existente, proporcione el nombre de un esquema existente junto con la nueva consultar que le gustaría usar en su lugar.

DROP LOCAL VIEW [MyViewName]

Esto elimina la vista del archivo de configuración JSON. Ya no se puede consultar.

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

Descripción general

Esta sección muestra los objetos API disponibles y proporciona más información sobre cómo ejecutar SQL en las APIs de Microsoft OneNote.

Características clave

• El conector modela entidades de Microsoft OneNote como usuarios y grupos como vistas relacionales, entidades como cuadernos, secciones, grupos de secciones y páginas como tablas relacionales, lo que le permite escribir SQL para consultar datos de Microsoft OneNote.
• Procedimientos almacenados* le permiten ejecutar operaciones en Microsoft OneNote, incluida la recuperación del token de acceso y mantenerlo actualizado en OAuth 2.0.
• La conectividad en vivo con estos objetos significa que cualquier cambio en su cuenta de Microsoft OneNote se refleja de inmediato al usar el conector.

Puntos de vista

Puntos de vista describe las vistas disponibles. Las vistas se definen estáticamente para modelar usuarios y grupos.

Mesas

Mesas describe las tablas disponibles. Las tablas se definen estáticamente para modelar cuadernos, grupos de secciones, secciones y páginas.

Procedimientos almacenados

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

Procedimientos almacenados son interfaces similares a funciones para OneNote. Se pueden usar para buscar, crear y modificar información en OneNote.

Mesas

El conector modela los datos en Microsoft OneNote en una lista de tablas que se pueden consultar mediante instrucciones SQL estándar.

Generalmente, consultar tablas de Microsoft OneNote es lo mismo que consultar una tabla en una base de datos relacional. A veces hay casos especiales, por ejemplo, incluir una determinada columna en la cláusula WHERE puede ser necesario para obtener datos para ciertas columnas de la tabla. Esto suele ser necesario para situaciones en las que se debe realizar una solicitud separada para cada fila para obtener ciertas columnas. Estos tipos de situaciones están claramente documentados en la parte superior de la página de la tabla vinculada a continuación.

Conector Jitterbit para Tablas de Microsoft OneNote

Cuadernos

Recupera todos los Notebooks para el usuario autenticado.

Información Específica de la Tabla

Seleccionar

La mayoría de los filtros se manejan en el lado del servidor, pero los campos específicos de Id, UserId y GroupId cambiarán el extremo que usamos para recuperar los datos. Deben especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM Notebooks WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Notebooks WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935', '1-56e2fc02-f3dd-4f82-fvgf-dfsdf4807935')
SELECT * FROM Notebooks WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Notebooks WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Insertar

La columna necesaria para realizar una operación de inserción en la tabla Notebooks es DisplayName. Si la operación INSERT se realiza en nombre de un grupo o usuario, también se debe especificar UserId o GroupId. Los siguientes ejemplos ilustran una operación Insertar en Notebooks:

INSERT INTO Notebooks (DisplayName) VALUES ('Getting started')
INSERT INTO Notebooks (DisplayName, UserId) VALUES ('Getting started','9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Notebooks (DisplayName, GroupId) VALUES ('Getting started','044d385d-6ca8-4d81-800d-223124b651db')

Columnas

SecciónGrupos

Recupera todos los grupos de secciones de los blocs de notas para el usuario autenticado.

Información Específica de la Tabla

Seleccionar

La mayoría de los filtros se manejan en el lado del servidor, pero los campos específicos de Id, UserId, GroupId y ParentNotebookId cambiarán el extremo que usamos para recuperar los datos. Deben especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM SectionGroups WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE ParentNotebookId = '1-2342423-1234-3424-82fb-519bc4807935'
SELECT * FROM SectionGroups WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-sdcgw3324-f3dd-5678-derf-519bc4807935')
SELECT * FROM SectionGroups WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM SectionGroups WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Insertar

Las columnas necesarias para realizar una operación de inserción en la tabla SectionGroups son DisplayName y ParentNotebookId. Si la operación INSERT se realiza en nombre de un grupo o usuario, también se debe especificar UserId o GroupId. Los siguientes ejemplos ilustran una operación de inserción en grupos de secciones:

INSERT INTO SectionGroups (DisplayName, ParentNotebookId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO SectionGroups (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Columnas

Secciones

Recupera todas las secciones de los cuadernos para el usuario autenticado.

Información Específica de la Tabla

Seleccionar

La mayoría de los filtros se manejan en el lado del servidor, pero los campos específicos de Id, UserId, GroupId, ParentNotebookId y ParentSectionGroupId cambiarán el extremo que usamos para recuperar los datos. Deben especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM Sections WHERE Id = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentNotebookId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE ParentSectionGroupId = '1-56e2fc02-f3dd-4f82-82fb-519bc4807935'
SELECT * FROM Sections WHERE Id IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentNotebookId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE ParentSectionGroupId IN ('1-56e2fc02-f3dd-4f82-82fb-519bc4807935','1-23423-f3dd-rtsd-gfds-4353423fsdf')
SELECT * FROM Sections WHERE UserId = '9525a3f1-aa40-4f17-a97b-68606d118adf'
SELECT * FROM Sections WHERE GroupId = '044d385d-6ca8-4d81-800d-223124b651db'

Insertar

Las columnas necesarias para realizar una operación de inserción en la tabla de secciones son DisplayName y ParentNotebookId. Si la operación INSERT se realiza en nombre de un grupo o usuario, también se debe especificar UserId o GroupId. Los siguientes ejemplos ilustran una operación de inserción en secciones:

INSERT INTO Sections (DisplayName, ParentNotebookId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571')
INSERT INTO Sections (DisplayName, ParentNotebookId, UserId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '9525a3f1-aa40-4f17-a97b-68606d118adf')
INSERT INTO Sections (DisplayName, ParentNotebookId, GroupId) VALUES ('Getting started','1-5c57790b-73c3-4996-940e-07c3f2157571', '044d385d-6ca8-4d81-800d-223124b651db')

Columnas

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.

Se admiten las vistas dinámicas, como las consultas expuestas como vistas y las vistas para buscar combinaciones específicas de elementos de trabajo project_team.

Conector Jitterbit para Vistas de Microsoft OneNote

Grupos

Recupera todos los grupos de Azure Active Directory (Azure AD), que pueden ser grupos de Office 365 o grupos de seguridad.

Información Específica de la Tabla

Los grupos requieren permisos de administrador. Para trabajar con ellos, debe crear su propia aplicación OAuth personalizada y configurar el apropiadoOAuthClientId y OAuthClientSecret. En esta app, debes configurarla para solicitar el permiso Group.Read.All. Esto se puede hacer en https://apps.dev.microsoft.com, o en el panel Registros de aplicaciones en http://portal.azure.com. Consulte Creación de una aplicación Microsoft Entra ID personalizada para obtener más detalles sobre cómo crear una aplicación personalizada.

Para autorizar permisos de Grupos, un administrador debe otorgar permisos de Grupos para su organización en general. Esto se puede hacer a través del extremo de autorización del administrador. Simplemente haga que el administrador navegue a la siguiente página web y otorgue permisos. Luego ejecute la autorización de OAuth como de costumbre.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Seleccionar

La mayoría de los filtros se manejan del lado del servidor, pero el campo específico de ID cambiará el extremo que usamos para recuperar los datos. Debe especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM Groups WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Groups WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Columnas

Paginas

Recupera todas las páginas de las libretas para el usuario autenticado.

Información Específica de la Tabla

Seleccionar

La mayoría de los filtros se manejan en el lado del servidor, pero los campos específicos de Id, ParentSectionId, UserId o GroupId cambiarán el extremo que usamos para recuperar los datos. Deben especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM Pages WHERE Id = '1-e8992fa8e5254df387d062d04e75a6e7!6-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE Id IN ('1193-dsdda-9392-4706514c636b', '1193-dsdda-9392-sdfasdw33324')
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Pages WHERE ParentSectionId = '1-e8341f6e-75b1-4811-8bb4-d2069c7f7a2d' AND GroupId = '1772bb5a-f8e9-405d-a90b-eac11b0b9b9a'
SELECT * FROM Pages WHERE GroupId = 'acabe397-8370-4c31-aeb7-2d7ae6b8cda1'
SELECT * FROM Pages WHERE UserId = '92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'

Columnas

Usuarios

Recupera todas las cuentas de usuario de Azure AD dentro de los permisos autenticados.

Información Específica de la Tabla

Los usuarios requieren permisos de administrador. Para trabajar con ellos, debe crear su propia aplicación OAuth personalizada y configurar el apropiadoOAuthClientId y OAuthClientSecret. En esta aplicación, debe configurarla para solicitar el permiso User.Read.All. Esto se puede hacer en https://apps.dev.microsoft.com, o en el panel Registros de aplicaciones en http://portal.azure.com. Consulte Creación de una aplicación Microsoft Entra ID personalizada para obtener más detalles sobre cómo crear una aplicación personalizada.

Para autorizar permisos de usuario, un administrador debe otorgar permisos de usuario para su organización en general. Esto se puede hacer a través del extremo de autorización del administrador. Simplemente haga que el administrador navegue a la siguiente página web y otorgue permisos. Luego ejecute la autorización de OAuth como de costumbre.

https://login.microsoftonline.com/common/adminconsent?client_id=[YourClientId]&redirect_uri=http://localhost:33333

Seleccionar

La mayoría de los filtros se manejan del lado del servidor, pero el campo específico de ID cambiará el extremo que usamos para recuperar los datos. Debe especificarse con una condición '=' o IN. Por ejemplo:

SELECT * FROM Users WHERE Id = '616391f0-32d8-4127-8f25-aa55771d6617'
SELECT * FROM Users WHERE ID IN ('616391f0-32d8-4127-8f25-aa55771d6617', 'dfgd4rw3-5rvg-76hy-tr5t-aa55771d6617')

Columnas

Procedimientos Almacenados

Procedimientos almacenados* son interfaces similares a funciones que amplían la funcionalidad del conector más allá de las simples operaciones SELECCIONAR/INSERTAR con Microsoft OneNote.

Procedimientos almacenados* aceptan una lista de parámetros, realizan la función prevista y luego devuelven, si corresponde, cualquier dato de respuesta relevante de Microsoft OneNote, junto con una indicación de si el procedimiento tuvo éxito o falló.

Jitterbit Connector para Procedimientos Almacenados de Microsoft OneNote

Cuaderno de Copia

Copia un bloc de notas en la carpeta Blocs de notas de la biblioteca Documentos de destino. La carpeta se crea si no existe.

Aporte

Columnas del Conjunto de Resultados

Copiar Página

Copia una página a una sección específica.

Aporte

Columnas del Conjunto de Resultados

Copiar Sección

Copia una sección a un cuaderno o grupo de secciones específico.

Aporte

Columnas del Conjunto de Resultados

Crear Página

Crea una nueva página para la sección especificada

Procedimientos Almacenados* Información Específica

Microsoft OneNote permite que se utilicen varias columnas en la consultar de Exec. Estas columnas normalmente se pueden usar con solo = comparación. Se requiere SectionId y uno de los parámetros Content o File para ejecutar este procedimiento.
Nota: En el caso de OAuthGrantType=CLIENT, se debe especificar uno de userId o groupId. Por ejemplo:

EXECUTE CreatePage SectionId = '1-8a84fed0-5381-47f3-89bc-cd16f7a4f06d', File = 'C:\Users\Dell\Desktop\content.html'

Aporte

Columnas del Conjunto de Resultados

DescargarDocumento

Para descargar el archivo o el objeto de recurso de imagen

Aporte

Columnas del Conjunto de Resultados

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

Columnas del Conjunto de Resultados

Obtener Token de Acceso de OAuth

Obtiene un token de autenticación de OneNote.

Aporte

Columnas del Conjunto de Resultados

Obtener URL de Autorización de OAuth

Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el token de autenticación de esta URL.

Aporte

Columnas del Conjunto de Resultados

Obtener Páginas

El contenido HTML de la página en particular

Aporte

Columnas del Conjunto de Resultados

RefreshOAuthAccessToken

Actualiza el token de acceso de OAuth utilizado para la autenticación con varios servicios de OneNote.

Aporte

Columnas del Conjunto de Resultados

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 Microsoft OneNote:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

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:

• 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

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas

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 Notebooks:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Notebooks' 

Columnas

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CopyNotebook' AND Direction=1 OR Direction=2

Columnas

Sys_keycolumns

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

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Notebooks'

Columnas

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

Sys_primarykeys

Describe las claves primarias. La siguiente consultar recupera las claves principales de todas las tablas y vistas:

SELECT * FROM sys_primarykeys

Columnas

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

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:onenote: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

Sys_sqlinfo

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

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.

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

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

Asignación de Tipos de Datos

Asignaciones de Tipos de Datos

El conector asigna tipos del origen de datos al tipo de datos correspondiente disponible en el esquema. La siguiente tabla documenta estas asignaciones.

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

Autenticación de Azure

OAuth

JWT OAuth

SSL

Esquema

Misceláneas

Autenticación

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

AuthScheme

El tipo de autenticación que se usará al conectarse a Microsoft OneNote.

Valores Posibles

AzureAD, AzureMSI, AzureServicePrincipal

Tipo de Datos

string

Valor por Defecto

"AzureAD"

Observaciones

• Microsoft Entra ID: 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.

Autenticación de Azure

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

AzureInquilino

El inquilino de Microsoft Online que se usa para acceder a los datos. Si no se especifica, se utiliza su arrendatario 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, 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, USGOVT, USGOVTDOD.

OAuth

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

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

Tipo de Datos

string

Valor por Defecto

"CLIENT"

Observaciones

Están disponibles las siguientes opciones: CÓDIGO,CLIENTE

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 a GETANDREFRESH para 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.

JWT OAuth

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

OAuthJWTCert

El almacén de certificados JWT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El nombre del almacén de certificados para el certificado de cliente.

El OAuthJWTCertType especifica el tipo de almacén de certificados especificado por OAuthJWTCert. Si la tienda está protegida con contraseña, especifique la contraseña en OAuthJWTCertPassword.

OAuthJWTCert se usa junto con OAuthJWTCertSubject para especificar certificados de cliente. Si OAuthJWTCert tiene un valor y OAuthJWTCertSubject, se inicia una búsqueda de un certificado. Consulte OAuthJWTCertSubject campo para más detalles.

Las designaciones de los almacenes de certificados dependen de la plataforma.

Las siguientes son designaciones de los almacenes de certificados de usuario y máquina más comunes en Windows:

En Java, el almacén de certificados normalmente es un archivo que contiene certificados y claves privadas opcionales.

Cuando el tipo de almacén de certificados es PFXFile, esta propiedad debe establecerse en el nombre del archivo. Cuando el tipo es PFXBlob, la propiedad debe establecerse en el contenido binario de un archivo PFX (es decir, almacén de certificados PKCS12).

OAuthJWTCertType

El tipo de almacén de claves que contiene el certificado JWT.

Valores Posibles

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Datos

string

Valor por Defecto

"USER"

Observaciones

Esta propiedad puede tomar uno de los siguientes valores:

OAuthJWTCertPassword

La contraseña para el certificado OAuth JWT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si el almacén de certificados es de un tipo que requiere una contraseña, esta propiedad se usa para especificar esa contraseña para abrir el almacén de certificados.

OAuthJWTCertSubject

El asunto del certificado OAuth JWT.

Tipo de Datos

string

Valor por Defecto

"\*"

Observaciones

Al cargar un certificado, el asunto se utiliza para ubicar el certificado en el almacén.

Si no se encuentra una coincidencia exacta, se busca en la tienda temas que contengan el valor de la propiedad.

Si aún no se encuentra una coincidencia, la propiedad se establece en una cadena vacía y no se selecciona ningún certificado.

El valor especial "*" selecciona el primer certificado en el almacén de certificados.

El asunto del certificado es una lista separada por comas de valores y campos de nombre distinguido. Por ejemplo, "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Los campos comunes y sus significados se muestran a continuación.

Si un valor de campo contiene una coma, debe estar entre comillas.

OAuthJWTIssuer

El emisor del token web de Java.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El emisor del token web de Java. Suele ser el ID del cliente o la dirección de Correo de la aplicación OAuth.

OAuthJWTAsunto

El sujeto de usuario para el que la aplicación solicita acceso delegado.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El sujeto de usuario para el que la aplicación solicita acceso delegado. Por lo general, el nombre de la cuenta de usuario o la dirección de correo.

SSL

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

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:

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.

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%\\\OneNote 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%\\OneNote Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

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.

Identificación del Grupo

Especifique este GroupId para acceder a los documentos de OneNote para este grupo.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifique este GroupId para acceder a los documentos de OneNote para este grupo.

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

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, "*=*".

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.

Vistas Definidas por el Usuario

Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

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 Notebooks 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"

ID de Usuario

Especifique este ID de usuario para acceder a los documentos de OneNote para este usuario.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifique este ID de usuario para acceder a los documentos de OneNote para este usuario.