Saltar al contenido

Detalles de Conexión de Microsoft Planner

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 Planner

El conector aprovecha la API de MSPlanner para habilitar el acceso bidireccional a MSPlanner.

Establecer una Conexión

Conexión a Microsoft Planner

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 Planner 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 AzureAD 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 AzureAD 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.

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 Planner 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 AzureAD 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.

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 AzureAD 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 funciones.

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 ejecuta Microsoft Planner 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 obtienen automáticamente para la autenticación.

Creación de una Aplicación AzureAD Personalizada

Hay dos tipos de aplicaciones personalizadas de AzureAD: AzureAD y AzureAD 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 AzureAD 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 AzureAD

Puede usar una aplicación AzureAD personalizada para autenticar una cuenta de servicio o una cuenta de usuario. Siempre puede crear una aplicación AzureAD 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 AzureAD Personalizada

Siga los pasos a continuación para obtener los valores de AzureAD 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 AzureAD 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 Planner. 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 Permisos requeridos y luego haga clic en Agregar. En Seleccionar una API, seleccione Microsoft Graph y seleccione específicamente los permisos Group.ReadWrite.All, Tasks.ReadWrite.Shared y User.Read.All.
  9. Guarde sus cambios.
  10. Si ha seleccionado usar permisos que requieren el consentimiento del administrador, 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 AzureAD 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.

Características Avanzadas

Esta sección detalla una selección de funciones avanzadas del conector de Microsoft Planner.

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 parte posible del procesamiento de la declaración SELECT en Microsoft Planner 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

El conector Jitterbit para Microsoft Planner le permite definir una tabla virtual cuyos contenidos se deciden 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 Tasks 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 Planner.

Características clave

  • El conector modela entidades de Microsoft Planner como tareas, planes y cubos como tablas relacionales, lo que le permite escribir SQL para consultar y modificar datos de Microsoft Planner.
  • Procedimientos almacenados* le permiten ejecutar operaciones en Microsoft Planner, 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 Planner se refleja de inmediato al usar el conector.

Mesas

Puntos de vista describe las tablas disponibles. Las tablas se definen dinámicamente para modelar tareas, planes, cubos y más.

Puntos de vista

Puntos de vista describe las vistas disponibles. Las vistas se definen dinámicamente para modelar grupos y usuarios. Las vistas no se pueden modificar, pero se pueden usar para complementar las consultas a las tablas.

Procedimientos almacenados

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

Procedimientos almacenados son interfaces similares a funciones para Microsoft Planner. Procedimientos almacenados* le permiten ejecutar operaciones en Microsoft Planner, incluida la actualización del formato del tablero de tareas y la recuperación de credenciales de autenticación.

Mesas

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

Generalmente, consultar tablas de Microsoft Planner 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 Planner

Nombre Descripción
Buckets El recurso Depósitos proporciona métodos que le permiten administrar depósitos para la cuenta.
PlanDetails El recurso PlanDetails proporciona métodos que le permiten administrar los detalles del plan para la cuenta.
Plans El recurso Planes proporciona métodos que le permiten administrar planes para la cuenta.
TaskDetails El recurso TaskDetails proporciona métodos que le permiten administrar los detalles de las tareas de la cuenta.
Tasks El recurso Tareas proporciona métodos que le permiten administrar tareas para la cuenta.

Cubos

El recurso Depósitos proporciona métodos que le permiten administrar depósitos para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • PlanId apoya el = operador.
  • BucketId apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM Buckets WHERE PlanId = 'nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM Buckets WHERE BucketId = 'qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Insertar

Los campos obligatorios para una inserción son: nombre y planId.
Opcional: orderHint.

INSERT INTO Buckets (Name, PlanId) VALUES ('Advertising','xqQg5FS2LkCp935s-FIFm2QAFkHM')
INSERT INTO Buckets (Name, PlanId, orderHint) VALUES ('Advertising','xqQg5FS2LkCp935s-FIFm2QAFkHM',' !')
Actualizar

Microsoft Planner permite actualizaciones para las columnas name y orderHint.

UPDATE Buckets SET Name = 'To do', orderHint=' !' WHERE BucketId='rWpNKGmHukm84GaiDF_ZL2UAOlMj'
Borrar

