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

PREP_PROCESS_AGENTGROUP

Fonction de script : Utilise des critères de sélection pour récupérer les agents d'un objet groupe d'agents et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur.

Syntaxe

PREP_PROCESS_AGENTGROUP(AgentGroup, [Host], [Selection option], [RunID])

Syntaxe	Description / format
Groupe d'agents	Nom de l'objet groupe d'agents dont les agents doivent être lus. Format : Nom AE, littéral de script ou variable de script
Hôte	Filtre pour le nom d'Agent Format : littéral de script ou variable de script 32 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.
Option de sélection	Méthode à utiliser pour récupérer les agents du groupe d'agents. Format : Nom AE, littéral de script ou variable de script Valeurs autorisées : "BY_RULE" (valeur par défaut), "ALL" et "RUNNR" "BY_RULE" : la fonction de script renvoie l'agent sur lequel la prochaine tâche sera exécutée. "ALL" : tous les agents du groupe d'agents sont récupérés. "RUNNR" : le ou les agents récupérés dépendent d'une tâche particulière. Le RunID du conteneur du groupes d'agents doit être spécifié dans le paramètre de même nom. Avec les groupes d'agents définis en mode "Tous", les options BY_RULE et ALL renvoient les mêmes résultats.
RunID	Numéro d'exécution (RunID) du conteneur du groupe d'agents. Format littéral de script, variable de script ou nombre Si vous utilisez ce paramètre, le script renvoie les agents sur lesquels la tâche est exécutée. Vous ne devez préciser ce paramètre que si vous avez choisi l'option de sélection RUNNR.

Code retour
Référence à la séquence de données de l'objet groupe d'agents.

Commentaires

La fonction de script lit les agents d'un objet groupe d'agents. Ces agents peuvent être limités via des paramètres. La référence à l'ensemble de la séquence de données est fournie par défaut.

Le code retour de la fonction de script est la référence d'une séquence de données. Elle est transmise aux instructions de script :PROCESS et :ENDPROCESS en tant que paramètre de démarrage. Grâce à l'utilisation conjointe de la fonction de script GET_PROCESS_LINE, vous accédez à toutes les lignes de la séquence de données. Celle-ci est divisée en deux colonnes que vous pouvez également lire de manière ciblée :

Nom de l'agent
Statut de l'agent ("Y" : l'agent est actif, "N" : l'agent est inactif)

Le statut est surtout important pour les groupes d'agents définis en mode "Tous". Pour ces groupes d'agents, la fonction de script renvoie toujours tous les agents sans vérifier s'ils sont actifs ou non. Les informations de statut peuvent être utilisées pour récupérer les agents sur lesquels des tâches peuvent réellement être exécutées.

Même si vous ne souhaitez appliquer un filtre que sur la sélection et/ou sur le RunID, vous devez conserver les virgules précédentes.

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.

Exemple

Le script du premier exemple détermine tous les agents d'un groupe d'agents dont le nom commence par "WIN".

:SET &HND# = PREP_PROCESS_AGENTGROUP("AGENTGROUP_WINDOWS","WIN*",ALL)

:PROCESS &HND#
:   SET &AGENT# = GET_PROCESS_LINE(&HND#,1)
:   SET &STATUS# = GET_PROCESS_LINE(&HND#,2)
:   PRINT "Agent: &AGENT#"
:   PRINT "Status: &STATUS#"
:ENDPROCESS

:CLOSE_PROCESS &HND#

Dans l'exemple suivant, une tâche est reprise. La fonction de script SYS_ACT_ME_NR renvoie le RunID de l'exécution initiale qui peut être utilisé pour récupérer RunID du conteneur de groupes d'agents. Les agents sur lesquels la tâche a été exécutée à l'origine peuvent ainsi être récupérés.

:SET &T_RUNNR# = SYS_ACT_ME_NR()
:SET &P_RUNNR# = GET_PARENT_NR(&T_RUNNR#)
:SET &HND# = PREP_PROCESS_AGENTGROUP("AGENTGROUP_DB",,RUNNR,&P_RUNNR#)

:PROCESS &HND#
:   SET &AGENT# = GET_PROCESS_LINE(&HND#,1)
:   SET &STATUS# = GET_PROCESS_LINE(&HND#,2)
:   PRINT "Agent: &AGENT#"
:   PRINT "Status: &STATUS#"
:ENDPROCESS

:CLOSE_PROCESS &HND#

Rubriques connexes :

Elément de script	Description
: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