Le temps passe, et les différentes demandes de mes clients m'ont conduit à modifier certains des programmes publiés ici. Comme d'habitude, je vous livre donc une mise à jour de ces évolutions.

La principale mise à jour concerne ZAUTODOC, le générateur de doc technique BW, qui passe de la version 3.1 à la version 3.4 et accueille de nouveaux objets, dont les queries BEx !

• Les queries BEx et les WAD sont maintenant documentées (très légèrement pour les WAD)
• Les process chain, les Open Hub, les infosets BW et les includes abap (dans les routines) sont maintenant documentés
• Si un objet BW (DSO, cube...) contient une documentation dans le système, le programme essaie de la récupérer pour l'inclure dans la documentation générée. Ainsi il devient possible d'ajouter de l'intelligence dans cette documentation automatique en uploadant sur l'objet principal d'un flux votre propre documentation.
• Extraction du code des user-exit ECC si un include/form par datasource existe
• Ajout d'un paragraphe à la fin du document qui indique comment regénérer cette documentation
• Gestion des groupes de règles dans les transformations
• Nombreuses autres modifications mineures

A noter : la version 1.4 de la classe CL_WORD est nécessaire. Elle est incluse dans le package.

En cas de mise à jour depuis une précédente version, pensez à bien récupérer votre personnalisation (variable cs_custo au début du code)

On continue avec ZTOAD - Requêteur Open SQL qui passe de la version 3.0 à la version 4.0 :

• Gestion d'onglets : vos requêtes et leurs résultats peuvent être gardées en mémoire dans des onglets séparés. Passez ainsi de l'une a l'autre en 1 clic.
• Import/export des requêtes sauvegardées
• Gestion du "case" dans la nouvelle syntaxe abap sql

ZSPRO, la boite à outils passe de la version 2.3 à la version 2.5.1 :

• Gestion de styles sur l'affichage de la documentation ABAP
• Affichage d'une image de fond dans la partie droite (le logo du programme) pour permettre une plus forte identification de l'application
• Divers corrections et ajouts mineurs

ZRSPC, le mini ordonanceur passe de la version 1.7.1 à la version 1.10 :

• CHANGE_DTP_SEL permet de modifier les critères de sélection d'un DTP
• TRIG_IP, TRIG_DTP et TRIG_CHAIN ont maintenant la possibilité de ne pas lancer plus de X chaines en parallèle
• Affichage de la documentation du programme sur l'écran de sélection
• Le mode test affiche désormais l'ALV d'exécution s'il n'y a pas d'erreur (ce qui permt d'interragir avec les différents objets)
• Diverses corrections mineures

ZAL11, l'explorateur de fichiers subit une mise à jour mineur pour corriger un DUMP potentiel.

Vous avez rêvé de pouvoir vérifier le contenu des programmes mis à disposition sur le site sans avoir à les télécharger/installer. Oui je le sais, un de vous m'a même demandé de fournir un fichier texte contenant le code.

Grâce à Sandra Rossi, le rêve devient réalité ! Dorénavant, vous aurez la possibilité, sur chaque page proposant un programme, de voir le contenu du nugget (le fichier .nugg pour saplink). Le code abap donc, mais pas que ! Textes, définition de table, dynpro, rien ne manque. Ansi, si le cœur vous en dit, vous pouvez même recréer "à la main" un programme, sans passer par saplink.

Un exemple : code source de la classe d'abstraction docx

Merci à Sandra pour l'idée originale et sa transformation xslt, je n'ai fait que recoder le tout en php et mettre un coup de peinture.

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, WAD ou Query BEx) 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 à des systèmes hors BW). Les routines abap et les formules sont également remontées dans le fichier

Propriétés Bex d'un InfoObjet

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.

Le mois dernier je vous ai présenté ma classe d'abstraction pour faire communiquer SAP et Word en utilisant les liens OLE. Bien que j'adore cette méthode pleine de poésie, ce n'est pas très rapide ni pratique pour générer de gros ou nombreux documents. J'ai donc du réfléchir à une autre méthode : créer des fichiers DOCX directement sans utiliser Microsoft.

Afin de pouvoir transformer rapidement mes différents projets clients utilisant l'ancienne classe, j'en ai repris l'interface : les méthodes portent le même nom et utilisent les mêmes paramètres (autant que possible)