Los cubos se pueden eliminar proporcionando BucketId.

DELETE FROM Buckets WHERE BucketId = 'yHiJQjZK0kGVt4flhItk0mUANJwN'
Columnas
Nombre Tipo Solo lectura Descripción
name String Falso
orderHint String Falso
planId String Falso
Linkedtasks String Falso
BucketId [KEY] String Falso
Etag String Falso

Detalles del Plan

El recurso PlanDetails proporciona métodos que le permiten administrar los detalles del plan para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • PlanId apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM PlanDetails WHERE planId='nETc1IDpYkmb1E17w8TxGmUAGFWC'
Insertar

Insertar no es compatible con esta tabla.

Actualizar

Microsoft Planner permite actualizaciones para las columnas title, bucketId, percentComplete, AssigneePriority, conversationThreadId, orderHint, dueDateTime y startDateTime.

Update PlanDetails SET  categoryDescriptions_category1 = 'Cat#1', categoryDescriptions_category2 = 'Cat#2', categoryDescriptions_category3 = 'Cat#3', categoryDescriptions_category4 = 'Cat#4', categoryDescriptions_category5 = 'Cat#5', categoryDescriptions_category6 = 'Cat#6'  WHERE PlanId='nETc1IDpYkmb1E17w8TxGmUAGFWC'
Borrar

No se admite la eliminación para esta tabla.

Columnas
Nombre Tipo Solo lectura Descripción
categoryDescriptions_category1 String Falso
categoryDescriptions_category2 String Falso
categoryDescriptions_category3 String Falso
categoryDescriptions_category4 String Falso
categoryDescriptions_category5 String Falso
categoryDescriptions_category6 String Falso
PlanId [KEY] String Falso

Planes

El recurso Planes proporciona métodos que le permiten administrar planes para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

Si Scope = NoAdminConsent, enumere los datos relacionados con los grupos de los que el usuario es miembro.

Si Scope = AdminConsent, enumere todos los datos relacionados con los grupos.

  • PlanId apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM Plans WHERE PlanId='nETc1IDpYk3r3e317w8TxGmUAGFWC'
Insertar

Los campos obligatorios para un inserto son: título y propietario.

INSERT INTO Plans(title,owner) VALUES ('Plan#5','acc24236-0d62-4d30-9a7f-98cfbcd3a6e7')
Actualizar

Microsoft Planner permite actualizaciones para las columnas de título y propietario.

UPDATE Plans SET  title = 'Plan#1' WHERE PlanId='nETc1IDpYkmb1E17c4TxGmUAGFWC'
Columnas
Nombre Tipo Solo lectura Descripción
createdBy_application_displayName String Falso
createdBy_application_id String Falso
createdDateTime Datetime Falso
owner String Falso
title String Falso
Linkedbuckets String Falso
Linkeddetails String Falso
Linkedtasks String Falso
GroupId String Falso
PlanId [KEY] String Falso
Etag String Falso

TareaDetalles

El recurso TaskDetails proporciona métodos que le permiten administrar los detalles de las tareas de la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • TaskId apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM TaskDetails WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
Insertar

Insertar no es compatible con esta tabla.

Actualizar

Microsoft Planner permite actualizaciones para las columnas title, bucketId, percentComplete, AssigneePriority, conversationThreadId, orderHint, dueDateTime y startDateTime.

UPDATE TaskDetails SET Description = 'Task description', previewType='reference' WHERE TaskId = '7POTl5DUfkOsgzptPrzdzGUAHy1z'
Borrar

No se admite la eliminación para esta tabla.

Columnas
Nombre Tipo Solo lectura Descripción
isChecked Bool Falso
title String Falso
orderHint String Falso
checklist_lastModifiedBy_application_displayName String Falso
checklist_lastModifiedBy_application_id String Falso
lastModifiedDateTime Datetime Falso
description String Falso
previewType String Falso
TaskId [KEY] String Falso
CheckListId String Falso

Tareas

