Variables

Una variable es un elemento de integración que conserva 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 el momento del diseño o se pueden pasar de forma dinámica a la integración en el entorno de ejecución.
  • Las variables pueden hacer referencia a otras variables en una integración.
  • Todas las tareas pueden acceder a las variables de manera global o acceder a una tarea específica de forma local.

Variables

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

  • Variables de configuración: Se establecen en el momento del diseño para almacenar los datos de configuración de la integración. Por ejemplo, puedes usarlo para establecer una dirección de correo electrónico de destino para la notificación, en lugar de codificarla de forma rígida 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 configuran de forma explícita en tu integración para hacer un seguimiento de los datos durante el transcurso de una ejecución de integración completa. Por ejemplo, puedes establecer una variable para almacenar el resultado de una tarea y usarla en una tarea posterior.
  • Variables de tarea: Se establecen de forma implícita cuando se ejecutan tareas específicas para almacenar el resultado de la tarea. Por ejemplo, la tarea Llamar al extremo REST establece la variable responseBody para almacenar el cuerpo de la respuesta del extremo REST. Las variables de tarea también se conocen como variables generadas automáticamente. Las variables generadas automáticamente tienen una convención de nomenclatura especial que usa comillas inversas alrededor del nombre de la variable.

Variables de integración

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

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

  • Se toman como entradas a la integración, también conocidas como variables de entrada.
  • Se muestran como resultados de la integración, también conocidos como variables de salida.
  • Se usa para mantener el estado temporal durante la ejecución de una integración.

Cuando marcas una variable como variable de entrada, indicas 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 se debe devolver como parte de la respuesta de la integración.

El valor de una variable no se debe definir de forma estática en la integración. Los valores de las variables se pueden pasar a una integración mediante un activador. Sin embargo, si una variable está definida de manera estática en la integración y la misma variable se proporciona de forma dinámica con el activador, la asignación de valor dinámico reemplazará la asignación estática.

Tipos de datos admitidos

Los siguientes tipos de datos son compatibles con las variables de integración:

  • String y array de strings
  • Números enteros y array de números enteros
  • Doble y array doble
  • Booleano y array booleano
  • JSON

Variables de tarea

Las variables de tarea son variables predefinidas que se generan automáticamente de una tarea. Si una tarea tiene un resultado, todos estos resultados estarán disponibles en una variable de tarea. No puedes borrar o editar una variable de tarea. Las variables de tarea también se conocen como variables generadas automáticamente.

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

Por ejemplo, la tarea Llamar al extremo REST tiene un resultado para el cuerpo de la respuesta. Si esta tarea tiene un ID de Task_5, el nombre único de la variable de tarea para el 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, por ejemplo, responseBody, sin el ID de tarea ni comillas inversas. Para ver el nombre completo y único de la variable que se requiere como referencia, haz clic en la variable en el panel y consulta sus detalles en el panel de la derecha.

Variables de configuración

Las variables de configuración te permiten externalizar la configuración para la integración. Con las variables de configuración, puedes configurar aspectos de tu integración, como detalles del conector, detalles de autenticación o endpoints de URL que se basan en el entorno de desarrollo, como QA, etapa de pruebas o producción. No es necesario que actualices tu integración de forma manual antes de subirla a un entorno nuevo. Application Integration te permite ingresar valores para las variables de configuración cuando publicas la integración.

Para ver y editar las variables de configuración definidas en tu integración, haz clic en la variable_add variable de configuración de la integración en el panel Variables. Para obtener información sobre cómo crear variables de configuración y usarlas, consulta el instructivo Crea CICD para tu integración.

Variables de sistema

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

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

    Puedes acceder a los mensajes de error creando 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: Es 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: Es el nombre de la integración.
  • Region: Es la región de la integración.
  • ProjectId: Es el ID del proyecto que contiene la integración.

Ver variables

Puedes usar el panel Variables para crear, editar, ver, duplicar y borrar variables en tu integración. En el panel Variables, también se muestra un recuento de las referencias de variables totales dentro de la integración.

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