Je vous livre donc cette nouvelle classe d'abstraction qui permet de générer un fichier DOCX directement en ABAP. Contrairement aux différents projets balbutiants et aux tutos que j'ai pu voir sur le net, ici la prise en main est ultra simple : un document "hello world" se génère en quelques lignes !

Code pour générer un DOCX Hello World en ABAP

Sont gérés par la classe :

• Création de document vierge ou via template (docx/docm/dotx/dotm)
• Écriture de texte avec ou sans style (style de paragraphe et/ou de police)
• Option bold, italique, souligné, barré, indice, exposant, petite majuscules, choix de police et taille, couleur, surlignage, espacement de caractères
• Gestion de l'alignement, de l'indentation, du retrait, des espaces avant et après le paragraphe, de l'interligne, des bordures de paragraphe et couleur de fond
• Saut de ligne, de page, de section et section continue
• Écriture de tableau avec ou sans style de tableau (et possibilité de définir des option de formatage par cellule : gras, couleur...)
• Écriture d’entête/pied de page simples
• Gestion de l'orientation (portrait/paysage) et des bordures de page
• Insertion d'image
• Insertion de note de bas de page ou de fin de document
• Insertion de commentaires
• Insertion de dessin (canvas)
• Insertion de table des matières
• Insertion de libellés numérotés (figure, table...)
• Insertion de table de libellés (figures, tables...)
• Insertion de propriété de document et de champs personnalisés (custom fields)
• Mise à jour des propriétés de document
• Création de style (caractère, paragraphe)
• Prise en charge des images/templates dans le SAP Web Repository (SAPWR via la stransaction SMW0)
• Pour les utilisateurs avancées ayant des besoins non gérés, possibilité d'inclure un fragment XML de votre composition dans le document en cours

Pour le téléchargement, je livre un programme de démo de la classe qui montre comment l'utiliser. Le zip contient :

• Le package NUGG avec programme de démo et classe dans un "include" séparé
• Un template word et 3 images utilisés par le programme démo
• Un fichier TXT contenant la classe pour ceux qui veulent jeter un oeil au code sans saplink

Prochainement, un cas d'usage sur BW...

Cela fait des années que je pratique cette méthode de communication, pour des petites "bidouilles" entre SAP et Microsoft. C'est rapide et ludique (j'adore voir Word se remplir tout seul, c'est "magique", un peu comme quand je regarde un piano automatique dont les touches s'enfoncent seules lorsqu'il joue).

Enfin rapide... une fois qu'on a réussi a trouver les bonnes commandes ! Car c'est assez galère à programmer :

• commande obscure
• pas ou peu de documentation ou d'exemple
• de nombreuses questions sur le net, mais les réponses sont rares

Cette fois j'ai eu un gros besoin. Je devais générer un document complet, sous word, à partir de tonnes de données SAP. Prenant mon courage à 2 mains, j'ai de nouveau déguainé OLE, et pour que ca soit réutilisable, j'en ai fait une classe d'abstraction.

En utilisant ma classe, fini la galère, vous avez juste a l'inclure en début de votre programme, et ensuite de simples appels aux méthod write_text ou write_table vont vous permettre de remplir votre document... magiquement !

Sont gérés par la classe :

• Création de document vierge ou via template dotx
• Ecriture de texte avec ou sans style (style de paragraphe et/ou de police)
• Option bold, italique, souligné, choix de police et taille, couleur
• Saut de ligne, de page, de section et section continue
• Ecriture de tableau avec ou sans style de tableau (et possibilité de définir des option de formatage par cellule : gras, couleur...)
• Note de bas de page
• Ecriture d'entete/pied de page simples
• Gestion de l'orientation (portrait/paysage)
• Insertion d'image
• Insertion de dessin (canvas)
• Insertion de table des matières
• Insertion de champs personnalisés (custom fields)
• Mise a jour du titre de la fenetre word
• Sauvegarde du document et fermeture de word

A l'usage, je me suis malgré tout rendu compte que la génération était assez longue (5 à 10 minutes pour un document de 50 pages). Ce sont les tableaux qui sont particulièrement lents.

Et donc finalement j'ai du changer de méthode pour mon projet, mais je publie malgré tout cette classe car elle est pleinement fonctionnelle, et pourra toujours vous servir de "how to" sur vos petits besoins OLE :)

Pour le téléchargement, je livre un programme de "test" de la classe qui montre comment l'utiliser. Le zip contient également un template, et quelques images qui sont utilisées par le programme test.