Ajouter de l’aide à vos DSPF

Vous voulez ajouter de l’aide à vos écrans DSPF ?

Nous allons vous présenter la méthode que nous utilisons en interne.

Nous avons choisi, comme format, les aides en UIM (panel de groupe).

Pour mettre en place de l’aide sur vos écrans vous devez faire 2 choses :

Mettre en place les mots clés dans le source de votre DSPF

D’abord au niveau fichier (au début du source) :

A                                      HLPTITLE('AIDE GPARAME')   
A                                      HLPPNLGRP(GPARAME GPARAME) 
A                                      ALTHELP(CA01)              
A                                      HELP
  • HLPTITLE indique le titre de votre fenêtre d’aide
  • HLPPNLGRP indique le nom du panel de groupe (conseil : mettre le même nom)
  • HELP pour pouvoir utiliser la touche de fonction Aide
  • ALTHELP pour indiquer que l’aide pourra être invoqué par F1, ce qui est le standard AUA

Ensuite au niveau du format (après la carte qui contient le R du format correspondant) :

A          H                           HLPPNLGRP('GPARAME/GLOG GPARAME')
A                                      HLPARA(*FLD GLOG)
  • HLPPNLGRP indique le panneau d’aide et le groupe
  • HLPARA aire pour laquelle ce panneau sera affiché, *FLD pour indiquer une zone

https://www.ibm.com/docs/en/i/7.5?topic=80-hlppnlgrp-help-panel-group-keyword-display-files

Créer votre panneau d’aide

Vous devez coder un source en UIM, qui correspond aux déclarations que vous avez indiqué dans votre DSPF :

                                       
:PNLGRP.                                        
:HELP NAME = 'GPARAME' .AIDE (GPARAME).         
:XH3. AIDE GPARAME.                             
:P.                                             
Ce programme vous permet de (ici descriptif général du programme)                
:EHELP.                                         
:HELP NAME = 'GPARAME/GLOG' .AIDE (GLOG).       
:XH3. AIDE GLOG.                                
:P.                                             
Cette zone (ici descriptif de la zone)                                 
:EHELP.  
...
:EPNLGRP.

C’est relativement simple à faire, vous pouvez utiliser tout le langage UIM.

Pour en savoir plus sur UIM : https://www.ibm.com/docs/en/i/7.4?topic=interfaces-user-interface-manager

Vous devez compiler votre panel de groupe :

==> CRTPNLGRP PNLGRP(lib/pannel) SRCFILE(libsrc/QPNLSRC)

Voici un exemple de ce que cala donne en faisant <F1> sur une Zone ici numéro de série

Pour vous aider, nous proposons un outil qui vous permet de générer les mots clés nécessaires pour le DSPF et le squelette de votre panel de groupe. Vous pouvez trouver l’outil ICI il s’appelle GENUIMDSP :

https://github.com/Plberthoin/PLB/tree/master/GENUIMDSP

Vous devez indiquer le fichier écran , le source avec les mots clés ici QDDSSRC, le squelette du panel ici dan QPNLSRC.

Remarque :

L’outil n’est pas parfait mais, il vous aide bien, si vous voulez contribuer, n’hésitez pas !

L’ajout des mots clés dans le DSPF ne change pas la commande de compile, ni les niveaux des formats dans lesquels vous ajoutez des aides.

La liaison est dynamique et si l’aide n’est pas trouvée, il n’y a pas de plantage donc pas de régression applicative, vous aurez « juste » le message suivant :

Ça peut être intéressant quand vous faites de la maintenance d’ajouter des aides, et avec notre méthode c’est rapide, simple et efficace.

Merci à Julien et Yoann pour leur aide.

/par