Use uma convenção de nomenclatura para variáveis no Jitterbit Studio
Introdução
Esta página fornece orientações sobre os nomes fornecidos pelo usuário para variáveis locais e globais.
Tipos de variáveis
O Harmony possui quatro tipos de variáveis:
- Variáveis Locais: Definidas e acessadas em um único Jitterbit Script ou JavaScript. Escopo limitado ao script.
- Variáveis Globais: Definidas em um Jitterbit Script ou JavaScript e disponíveis em todo o projeto.
- Variáveis de Projeto: Definidas na interface do Studio e disponíveis em todo o projeto. Atualizáveis através do Console de Gerenciamento.
- Variáveis Jitterbit: Predefinidas no Harmony ou definidas no arquivo de configuração de um agente privado. Disponíveis em todo o 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 ou em operações e scripts subsequentes dentro de uma cadeia de operações), devem usar uma convenção de nomenclatura consistente para evitar confusão. Por exemplo, usando múltiplos componentes para um nome de variável, separados por sublinhados, você poderia seguir um padrão como este:
type_name
| Componente | Descrição |
|---|---|
type |
Uma abreviação curta identificando o tipo da variável, como pv (variável de projeto), gv (variável global), io (nome da fonte/alvo do endpoint), dict (dicionário), etc. |
name |
Um nome lógico para a variável, como purchase_orders, categories, ids, etc. Substitutos adicionais podem ser usados conforme necessário. |
Combinando esses componentes, estes são os nomes de variáveis possíveis:
$pv_shopify_base_url$dict_staples_po_line_items$io_request$gv_sfdc_workorder_id
Como as variáveis são organizadas em ordem alfabética em vários lugares da interface, organizá-las hierarquicamente ajudará na gestão e uso das variáveis.
Qualquer convenção que você escolher usar, recomendamos codificá-la e documentá-la para que todos os membros da equipe possam utilizá-la de forma consistente em todos os projetos.
Nota
Se você planeja usar variáveis globais do Jitterbit Script em um script de JavaScript, é importante usar sublinhados em vez de pontos:
$example_arr_names$example_sfdc_success_message