Conventions de nommage SAP CPI : un jeu de règles que votre équipe peut faire respecter

La plupart des équipes SAP Cloud Integration (SAP CPI) ont des conventions de nommage. Moins nombreuses sont celles dont tous les iFlows les respectent, car les règles vivent sur une page de wiki et personne ne vérifie le nom d'un Content Modifier avant un transport.

Cet article propose une convention de départ pour les étapes, les canaux, les propriétés et les adresses, montre comment l'écrire sous forme de règles vérifiables par un outil, et comment une équipe peut la partager et la faire respecter.

Pourquoi les noms comptent dans SAP CPI

Le nom d'une étape est ce que vous voyez quand quelque chose casse. Le moniteur désigne l'étape en échec par son nom, une recherche de « l'étape qui définit l'ID de commande » ne la trouve que si son nom le dit, et un document de conception ou une passation se lit comme les libellés du diagramme. « Content Modifier 3 » ne dit rien ; CM_SetOrderHeaders dit ce qu'il fait.

Des noms cohérents rendent aussi deux iFlows comparables : un relecteur qui connaît la convention peut lire d'un coup d'œil n'importe quel iFlow de l'équipe.

Une convention de départ

Un préfixe pour le type d'étape, suivi de ce qu'elle fait, en PascalCase, suffit à la plupart des équipes. C'est le jeu de règles fourni avec Kitegra ; c'est un point de départ à adapter, pas un standard SAP :

Écrire la convention sous forme de règles

Une convention qu'un outil peut vérifier est une liste de règles, une par type d'élément. Le texte littéral doit correspondre exactement ; <Placeholder> représente n'importe quel texte ; <PascalCase>, <camelCase>, <UPPER>, <lower> et <Number> représentent un texte de cette forme. La première règle de chaque type s'applique, et chaque règle a une gravité : Erreur, Avertissement ou Info.

Dans Kitegra, les règles forment un jeu de règles JSON. Un extrait :

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

S'accorder en équipe

1. Ouvrez la page des options de l'extension et trouvez « Règles de nommage ». Elle démarre avec le jeu de règles par défaut.
2. Modifiez le « Modèle », la « Gravité » ou les « Notes » d'une règle, désactivez-en une avec « Règle active », ou choisissez « Ajouter une règle » et sélectionnez ce qu'elle « Vérifie ».
3. Choisissez « Exporter en JSON » et placez le fichier là où l'équipe conserve ses standards, à côté des consignes de transport.
4. Chaque collègue choisit « Importer un JSON » avec ce fichier. S'il est connecté avec Kitegra, le jeu de règles le suit ensuite sur chaque ordinateur.

La synchronisation garde le jeu de règles d'une personne identique sur tous ses ordinateurs ; c'est le fichier JSON partagé qui maintient toute l'équipe sur les mêmes règles.

Confronter un iFlow aux règles

Ouvrez l'iFlow, cliquez sur le bouton « Outils Kitegra » et choisissez « Inspecteur » (ou appuyez sur Alt+Shift+K). L'onglet « Nommage » liste chaque nom hors règles, avec leur nombre sur le bouton : le nom actuel, ce qui est « Attendu », un « Exemple » et, quand le contenu de l'étape le permet, une « Proposition » de nom construite à partir de ce que fait l'étape. Un clic sur un constat sélectionne l'étape sur le diagramme.

En mode édition, « Renommer » saisit le nom proposé dans le champ Name de l'étape. Rien n'est enregistré : le panneau indique « Renommé. Enregistrez l'iFlow pour le garder. », et c'est vous qui décidez.

Les mêmes constats figurent dans le rapport de l'iFlow à côté des contrôles de conception, comme le montre la checklist de revue d'iFlow, et de bons noms rendent un document de conception généré agréable à lire.

Comment Kitegra vous aide

Le nommage fait partie de l'iFlow Inspector de Kitegra. Le contrôle lit le modèle de l'iFlow dans votre navigateur ; votre jeu de règles se synchronise avec votre compte Kitegra quand vous êtes connecté, et le contenu de l'iFlow n'est jamais envoyé.

Le Helper, le Message Monitor, l'iFlow Inspector et iFlow Docs comptent chacun les iFlows sur lesquels vous les utilisez : 5 par module sans compte Kitegra, 50 avec le forfait Free, 100 avec Starter et 300 avec Pro ; Business n'a pas de limite. La Toolbox et les extras de l'espace de travail sont gratuits. Comparez les forfaits.

Essayez-le dans votre prochain iFlow

Découvrez ce que Kitegra ajoute autour du designer de SAP Integration Suite, ou voyez-le aux côtés des autres extensions Chrome de Kitegra.

Questions fréquentes