Message/Historique/logs

Afficher un message d’information

Il s’agit d’un message d’information standard (ie sous le champ) :

iResourceController.inform("NomSystemeChamp","Message");

Afficher une fenêtre avec un message

La fenêtre dispose d’un bouton de validation :

iResourceController.alert("texte");

Dans certains contextes, on peut trouver/utiliser directement alert("texte").

Écrire dans les fichiers vdp.log et server.log

log.info(texte) ou log.error(texte).

N’est pas disponible dans tous les contextes. Par défaut, dans les scripts back-end, log n’est pas défini. Pour écrire dans le log serveur, initialiser un logger :

var log = Packages.com.axemble.vdoc.sdk.utils.Logger.getLogger("Debug - script");

Écrire dans le tableau d’historique du document

Code JavaScript

iWorkflowInstance.getHistory().addEvent( "Augmenter le délai", iTask.getLabel(), iUser, iUser, delayComment, iTask.getRole().getLabel() );

Correspondance dans le tableau d’historique : iWorkflowInstance.getHistory().addEvent( "Colonne Décision" , "Colonne Étape", iUser , iUser , "Colonne Commentaires" , null );.

Exemple d’utilisation

Cet exemple explique comment ajouter dans l’historique un commentaire en cas d’annulation.

Paramétrage

Pour ajouter dans l’historique un commentaire sur l’action d’annulation (rappel : action disponible possible pour le créateur du document) :

  • Ouvrir le formulaire d’annulation (ABORT_DOCUMENT_Edit)
  • Ajouter un champ texte dans le formulaire sur l’action d’annulation, ici “CommentairesDAnnulation”
  • Ajouter un le script suivant : 
    function onBeforeSave(){
  iWorkflowInstance.getHistory().addEvent( "Annuler ma demande" , "Annulation", iUser , iUser , iWorkflowInstance.getValue("CommentairesDAnnulation") , null );
}

Résultat obtenu dans l’historique

Si l’utilisateur annule le document en saisissant “Erreur de saisie” dans le formulaire d’action annulation : Exemple Commentaire Dans Historique Exemple Commentaire Dans Historique

Variante pour centraliser le code spécifique dans les abonnements

Inclure le code ci-dessus dans les abonnements de la version du processus pour que le code se déclenche sur la modification du champ “Commentaires” présent dans le formulaire d’annulation que l’on souhaite ajouter à l’historique (il faudra que le champ texte, ici “CommentairesDAnnulation”, ne soit présent que dans le formulaire d’annulation) :

<script event="onChange" for="CommentairesDAnnulation">
<![CDATA[
            // code précédent
]]>
</script>

Commenter du code

Pour débuguer ou documenter.

  • Dans le XML (à l’extérieur de la balise <script>) : <!--Mon texte commenté-->
  • Dans le JavaScript (à l’intérieur de la balise <script>) :
    • Commenter une ligne : // Mon texte commenté
    • Commenter un bloc : /* Mon bloc commenté */

Source : https://wiki.myvdoc.net/xwiki/bin/view/Dev+Floor/RefScriptsInformer