Variables

Una variable es un elemento de integración que contiene y transporta datos entre las tareas, los activadores y los bordes de una integración.

  • Las variables se pueden definir de forma estática en tiempo de diseño o se pueden transferir de forma dinámica a la integración en tiempo de ejecución.
  • Las variables pueden hacer referencia a otras variables de una integración.
  • Las variables pueden ser accesibles de forma global para todas las tareas o de forma local para una tarea específica.

Variables

En Application Integration, las variables se definen o inicializan en varios lugares:

  • Variables de configuración: se definen en tiempo de diseño para almacenar los datos de configuración de la integración. Por ejemplo, puedes usarlo para definir una dirección de correo de destino para las notificaciones en lugar de codificarla directamente en la integración.
  • Variables del sistema: el sistema las genera automáticamente para almacenar los datos de configuración de la integración. Por ejemplo, la variable ExecutionId almacena el ID de ejecución de la integración.
  • Variables de integración: se definen explícitamente en la integración para hacer un seguimiento de los datos a lo largo de toda la ejecución de la integración. Por ejemplo, puedes definir una variable para almacenar el resultado de una tarea y usarla en una tarea posterior.
  • Variables de tarea: se definen implícitamente al ejecutar tareas específicas para almacenar el resultado de la tarea. Por ejemplo, la tarea Llamar a un punto final REST asigna a la variable responseBody el cuerpo de la respuesta del punto final REST. Las variables de tarea también se conocen como variables autogeneradas. Las variables generadas automáticamente tienen una convención de nomenclatura especial que consiste en usar comillas inversas alrededor del nombre de la variable.

Variables de integración

Las variables de integración, que incluyen variables de entrada y de salida, son similares a las variables que se usan en un lenguaje de programación. Los datos de las variables se pueden leer y escribir durante toda la ejecución de la integración.

Las variables de integración se pueden usar de las siguientes formas:

  • Se usan como entradas de la integración y también se conocen como variables de entrada.
  • Se devuelven como salidas de la integración, también conocidas como variables de salida.
  • Se usa para mantener el estado temporal durante la ejecución de una integración.

Cuando marca una variable como variable de entrada, indica que se espera que se proporcione el valor de la variable cuando se active la integración. El valor de una variable de entrada se puede modificar durante la ejecución de la integración.

Cuando marcas una variable como variable de salida, indicas que el valor final de la variable debe devolverse como parte de la respuesta de la integración.

El valor de una variable no tiene que definirse de forma estática en la integración. Los valores de las variables se pueden transferir a una integración mediante un activador. Sin embargo, si una variable se define de forma estática en la integración y la misma variable se proporciona de forma dinámica con un activador, la asignación de valor dinámico sobrescribirá la asignación estática.

Tipos de datos admitidos

Se admiten los siguientes tipos de datos para las variables de integración:

  • Cadena y array de cadenas
  • Número entero y matriz de números enteros
  • Doble y matriz doble
  • Booleano y matriz booleana
  • JSON

Variables de tarea

Las variables de tarea son variables predefinidas que se generan automáticamente en una tarea. Si una tarea tiene una salida, todas las salidas estarán disponibles en una variable de tarea. No puedes eliminar ni editar una variable de tarea. Las variables de tarea también se conocen como variables autogeneradas.

El nombre único de una variable de tarea sigue una convención de nomenclatura especial: utiliza comillas inversas alrededor del nombre de la variable e incluye el ID de la tarea. El formato es `<Task ID>_<Variable Name>`.

Por ejemplo, la tarea Llamar a un punto final REST tiene una salida para el cuerpo de la respuesta. Si esta tarea tiene el ID Task_5, el nombre de la variable de tarea única del cuerpo de la respuesta es `Task_5_responseBody`.

En el panel Variables, las variables de tarea pueden aparecer con un nombre de salida común, como responseBody, sin el ID de tarea ni las comillas inversas. Para ver el nombre completo y único de la variable que se necesita para hacer referencia a ella, haz clic en la variable del panel y consulta sus detalles en el panel de la derecha.

Variables de configuración