El recurso Tareas proporciona métodos que le permiten administrar tareas para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • TaskId apoya el = operador.
  • PlanId apoya el = operador.
  • UserId apoya el = operador.
  • BucketId apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM Tasks WHERE TaskId='BCrvyMoiLEafem-3RxIESmUAHbLK'
SELECT * FROM Tasks WHERE PlanId='nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM Tasks WHERE UserId='92dfdfc6-f1d4-4965-9f71-30e4da4fa7fe'
SELECT * FROM Tasks WHERE BucketId='qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Insertar

Los campos obligatorios para una inserción son: título y planId.
Opcional: ID de cubo.

INSERT INTO Tasks(title, planId) VALUES ('test44','nETc1IDpYkmb1E17w8TxGmUAGFWC')
INSERT INTO Tasks(title, planId, bucketId) VALUES ('test44','nETc1IDpYkmb1E17w8TxGmUAGFWC','ZfzKVriNQ0yzR4IqJp-8FWUADq0Y')
Actualizar

Microsoft Planner permite actualizaciones para las columnas title, bucketId, percentComplete, AssigneePriority, conversationThreadId, orderHint, dueDateTime y startDateTime.

UPDATE Tasks SET assigneePriority='8377555 94446!',bucketId='rWpNKGmHukm84GaiDF_ZL2UAOlMj',conversationThreadId='AAQkADlmMzE1ZGIzLWY3OTctNDcyMy1iYmNlLWNlZmNlZTc5',dueDateTime='2019-09-30T14:49:23',orderHint='343d 454fd!',startDateTime='2019-07-31T14:49:23.269',title='updatedTask', percentComplete = '35'  WHERE TaskId='7POTl5DUfkOsgzptPrzdzGUAHy1z'
Borrar

Las tareas se pueden eliminar proporcionando TaskId.

DELETE FROM Tasks WHERE TaskId='BCrvyMoiLEafem-3RxIESmUAHbLK'
Columnas
Nombre Tipo Solo lectura Descripción
activeChecklistItemCount Int Falso
assigneePriority String Falso
bucketId String Falso
checklistItemCount Int Falso
completedBy_application_displayName String Falso
completedBy_application_id String Falso
completedDateTime Datetime Falso
conversationThreadId String Falso
createdBy_application_displayName String Falso
createdBy_application_id String Falso
createdDateTime Datetime Falso
dueDateTime Datetime Falso
hasDescription Bool Falso
orderHint String Falso
percentComplete Int Falso
planId String Falso
previewType String Falso
referenceCount Int Falso
startDateTime Datetime Falso
title String Falso
LinkedassignedToTaskBoardFormat String Falso
LinkedbucketTaskBoardFormat String Falso
Linkeddetails String Falso
LinkedprogressTaskBoardFormat String Falso
TaskId [KEY] String Falso
UserId String Falso
Etag String Falso

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 Planner

Nombre Descripción
Groups El recurso Grupos proporciona métodos que le permiten administrar grupos para la cuenta.
TaskAssignments El recurso Tareas proporciona métodos que le permiten administrar tareas para la cuenta.
Users El recurso Usuarios proporciona métodos que le permiten administrar usuarios para la cuenta.

Grupos

El recurso Grupos proporciona métodos que le permiten administrar grupos para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

Si Scope = NoAdminConsent, enumere los datos relacionados con los grupos de los que el usuario es miembro.

Si Scope = AdminConsent, enumere todos los datos relacionados con los grupos.

  • Id apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM Groups WHERE Id='nETc1IDpYkmb1E17w8TxGmUAGFWC'
Columnas
Nombre Tipo Descripción
id [KEY] String
Etag String
deletedDateTime Datetime
allowExternalSenders Bool
assignedLicenses String
autoSubscribeNewMembers Bool
classification String
createdDateTime Datetime
description String
displayName String
groupTypes String
hasMembersWithLicenseErrors Bool
isArchived Bool
isSubscribedByMail Bool
licenseProcessingState_state String
mail String
mailEnabled Bool
mailNickname String
onPremisesLastSyncDateTime Datetime
onPremisesProvisioningErrors String
onPremisesSecurityIdentifier String
onPremisesSyncEnabled Bool
preferredDataLocation String
proxyAddresses String
renewedDateTime Datetime
securityEnabled Bool
unseenCount Int
visibility String

