Générer un document de conception technique SAP CPI à partir de l'iFlow

Tout projet SAP Cloud Integration (SAP CPI) exige un document de conception technique, et la plupart sont écrits deux fois : une fois avant la réalisation, à partir de la spécification, et une fois à la passation, à partir de l'iFlow, parce que l'iFlow a changé. La seconde fois consiste surtout à recopier ce que l'iFlow dit déjà.

Cet article liste ce que doit contenir le document de conception technique d'un iFlow, et montre comment le générer à partir de l'iFlow lui-même, en Word, PDF ou HTML, ou dans le modèle Word de votre entreprise.

À quoi sert le document

Un document de conception technique explique le fonctionnement de l'iFlow à quelqu'un qui ne l'a pas construit : quels systèmes il relie, ce qu'il fait d'un message en chemin, comment il échoue, et ce dont un opérateur a besoin pour l'exploiter. On le lit lors des revues, à la passation, et des mois plus tard quand l'interface tombe en panne.

Ce qu'il faut y mettre

• Vue d'ensemble de l'interface : nom, ID, package, objectif, émetteurs et récepteurs avec leurs adaptateurs et adresses.
• Flux : un diagramme et, pour chaque processus, un court récit de ce qui arrive au message.
• Routage : chaque Router, ses routes et leurs conditions, et la route par défaut.
• Mappings et scripts : ce que fait chacun, en une ou deux phrases.
• Headers et propriétés : ce que l'iFlow définit et ce qu'il lit.
• Gestion des erreurs : les Exception Subprocess et ce qu'ils font.
• Sécurité : les noms d'identifiants et de clés qu'il utilise (jamais les secrets).
• Les paramètres externalisés, ainsi que les Data Stores, files JMS et liaisons ProcessDirect qu'il utilise.
• Exploitation : où le surveiller, que faire en cas d'échec, qui contacter.

Pourquoi les documents écrits à la main se périment

Chaque élément de cette liste se trouve déjà dans l'iFlow. L'écrire à la main, c'est recopier des adresses, des conditions et des noms de paramètres, et chaque modification de l'iFlow rend la copie un peu plus fausse. Un document généré à partir de l'iFlow est exact le jour où il est produit, et le régénérer après une modification prend une minute.

Le générer à partir de l'iFlow

1. Ouvrez l'iFlow dans le designer, cliquez sur le bouton « Outils Kitegra » et choisissez « Documenter cet iFlow ». Le « Document de l'iFlow » s'ouvre dans un nouvel onglet.
2. Vérifiez les informations lues : participants et adaptateurs, processus et leurs étapes, routes, mappings et scripts, headers et propriétés, paramètres, noms de Security Material, stores et liaisons, et la gestion des erreurs.
3. Choisissez un « Modèle » : « Conception technique », « Résumé court » ou « Passation aux opérations ».
4. Renseignez « Projet » et « Auteur » ; ils sont conservés pour le document suivant.
5. Téléchargez-le en Word, PDF ou HTML.

Le diagramme est dessiné à partir de l'iFlow, et chaque processus reçoit un récit du type « Reçoit des messages de … via … » et « En cas d'erreur : … ». Sans le designer, choisissez plutôt « Téléverser un iFlow (ZIP ou .iflw) » ; un fichier téléversé ne compte pas dans les iFlows de votre forfait. Les libellés du PDF sont en anglais.

Utiliser le modèle Word de votre entreprise

Si votre projet a un modèle, choisissez « Votre propre modèle Word ». Écrivez des balises dans un fichier .docx là où les informations doivent figurer, puis choisissez « Remplir et télécharger » :

Interface:   {{iflowName}} ({{iflowId}})
Package:     {{package}}
Project:     {{project}}        Author: {{author}}        Date: {{date}}

Purpose
{{description}}

Senders: {{senders}}        Receivers: {{receivers}}
Adapters: {{adapters}}

How it works
{{narrative}}

Routing: {{routes}}
Scripts: {{scripts}}
Error handling: {{errorHandling}}

La page liste chaque balise qu'elle remplit, dont {{iflowName}}, {{package}}, {{narrative}}, {{routes}}, {{parameters}}, {{securityMaterial}} et {{errorHandling}}. Les Message Mappings ont leur propre tableau : voir la documentation des Message Mappings dans Excel.

Comment Kitegra vous aide

Les documents constituent le domaine iFlow Docs de Kitegra. Le document est construit dans votre navigateur ; les scripts et mappings ne sont jamais envoyés à Kitegra. Avant de documenter un iFlow, la checklist de revue repère ce que vous ne voudriez pas mettre par écrit.

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