Liste alphabétique des instructions de scripts et fonctions
Cette rubrique dresse une liste alphabétique de tous les éléments de Langage de script Automation Engine en décrivant brièvement leurs fonctions.
[Instructions de script] [Fonctions de scripts]
Instruction de script |
Description |
---|---|
Ajoute des destinataires à une notification pendant l'exécution. |
|
Ajoute un commentaire à une tâche. |
|
Attribue un objet Sync à une tâche. |
|
:ATTACH_RES | Ressources des transferts d'un objet Stockage vers l'agent Windows ou Unix. |
Début et fin d'un dialogue destiné aux questions posées à l'utilisateur. |
|
:BEGIN_EXT_INTERPRETERS... :END_EXT_INTERPRETERS | Marque le début et la fin d'un script d'interpréteur externe dans l'onglet Traitement des objets Job Windows et UNIX. Utilisé en combinaison avec l'objet Stockage. |
:CLEAR | Réinitialise un tableau de script avec ses valeurs initiales. |
Supprime une séquence de données dans un script. |
|
:CONST | Crée une variable de script comme constante avec une valeur définie. |
:DATA |
Déclaration explicite d'une ligne DATA dans un script. |
:DEFINE | Déclare une variable de script avec un type spécifique de données. |
Supprime une ou toutes les valeurs d'un objet variable. |
|
Déconnecte une connexion au système AE. |
|
Instruction permettant de terminer le traitement du script avec un code retour. |
|
Désactive la journalisation du script d'une tâche. |
|
Active la journalisation du script d'une tâche. |
|
:FILL | Enregistre plusieurs valeurs dans un tableau de script. |
Contrôle le traitement des lignes de script pendant l'exécution. |
|
Ramification sous certaines conditions |
|
:INCLUDE | Intègre un objet Include dans le script actuel. |
:INC_SCRIPT | Intègre un script dans un autre script du même objet. |
:IFVERS [:ELSEVERS] :ENDVERS | Les instructions du précompilateur pour le saut de blocs de script dépendent de la version Automation Engine installée. |
:JCL_CONCAT_CHAR | Création de lignes JCL jusqu'à une taille maximale de 2 Ko. |
:JCL_SUBSTITUTE | Remplace un jeu de caractères du JCL par un autre jeu de caractères. |
:MODIFY_STATE | Modifie le code retour ou le texte du statut d'un job une fois ce dernier terminé. |
Détermine la réaction à certaines erreurs ou messages d'éléments de script. |
|
Écrit le texte dans une boîte de dialogue destinée aux questions posées à l'utilisateur ou dans le rapport d'activation d'un objet. |
|
: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. |
Attribue une valeur à une variable d'objet. |
|
:PUBLISH | Définit les variables de script et les tableaux comme variables d'objet. |
Modifie la valeur d'un attribut pendant la génération. |
|
:PUT_ATT_APPEND | Étend le texte du message de l'objet Notification à l'exécution. |
:PUT_PROMPT_BUFFER | Enregistre le nom et le contenu d'une variable de script dans un cache. |
:PUT_READ_BUFFER | Enregistre le nom et le contenu d'une variable de script dans un cache. |
:PUT_VAR | Enregistre une valeur dans un objet Variable. |
:PUT_VAR_COL | Enregistre une valeur dans une colonne déterminée d'un objet variable statique. |
:PUT_VAR_PROCESS | Ecrit le contenu d'une séquence de données dans un objet variable statique. |
:LIRE | Lit les données saisies par l'utilisateur dans la boîte de dialogue. |
:REGISTER_VARIABLE | Disponible sous Windows et UNIX, utilisé dans l'onglet Traitement d'un objet Job (JOBS) dans :BEGIN_EXT_INTERPRETER... :END_EXT_INTERPRETER ou un appel d'interpréteur de script externe. |
:REGISTER_OUTPUTFILE | Enregistre un fichier comme sortie externe du job |
Supprime des destinataires d'un objet notification pendant l'exécution. |
|
Remplace la structure d'un Workflow lors de son activation par la structure d'un autre Workflow. |
|
:RESOLVE | Tente de résoudre toutes les variables de la chaîne de caractères. |
Définit des points de reprise dans un objet. |
|
:RSET | Attribue une valeur à une variable de script et l'enregistre dans le rapport d'activation. |
:SEND_MSG | Envoie des messages à l'utilisateur de Interface Web Automic. |
:SEND_SNMP_TRAP | Envoie une trap SNMP. |
:SET | Attribue une valeur à une variable de script. |
:SET_CALE | Insère / supprime une date ou une période dans un calendrier. |
:SET_CONDITION | Définit l'heure de début au plus tôt dans les Workflows. |
:SET_LAST_ERR | Définit le numéro et le texte de l'erreur. |
:SET_SCRIPT_VAR | Définit les valeurs des variables de script par accès indirect. |
:SET_UC_SETTING | Modifie les paramètres système au cours de l'exécution. |
Arrête un système AE. |
|
:STOP |
Interrompt le traitement d'un script. |
:SWITCH... :CASE... :ENDSWITCH | Vérifie si la valeur d'une variable correspond à certaines valeurs et exécute différentes actions en fonction du résultat. |
:TERMINATE | Arrête un agent, un processus de travail ou de communication. |
:WAIT | Arrête le traitement du script pendant un certain temps. |
Boucle d'exécution répétée des instructions de script. |
|
Ferme un document XML |
[Instructions de script] [Fonctions de script]
Fonction de script |
Description |
Variable prédéfinie |
---|---|---|
Active un objet. |
||
Ajoute. |
||
Ajoute des jours à une date donnée. |
||
Ajoute une période à une date indiquée |
||
Ajoute une heure à une autre |
||
Additionne une durée à partir d'un horodatage. |
||
Convertit le nom d'un job ou d'un fichier de rapport en RunID. |
||
ARRAY_2_STRING | Convertit un tableau de script en une chaîne de caractères. | |
Calcule les données de simulation pour des activités futures. |
||
Renvoie la date suivante en fonction des conditions de calendrier. |
||
Interrompt l'exécution d'un objet activé. |
||
Déclenche un changement de fichier log. |
||
Convertit le format d'une date. |
||
Convertit tous les caractères d'une chaîne en minuscules. |
||
Convertit la date et l'heure dans un autre fuseau horaire. |
||
Convertit tous les caractères d'une chaîne en majuscules. |
||
CONVERT | Convertit le type de données d'une valeur. | |
Crée un objet (uniquement calendrier, Login et variable). |
||
CREATE_PROCESS | Crée une nouvelle séquence de données. | |
Retourne le jour actuel de l'année. |
||
DEACTIVATE_UC_OBJECT | Désactive une tâche terminée. | |
DELETE_FORECAST | Supprime un nombre quelconque ou les simulations données de la base de données Automation Engine. | |
DIFF_DATE | Détermine le nombre de jours entre deux dates. | |
DIFF_TIME | Retourne la différence entre deux heures. | |
DIV | Divise. | |
Exporte les objets dans un fichier XML. |
||
FIND | Recherche un tableau de script et retourne l'index correspondant. | |
Détermine le premier jour de la période pour une date donnée. |
||
Crée une simulation d'objet donné. |
||
Crée une simulation de tâche en cours d'exécution. |
||
Modifie le formatage d'un nombre. |
||
GENERATE_SCRIPT_VARS | Génère une variable de script via un objet VARA ou une séquence de données à la volée. | |
GET_ATT | Renvoie les valeurs d'attributs d'un objet pendant sa génération. | |
GET_ATT_SUBSTR |
Fournit une partie du texte du message de la notification. |
|
GET_BIT | Vérifie qu'un bit particulier est défini dans un champ de bit | |
GET_CONDITION | Détermine l'heure de début au plus tôt des Workflows. | |
GET_CONNECTION | Lit les informations d'un objet connexion BD. | |
GET_CONSOLE | Lit les données du message de l'événement de console survenu. | |
Lit les données d'événements valeurs des événements Console, Système de fichiers ou Base de données s'étant produits. |
||
Extrait plusieurs valeurs du système de fichiers à partir d'un chemin d'ordinateur défini. |
||
GET_MSG_TXT | Récupère le texte du message de la dernière erreur survenue. | |
Récupère le type d'un numéro de message. |
||
GET_LOGIN | Lit les informations d'un objet Login. | |
Renvoie le type d'objet de la tâche. |
||
GET_OH_IDNR | Fournit le numéro interne d'un objet. | |
Renvoie le nom de la tâche supérieure (parent). |
||
GET_PARENT_NR | Renvoie le numéro d'exécution de la tâche supérieure (parent). | |
GET_PARENT_TYPE | Renvoie le type d'objet de la tâche supérieure (parent). | |
GET_PROCESS_INFO | Récupère les informations d'une séquence de données | |
GET_PROCESS_LINE | Retourne le contenu actuel des lignes d'une séquence de données. | |
GET_PUBLISHED_VALUE | Récupère la valeur ou la variable de PromptSet d'une tâche donnée. | |
GET_SCRIPT_VAR | Retourne les valeurs des variables de script par accès indirect. | |
Extrait les informations de l'enregistrement statistique d'un objet exécutable. |
||
Demande le statut ou la valeur actuelle d'un objet Sync. |
||
GET_UC_OBJECT_NR | Indique le numéro d'exécution (RunID) d'un objet activé. | |
GET_UC_OBJECT_STATUS | Retourne le statut d'un objet activé | |
GET_UC_SERVER_NAME | Détermine le nom du processus de travail dans lequel le script est exécuté. | |
GET_UC_SETTING | Lit les paramètres système courants. | |
GET_UC_SYSTEM_NAME | Détermine le nom du système AE. | &$SYSTEM# |
GET_VAR |
Renvoie la valeur d'un objet variable. |
|
GET_WIN_EVENT | Détermine les entrées dans les journaux système, de sécurité et d'application Windows lorsqu'un événement se produit. | |
HEX | Convertit un jeu de caractères au format hexadécimal. | |
ILM | Contrôle la fonctionnalité ILM. | |
Importe des objets d'un fichier XML. |
||
Vérifie l'appartenance d'un utilisateur à un groupe d'utilisateurs. |
||
Vérifie si un jeu de caractères est numérique. |
||
LAST_OF_PERIOD | Détermine le dernier jour de la période pour une date donnée. | |
LENGTH | Récupère la taille d'un tableau de script. | |
LOAD_PROCESS | Charge une séquence de données enregistrée. | |
MID | Copie les caractères d'une chaîne de caractères. | |
MOD | Indique le reste d'une division. | |
Modifie un objet existant (uniquement calendrier, Login et variable). |
||
MODIFY_SYSTEM | Traite les actions de ServiceManager ou les modifications de queue. | |
MODIFY_TASK | Modifie les workflows en cours. | |
Modifie l'attribut d'un objet activé. |
||
Déplace un objet dans un dossier. |
||
Multiplie. |
||
Cette fonction de script exécute à l'aide d'objets Job spécifiques (jobs d'événement) des commandes de processus sur un ordinateur et renvoie la sortie de console sous forme de liste interne (séquence de données) qui peut être utilisée pour des traitements ultérieurs. |
||
PREP_PROCESS_AGENTGROUP | Utilise des critères de sélection pour récupérer les agents d'un objet groupe d'agents et fournit le résultat comme liste interne (séquence de données) pour un traitement ultérieur. | |
Utilise les paramètres de filtre pour récupérer l'horodatage, l'utilisateur et le texte des commentaires des tâches et fournit le résultat sous la forme d'une liste interne (séquence de données) pour un traitement ultérieur. |
||
PREP_PROCESS_DOCU | Met à disposition le contenu d'un onglet de documentation comme liste interne (séquence de données) pour un traitement ultérieur. | |
Utilise des critères de filtre pour récupérer ligne par ligne le contenu d'un fichier texte qui se trouve sur un ordinateur donné. Met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur. |
||
PREP_PROCESS_FILENAME | Extrait une liste de noms de fichiers disponibles dans un répertoire spécifié de l'ordinateur. Met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur. | |
PREP_PROCESS_PROMPTSET | Lit la définition des objets PromptSet et la met à disposition comme liste interne (séquence de données) pour un traitement ultérieur. | |
Récupère les lignes de rapport des objets activables à l'aide de critères de filtrage et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur. |
||
PREP_PROCESS_REPORTLIST | Extrait la liste de la sortie enregistrée en attente des jobs déjà exécutés et donne le résultat sous forme de liste interne (séquence de données) pour un traitement ultérieur. | |
PREP_PROCESS_VAR et PREP_PROCESS_VAR_XML | Récupère une liste de valeurs d'un objet variable à l'aide de critères de sélection et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur. | |
PUT_PROCESS_LINE | Ajoute une ligne à une séquence de données déterminée | |
RANDOM | Génère des nombres aléatoires. | |
Supprime un objet existant. |
||
RERUN_UC_OBJECT | Continue un certain Workflow. | |
RESOLVE_VAR | Résout tout type de variable (valeurs de prompt, variables de système, variables de script, objets de variable) dans le texte. | |
Répète l'exécution d'une tâche. |
||
ROLLBACK_UC_OBJECT | Exécute le rollback d'une tâche déterminée | |
Convertit le RunID en noms de fichier correspondants. |
||
SAVE_PROCESS | Enregistre une séquence de données spécifique. | |
Envoie un e-mail à un utilisateur. |
||
SET_SYNC | Exécute l'action définie d'un objet Sync. | |
STR_CAT | Combine deux chaînes de caractères en une troisième. | |
STR_CUT | Copie les caractères d'une chaîne de caractères. | |
STR_ENDS_WITH | Vérifie si une chaîne de caractères se termine par une autre chaîne de caractères spécifique. | |
STR_FIND | Recherche un caractère ou une chaîne de caractères dans une chaîne de caractères. | |
STR_FIND_REVERSE | Recherche un caractère ou une chaîne de caractères dans une chaîne de caractères. La recherche commence à la fin de la chaîne de caractères à rechercher. | |
STR_ISLOWER | Vérifie si les caractères d'une chaîne de caractères sont écrits en lettres minuscules. | |
STR_ISUPPER | Vérifie si les caractères d'une chaîne de caractères sont écrits en lettres majuscules. | |
STR_LC | Convertit tous les caractères d'une chaîne en minuscules. | |
STR_LENGTH | Renvoie la longueur d'une chaîne de caractères. | |
STR_LNG | Renvoie la longueur d'une chaîne de caractères. | |
STR_LTRIM | Supprime les espaces vides au début d'un jeu de caractères. | |
STR_PAD | Étend une chaîne de caractères à une longueur définie. | |
STR_MATCH | Compare deux jeux de caractères. | |
STR_REVERSE | Inverse l'ordre des caractères d'une chaîne. | |
STR_RTRIM | Supprime les espaces vides à la fin d'un jeu de caractères. | |
STR_SPLIT | Divise une chaîne de caractères en plusieurs parties à l'aide d'un séparateur. | |
STR_STARTS_WITH | Vérifie si une chaîne de caractères commence par une autre chaîne de caractères spécifique. | |
STR_SUBSTITUTE | Remplace un caractère ou une chaîne de caractères dans une chaîne de caractères. | |
STR_SUBSTITUTE_VAR | Remplace les noms de variables de script par leurs valeurs. | |
Supprime les espaces vides au début et à la fin d'un jeu de caractères. |
||
STR_UC | Convertit tous les caractères d'une chaîne en majuscules. | |
SUB | Soustrait. | |
SUB_DAYS | Soustrait des jours à une date indiquée. | |
SUB_PERIOD | Soustrait une période d'une date donnée. | |
SUB_TIME | Soustrait deux heures. | |
Soustrait une durée d'un horodatage. |
||
Copie les caractères d'une chaîne de caractères. |
||
SYS_ACT_CLIENT | Renvoie le numéro du client actuel. | &$CLIENT# |
SYS_ACT_CLIENT_TEXT | Renvoie le texte du client actuel. | &$CLIENT_DESC# |
SYS_ACT_HOST | Retourne le nom de l'hôte. | |
Détermine si une tâche a été activée dans un Workflow. |
&$IN_PROCESSFLOW# | |
SYS_ACT_ME_LNR | Renvoie le numéro d'emplacement d'une tâche dans un workflow | |
SYS_ACT_ME_NAME | Retourne le nom de l'objet concerné. | &$NAME# |
SYS_ACT_ME_NR | Retourne le numéro d'exécution (RunID) de l'objet considéré. | &$RUNID# |
SYS_ACT_ME_TYPE | Renvoie le type de l'objet considéré | &$OBJECT_TYPE# |
Fournit le nom de la tâche supérieure. |
&$ACTIVATOR# &$PROCESSOR# |
|
SYS_ACT_PARENT_NR | Renvoie le numéro d'exécution (RunID) de tâche supérieure. | &$ACTIVATOR_RUNID# &$PROCESSOR_RUNID# |
SYS_ACT_PARENT_TYPE | Renvoie le type d'objet de la tâche supérieure. | &$ACTIVATOR_TYPE# &$PROCESSOR_TYPE# |
SYS_ACT_PREV_NAME | Retourne le nom de la tâche précédente dans un Workflow. | |
SYS_ACT_PREV_NR | retourne le numéro d'exécution (RunID) de la tâche précédente dans un Workflow. | |
SYS_ACT_PTTYP | Renvoie le type de partenaire de l'utilisateur | &$PARTNER_TYPE# |
SYS_ACT_RESTART | Indique si l'objet a été activé en mode reprise. | &$RESTARTED# |
SYS_ACT_RESTART_COUNT | Donne le nombre de redémarrages exécutés pour les tâches de workflows via l'instruction de script RESTART TASK (Postconditions). | &$RESTART_COUNT# |
SYS_ACT_RESTART_ME_NR | Retourne le numéro d'exécution (RunID) de l'objet activé en mode de reprise. | &$RESTART_RUNID# |
SYS_ACT_TOP_NAME | Nom du workflow de plus haut niveau. | &$TOP_PROCESSFLOW_NAME# |
SYS_ACT_TOP_NR | Détermine le numéro d'exécution (RunID) du Workflow de plus haut niveau. | &$TOP_PROCESSFLOW_RUNID# |
SYS_ACT_USERID | Fournit l'ID utilisateur sous lequel le job sera exécuté. | |
SYS_ACTIVE_COUNT | Renvoie le nombre de tous les objets activés | |
SYS_BUSY_01 | Renvoie la taille de la charge utile de Automation Engine pendant la dernière minute (en pourcentage). | |
SYS_BUSY_10 | Renvoie la taille de la charge utile de Automation Engine pendant les 10 dernières minutes (en pourcentage). | |
SYS_BUSY_60 | Renvoie la taille de la charge utile de Automation Engine pendant la dernière heure (en pourcentage). | |
SYS_DATE | Renvoie la date courante au début du traitement du script | &$DATE_format# |
SYS_DATE_PHYSICAL | Renvoie la date courante. | &$PHYS_DATE_format# |
SYS_HOST_ALIVE | Vérifie si un hôte particulier est actif. | |
Lit les informations relatives au système AE. |
||
SYS_LAST_ARRAY_INDEX | Renvoie le dernier index renseigné d'un tableau. | |
Fournit la partie variable du message d'erreur pour la dernière erreur survenue. |
||
SYS_LAST_ERR_NR | Renvoie le numéro de la dernière erreur survenue. | |
SYS_LAST_ERR_SYSTXT | Récupère le texte d'erreur du système d'exploitation pour la dernière erreur survenue. | |
SYS_LAST_REGISTERED_OFILE |
Renvoie le dernier fichier de sortie utilisé de la commande :REGISTER_OUTPUTFILE |
|
SYS_LAST_REGISTERED_ULOGIN | Renvoie le dernier login utilisé de la commande :REGISTER_OUTPUTFILE | |
SYS_LAST_REGISTERED_VALUENAME | Renvoie la dernière valeur de variable utilisée de la commande :REGISTER_VARIABLE | |
SYS_LAST_REGISTERED_VARNAME | Renvoie le dernier nom de variable utilisé de la commande :REGISTER_VARIABLE | |
SYS_LAST_RESTART_POINT | Fournit le nom du point de reprise précédent dans le script. | |
SYS_LAST_RESTART_TEXT | Fournit le texte du point de reprise précédent dans le script. | |
SYS_LDATE | Retourne la date logique. | &$LDATE_format# |
SYS_RESTART_POINT | Point de reprise à partir duquel l'objet doit être exécuté. | &$RESTART_POINT# |
Vérifie qu'un processus serveur particulier est actif |
||
Vérifie que la connexion SNMP (Simple Network Management Protocol) d'AE est active. |
&$SNMP_ACTIVE# | |
SYS_STATE_ACTIVE | Vérifie si un objet est déjà actif. | |
SYS_STATE_JOB_ACTIVE | Vérifie si un job a déjà été activé. | |
SYS_STATE_JOBS_IN_GROUP | Retourne le nombre de jobs enregistrés dans des groupes | |
SYS_STATE_JP_ACTIVE | Vérifie si un Workflow a déjà été activé. | |
SYS_TIME | Extrait l'heure du jour actuelle au début du traitement du script. | &$TIME_format# |
SYS_TIME_PHYSICAL | Détermine l'heure actuelle de la journée. | &$PHYS_TIME_format# |
Indique la date et l'heure courantes. |
||
Vérifie si un utilisateur est connecté à AE avec un Interface Web Automic. |
||
SYS_USER_DEP |
Fournit le département de l'utilisateur qui a démarré la tâche. |
&$DEPARTMENT# |
SYS_USER_LANGUAGE | Langage de génération des fichiers journaux dans le serveur. | &$SYS_LANGUAGE# |
SYS_USER_LNAME |
Prénom et nom de l'utilisateur ayant démarré la tâche. |
&$USER_FL# |
SYS_USER_NAME |
Nom de l'utilisateur ayant démarré la tâche. |
&$USER# |
TOGGLE_OBJECT_STATUS | Arrête ou démarre le traitement automatique de plusieurs types d'objets. | |
TOGGLE_SYSTEM_STATUS | Arrête ou démarre le traitement automatique d'un client. | |
UC_CRLF | Renvoie un saut de page. | |
VALID_CALE | Vérifie si une date est contenue dans l'événement de calendrier. | |
VALID_DATE | Vérifie si une date est valable. | |
VALID_TIME | Vérifie si l'heure est valide. | |
WEEK_NR | Renvoie la semaine calendaire d'une date donnée. | |
WEEKDAY_NR | Retourne le jour de la semaine d'une date dans un nombre. | |
WEEKDAY_XX | Retourne le jour de la semaine d'une date donnée sous la forme d'une abréviation. | |
WRITE_PROCESS | Écrit le contenu d'une séquence de données dans un fichier. | |
XML_APPEND_BEFORE | Déplace un élément XML devant un autre élément. | |
XML_APPEND_CHILD | Ajoute un nouveau sous-élément à un élément XML. | |
XML_APPEND_CLONE | Duplique un élément XML et l'attache à un autre élément. | |
XML_APPEND_ELEMENT | Joint un élément XML existant à un autre élément. | |
Améliore l'affichage de la structure d'un élément. |
||
XML_CLONE_AND_RENAME | Duplique et renomme un élément XML. | |
XML_DELETE_NODE | Supprime un élément XML spécifique. | |
XML_DOM_TO_PROCESS | Crée une séquence de données basée sur un document XML spécifié. | |
Fournit la valeur d'un attribut. |
||
Compte les sous-éléments d'un élément. |
||
Identifie le premier sous-élément d'un élément |
||
XML_GET_LAST_CHILD | Identifie le dernier sous-élément d'un élément. | |
Identifie l'élément suivant. |
||
Indique le nom d'un élément |
||
Indique le texte d'un élément |
||
XML_INSERT_BEFORE | Crée un nouvel élément XML et l'insère avant un autre élément. | |
Ouvre un document XML en vue du traitement |
||
Ecrit le document XML dans un fichier. |
||
XML_PROCESS_TO_DOM | Crée un document XML à partir d'une séquence de données. | |
XML_REMOVE_CHILDREN | Supprime tous les sous-éléments d'un élément XML. | |
Identifie un élément quelconque. |
||
XML_SET_ATTRIBUTE | Ajoute un nouvel attribut à un élément XML ou modifie un attribut existant. | |
XML_SET_NODE_TEXT | Modifie ou définit la valeur d'un élément XML. | |
XML_TO_STRING | Renvoie le XML d'un élément spécifique sous forme de texte. | |
Extrait l'année d'une date donnée. |