Introducción
Este módulo trata sobre el uso de directivas con conectores personalizados y explica cómo pueden configurarse mediante el uso de plantillas de directivas.
Contenido del módulo:
Descubrir cómo las directivas pueden modificar el comportamiento de los conectores personalizados en tiempo de ejecución.
Aplicar plantillas de directivas a un conector personalizado.
Las directivas permiten modificar el comportamiento de un conector personalizado en tiempo de ejecución. Puede usar directivas para realizar conversiones de datos, enrutar solicitudes, establecer valores de parámetros y más. Puede configurar directivas directamente en el archivo de propiedades de la API del conector personalizado antes de la importación, o puede hacerlo desde el portal de creadores en el diseñador de conectores personalizados aplicando plantillas de directivas.
Los casos de uso de directivas comunes son:
Establecer URL de host: de forma predeterminada, la URL del servidor está codificada en la configuración del conector. Una directiva, combinada con un parámetro de conexión, permite especificar la URL del host cada vez que se crea una conexión mediante el conector. Por ejemplo, este caso de uso podría manejar una versión de desarrollo, prueba y producción de la API del sistema.
Establecer encabezado: úselo para promover datos desde los parámetros de conexión, la consulta o el cuerpo de la solicitud al encabezado. Por lo general, este proceso se realiza para adaptarse a las API que desean que se configure información específica en el encabezado. Por ejemplo, este caso de uso podría ser un Id. de correlación para realizar un seguimiento del proceso empresarial completo que se está realizando.
Establecer parámetro de consulta: úselo para manejar valores predeterminados, si es necesario, pero el fabricante no configura uno. Por ejemplo, si una API requiere un parámetro superior para la cantidad de registros a devolver mediante el uso de una directiva, puede establecer un valor predeterminado a utilizar si el fabricante no configura uno.
Puede usar directivas para manejar necesidades específicas de API y facilitar el uso del conector ocultando complejidades innecesarias.
Aplicar una directiva
La aplicación de una plantilla de directiva a un conector personalizado le permite seleccionar una directiva que desee utilizar de una lista de plantillas. Cada plantilla seleccionada le pedirá rellenar la configuración necesaria para esa directiva. Cuando complete el formulario, la directiva se activará después de actualizar el conector. La siguiente captura de pantalla muestra un ejemplo de cómo crear una nueva directiva utilizando una de las plantillas.
Cuando aplica una plantilla de directiva, puede optar por que se aplique a todas las acciones y desencadenadores o solo a algunos determinados.
Por ejemplo, la plantilla Establecer URL de host se aplica normalmente a todas las acciones y desencadenadores. Por el contrario, la plantilla Convertir una matriz en un objeto (versión preliminar) solo se puede aplicar a una o dos acciones que devuelvan datos similares.
Al configurar una directiva para que se ejecute con todas las acciones y desencadenadores, debe asegurarse de que todas las rutas de datos que se utilizan en los parámetros de la directiva sean válidas para todos los desencadenadores y acciones; de lo contrario, le aparecerán errores en runtime.
En la lista de directivas configuradas, puede seleccionar los puntos suspensivos (…) junto a cada directiva y moverla hacia arriba o hacia abajo en la lista. Esta característica le permite configurar el orden en el que se aplican las directivas en runtime, lo que puede resultar útil en situaciones en las que utilice varias plantillas de directivas para realizar la conversión de datos. Por ejemplo, una directiva podría analizar una cadena delimitada en una matriz y otra directiva podría convertir la matriz en un objeto. En este ejemplo, el orden de implementación sería importante.
La configuración de una plantilla de directiva da como resultado la modificación de las propiedades de la API del conector. Las propiedades de la API se almacenan por separado de la definición de la API para el conector. Puede importar una definición de API actualizada a través del portal sin sobrescribir las directivas que haya configurado.
Ver y modificar utilizando CLI
Además de ver las directivas en el portal, también puede exportarlas como parte del archivo de propiedades de API mediante el comando de descarga paconn de CLI.
La descarga incluye cuatro archivos (apiDefintion.swagger.json, apiProperties.json, icon.png y settings.json).
Si abre el archivo apiProperties.json y localiza la sección policyTemplateInstances, podrá ver todas las directivas configuradas.
La captura de pantalla siguiente es un ejemplo de la sección policyTemplateInstances.
También puede modificar el archivo apiProperties.json directamente si está familiarizado con el trabajo en JSON. Con algunas directivas, como Establecer URL de host, si desea solicitar la URL cuando se crea una conexión, tendrá que modificar connectionParameters en el archivo apiPropertiess.json para completar la configuración de la directiva. El comando de actualización paconn se puede utilizar para importar los cambios.
Puede resultar beneficioso considerar cómo otros conectores utilizan las directivas. El repositorio de GitHub Conectores de Microsoft Power Platform contiene muchos ejemplos excelentes de conectores certificados y no certificados que puede ver. Además, puede examinar y ver el archivo apiProperties.json de los conectores. La búsqueda en el repositorio utilizando un nombre de plantilla de directiva, como setHeader, también puede revelar rápidamente qué conectores están usando esa directiva.