Asignaciones de Tareas

El recurso Tareas proporciona métodos que le permiten administrar tareas para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector usa la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

Si Scope = NoAdminConsent, enumere los datos relacionados con los grupos de los que el usuario es miembro.

Si Scope = AdminConsent, enumere todos los datos relacionados con los grupos.

  • TaskId apoya el = operador.
  • PlanId admite los operadores '=' e 'IN'.
  • BucketId apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM TaskAssignments WHERE TaskId='BCrvyMoiLEafem-3RxIESmUAHbLK'
SELECT * FROM TaskAssignments WHERE PlanId='nETc1IDpYk3r3e317w8TxGmUAGFWC'
SELECT * FROM TaskAssignments WHERE PlanId IN ('nETc1IDpYk3r3e317w8TxGmUAGFWC', 'v8iK3uCb30C5I_ocMGu3SGUAHQLI', 't2eNwoPxpEqhZs38GwT1HWUADwjN')
SELECT * FROM TaskAssignments WHERE BucketId='qIguxctMLEGHYhmgSVGSNGUAAZOZ'
Columnas
Nombre Tipo Descripción
PlanId [KEY] String
BucketId String
TaskId [KEY] String
AssignedToUser String
AssignedByUserId String
AssignedByUserName String
AssignedDateTime Datetime
OrderHint String

Usuarios

El recurso Usuarios proporciona métodos que le permiten administrar usuarios para la cuenta.

Información Específica de la Tabla
Seleccionar

El conector utilizará la API de Microsoft Planner para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • Id apoya el = operador.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM Users WHERE Id='9523f1-aa0-4fe17-a9w7b-6860618adf'
Columnas
Nombre Tipo Descripción
aboutMe String
accountEnabled Bool
ageGroup String
assignedLicenses String
assignedPlans String
birthday Datetime
businessPhones String
city String
companyName String
consentProvidedForMinor String
country String
department String
deviceEnrollmentLimit Int
displayName String
employeeId String
faxNumber String
givenName String
hireDate Datetime
imAddresses String
interests String
isResourceAccount Bool
jobTitle String
legalAgeGroupClassification String
licenseAssignmentStates String
mail String
mailboxSettings_automaticRepliesSetting_status String
mailboxSettings_automaticRepliesSetting_externalAudience String
mailboxSettings_automaticRepliesSetting_scheduledStartDateTime_dateTime String
mailboxSettings_automaticRepliesSetting_scheduledStartDateTime_timeZone String
mailboxSettings_automaticRepliesSetting_internalReplyMessage String
mailboxSettings_automaticRepliesSetting_externalReplyMessage String
mailboxSettings_archiveFolder String
mailboxSettings_timeZone String
mailboxSettings_language_locale String
mailboxSettings_language_displayName String
mailboxSettings_workingHours_daysOfWeek String
mailboxSettings_workingHours_startTime Time
mailboxSettings_workingHours_endTime Time
mailboxSettings_workingHours_timeZone_name String
mailNickname String
mobilePhone String
mySite String
officeLocation String
onPremisesDistinguishedName String
onPremisesDomainName String
onPremisesExtensionAttributes_extensionAttribute1 String
onPremisesExtensionAttributes_extensionAttribute2 String
onPremisesExtensionAttributes_extensionAttribute3 String
onPremisesExtensionAttributes_extensionAttribute4 String
onPremisesExtensionAttributes_extensionAttribute5 String
onPremisesExtensionAttributes_extensionAttribute6 String
onPremisesExtensionAttributes_extensionAttribute7 String
onPremisesExtensionAttributes_extensionAttribute8 String
onPremisesExtensionAttributes_extensionAttribute9 String
onPremisesExtensionAttributes_extensionAttribute10 String
onPremisesExtensionAttributes_extensionAttribute11 String
onPremisesExtensionAttributes_extensionAttribute12 String
onPremisesExtensionAttributes_extensionAttribute13 String
onPremisesExtensionAttributes_extensionAttribute14 String
onPremisesExtensionAttributes_extensionAttribute15 String
onPremisesImmutableId String
onPremisesLastSyncDateTime Datetime
onPremisesProvisioningErrors String
onPremisesSamAccountName String
onPremisesSecurityIdentifier String
onPremisesSyncEnabled Bool
onPremisesUserPrincipalName String
otherMails String
passwordPolicies String
passwordProfile_password String
passwordProfile_forceChangePasswordNextSignIn Bool
passwordProfile_forceChangePasswordNextSignInWithMfa Bool
pastProjects String
postalCode String
preferredLanguage String
preferredName String
provisionedPlans String
proxyAddresses String
responsibilities String
schools String
showInAddressList Bool
signInSessionsValidFromDateTime Datetime
skills String
state String
streetAddress String
surname String
usageLocation String
userPrincipalName String
userType String
Id [KEY] String

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/ACTUALIZAR/ELIMINAR con Microsoft Planner.

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 Planner, junto con una indicación de si el procedimiento tuvo éxito o falló.

