Aller au contenu

Création dynamique d'une documentation de processus

Création dynamique d'une documentation de processus

En tant que responsable informatique et des processus, vous devez vous assurer que les interfaces entre les applications sont toujours documentées de manière détaillée. L'expérience montre que maintenir cette documentation à jour à tout moment représente un défi particulier, car les applications et donc les interfaces sont souvent étendues ou adaptées.

Objectifs et avantages

Grâce à ADIB, vous pouvez relever ce défi avec un effort raisonnable. Pour ce faire, vous saisissez certaines informations sur les applications et les interfaces dans CentralStation. Cela est très facile à faire grâce à un éditeur de texte intégré.

Grâce à l'ADIB, vous n'avez plus besoin de créer une documentation détaillée sur les processus, car l'ADIB le fait pour vous en un clic. Vous économisez ainsi beaucoup de temps et d'efforts, car vous n'avez pas besoin de saisir à nouveau ces données dans un autre outil qui, d'après notre expérience, est rarement à jour. Cela ne vous arrivera pas avec l'ADIB !

Vous établissez ainsi l'ADIB comme solution centrale pour la configuration et la documentation des processus

  • Création de la documentation actuelle des processus en un clic
  • Exportation de la documentation au format PDF ou Word
  • La documentation des processus correspond toujours exactement à l'état actuel

Création et génération de la documentation

Grâce à l'éditeur de texte intégré, vous pouvez enregistrer certaines informations de base et certains graphiques directement pendant la création de l'interface

  • Au niveau du travail, c'est-à-dire pour l'ensemble de la tâche d'intégration
  • Au niveau de l'étape, et donc pour le transfert de données individuel entre une source et une destination.

Dans l'exemple, une explication accompagnée d'un graphique a également été enregistrée au niveau du travail. Pour lancer l'éditeur, double-cliquez sur le champ « Description » dans le travail correspondant.

cest_documentation-0 \Image 157 : double-cliquez sur le champ « Description » pour démarrer l'éditeur

cest_documentation-1 \Image 158 : Éditeur intégré pour la gestion des informations de base

Procédez de la même manière au niveau des étapes. Il suffit toutefois de saisir uniquement les informations de base. Les informations détaillées telles que les champs transférés, les paramètres enregistrés, l'heure et le jour d'exécution de la tâche, etc. sont automatiquement ajoutées par l'ADIB en fonction de la configuration effectuée.

  • Pour créer le document de processus, cliquez sur le bouton « Process Documentation » dans la partie supérieure du masque de tâche.
  • Le masque suivant s'ouvre alors, dans lequel vous pouvez définir divers paramètres.
    • (1) : Sélection de l'instance pour laquelle la documentation doit être créée
    • (2) : Niveau de détail de la documentation : Vous définissez ici si les paramètres et les positions des étapes (tous ou seulement ceux qui sont actifs) doivent être affichés
    • (3) : affichage des autres éléments de la configuration
      • Listes de mappage
      • Listes de flexmapping
      • Autres paramètres
    • Il est judicieux d'afficher la documentation du processus séparément pour chaque instance. Si vous avez des listes de mappage très volumineuses, il peut être préférable de ne pas les afficher.

cest_documentation-2 \Image 159 : Options de configuration pour la génération de la documentation du processus

  • Après avoir cliqué sur OK dans la zone inférieure droite, un aperçu est créé.

cest_documentation-3 \Image 160 : aperçu de la documentation du processus sur la base des paramètres définis

  • Vous pouvez ensuite exporter le document au format PDF (ou au format docx pour un traitement ultérieur).
    • Le PDF créé dispose d'une table des matières générée automatiquement, ce qui facilite grandement la navigation dans le document

cest_documentation-4 \Image 161 : page d'accueil du processus et zone de navigation générée automatiquement

  • Conformément aux paramètres, les paramètres de pas, les positions de pas, etc. sont ajoutés à chaque pas avec la configuration actuelle, de sorte que la documentation du processus créée est toujours à jour !

cest_documentation-5 \Image 162 : Les paramètres/positions actuels sont automatiquement inclus dans la documentation