Variables de Jitterbit en Design Studio

Descripción general

Las variables de Jitterbit son uno de los tres tipos de elementos de datos globales disponibles en Harmony. (Los otros dos tipos de elementos de datos globales—variables globales y variables de proyecto—también están disponibles globalmente a lo largo de un proyecto. Se configuran de manera diferente, como se describe en Variables globales y Variables de proyecto.)

Las variables de Jitterbit están siempre disponibles a lo largo de su proyecto. Son predefinidas por Jitterbit o configuradas en el archivo de configuración de Jitterbit.

Los casos de uso más comunes para las variables de Jitterbit son leer una variable para poder recopilar información sobre lo que ocurrió durante una operación o para obtener información global como el nombre del archivo fuente actual. Con menos frecuencia, se escriben variables de Jitterbit al cambiar la configuración predeterminada utilizada para procesar la cadena de operaciones.

Si una variable de Jitterbit afecta la forma en que funciona una función, debe establecerse antes de la llamada a la función. Las operaciones o scripts anteriores son aquellos que están vinculados dentro de una cadena de operaciones utilizando acciones de operación o las funciones RunOperation o RunScript. "Anterior" en este contexto también se refiere a cambiar el valor de la variable de Jitterbit en el mismo script, pero antes de la llamada a la función.

Dado que estas variables son variables predefinidas, los proyectos rara vez crean o cambian el valor predeterminado de una variable de Jitterbit. Sin embargo, al usar un agente privado, se pueden crear variables de Jitterbit o modificar su valor predeterminado. Consulte Crear nuevas variables o establecer valores predeterminados en agentes privados a continuación para más detalles.

Consulta estas páginas para la documentación sobre las variables predefinidas de Jitterbit:

Visualización de variables Jitterbit

Al diseñar tu proyecto, las variables Jitterbit están disponibles en la pestaña Elementos de Datos del generador de scripts accesible desde las pantallas de scripts y transformaciones. Cada variable Jitterbit predefinida por Jitterbit está documentada en una página bajo esta sección.

Establecer variables de Jitterbit en scripts o transformaciones

Mientras que el caso de uso más común para las variables de Jitterbit es leer información, hay algunas variables de Jitterbit que se pueden establecer para comunicar algo a un agente. En Integration Studio, las variables de Jitterbit se pueden establecer utilizando Jitterbit Script o JavaScript, de la misma manera que se puede establecer cualquier variable global.

Consejo

Consulta la documentación para cada variable de Jitterbit para obtener información sobre cuáles se pueden establecer y a qué se pueden establecer.

Jitterbit Script

En Jitterbit Script utilizado dentro de scripts y transformaciones, el valor de una variable de Jitterbit se puede establecer comenzando con un signo de dólar $ o llamando a la función Set().

$: Usando la sintaxis del signo de dólar $, $jitterbit.api.response="Success" establece la respuesta de la API (jitterbit.api.response) para devolver la cadena "Success" a la aplicación solicitante.
Set: Usando la función Set(), Set("jitterbit.api.response", "Success") establece la respuesta de la API (jitterbit.api.response) para devolver la cadena "Success" a la aplicación solicitante.

En scripts y transformaciones, las variables de Jitterbit también se mostrarán en la pestaña Variables de la paleta de componentes del script, dentro de la subpestaña Variables de Jitterbit.

JavaScript

En JavaScript utilizado dentro de scripts creados como un componente de proyecto, las variables de Jitterbit predefinidas por Jitterbit solo se pueden establecer con la función Jitterbit.SetVar(). Esto se debe a que todas las variables de Jitterbit predefinidas por Jitterbit contienen puntos dentro del nombre de la variable.

Jitterbit.SetVar: Usando Jitterbit.SetVar, el ejemplo de código Jitterbit.SetVar("$jitterbit.api.response", "Success") establece la respuesta de la API para devolver la cadena "Success" a la aplicación solicitante.

En scripts y transformaciones, las variables de Jitterbit también se mostrarán en la pestaña Variables del panel de componentes de script, dentro de la subpestaña Variables de Jitterbit.

Advertencia

Las funciones de JavaScript Jitterbit.SetVar y Jitterbit.GetVar están diseñadas específicamente para acceder a las variables de Jitterbit predefinidas. No deben usarse para acceder a variables globales definidas por el usuario.

En JavaScript, no mezcles y combines tu uso de SetVar (y GetVar) con el prefijo $ al establecer (y recuperar) una variable. Usa solo una sintaxis. Mezclar las dos sintaxis diferentes para la misma variable puede causar problemas en tiempo de ejecución.

Recuperar variables de Jitterbit en scripts o transformaciones

