Ir para o conteúdo

Metodologia de Nomenclatura de Vinyl

Jitterbit possui uma metodologia que define convenções de nomenclatura a serem seguidas ao desenvolver e manter aplicativos Vinyl. É importante seguir essas convenções de nomenclatura para fins de consistência e simplicidade, e para que qualquer aplicativo do Vinyl possa ser compreendido de forma rápida e fácil por diferentes desenvolvedores do Vinyl.

Este documento descreverá as convenções de nomenclatura, bem como fornecerá exemplos para ajudar a ilustrar.

Camada de Lógica de Negócios

Regras do Negócio

As seguintes diretrizes gerais devem ser usadas ao nomear Regras de Negócios em Vinyl. Diferentes tipos de regras de negócios são enumerados, juntamente com exemplos de cada um.

Objetos de negócios habilitados para eventos:

  • Alvo ({{Business Object Descriptor}})

Todo o resto:

  • Alvo ({{Purpose or Subtype}}) {{Descriptor}} – {{Optional Filter}}

Objeto de Negócio com Eventos (mrp/srp/board)

  • {{Target}} ({{Descriptor}})
  • Exemplos:
    • Cliente (Detalhes)
    • Pedido (Detalhes)

Objeto de Negócios com Gráfico de Relatório de Subtipo/calendário/pivot/mapa/gráfico de Rede/gantt/relatório

  • {{Target}} ({{Edge Case Subtype}}) {{Descriptor}}
  • Exemplos:
    • Visitas ativas do cliente (calendário)
    • Cronograma do projeto do cliente (Gantt)
    • Tendência de vendas do cliente (gráfico) por mês - Pedidos aprovados

Lista

  • {{Target}} (Lista) {{Optional Descriptor}}
  • Exemplos:
    • Cliente (Lista)
    • Cliente (Lista) Quem

Subconsulta

  • {{Target}} (Subconsulta) {{Descriptor}}
  • Exemplo:
    • Cliente (Subconsulta) Concatenar termo de pesquisa

CRUD/Migração - Subtipo Inserir/Atualizar/Cram/Excluir

Inserir
  • {{Target}} ({{Subtype}}) {{Descriptor|Source}}
  • Exemplo:
    • Cliente (inserir) Salesforce
Estudar
  • {{Target}} ({{Subtype}}) {{Descriptor|Source}}
  • Exemplo:
    • Cliente (Cram) Salesforce
Atualizar
  • {{Target}} ({{Subtype}}) {{Descriptor|Field Names}}
  • Exemplo:
    • ID permanente do cliente (atualização) - Positivo
Excluir
  • {{Target}} ({{Subtype}}) {{Descriptor}}
  • Exemplo:
    • Cliente (Excluir) Sem atividade

Padrão

  • {{Target}} (Padrão) {{FieldNames}} – {{SourceTable}}
  • Exemplos:
    • Cliente (padrão) AccountStatusID
    • País do cliente (padrão), LeadSource - Param

Funções SQL de Desempenho - Group By, Union, Pivot, Stuff

  • {{Target}} {{SQL Function}} {{Descriptor}}
  • Exemplos:
    • Cliente (Agrupar por) País, Estado - Ativo
    • Posição do cliente (pivô)
    • Cliente (sindicato) Cliente, cliente potencial, contatos
    • Nomes de contato do cliente (coisas)

Validação

  • {{Target}} (Validação) {{Descriptor}}
  • Exemplo:
    • Nome do cliente (validação) muito curto

Visibilidade

  • {{Target}} (Visibilidade) {{Descriptor|Source Table}}
  • Exemplo:
    • Cliente (Visibilidade) CustomerType

Ponte

  • {{Target}} (Ponte) {{Description}}
  • Exemplo:
    • Falha no pedido (ponte)

Alcançar

  • {{Target}} (Alcançar) {{Descriptor|Source Table}}
  • Exemplo:
    • Cliente (alcance) CustomerType

Webhook

  • {{Target}} (Webhook) {{Descriptor}}
  • Exemplo:
    • Cliente (Webhook) Externo