Convenzioni di denominazione in SAP CPI: un pacchetto di regole che il team può far rispettare

La maggior parte dei team SAP Cloud Integration (SAP CPI) ha convenzioni di denominazione. Meno team hanno convenzioni che ogni iFlow rispetta, perché le regole stanno in una pagina wiki e nessuno controlla il nome di un Content Modifier prima di un trasporto.

Questo articolo propone una convenzione di partenza per step, canali, proprietà e indirizzi, mostra come scriverla sotto forma di regole che uno strumento può verificare, e come un team può condividerla e farla rispettare.

Perché i nomi contano in SAP CPI

Il nome di uno step è ciò che vedi quando qualcosa si rompe. Il monitor segnala per nome lo step che ha fallito, una ricerca dello «step che imposta l'ID dell'ordine» lo trova solo se il nome lo dice, e un documento di design o un passaggio di consegne si legge come le etichette del diagramma. «Content Modifier 3» non dice nulla; CM_SetOrderHeaders dice cosa fa.

Nomi coerenti rendono anche due iFlow confrontabili: un revisore che conosce la convenzione può leggere a colpo d'occhio qualsiasi iFlow del team.

Una convenzione di partenza

Un prefisso per il tipo di step, poi cosa fa, in PascalCase: per la maggior parte dei team basta. Questo è il pacchetto incluso in Kitegra; è un punto di partenza da adattare, non uno standard SAP:

Scrivere la convenzione come regole

Una convenzione che uno strumento può verificare è un elenco di regole, una per tipo di elemento. Il testo letterale deve corrispondere esattamente; <Placeholder> sta per qualsiasi testo; <PascalCase>, <camelCase>, <UPPER>, <lower> e <Number> stanno per un testo di quella forma. Si applica la prima regola di ogni tipo, e ogni regola ha una gravità: Errore, Avviso o Info.

In Kitegra le regole sono un pacchetto di regole JSON. Un estratto:

{
  "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
    }
  ]
}

Concordarla come team

1. Apri la pagina delle opzioni dell'estensione e trova Regole di denominazione. Si parte dal pacchetto predefinito.
2. Modifica il Modello, la Gravità o le Note di una regola, disattivane una con «Regola attiva», oppure scegli «Aggiungi regola» e indica cosa Controlla.
3. Scegli «Esporta JSON» e metti il file dove il team conserva i propri standard, accanto alle linee guida per i trasporti.
4. Ogni collega sceglie «Importa JSON» con quel file. Se ha effettuato l'accesso con Kitegra, il pacchetto lo segue poi su ogni computer.

La sincronizzazione mantiene uguale il pacchetto di una persona su tutti i suoi computer; è il file JSON condiviso a mantenere il team sulle stesse regole.

Verificare un iFlow rispetto alle regole

Apri l'iFlow, fai clic sul pulsante «Strumenti Kitegra» e scegli Ispettore (oppure premi Alt+Shift+K). La scheda Denominazione elenca ogni nome fuori regola, con il conteggio sul pulsante: il nome effettivo, ciò che era Atteso, un Esempio e, dove il contenuto dello step lo consente, una Proposta di nome costruita da ciò che lo step fa. Un clic su un risultato seleziona lo step sul diagramma.

In modalità di modifica, Rinomina scrive il nome proposto nel campo Name dello step. Non salva mai: il pannello dice «Rinominato. Salva l’iFlow per mantenerlo.», e decidi tu.

Gli stessi risultati compaiono nel report iFlow accanto ai controlli di design, come mostra la checklist di revisione degli iFlow, e nomi ben scelti rendono leggibile un documento di design generato.

Come aiuta Kitegra

La denominazione fa parte dell'iFlow Inspector di Kitegra. Il controllo legge il modello dell'iFlow nel tuo browser; il tuo pacchetto di regole si sincronizza con il tuo account Kitegra quando accedi, e il contenuto dell'iFlow non viene mai inviato.

Helper, Message Monitor, iFlow Inspector e iFlow Docs contano ciascuno gli iFlow su cui li usi: 5 per modulo senza un account Kitegra, 50 con il piano Free, 100 con Starter e 300 con Pro; Business non ha limiti. La Toolbox e gli extra dell'area di lavoro sono gratuiti. Confronta i piani.

Provalo nel tuo prossimo iFlow

Scopri cosa aggiunge Kitegra attorno al designer di SAP Integration Suite, oppure guardalo accanto alle altre estensioni Chrome di Kitegra.

Domande frequenti