El valor de una variable de Jitterbit puede ser devuelto usando ya sea Jitterbit Script (en scripts o transformaciones) o usando JavaScript (solo en scripts creados como un componente de proyecto) de la misma manera en que se puede recuperar una variable global.

Advertencia

Hay un problema conocido que mapea variables con puntos en el nombre de la variable que no funcionan correctamente, resultando en un mapeo de campo de destino incorrecto en la transformación. Hasta que este problema se resuelva, las variables de Jitterbit no pueden ser referenciadas directamente dentro de una transformación. Se puede usar scripting para crear un mecanismo alternativo para pasar valores.

Jitterbit Script

En scripts y transformaciones, puedes comenzar con un signo de dólar $ o usar la función Get() para recuperar el valor de una variable de Jitterbit:

$: Prefijado con un signo de dólar $, el ejemplo de código $jitterbit.operation.error recupera el valor de la variable de Jitterbit "jitterbit.operation.error".
Get: Usando la función Get(), el ejemplo de código Get("jitterbit.operation.error") devuelve el mismo valor.

En scripts y transformaciones, las variables de Jitterbit también se mostrarán en la pestaña Variables del panel de componentes del script, dentro de la subpestaña Variables de Jitterbit.

JavaScript

En scripts de JavaScript dentro de una operación, las variables de Jitterbit predefinidas por Jitterbit solo se pueden acceder con las funciones Jitterbit.SetVar() y Jitterbit.GetVar(). Esto se debe a que todas las variables de Jitterbit predefinidas por Jitterbit contienen puntos dentro del nombre de la variable.

Jitterbit.GetVar: Usando Jitterbit.GetVar, el ejemplo de código Jitterbit.GetVar("$jitterbit.operation.error") devuelve el valor de la variable de Jitterbit llamada "jitterbit.operation.error". Tenga en cuenta que un signo de dólar $ al principio es opcional antes del nombre al recuperar valores. Los nombres jitterbit.operation.name y $jitterbit.operation.name son equivalentes al recuperar valores.

Advertencia

Las funciones de JavaScript Jitterbit.SetVar y Jitterbit.GetVar están diseñadas específicamente para acceder a las variables de Jitterbit predefinidas. No deben usarse para acceder a variables globales definidas por el usuario.

En JavaScript, no mezcle y combine el uso de SetVar (y GetVar) con el prefijo $ al establecer (y recuperar) una variable. Use solo una sintaxis. Mezclar las dos sintaxis diferentes para la misma variable puede causar problemas en tiempo de ejecución.

En scripts y transformaciones, las variables de Jitterbit también se mostrarán en la pestaña Variables del panel de componentes del script, dentro de la subpestaña Variables de Jitterbit.

Use Jitterbit variables in definition screens

En una pantalla de definición (durante la configuración de fuentes o destinos), puede hacer referencia a las variables de Jitterbit usando la sintaxis [JitterbitVariableName].

Por ejemplo, si estás utilizando la variable de Jitterbit como parte de un nombre de archivo o como una propiedad de un objeto diferente que no está en un script, entonces puedes hacer referencia a ella usando corchetes como [jitterbit.source.filename].

Crear nuevas variables o establecer valores predeterminados en agentes privados

Aquellos que utilizan agentes privados pueden cambiar programáticamente el comportamiento predeterminado de las variables de Jitterbit, así como crear nuevas variables de Jitterbit a través del archivo de configuración del agente privado. Sin embargo, ten en cuenta que esto se utiliza solo en casos de uso raros implementados por usuarios avanzados. La mayoría de los casos de uso pueden manejarse creando una variable de proyecto en lugar de una variable de Jitterbit.

Cambiar valores predeterminados o crear nuevas variables de Jitterbit se realiza desde estas secciones del archivo de configuración del agente privado:

[PredefinedGlobalVariables]
Verifica o cambia los valores predeterminados de las variables de Jitterbit.
[PredefinedServerGlobalDataElement]
Define tus propias variables de Jitterbit personalizadas y valores predeterminados.

Los nombres de las variables de Jitterbit pueden estar compuestos por estos caracteres: letras (a-z, A-Z), números (0-9), puntos y guiones bajos. No se recomiendan otros caracteres y pueden causar problemas.

Nota

Al actualizar un agente privado, se preserva el archivo de configuración y no se sobrescribe con la última versión.

Advertencia

Al crear nuevas variables de Jitterbit, no se recomienda usar puntos en un nombre de variable si planeas acceder a ellas con JavaScript. En su lugar, se recomienda que crees variables de Jitterbit que no contengan puntos y que uses guiones bajos en lugar de puntos. Consulta la información sobre variables globales, que también es aplicable a las variables de Jitterbit.

Para obtener más información sobre cómo editar o crear variables de Jitterbit, consulta Editar el archivo de configuración (jitterbit.conf).