Manuel des Scripts Automation Engine > Organisation fonctionnelle > Séquences de données > PREP_PROCESS_COMMENTS

PREP_PROCESS_COMMENTS

Fonction de script : Utilise les paramètres de filtre pour récupérer l'horodatage, l'utilisateur et le texte des commentaires des tâches et met le résultat à disposition sous la forme d'une liste interne (séquence de données) pour un traitement ultérieur.

Syntaxe

PREP_PROCESS_COMMENTS([RunID], [Text], [User])

Syntaxe

Description / format

RunID

Numéro d'exécution (RunID) de la tâche dont les commentaires doivent être lus.
Format : littéral de script, variable de script ou nombre

Si vous n'indiquez aucun RunID, les commentaires de la tâche qui exécute l'instruction de script sont lus.

Texte

Filtre permettant de rechercher une expression dans le texte des commentaires
Format : littéral de script ou variable de script
200 caractères maximum
Valeur par défaut : "*"

Les caractères génériques "*" et "?" sont autorisés. "*" signifie n'importe quelle chaîne de caractères et "?" exactement un caractère.

Utilisateur

Filtre permettant de rechercher le nom d'un objet utilisateur
Format : littéral de script ou variable de script
200 caractères maximum
Valeur par défaut : "*"

Les caractères génériques "*" et "?" sont autorisés. "*" signifie n'importe quelle chaîne de caractères et "?" exactement un caractère.

Même si vous ne souhaitez appliquer un Filtre que sur le nom d'utilisateur, vous devez conserver la première virgule.

:SET &HND# = PREP_PROCESS_COMMENTS(,,"SMITH/AE")


Code retour

Référence sur la séquence de données des commentaires.

Commentaires

Cette fonction de script lit les commentaires d'une tâche. Vous pouvez limiter les résultats à l'aide des paramètres Texte et Utilisateur.

Le filtrage tient compte de la casse des données entrées.

Attention : indiquer une chaîne vide "" pour le filtrage équivaut à entrer "*" : toutes les valeurs sont alors renvoyées.

Le code retour de cette fonction de script est la référence d'une séquence de données qui est attribuée aux instructions de script :PROCESS et :ENDPROCESS en tant que paramètre de démarrage. Grâce à l'utilisation de la fonction de script GET_PROCESS_LINE , vous accédez à tous les commentaires de la tâche.

Si le commentaire ne contient pas les valeurs recherchées, aucun message d'erreur n'apparaît. Le traitement de la séquence de données, défini entre :PROCESS et :ENDPROCESS, n'est tout simplement pas lancé.

Aucune nouvelle valeur ne peut être attribuée à la variable de script contenant la référence de la séquence de données. La séquence de données doit tout d'abord être supprimée avec l'instruction de script :CLOSE_PROCESS pour que la variable puisse être réutilisée.

Exemples

Les commentaires suivants sont fournis :

Le premier exemple prend en compte tous les commentaires et affiche l'utilisateur et le texte avec l'instruction :PRINT.

:SET &HND# = PREP_PROCESS_COMMENTS()

:
PROCESS &HND#
:   
SET &USER# = GET_PROCESS_LINE(&HND#,2)
:   
SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   
PRINT "&USER#:  &TEXT#"
:
ENDPROCESS

:
CLOSE_PROCESS &HND#

Dans le deuxième exemple, seules les entrées de Monsieur Dupont sont lues et indiquées avec un horodatage.

:SET &HND# = PREP_PROCESS_COMMENTS(,,"SMITH/AE")

:
PROCESS &HND#
:   
SET  &TIME# = GET_PROCESS_LINE(&HND#,1)
:   
SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   
PRINT "&TIME#:  &TEXT#"
:
ENDPROCESS

:
CLOSE_PROCESS &HND#

Dans le troisième exemple, la fonction de script a été appelée à partir d'une autre tâche. Le RunID correspondant est donc utilisé. Tous les commentaires qui contiennent le mot "fichier" sont renvoyés.

:SET &RunID = GET_UC_OBJECT_NR(MM.RETRIEVE.FILES)

:SET &HND# = PREP_PROCESS_COMMENTS(&RunID,"*file*")

:
PROCESS &HND#
:   
SET &TEXT# = GET_PROCESS_LINE(&HND#,3)
:   
PRINT "Comment: &TEXT#"
:
ENDPROCESS

:
CLOSE_PROCESS &HND#

 

Rubriques connexes :

Elément de script Description

:ADD_COMMENT

Ajoute un commentaire à une tâche.

:CLOSE_PROCESS

Supprime une séquence de données inutile.

:PROCESS... :TERM_PROCESS... :ENDPROCESS

Définissent une boucle pour le traitement par lignes d'une séquence de données, comme le contenu d'un fichier séquentiel ou le résultat de type texte d'une commande.

GET_PROCESS_LINE

Détermine le contenu actuel des lignes d'une séquence de données.

Eléments de script - Séquences de données

Généralités sur les scripts
Eléments de script - Liste alphabétique

Eléments de script - Répartition fonctionnelle