Usar una Convención de Nomenclatura para Variables¶
Introducción¶
Esta página proporciona orientación sobre los nombres proporcionados por el usuario de las variables locales y globales.
Tipos de Variables¶
Harmony tiene cuatro tipos de variables:
- Variables locales: Definido y accedido en un único Jitterbit Secuencia de Comandos o JavaScript. Alcance limitado al secuencia de comandos.
- Variables globales: Definido en un Jitterbit Script o JavaScript y disponible en un proyecto.
- Variables del proyecto: Definido en la interfaz de usuario de Cloud Studio y disponible en un proyecto. Actualizable a través de Management Console.
- Variables de jitterbit: Predefinido en Harmony o definido en el archivo de configuración de un agente privado. Disponible en un proyecto.
Variables Locales¶
Como el alcance de una variable local se limita a un solo secuencia de comandos, una convención de nomenclatura para ellas puede ser muy simple, como letras en minúsculas o una palabra inicial, como return o myVariable. No se permiten puntos en las variables locales.
Variables Globales¶
Las variables globales, dado que su alcance es mayor (una variable global está disponible para ser referenciada en las mismas operaciones y secuencias de comandos abajo en la cadena dentro de una cadena de operación), deben usar una convención de nomenclatura coherente para evitar confusiones. Por ejemplo, si usa varios componentes para un nombre de variable, separados por guiones bajos, podría seguir un patrón como este:
type_name
| Componente | Descripción |
|---|---|
type | Una abreviatura corta que identifica el tipo de variable, como pv (variable del proyecto), gv (variable global), io(nombre de extremo /destino del punto final), dict (diccionario), etc |
name | Un nombre lógico para la variable, como purchase_orders, categories, ids, etc. Se pueden usar guiones bajos adicionales según sea necesario. |
Combinando estos componentes, estos son posibles nombres de variables:
$pv_shopify_base_url$dict_staples_po_line_items$io_request$gv_sfdc_workorder_id
Dado que las variables se ordenan alfabéticamente en varios lugares de la interfaz de usuario, organizarlas jerárquicamente ayudará a administrar y usar las variables.
Cualquiera que sea la convención que elija usar, le recomendamos que la codifique y la documente para que todos los miembros del equipo puedan usarla de manera consistente en todos los proyectos.
Nota
Si planea usar Jitterbit Secuencia de Comandos variables globales en un JavaScript secuencia de comandos, es importante usar guiones bajos en lugar de puntos:
$example_arr_names$example_sfdc_success_message