Las variables config te permiten externalizar la configuración de la integración. Con las variables de configuración, puedes configurar aspectos de tu integración, como los detalles del conector, los detalles de autenticación o los endpoints de URL que se basan en el entorno de desarrollo (por ejemplo, QA, staging o producción). No es necesario que actualices manualmente la integración antes de subirla a un nuevo entorno. Integración de aplicaciones te permite introducir valores para las variables de configuración cuando publicas la integración.

Para ver y editar las variables config definidas en su integración, haga clic en la variable_add Variable config de integración en el panel Variables. Para saber cómo crear variables de configuración y usarlas, consulta el tutorial Crea una integración de CICD.

Variables del sistema

Las variables del sistema se generan automáticamente al crear una integración. Puedes usar estas variables en tus tareas de integración y para gestionar errores. La integración contiene las siguientes variables generadas por el sistema:

  • ErrorInfo: si la ejecución falla, puedes acceder a los detalles del error con la variable ErrorInfo:
    {
      "ErrorInfo": {
      "message": String,
      "code": Number
      }
    }
    

    Para acceder a los mensajes de error, crea una variable de integración llamada ErrorMessage. Sin embargo, te recomendamos que uses la variable ErrorInfo.message generada por el sistema para acceder a los mensajes de error.

  • ExecutionMode: el modo de ejecución basado en el activador. Los valores válidos son SYNC y ASYNC.
  • ExecutionId: ID de ejecución de la integración.
  • IntegrationName: el nombre de la integración.
  • Region: la región de la integración.
  • ProjectId: el ID del proyecto que contiene la integración.

Ver variables

Puedes usar el panel Variables para crear, editar, ver, duplicar y eliminar variables en tu integración. El panel Variables también muestra el número total de referencias de variables de la integración.

Para ver el panel Variables, haga clic en (Alternar panel) en la barra de navegación del diseñador.

En la siguiente imagen se muestra un ejemplo de diseño del panel Variables:

Variable del diseñador de integraciones Variable del diseñador de integraciones

Ver y editar variables de configuración

Para ver las variables config definidas en su integración, haga clic en variable_add Variable config de integración en el panel Variables. Se abrirá el panel Variables de configuración, que muestra todas las variables de configuración definidas en su integración. Solo tiene que hacer clic en el campo Valor para editar el valor de la variable de configuración.

En la siguiente imagen se muestra un diseño de ejemplo del panel Variables de configuración:

Variable de configuración de integraciones Variable de configuración de integraciones

Crear una variable

Para crear una variable, sigue estos pasos:

  1. En la barra de navegación del editor de integraciones, haga clic en , el panel de activación, para que aparezca el panel Variables.
  2. Haz clic en + Crear.
  3. En el panel Crear variable, haga lo siguiente:
    1. Nombre: introduce el nombre de la variable.
    2. Tipo de variable: elija el tipo de variable.
    3. Tipo de datos Descripción
      Ninguno Una variable local en una integración.
      Variable config para la integración Una variable config en una integración.
      Entrada de integración Durante la ejecución, la variable se proporcionará como entrada al activador ejecutado.
      Salida de la integración El valor final de la variable al final de la ejecución debe enviarse al llamador de la integración.
      Entrada y salida de la integración Durante la ejecución, la variable se proporcionará como entrada al activador ejecutado y su valor final se enviará como salida a la persona que llama a la integración.
    4. Tipo de datos: elija el tipo de datos de la variable. Puede identificar el tipo de datos de una variable mediante el icono situado junto al nombre de la variable.
      Tipo de datos Ejemplo
      Cadena Alex
      Número entero 30
      Doble 30.5
      Booleano true
      JSON { "employee":{"name":"Alex", "age":30, "city":"Mountain View"} }
      Array de cadenas Alex, Kai, Raha
      Matriz de números enteros 30, 25, 22
      Matriz doble 30.5, 25.34, 22.134
      Matriz booleana true, false, false

      Para obtener información sobre los tipos de datos admitidos, consulta Tipos de datos admitidos.

    5. Valor predeterminado: introduce el valor predeterminado de la variable. Este campo es opcional.
    6. Esquema: selecciona el esquema JSON de la variable.
      • Generar a partir de una carga útil de JSON de muestra: genera un esquema JSON a partir de una carga útil de JSON de muestra. La carga útil de muestra se descarta después de que se genere el esquema. Solo se guardará el esquema generado.
      • Introduce un esquema JSON: introduce manualmente un esquema JSON completo.
      • Inferir a partir del valor predeterminado: genera un esquema JSON a partir del valor predeterminado proporcionado.
      • Ninguno: no hay ningún esquema JSON.
    7. Máscara de la variable en los registros (vista previa): selecciona esta opción para habilitar el enmascaramiento de la variable en los registros de ejecución de la integración. Para habilitar el enmascaramiento de la variable, debes habilitar las variables de enmascaramiento de tu integración y región. Para obtener información sobre cómo habilitar el enmascaramiento en la integración y en la región, consulta los artículos Editar una integración y Editar regiones.

      Para obtener información sobre el enmascaramiento, consulta Enmascarar datos sensibles en los registros.

  4. Haz clic en Crear.

