Conexión OData
Introducción
Una conexión OData, creada utilizando el conector OData, establece acceso a los puntos finales de OData. Una vez que se configura una conexión, se pueden crear instancias de actividades OData asociadas con esa conexión para ser utilizadas como fuentes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).
Nota
Este conector soporta la Habilitar Re-autenticación al Cambiar política de organización. Si está habilitada, un cambio en la URL de Metadatos OData, Autenticación, Nombre de usuario o ID de cliente en esta conexión requiere que los usuarios vuelvan a ingresar la Contraseña o Secreto de cliente (dependiendo de la Autenticación seleccionada) para la conexión.
Crear o editar una conexión OData
Se crea una nueva conexión OData utilizando el conector OData desde una de estas ubicaciones:
- La pestaña Puntos finales y conectores del componente de diseño en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
- La página de Puntos finales globales (ver Crear un punto final global en Puntos finales globales).
Una conexión OData existente se puede editar desde estas ubicaciones:
- La pestaña Puntos finales y conectores del componente de diseño en la paleta de componentes de diseño (ver Paleta de componentes de diseño).
- La pestaña Componentes del panel del proyecto (ver Menú de acciones del componente en Pestaña de componentes del panel del proyecto).
- La página de Puntos finales globales (ver Editar un punto final global en Puntos finales globales).
Configurar una conexión OData
Cada elemento de la interfaz de usuario de la pantalla de configuración de la conexión OData se describe a continuación.
Consejo
Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comience escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar un menú con las variables existentes de las que elegir.
-
Nombre de la Conexión: Ingrese un nombre para identificar la conexión. El nombre debe ser único para cada conexión OData y no debe contener barras diagonales (
/) ni dos puntos (:). Este nombre también se utiliza para identificar el punto final de OData, que se refiere tanto a una conexión específica como a sus actividades. -
URL de Metadatos de OData: Ingrese la URL del punto final de OData
$metadata. -
Autenticación: Seleccione el método de autenticación, uno de Sin Auth, Auth Básica o OAuth2:
-
Sin Auth: El acceso al punto final de OData es anónimo sin autorización.
-
Auth Básica: Expande opciones de configuración adicionales donde se especifica un nombre de usuario y una contraseña para usar en la autorización básica:
-
Nombre de Usuario: Ingrese un nombre de usuario válido.
-
Contraseña: Ingrese una contraseña válida.
-
-
OAuth2: Expande opciones adicionales para configurar OAuth 2.0:
-
Tipos de Concesión: Seleccione Credenciales de Cliente o Concesión de Contraseña como el tipo de concesión para la autenticación OAuth. Credenciales de Cliente está seleccionado por defecto, pero los usuarios pueden especificar un Nombre de Usuario y una Contraseña adicionales si se selecciona Concesión de Contraseña.
-
Endpoint de Token OAuth: Ingrese el endpoint de token OAuth.
-
ID de Cliente: Ingrese el ID de cliente.
-
Secreto de Cliente: Ingrese el secreto de cliente.
-
Nombre de Usuario: Ingrese un nombre de usuario válido. Visible solo si el Tipo de Concesión está configurado como Concesión de Contraseña.
-
Contraseña: Ingresa una contraseña válida. Visible solo si el Tipo de Concesión está configurado como Concesión de Contraseña.
-
Ámbito: Ingresa el ámbito.
-
Tipo de Token: Ingresa el tipo de token.
-
Autenticación del Cliente: Selecciona el método por el cual se envía la autenticación del cliente en la solicitud. La autenticación puede enviarse como Enviar como encabezado de Autenticación Básica o Enviar credenciales del cliente en el cuerpo.
-
-
-
Propiedades HTTP Avanzadas: Define los encabezados HTTP para la conexión. El protocolo OData acepta encabezados HTTP estándar definidos en Rfc 2616 (sección 14) así como cualquier encabezado personalizado específico para el punto final. Haz clic en el ícono de agregar para añadir un encabezado a la tabla a continuación e ingresa un par clave-valor para cada parámetro de solicitud.
Para guardar la fila, haz clic en el ícono de enviar en la columna más a la derecha.
Para editar o eliminar una sola fila, pasa el cursor sobre la columna más a la derecha y utiliza el ícono de editar o el ícono de eliminar .
Para eliminar todas las filas, haz clic en Limpiar Todo.
Nota
Los encabezados personalizados deben configurarse en el punto final para que los acepte como parte de esta solicitud. Si estás utilizando Microsoft Azure para gestionar tu punto final OData, consulta la documentación de Microsoft sobre Encabezados Personalizados en Accediendo a Puntos Finales que Requieren Autenticación.
Importante
Los campos en la tabla de Propiedades HTTP Avanzadas muestran el ícono de variable solo en modo de edición. Para que los valores de variable de estos campos se completen en tiempo de ejecución, la versión del agente debe ser al menos 10.75 / 11.13.
Los campos en la tabla de Propiedades HTTP Avanzadas no admiten el uso de variables para pasar JSON sin procesar. Si tu caso de uso no admite definir JSON sin procesar en los campos directamente, escapa el contenido JSON antes de pasarlo con una variable. Por ejemplo, escapar
{"success": "true"};se convierte en{\"success\": \"true\"};. -
Prueba: Haz clic para verificar la conexión utilizando la configuración proporcionada. Cuando se prueba la conexión, la última versión del conector es descargada por el(los) agente(s) en el grupo de agentes asociado con el entorno actual. Este conector admite suspender la descarga de la última versión del conector utilizando la Política de Desactivar Actualización Automática del Conector política de organización.
-
Guardar Cambios: Haz clic para guardar y cerrar la configuración de la conexión.
-
Descartar Cambios: Después de realizar cambios en una configuración nueva o existente, haz clic para cerrar la configuración sin guardar. Un mensaje te pide que confirmes que deseas descartar los cambios.
-
Eliminar: Después de abrir una configuración de conexión existente, haz clic para eliminar permanentemente la conexión del proyecto y cerrar la configuración (ver Dependencias de componentes, eliminación y remoción). Un mensaje te pide que confirmes que deseas eliminar la conexión.
Próximos pasos
Después de que se ha creado una conexión OData, colocas un tipo de actividad en el lienzo de diseño para crear instancias de actividad que se utilizarán como fuentes (para proporcionar datos en una operación) o como destinos (para consumir datos en una operación).
Las acciones del menú para una conexión y sus tipos de actividad son accesibles desde el panel del proyecto y la paleta de componentes de diseño. Para más detalles, consulta Menús de acciones en Conceptos básicos del conector.
Estos tipos de actividad están disponibles:
-
Consulta: Consulta datos de objetos desde un punto final OData y está destinado a ser utilizado como fuente en una operación.
-
Actualizar: Actualiza datos de objetos en un punto final OData y está destinado a ser utilizado como destino en una operación.
-
Insertar: Inserta datos de objetos en un punto final OData y está destinado a ser utilizado como destino en una operación.
-
Eliminar: Elimina datos de objetos de un endpoint OData y está destinado a ser utilizado como un objetivo en una operación.