Manuel des Scripts Automation Engine > Organisation fonctionnelle > Aperçu du tableau

Scripts - Organisation fonctionnelle

La vue d'ensemble suivante présente le script AE organisé selon ses domaines de fonction.

Modification d'objets

[Modification d'objets] [Activation d'objets] [Lecture ou modification d'objets] [Elaboration et traitement des scripts] [Traitement des erreurs et messages] [Données d'activation] [Données Utilisateur] [Séquences de données] [Traitement d'Evènement] [Statuts et utilisation du système] [Date et heure] [Calcul] [Chaînes]

Elément de script	Description
:REGISTER_OUTPUTFILE	Enregistre un fichier comme résultat externe de Job
CREATE_OBJECT	Crée un objet (uniquement calendrier, Login et variable)
EXPORT	Exporte des objets dans un fichier XML
IMPORT	Importe des objets d'un fichier XML
MODIFY_OBJECT	Modifie un objet disponible (uniquement calendrier, Login et variable)
MOVE_OBJECT	Déplace un objet dans un dossier
REMOVE_OBJECT	Supprime un objet disponible

Activation d'objets

Elément de script	Description
:BEGINREAD... :ENDREAD	Débute et termine une boîte de dialogue destinée aux questions posées à l'Utilisateur
:PRINT	Affiche du texte dans une boîte de dialogue destinée aux questions posées à l'Utilisateur ou dans le protocole d'activation d'un objet
:PUT_READ_BUFFER	Enregistre le nom et le contenu d'une Variable de script dans un cache
:PUT_PROMPT_BUFFER	Enregistre le nom et le contenu d'une Variable de script dans un cache
:READ	Invite l'Utilisateur à saisir des données dans la boîte de dialogue
ACTIVATE_UC_OBJECT	Active un objet
AUTOFORECAST	Calcule les données de simulation pour des activités futures.
CANCEL_UC_OBJECT	Interrompt un objet activé
DEACTIVATE_UC_OBJECT	Désactive une tâche terminée.
FORECAST_OBJECT	Crée une simulation pour l'objet indiqué
FORECAST_TASK	Crée une simulation pour la Tâche courante
RERUN_UC_OBJECT	Poursuite d'un Workflow spécifique.
RESTART_UC_OBJECT	Répète l'exécution d'une Tâche
ROLLBACK_UC_OBJECT	Exécuter un rollback d'une tâche définie.
SYS_ACTIVE_COUNT	Détermine le nombre d'objets actifs
SYS_STATE_ACTIVE	Vérifie qu'un objet est déjà actif
SYS_STATE_JOB_ACTIVE	Vérifie qu'un Job est déjà actif
SYS_STATE_JOBS_IN_GROUP	Détermine le nombre de Jobs enregistrés en attente dans des Groupes
SYS_STATE_JP_ACTIVE	Vérifie si un Workflow est déjà actif
TOGGLE_OBJECT_STATUS	Arrête ou démarre le traitement automatique de certains types d'objet

Lecture ou modification d'objets

Elément de script	Description
:ADD_ATT	Ajoute des destinataires à un objet Alerte pendant l'exécution
:ADD_COMMENT	Ajoute un commentaire à une Tâche
:ATTACH_SYNC	Attribue un objet Sync à une Tâche
:DELETE_VAR	Supprime une ou toutes les valeurs d'un objet Variable statique
:MODIFY_STATE	Modifie le code retour ou le texte de statut d'un Job une fois ce dernier terminé
:PUT_ATT	Définit ou modifie des attributs d'objets
:PUT_ATT_APPEND	Etend le texte du message de l'Alerte pendant l'exécution
:PUT_VAR	Enregistre les valeurs dans un objet Variable statique
:PUT_VAR_COL	Enregistre une valeur dans une colonne spécifique d'un objet Variable statique
:REMOVE_ATT	Supprime des destinataires d'un objet Alerte pendant l'exécution
:REPLACE_STRUCTURE	Remplace la structure d'un Workflow lors de son activation par la structure d'un autre Workflow.
:SET_CALE	Attribue une date à une règle d'un calendrier
:SET_CONDITION	Définit l'heure de début au plus tôt dans les Workflows.
:XML_CLOSE	Ferme un document XML
GET_ATT	Indique la valeur des attributs d'un objet pendant la génération
GET_ATT_PLAIN	Indique la valeur des attributs d'une Tâche pendant la génération sans suppression des Variables.
GET_ATT_SUBSTR	Indique une partie du texte du message de l'Alerte
GET_CONDITION	Indique l'heure de début la plus ancienne des Workflows.
GET_CONNECTION	Lit les informations à partir d'un objet Connexion BD.
GET_LOGIN	Lit les informations à partir d'objets Login.
GET_OBJECT_TYPE	Indique le type d'objet de la Tâche
GET_OH_IDNR	Indique le numéro interne d'un objet.
GET_PUBLISHED_VALUE	Déterminer la valeur des Variables d'objet et PromptSet d'une tâche définie.
GET_STATISTIC_DETAIL	Détermine les détails à partir d'un enregistrement statistique d'un objet activable
GET_SYNC	Lit la valeur ou le statut actuel d'un objet Sync
GET_VAR	Indique la valeur d'un objet Variable.
MODIFY_TASK	Modifie les Workflows en cours
MODIFY_UC_OBJECT	Modifie l'attribut d'un objet activé
SET_SYNC	Exécute l'action définie d'un objet Sync
XML_BEAUTIFY	Prépare le style d'affichage de la structure d'un élément
XML_GET_ATTRIBUTE	Indique la valeur d'un attribut
XML_GET_CHILD_COUNT	Détermine le nombre de sous-éléments d'un élément
XML_GET_FIRST_CHILD	Détermine le premier sous-élément d'un élément
XML_GET_LAST_CHILD	Détermine le dernier sous-élément d'un élément
XML_GET_NEXTSIBLING	Détermine l'élément suivant
XML_GET_NODE_NAME	Indique le nom d'un élément
XML_GET_NODE_TEXT	Indique le texte d'un élément
XML_OPEN	Ouvre un document XML en vue du traitement
XML_PRINTINTOFILE	Affiche le document XML dans un fichier
XML_SELECT_NODE	Détermine un élément quelconque

Elaboration et traitement des scripts

Elément de script	Description
:CLEAR	Réinitialise un tableau de script à ses valeurs initiales.
:CONST	Crée une Variable de script comme constante avec une valeur définie.
:DATA	Déclaration explicite d'une ligne DATA dans le script
:DEFINE	Création d'une Variable de script avec un type spécifique de données.
:FILL	Enregistre plusieurs valeurs dans un Tableau de script.
:EXT_REPORT_OFF	Désactive la journalisation du script d'une Tâche
:EXT_REPORT_ON	Active la journalisation du script d'une Tâche
:GENERATE	Contrôle la gestion des lignes de script pendant le traitement d'un script
:IF... :ELSE... :ENDIF	Ramification en fonction de conditions
:INCLUDE	Associe un objet Include au script actuel
:INC_SCRIPT	Associe un script à un autre script du même objet
:JCL_CONCAT_CHAR	Forme des lignes JCL jusqu'à une taille maximale de 2 Ko
:JCL_SUBSTITUTE	Remplace une chaîne de caractères du JCL par une autre chaîne de caractères
:PSET	Attribue une valeur à une Variable d'objet.
:PUBLISH	Définir les Variables de script et les tableaux comme Variables d'objet.
:RESTART	Définit des points de redémarrage dans un objet
:RSET	Attribue une valeur à une Variable de script et l'enregistre dans le rapport d'activation
:SET	Attribue une valeur à des Variables de script
:SET_SCRIPT_VAR	Définit les valeurs des Variables de script par accès indirect
:SWITCH ... :CASE ... :ENDSWITCH	Vérifie si la valeur d'une Variable correspond à certaines valeurs et exécute différentes actions en fonction de cela.
:WAIT	Suspend le traitement du script pour une période donnée
:WHILE... :ENDWHILE	Boucle permettant de répéter l'exécution de parties du script
FIND	Recherche un Tableau de script et retourne l'Index correspondant.
GET_SCRIPT_VAR	Indique les valeurs des Variables de script par accès indirect
LENGTH	Détermine la longueur d'un Tableau de script.

Traitement des erreurs et messages

Elément de script	Description
:EXIT	Termine le traitement du script avec un code retour
:ON_ERROR	Définit des réactions associées à certaines erreurs ou certains messages de script
:SEND_MSG	Envoie des messages aux Utilisateurs de l'Interface Utilisateur
:SEND_SNMP_TRAP	Envoie une interruption SNMP
:SET_LAST_ERR	Définit le numéro et le texte de l'erreur
:STOP	Interrompt l'activation d'un objet et affiche éventuellement un message d'erreur
GET_MSG_TXT	Détermine le texte du message de la dernière erreur survenue
GET_MSG_TYPE	Indique le type d'un numéro de message.
SEND_MAIL	Envoie des e-mails à un Utilisateur
SYS_LAST_ERR_INS	Indique la partie Variable du message de la dernière erreur survenue
SYS_LAST_ERR_NR	Renvoie le numéro de la dernière erreur survenue
SYS_LAST_ERR_SYSTXT	Détermine le texte d'erreur du système d'exploitation pour la dernière erreur survenue

Données d'activation

Elément de script	Description	Variable prédéfinie
GET_PARENT_NAME	Renvoie le nom de la Tâche supérieure (parent)
GET_PARENT_NR	Renvoie le numéro courant (RunID) de la Tâche supérieure (parent)
GET_PARENT_TYPE	Renvoie le type d'objet de la Tâche supérieure (parent)
GET_UC_OBJECT_NR	Indique le RunID d'un objet activé
GET_UC_OBJECT_STATUS	Indique le statut d'un objet activé
SYS_ACT_HOST	Détermine le nom de l'hôte
SYS_ACT_JP	Détermine si une tâche a été activée dans un Workflow.	&$IN_PROCESSFLOW#
SYS_ACT_ME_NAME	Indique le nom de l'objet considéré	&$NAME#
SYS_ACT_ME_NR	Indique le numéro courant (RunID) de l'objet considéré	&$RUNID#
SYS_ACT_ME_TYPE	Indique le type de l'objet considéré	&$OBJECT_TYPE#
SYS_ACT_PARENT_NAME	Indique le nom de la Tâche supérieure	&$ACTIVATOR# &$PROCESSOR#
SYS_ACT_PARENT_NR	Indique le numéro courant (RunID) de la Tâche supérieure	&$ACTIVATOR_RUNID# &$PROCESSOR_RUNID#
SYS_ACT_PARENT_TYPE	Indique le type d'objet de la Tâche supérieure	&$ACTIVATOR_RUNID# &$PROCESSOR_RUNID#
SYS_ACT_PREV_NAME	Indique le nom de la Tâche précédente dans un Workflow
SYS_ACT_PREV_NR	Indique le numéro courant (RunID) de la Tâche précédente dans un Workflow
SYS_ACT_PTTYP	Indique le type de partenaire de l'Utilisateur	&$PARTNER_TYPE#
SYS_ACT_RESTART	Détermine si l'objet a été activé en mode reprise	&$RESTARTED#
SYS_ACT_RESTART_COUNT	Indique le nombre de redémarrages de Tâches de Workflow qui sont exécutées par l'instruction RESTART TASK (Postconditions)	&$RESTART_COUNT#
SYS_ACT_RESTART_ME_NR	Indique le numéro courant (RunID) de l'objet activé en mode de reprise	&$RESTART_RUNID#
SYS_ACT_TOP_NAME	Indique le 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	Indique l'ID Utilisateur sous lequel le Job est exécuté
SYS_LAST_RESTART_POINT	Indique la désignation du point de reprise précédent dans le script
SYS_LAST_RESTART_TEXT	Indique le texte du point de reprise précédent dans le script
SYS_RESTART_POINT	Indique le point de reprise utilisé pour l'exécution de l'objet	&$RESTART_POINT#

Données Utilisateur

Elément de script	Description	Variable prédéfinie
IS_GROUP_MEMBER	Vérifie l'appartenance d'un Utilisateur à un Groupe Utilisateur
SYS_ACT_CLIENT	Indique le numéro du Client actuel	&$CLIENT#
SYS_ACT_CLIENT_TEXT	Indique le texte du Client actuel	&$CLIENT_DESC#
SYS_USER_ALIVE	Vérifie que l'Utilisateur est connecté à UC4 via une Interface Utilisateur
SYS_USER_DEP	Indique le département de l'Utilisateur qui a démarré la Tâche	&$DEPARTMENT#
SYS_USER_LNAME	Indique le nom et le prénom de l'Utilisateur qui a démarré la Tâche	&$USER_FL#
SYS_USER_NAME	Indique le nom de l'Utilisateur qui a démarré la Tâche	&$USER#

Séquences de données

Elément de script	Description
:CLOSE_PROCESS	Supprime une séquence de données au sein d'un script
:PROCESS... :TERM_PROCESS... :ENDPROCESS	Boucle pour le traitement par lignes d'une séquence de données, par exemple pour les fichiers séquentiels ou les résultats de commande
CREATE_PROCESS	Crée une nouvelle séquence de données.
GET_PROCESS_INFO	Déterminer des informations d'une séquence de données.
GET_PROCESS_LINE	Détermine le contenu actuel des lignes d'une séquence de données
LOAD_PROCESS	Charge une séquence de données enregistrée.
PREP_PROCESS	Exécute avec l'aide d'objets Job spécifiques (Jobs d'Evènement) des commandes sur un ordinateur et fournit la sortie de console comme liste interne (séquence de données) qui peut être utilisée pour des traitements ultérieurs.
PREP_PROCESS_AGENTGROUP	Détermine les Agents d'un objet Groupe Agent grâce à des critères de sélection et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur.
PREP_PROCESS_COMMENTS	Détermine les paramètres de Filtre de l'Marque horaire, de l'Utilisateur et du Texte des commentaires de Tâches et met le résultat à disposition comme 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.
PREP_PROCESS_FILE	Détermine grâce aux critères de filtrage par ligne le contenu d'un fichier texte qui se trouve sur un ordinateur indiqué et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur.
PREP_PROCESS_FILENAME	Détermine une liste avec le nom des fichiers qui se trouvent sur l'ordinateur indiqué et met cette dernière à 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.
PREP_PROCESS_REPORT	Détermine 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	Détermine la liste de sorties enregistrées des Jobs déjà effectués et met le résultat à disposition comme liste interne (séquence de données) pour un traitement ultérieur.
PREP_PROCESS_VAR	Détermine 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 spécifique.
SAVE_PROCESS	Enregistre une séquence de données spécifique.
WRITE_PROCESS	Ecrit le contenu d'une séquence de données dans un fichier.

Traitement d'Evènement

Elément de script	Description
GET_CONSOLE	Lit les données de message de l'Evènement de console survenu
GET_EVENT_INFO	Lit des données des Evènements de console, de fichier ou de base de données survenus
GET_FILESYSTEM	Détermine les différentes valeurs de système de fichiers à partir d'une machine à l'emplacement correspondant au chemin indiqué.
GET_WIN_EVENT	Détermine des entrées dans le protocole système, de sécurité et d'application de Windows NT, 2000 ou XP lorsqu'un Evènement se produit

Statuts et utilisation du système

Elément de script	Description	Variable prédéfinie
:DISCONNECT	Déconnecte du système AE
:SET_UC_SETTING	Modifie les paramètres système au cours de l'exécution
:SHUTDOWN	Ferme un système AE
:TERMINATE	Met fin à un Agent, un processus de travail ou de communication
CHANGE_LOGGING	Changement du fichier log.
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 actuels
GET_UC_SYSTEM_NAME	Détermine le nom du système AE	&$SYSTEM#
ILM	Contrôle la fonctionnalité ILM
MODIFY_SYSTEM	Exécute des actions ServiceManager ou des modifications de Queue.
SYS_BUSY_01	Indique l'utilisation en pourcentage d'Automation Engine pendant la dernière minute.
SYS_BUSY_10	Indique l'utilisation en pourcentage d'Automation Engine pendant les 10 dernières minutes.
SYS_BUSY_60	Indique l'utilisation en pourcentage d'Automation Engine pendant la dernière heure.
SYS_HOST_ALIVE	Vérifie qu'un hôte particulier est actif
SYS_INFO	Lit des informations sur l'ensemble du système AE
SYS_SERVER_ALIVE	Vérifie qu'un processus Serveur particulier est actif
SYS_SNMP_ACTIVE	Vérifie que la connexion SNMP (Simple Network Management Protocol) de l'Automation Engine est active	&$SNMP_ACTIVE#
SYS_USER_LANGUAGE	Indique la langue dans laquelle le Serveur produit les fichiers log	&$SYS_LANGUAGE#
TOGGLE_SYSTEM_STATUS	Arrête ou démarre le traitement automatique de l'intégralité d'un Client

Date et heure

Elément de script	Description	Variable prédéfinie
ADD_DAYS	Ajoute des jours à une date indiquée
ADD_PERIOD	Ajoute une période à une date indiquée
ADD_TIME	Ajoute une heure à une autre
ADD_TIMESTAMP	Ajoute l'heure à une marque horaire
CALE_LOOK_AHEAD	Détermine la date suivante en fonction des conditions calendaires.
CONV_DATE	Change le format d'une date
CONV_TIMESTAMP	Convertit la date et l'heure dans un autre Fuseau horaire
DAY_OF_YEAR	Indique le jour actuel de l'année
DIFF_DATE	Détermine la différence (en jours) entre deux dates
DIFF_TIME	Détermine la différence entre deux heures
FIRST_OF_PERIOD	Détermine le premier jour de la période pour la date indiquée
LAST_OF_PERIOD	Détermine le dernier jour de la période pour la date indiquée
SUB_DAYS	Soustrait des jours à une date indiquée
SUB_PERIOD	Soustrait une période à une date indiquée
SUB_TIME	Soustrait une heure à une autre
SUB_TIMESTAMP	Soustrait une heure d'une marque horaire
SYS_DATE	Détermine la date du jour actuelle en vue du lancement du traitement de script	&$DATE_format#
SYS_DATE_PHYSICAL	Détermine la date du jour actuelle	&$PHYS_DATE_format#
SYS_LDATE	Détermine la date logique	&$LDATE_format#
SYS_TIME	Détermine l'heure du jour actuelle en vue du lancement du traitement de script	&$TIME_format#
SYS_TIME_PHYSICAL	Détermine l'heure du jour actuelle	&$PHYS_TIME_format#
SYS_TIMESTAMP_PHYSICAL	Indique la date et l'heure actuelles
VALID_CALE	Vérifie qu'une date est contenue dans un Calendrier
VALID_DATE	Vérifie qu'une date est valide
VALID_TIME	Vérifier qu'une heure est valide
WEEK_NR	Indique la semaine calendaire à laquelle une date appartient
WEEKDAY_NR	Indique sous la forme d'un chiffre le jour de la semaine correspondant à la date
WEEKDAY_XX	Renvoie sous la forme d'une abréviation le jour de la semaine correspondant à la date
YEAR_9999	Extrait l'année d'une date donnée

Calcul

Elément de script	Description
ADD	Exécute une addition
DIV	Exécute une division
GET_BIT	Vérifie qu'un bit particulier est défini dans un champ de bit
MOD	Indique le reste d'une division
MULT	Exécute une multiplication
RANDOM	Génère des nombres aléatoires
SUB	Exécute une soustraction

Chaînes

Elément de script	Description
ALPHA2RUNNR	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.
CONV_LC ou STR_LC	Transforme toutes les majuscules d'une chaîne de caractères en minuscules
CONV_UC ou STR_UC	Transforme toutes les minuscules d'une chaîne de caractères en majuscules
CONVERT	Convertit le type de données d'une valeur
FORMAT	Modifie le formatage d'un nombre
HEX	Convertit une chaîne de caractères au format hexadécimal
ISNUMERIC	Vérifie qu'une chaîne de caractères est numérique
MID, STR_CUT ou SUBSTR	Copie les caractères d'une chaîne de caractères
RUNNR2ALPHA	Convertit un RunID en nom de fichier correspondant
STR_CAT	Lie deux chaînes de caractères à une troisième
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 lettres d'une chaîne de caractères spécifique sont en minuscules.
STR_ISUPPER	Vérifie si les lettres d'une chaîne de caractères spécifique sont en majuscules.
STR_LENGTH ou STR_LNG	Détermine la longueur d'une chaîne de caractères
STR_LTRIM	Supprime les espaces qui figurent au début d'une chaîne de caractères
STR_MATCH	Compare deux chaînes de caractères
STR_PAD	Elargir une chaîne de caractères à une longueur définie.
STR_REVERSE	Inverse l'ordre des caractères d'une chaîne
STR_RTRIM	Supprime les espaces qui figurent à la fin d'une chaîne de caractères
STR_SPLIT	Séparer la 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
STR_SUBSTITUTE_VAR	Remplace le nom de Variables de scripts par leur valeur.
STR_TRIM	Supprime les espaces qui figurent au début et à la fin d'une chaîne de caractères
UC_CRLF	Indique un retour à la ligne