Quelquepart

Blog d'un développeur ABAP

Vous êtes ici : Accueil>Mots clés>documentation

documentation

ZAUTODOC : Documentation technique BW automatique !

Rédigé par Sébastien Hermann dans Application -

Dans un passé fort lointain, je me suis retrouvé chez un client qui avait la phobie du black out. Il craignait par dessus tout que l'ensemble de ses serveurs soit détruits, backup compris. Aussi souhaitait-il une documentation papier complète de chaque système. BW n’échappant pas à la règle, le client souhaitait une documentation de chaque objet et de chaque flux...

C'est à cette époque que j'ai décidé d'automatiser le tout, et ZAUTODOC est né. Ce programme va lire dans la base de données toutes les informations relatives à un flux ou un objet afin de le retranscrire dans Word.

Si la première version générait du HTML (le docx n'existait pas encore... c'est dire si le programme est vieux !), le programme a fait beaucoup d'émules et a été utilisé dans de nombreux projets. Je l'ai même retrouvé récemment chez un client, taggé au nom d'une SSII sans scrupule dont je tairais le nom.

Depuis la version originale de 2006, ZAUTODOC a bien évolué. Enrichi par plusieurs développeurs talentueux puis livré aux aléas du temps, je l'ai entièrement réécrit récemment afin qu'il génère un DOCX directement (grâce a la classe CL_WORD).

Son utilisation est simple : Vous choisissez un objet (DSO, Cube, InfoObjet, mais aussi multiprovider ou même WORKBOOK) et le programme va créer un fichier Word contenant l'objet et son flux d'alimentation (une option vous permet de remonter l'intégralité du flux jusqu'à arriver a des systèmes hors BW). Les routines abap et les formules sont également remontées dans le fichier

Le document contient également un diagramme "data flow" du flux, ainsi que la liste des process chain utilisées. Les DTP et IP peuvent également y être ajoutés. Enfin le programme gère le traitement en masse afin de générer 1 fichier par objet (cube, dso...). Les flux 7, mais aussi les vieillissants flux 3 sont pris en charge. Le programme peut très facilement être personnalisé : au tout début du code, vous trouverez tous les points de paramétrage dans une structure cs_custo afin de définir vos préférences projets.

Le seul travail qu'il vous reste à faire est de créer le template DOTX aux couleurs de votre projet afin de personnaliser votre documentation technique !

Un template et une image de couverture de démo ont été ajoutés dans ZIP, n'oubliez pas d'en indiquer le chemin dans le programme avant de l'exécuter. CL_WORD en version 1.2 a également été ajouté. C'est la version minimale nécessaire pour ZAUTODOC.