Conector Jitterbit para Procedimientos Almacenados de Microsoft Planner

Nombre Descripción
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 un token de autenticación de Office365.
GetOAuthAuthorizationURL 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.
RefreshOAuthAccessToken Actualiza el token de acceso de OAuth utilizado para la autenticación con varios servicios de MSPlanner.
UpdateAssignedToTaskBoardTaskFormat Este procedimiento almacenado* se utiliza para representar una tarea correctamente en la vista Asignado a del Tablero de tareas (una vista organizada por usuarios a los que se asignan tareas).
UpdateBucketTaskBoardFormat Este procedimiento almacenado* se utiliza para representar una tarea correctamente en la vista de cubos del tablero de tareas (una vista organizada por tareas dentro de los cubos a los que están asignadas).
UpdateProgressTaskBoardFormat Este procedimiento almacenado* se usa para representar una tarea correctamente en la vista Progreso del Tablero de tareas (una vista organizada por el estado del campo Porcentaje completado en el objeto de la tarea, con columnas para No iniciado, En progreso y Completado).

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 Obligatorio Descripción
CallbackUrl String Falso 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 Falso El mismo valor para el estado que envió cuando solicitó el código de autorización.
Scope String Falso Una lista separada por espacios de permisos para solicitar al administrador. El valor predeterminado es 'offline_access https://graph.microsoft.com/Group.Read.All https://graph.microsoft.com/User.ReadBasic.All https://graph.microsoft.com/User.Read.All'
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
URL String La URL de autorización, ingresada en un navegador web para obtener el token de verificación y autorizar su aplicación.

Obtener Token de Acceso de OAuth

Obtiene un token de autenticación de Office365.

Aporte
Nombre Tipo Obligatorio Descripción
AuthMode String Falso El tipo de modo de autenticación a utilizar. Seleccione Aplicación para obtener tokens de autenticación a través de una aplicación de escritorio. Seleccione Web para obtener tokens de autenticación a través de una aplicación web. Los valores permitidos son APP, WEB. El valor predeterminado es APLICACIÓN.
Scope String Falso Una lista separada por espacios de permisos para solicitar al usuario. Cuando OAuthGrantType='CODE', el valor predeterminado es 'offline_access https://graph.microsoft.com/User.ReadBasic.All'. Pero cuando OAuthGrantType='CLIENT', un ámbito de 'https://graph.microsoft.com/.default' se usa '/.default' recoge los permisos que ya tiene su aplicación.
CallbackUrl String Falso 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 que especificó en la configuración de la aplicación de Azure AD.
Verifier String Falso El verificador devuelto por Azure AD después de que el usuario haya autorizado su aplicación para tener acceso a sus datos. Este valor se devolverá como un parámetro para la URL de devolución de llamada.
State String Falso Una cadena arbitraria de su elección que se devuelve a su aplicación; un viaje de ida y vuelta exitoso de esta cadena ayuda a garantizar que su aplicación haya iniciado la solicitud.
Prompt String Falso 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 acceso utilizado para la comunicación con Office365.
ExpiresIn String El tiempo de vida restante en el token de acceso. Un -1 indica que no caducará.
OAuthRefreshToken String Actualizar token para renovar el token de acceso.

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
Nombre Tipo Obligatorio Descripción
Scope String Falso Una lista separada por espacios de permisos para solicitar al usuario. Cuando OAuthGrantType='CODE', el valor predeterminado es 'offline_access https://graph.microsoft.com/User.ReadBasic.All'. Pero cuando OAuthGrantType='CLIENT', un ámbito de 'https://graph.microsoft.com/.default' se usa '/.default' recoge los permisos que ya tiene su aplicación.
CallbackUrl String Falso 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 Falso El mismo valor para el estado que envió cuando solicitó el código de autorización.
Prompt String Falso 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 de autorización, ingresada en un navegador web para obtener el token de verificación y autorizar su aplicación.

