Convenções de nomenclatura no SAP CPI: um pacote de regras que sua equipe pode aplicar

A maioria das equipes de SAP Cloud Integration (SAP CPI) tem convenções de nomenclatura. Menos equipes têm convenções que todo iFlow segue, porque as regras ficam em uma página de wiki e ninguém confere o nome de um Content Modifier antes de um transporte.

Este artigo propõe uma convenção inicial para etapas, canais, propriedades e endereços, mostra como escrevê-la como regras que uma ferramenta consegue verificar e como uma equipe pode compartilhá-la e garantir que seja seguida.

Por que os nomes importam no SAP CPI

O nome de uma etapa é o que você vê quando algo quebra. O monitor informa a etapa com falha pelo nome, uma busca por “a etapa que define o ID do pedido” só a encontra se o nome disser isso, e um documento de design ou uma passagem de conhecimento se lê como os rótulos do diagrama. “Content Modifier 3” não diz nada; CM_SetOrderHeaders diz o que faz.

Nomes consistentes também tornam dois iFlows comparáveis: um revisor que conhece a convenção consegue ler qualquer iFlow da equipe de relance.

Uma convenção inicial

Um prefixo para o tipo de etapa, seguido do que ela faz, em PascalCase, basta para a maioria das equipes. Este é o pacote que vem com o Kitegra; é um ponto de partida para adaptar, não um padrão do SAP:

Escreva a convenção como regras

Uma convenção que uma ferramenta consegue verificar é uma lista de regras, uma por tipo de elemento. O texto literal precisa coincidir exatamente; <Placeholder> representa qualquer texto; <PascalCase>, <camelCase>, <UPPER>, <lower> e <Number> representam texto com aquele formato. Vale a primeira regra de cada tipo, e cada regra tem uma gravidade: Erro, Aviso ou Info.

No Kitegra, as regras formam um pacote de regras em JSON. Um trecho:

{
  "rules": [
    {
      "id": "content-modifier",
      "target": "content-modifier",
      "pattern": "CM_<Action>",
      "example": "CM_SetOrderHeaders",
      "notes": "Content Modifier: CM_ and what it sets.",
      "severity": "warning",
      "enabled": true
    },
    {
      "id": "mapping",
      "target": "mapping",
      "pattern": "MM_<Source>_to_<Target>",
      "example": "MM_Order_to_SalesOrder",
      "notes": "Message Mapping: source and target message.",
      "severity": "info",
      "enabled": true
    },
    {
      "id": "property",
      "target": "property",
      "pattern": "<camelCase>",
      "example": "orderId",
      "notes": "Exchange property names in camelCase.",
      "severity": "info",
      "enabled": true
    }
  ]
}

Combine as regras em equipe

1. Abra a página de opções da extensão e encontre “Regras de nomenclatura”. Ela começa com o pacote padrão.
2. Altere o “Padrão”, a “Gravidade” ou as “Notas” de uma regra, desligue uma com “Regra ativa”, ou escolha “Adicionar regra” e selecione o que ela “Verifica”.
3. Escolha “Exportar JSON” e coloque o arquivo onde a equipe guarda os seus padrões, junto com as diretrizes de transporte.
4. Cada colega escolhe “Importar JSON” com esse arquivo. Quando ele está conectado com o Kitegra, o pacote passa a acompanhá-lo em qualquer computador.

A sincronização mantém o pacote de uma pessoa igual em todos os computadores dela; o arquivo JSON compartilhado é o que mantém a equipe com as mesmas regras.

Verifique um iFlow com as regras

Abra o iFlow, clique no botão “Ferramentas do Kitegra” e escolha “Inspetor” (ou pressione Alt+Shift+K). A aba “Nomenclatura” lista cada nome fora das regras, com a contagem no botão: o nome atual, o “Esperado”, um “Exemplo” e, quando o conteúdo da etapa permite, uma “Sugestão” de nome construída a partir do que a etapa faz. Clicar em um apontamento seleciona a etapa no diagrama.

No modo de edição, “Renomear” digita o nome sugerido no campo Name da etapa. Ele nunca salva: o painel diz “Renomeado. Salve o iFlow para manter.”, e a decisão é sua.

Os mesmos apontamentos aparecem no relatório do iFlow, ao lado das verificações de design, como mostra o checklist de revisão de iFlows, e bons nomes fazem um documento de design gerado ficar fácil de ler.

Como o Kitegra ajuda

A nomenclatura faz parte do iFlow Inspector do Kitegra. A verificação lê o modelo do iFlow no seu navegador; o seu pacote de regras é sincronizado com a sua conta Kitegra quando você entra, e o conteúdo do iFlow nunca é enviado.

O Helper, o Message Monitor, o iFlow Inspector e o iFlow Docs contam, cada um, os iFlows em que você os usa: 5 por módulo sem uma conta Kitegra, 50 no plano Free, 100 no Starter e 300 no Pro; o Business não tem limite. A Toolbox e os extras do espaço de trabalho são gratuitos. Compare os planos.

Experimente no seu próximo iFlow

Veja o que o Kitegra acrescenta ao redor do designer do SAP Integration Suite, ou confira-o ao lado das outras extensões do Chrome da Kitegra.

Perguntas frequentes