En la siguiente imagen, aparece un diseño de muestra del panel Variables:

Variables del diseñador de integraciones Variables del diseñador de integraciones

Cómo ver y editar variables de configuración

Para ver las variables de configuración definidas en tu integración, haz clic en variable_add Variable de configuración de integración en el panel Variables. Se abrirá el panel Variables de configuración, en el que se mostrarán todas las variables de configuración definidas en tu integración. Simplemente, puedes hacer clic en el campo Value para editar el valor de la variable de configuración.

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

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

Crea una variable

Para crear un clúster, realiza los siguientes pasos:

  1. En la barra de navegación del editor de integración, haz clic en (Panel de activación) para abrir el panel Variables.
  2. Haz clic en +Crear.
  3. Haz lo siguiente en el panel Crear variable:
    1. Nombre: Ingresa el nombre de la variable.
    2. Tipo de variable: Elige el tipo de variable.
    3. Tipo de datos Descripción
      Ninguno Es una variable local en una integración.
      Variable de configuración para la integración Una variable de configuración en una integración.
      Entrada para la 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 se debe generar como salida para el llamador de la integración.
      Entrada y salida de la integración En el momento de la ejecución, la variable se proporcionará como entrada al activador ejecutado y su valor final se generará como salida para el llamador de la integración.
    4. Tipo de datos:elige el tipo de datos de la variable. Puedes identificar el tipo de datos de una variable con el ícono 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 strings Alex, Kai, Raha
      Array de números enteros 30, 25, 22
      Array doble 30.5, 25.34, 22.134
      Array booleano true, false, false

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

    5. Valor predeterminado: Ingresa el valor predeterminado para la variable. Este paso es opcional,
    6. Esquema: Selecciona el esquema JSON para la variable.
      • Inferir de una carga útil JSON de muestra: genera un esquema JSON a partir de una carga útil JSON de muestra. La carga útil de muestra se descarta después de que se genera el esquema. Solo se guardará el esquema generado.
      • Ingresar un esquema JSON: ingresa manualmente un esquema JSON completo.
      • Inferir del valor predeterminado: genera un esquema JSON con el valor predeterminado proporcionado.
      • Ninguno: No hay esquema JSON.
    7. Enmascarar 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 integración. Para habilitar el enmascaramiento para la variable, debes habilitar las variables de enmascaramiento para tu integración y región. Si quieres obtener información para habilitar el enmascaramiento para la integración y la región, consulta Edita una integración y Edita regiones.

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

  4. Haz clic en Crear.

Cómo funcionan las variables en las integraciones

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

Después de crear el objeto Event, se compila un gráfico de tareas en la memoria con la definición de integración. Los valores de las variables entrantes se pasan a las tareas según tu configuración. A medida que se ejecuta la integración, las tareas leen y escriben datos en el objeto de Event para que las usen las tareas posteriores o para que formen los datos de salida de la integración.

En la siguiente tabla, se resumen los diferentes 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 establece en el momento del diseño y se puede editar cuando publicas la integración. Es una dirección de correo electrónico de destino para la notificación.
Variable del sistema El sistema lo genera automáticamente. Es de solo lectura y no se puede editar. Es la variable ExecutionId.
Variable de integración Hacen un seguimiento de los datos durante el transcurso de una ejecución de integración completa. Se configura de forma explícita en tu 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 establece de forma implícita cuando se ejecuta una tarea y no se puede editar. La variable responseBody de la tarea Llamar a extremo de 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 toma el formato $paramKey$, en el que paramKey es el nombre de la variable.

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

Por ejemplo:

  • Un condicional de borde podría verse de la siguiente manera:
    $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 de número entero.

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

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

    La plantilla para el cuerpo del correo electrónico 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 reemplaza 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 a variables en los siguientes lugares:

Cuando te refieras a una variable generada automáticamente o de tarea, debes usar su nombre completo y único, que incluye acentos graves y el ID de la tarea, dentro de los delimitadores de signo de dólar. Por ejemplo, para hacer referencia al resultado responseBody de una tarea Llamar a extremo de 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.

¿Qué sigue?