Cómo funcionan las variables en las integraciones

Durante la ejecución de una integración, los datos del tiempo de ejecución se transfieren como variables que se declaran para la integración o la tarea. Una vez que empieza la ejecución, los datos de entrada se convierten en un objeto en memoria llamado Event.

Una vez creado el objeto Event, se crea un gráfico de tareas en memoria mediante la definición de la integración. Los valores de las variables entrantes se transfieren a las tareas en función de la configuración. A medida que se ejecuta la integración, las tareas leen y escriben datos en el objeto Event para que los usen las tareas posteriores o para formar los datos de salida de la integración.

En la siguiente tabla se resumen los distintos tipos de variables y su comportamiento:

Tipo de variable Descripción Comportamiento Ejemplo
Variable de configuración Almacena los datos de configuración de la integración. Se define en tiempo de diseño y se puede editar al publicar la integración. Una dirección de correo de destino para la notificación.
Variable de sistema Generado automáticamente por el sistema. Es de solo lectura y no se puede editar. La variable ExecutionId.
Variable de integración Hace un seguimiento de los datos a lo largo de toda la ejecución de una integración. Se define explícitamente en la integración y se puede editar durante la ejecución de la integración. Una variable para almacenar el resultado de una tarea.
Variable de tarea Almacena el resultado de una tarea específica. Se define implícitamente al ejecutar una tarea y no se puede editar. La variable responseBody de la tarea Llamar a un punto final REST.

Referencias de variables

Las tareas, los activadores y los bordes de una integración leen y escriben en variables mediante referencias de variables. Una referencia de variable tiene el formato $paramKey$, donde paramKey es el nombre de la variable.

$isNameUnique$ = true AND $numAccounts$ >= 1

Por ejemplo:

  • Una condición de borde podría tener este aspecto:
    $isNameUnique$ = true AND $numAccounts$ >= 1

    En este ejemplo, isNameUnique es una variable del tipo de datos booleano y numAccounts es un parámetro del tipo de datos entero.

  • Puedes crear una notificación por correo electrónico para el registro de un nuevo usuario en un flujo de trabajo de integración de aplicaciones. Supongamos que tiene dos variables:

    • $userName$: contiene el nombre del nuevo usuario (por ejemplo, "Alex").
    • $orderID$: contiene un identificador de pedido único (por ejemplo, "ORD-12345").

    La plantilla del cuerpo del correo podría ser la siguiente:

    Hello $userName$, thank you for your order! Your order ID is $orderID$.

    Cuando se envía este mensaje, el sistema sustituye las referencias de variables por sus valores correspondientes. El mensaje final será el siguiente:

    Hello Alex, thank you for your order! Your order ID is ORD-12345.

Puedes usar referencias de variables en los siguientes lugares:

Cuando hagas referencia a una variable de tarea o generada automáticamente, debes usar su nombre completo y único, que incluye comillas inversas y el ID de tarea, entre delimitadores de signo de dólar. Por ejemplo, para hacer referencia a la salida responseBody de una tarea Llamar a un endpoint REST con el ID Task_5, debes usar $`Task_5_responseBody`$.

Cuotas y límites

Para obtener información sobre las cuotas y los límites, consulta Cuotas y límites.

Siguientes pasos