RefreshOAuthAccessToken

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

Aporte
Nombre Tipo Obligatorio Descripción
OAuthRefreshToken String Cierto El token de actualización devuelto del intercambio de código de autorización original.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Azure AD. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular.
OAuthRefreshToken String Un token que puede usarse para obtener un nuevo token de acceso.
ExpiresIn String El tiempo de vida restante en el token de acceso.

ActualizarAssignedToTaskBoardTaskFormat

Este procedimiento almacenado* se utiliza para representar una tarea correctamente en la vista Asignado a del Tablero de tareas (una vista organizada por usuarios a los que se asignan tareas).

Aporte
Nombre Tipo Obligatorio Descripción
TaskId String Cierto El identificador de la tarea.
UserId String Cierto ID de usuario asignado.
OrderHint String Cierto Sugerencia de pedido.

UpdateBucketTaskBoardFormat

Este procedimiento almacenado* se utiliza para representar una tarea correctamente en la vista de cubos del tablero de tareas (una vista organizada por tareas dentro de los cubos a los que están asignadas).

Aporte
Nombre Tipo Obligatorio Descripción
TaskId String Cierto El identificador de la tarea.
OrderHint String Cierto Sugerencia de pedido.

UpdateProgressTaskBoardFormat

Este procedimiento almacenado* se usa para representar una tarea correctamente en la vista Progreso del Tablero de tareas (una vista organizada por el estado del campo Porcentaje completado en el objeto de la tarea, con columnas para No iniciado, En progreso y Completado).

Aporte
Nombre Tipo Obligatorio Descripción
TaskId String Cierto El identificador de la tarea.
OrderHint String Cierto Sugerencia de pedido.

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

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tasks' 
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 UpdateAssignedToTaskBoardFormat:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='UpdateAssignedToTaskBoardFormat' 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 Tareas:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tasks'
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_primarykeys

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

SELECT * FROM sys_primarykeys
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.
KeySeq String El número de secuencia de la clave principal.
KeyName String El nombre de la clave principal.

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:microsoftplanner: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.

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 Microsoft Planner.

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 utiliza su arrendatario 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.
OAuthGrantType El tipo de concesión para el flujo de 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.
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.

JWT OAuth

Propiedad Descripción
OAuthJWTCert El almacén de certificados JWT.
OAuthJWTCertType El tipo de almacén de claves que contiene el certificado JWT.
OAuthJWTCertPassword La contraseña para el certificado OAuth JWT.
OAuthJWTCertSubject El asunto del certificado OAuth JWT.
OAuthJWTIssuer El emisor del token web de Java.
OAuthJWTSubject El sujeto de usuario para el que la aplicación solicita acceso delegado.

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
Scope Especifique esta propiedad para activar/desactivar los ámbitos de consentimiento del administrador.
IncludeLabels Determina si se mostrarán las etiquetas de la tarea.
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.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
UserDefinedViews Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.

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 Microsoft Planner.

AuthScheme

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

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.

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 utiliza su arrendatario 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 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.

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.
OAuthGrantType El tipo de concesión para el flujo de 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.
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.

OAuthGrantType

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

Valores Posibles

CODE, PASSWORD

Tipo de Datos

string

Valor por Defecto

"CODE"

Observaciones

El tipo de concesión para el flujo de OAuth. Están disponibles las siguientes opciones: CÓDIGO, CONTRASEÑA;

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.

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.

