Use uma Convenção de Nomenclatura para Variáveis¶
Introdução¶
Esta página fornece orientação sobre nomes fornecidos pelo usuário de variáveis locais e globais.
Tipos de Variáveis¶
Harmony tem quatro tipos de variáveis:
- Variáveis Locais: Definido e acessado em um único Jitterbit Script ou JavaScript. Escopo limitado ao script.
- Variáveis globais: Definido em um Jitterbit Script ou JavaScript e disponível em um projeto.
- Variáveis do Projeto: Definido na IU do Cloud Studio e disponível em um projeto. Atualizável por meio do Management Console.
- Variáveis Jitterbit: Predefinido no Harmony ou definido no arquivo de configuração de um Agente Privado. Disponível em um projeto.
Variáveis locais¶
Como o escopo de uma variável local é limitado a um único script, uma convenção de nomenclatura para elas pode ser muito simples, como letras minúsculas ou uma palavra inicial, como return ou myVariable. Pontos não são permitidos em variáveis locais.
Variáveis Globais¶
As variáveis globais, como seu escopo é maior (uma variável global está disponível para ser referenciada nas mesmas operações e scripts abaixo dentro de uma cadeia de operação ), devem usar uma convenção de nomenclatura consistente para evitar confusão. Por exemplo, usando vários componentes para um nome de variável, separados por sublinhados, você pode seguir um padrão como este:
type_name
| Componente | Descrição |
|---|---|
type | Uma abreviação curta identificando o tipo de variável, como pv (variável do projeto), gv (variável global), io(nome de origem/destino do endpoint ), dict (dicionário), etc. |
name | Um nome lógico para a variável, como purchase_orders, categories, ids, etc. Sublinhados adicionais podem ser usados conforme necessário. |
Combinando esses componentes, esses são os possíveis nomes de variáveis:
$pv_shopify_base_url$dict_staples_po_line_items$io_request$gv_sfdc_workorder_id
Como as variáveis são classificadas alfabeticamente em vários locais da interface do usuário, organizá-las hierarquicamente ajudará no gerenciamento e no uso de variáveis.
Seja qual for a convenção que você escolher usar, recomendamos codificá-la e documentá-la para que todos os membros da equipe possam usá-la consistentemente em todos os projetos.
Nota
Se você planeja usar Jitterbit Script variáveis globais em um JavaScript script, é importante usar sublinhados em vez de pontos:
$example_arr_names$example_sfdc_success_message