Générer automatiquement une documentation de son workflow

[WilliamR]

How To: Générer automatiquement une documentation de son workflow

L'une des grandes force d'Alteryx Designer est de pouvoir visuellement documenter son workflow afin de le rendre facilement compréhensible notamment par d'autres utilisateurs qui ne l'auraient pas créé. Un fichier .yxmd (extension du fichier Workflow), est un fichier XML qui décrit l'ensemble des configurations des différents outils utilisés, et ce fichier contient aussi les commentaires que vous pouvez ajouter sur chacun des outils (à l'aide des annotations) mais aussi les commentaires que vous pouvez entrer dans les formules par exemple. L'une des beautés de la chose, c'est de pouvoir exploiter ces informations avec...Alteryx Designer!

Dans cet optique, un workflow spécifique de génération de documentation a été créé.

Il est disponible en attachement.

Prérequis

• Alteryx Designer

Procedure

1. Télécharger le contenu du package (AutoDocumentor.yxzp) et exécutez le,
2. Exécuter l'application analytique contenue dans le package (AutoDocumentor.yxwz),
3. Naviguer jusqu'au fichier de workflow (.yxmd) à documenter (bien penser à modifier le ficltre sur le nom du fichier par *.*, cf capture ci-après),
4. Récupérer la documentation (.pdf). 

Problèmes connus

Les workflow contenant des images en fond d'outils "Commentaires" peuvent rencontrer des problèmes.

Les containers ne sont pas beaucoup appréciés non plus tout comme les caractères spéciaux dans le nom des workflows !

Ressource additionnelle

Pour plus de détail, le message d'origine se trouve ici.

En pièce jointe un exemple de rapport ainsi que le package.