Propiedad Descripción
OAuthJWTCert El almacén de certificados JWT.
OAuthJWTCertType El tipo de almacén de claves que contiene el certificado JWT.
OAuthJWTCertPassword La contraseña para el certificado OAuth JWT.
OAuthJWTCertSubject El asunto del certificado OAuth JWT.
OAuthJWTIssuer El emisor del token web de Java.
OAuthJWTSubject El sujeto de usuario para el que la aplicación solicita acceso delegado.

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:

Propiedad Descripción
MY Un almacén de certificados que contiene certificados personales con sus claves privadas asociadas.
CA Certificados de la autoridad certificadora.
ROOT Certificados raíz.
SPC Certificados de editor de software.

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:

Propiedad Descripción
USER Para Windows, esto especifica que el almacén de certificados es un almacén de certificados propiedad del usuario actual. Nota: Este tipo de tienda no está disponible en Java.
MACHINE Para Windows, esto especifica que el almacén de certificados es un almacén de máquinas. Nota: este tipo de tienda no está disponible en Java.
PFXFILE El almacén de certificados es el nombre de un archivo PFX (PKCS12) que contiene certificados.
PFXBLOB El almacén de certificados es una cadena (codificada en base 64) que representa un almacén de certificados en formato PFX (PKCS12).
JKSFILE El almacén de certificados es el nombre de un archivo de almacén de claves Java (JKS) que contiene certificados. Nota: este tipo de tienda solo está disponible en Java.
JKSBLOB El almacén de certificados es una cadena (codificada en base 64) que representa un almacén de certificados en formato de almacén de claves Java (JKS). Nota: este tipo de tienda solo está disponible en Java.
PEMKEY_FILE El almacén de certificados es el nombre de un archivo con codificación PEM que contiene una clave privada y un certificado opcional.
PEMKEY_BLOB El almacén de certificados es una cadena (codificada en base64) que contiene una clave privada y un certificado opcional.
PUBLIC_KEY_FILE El almacén de certificados es el nombre de un archivo que contiene un certificado de clave pública con codificación PEM o DER.
PUBLIC_KEY_BLOB El almacén de certificados es una cadena (codificada en base 64) que contiene un certificado de clave pública con codificación PEM o DER.
SSHPUBLIC_KEY_FILE El almacén de certificados es el nombre de un archivo que contiene una clave pública de estilo SSH.
SSHPUBLIC_KEY_BLOB El almacén de certificados es una cadena (codificada en base 64) que contiene una clave pública de estilo SSH.
P7BFILE El almacén de certificados es el nombre de un archivo PKCS7 que contiene certificados.
PPKFILE El almacén de certificados es el nombre de un archivo que contiene una PPK (clave privada PuTTY).
XMLFILE El almacén de certificados es el nombre de un archivo que contiene un certificado en formato XML.
XMLBLOB El almacén de certificados es una cadena que contiene un certificado en formato XML.

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.

Campo Significado
CN Nombre común. Este es comúnmente un nombre de alojar como www.server.com.
O Organización
OU Unidad organizativa
L localidad
S Estado
C País
E Dirección de Correo

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.

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%\\\MicrosoftPlanner 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%\\MicrosoftPlanner 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
Scope Especifique esta propiedad para activar/desactivar los ámbitos de consentimiento del administrador.
IncludeLabels Determina si se mostrarán las etiquetas de la tarea.
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.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
UserDefinedViews Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.

Alcance

Especifique esta propiedad para activar/desactivar los ámbitos de consentimiento del administrador.

Valores Posibles

AdminConsent, NoAdminConsent

Tipo de Datos

string

Valor por Defecto

"NoAdminConsent"

Observaciones

Especifique el ámbito para obtener el acceso inicial y el token de actualización.

Establezca esta propiedad en AdminConsent para habilitar los ámbitos de consentimiento del administrador en el controlador o establezca en NoAdminConsent para utilizar ámbitos predeterminados que no requieren el consentimiento del administrador.

Incluir Etiquetas

Determina si se mostrarán las etiquetas de la tarea.

Tipo de Datos

bool

Valor por Defecto

false

Observaciones

Determina si se mostrarán las etiquetas de la tarea.

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.

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