Manuel des Scripts Automation Engine > Organisation fonctionnelle > Statuts et utilisation du système > GET_UC_SETTING

GET_UC_SETTING

Fonction de script : Lit les paramètres système actuels.

Syntaxe

GET_UC_SETTING(Setting, Component, Option)

Syntaxe

Description / format

Paramètre

Paramètre système devant être lu.
Format : Nom AE, littéral de script ou variable de script

Valeurs autorisées : WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB, WORKLOAD_MAX_FT, WORKLOAD_MAX_JOB, SET_TRACE, SERVER_MODE, SERVER_OPTIONS

WORKLOAD_ACTUAL_FT : ressources actuellement utilisées mises à disposition par l'agent pour les transferts de fichiers
WORKLOAD_ACTUAL_JOB : ressources actuellement utilisées mises à disposition par l'agent pour les jobs
WORKLOAD_MAX_FT : quantité maximale de ressources mises à disposition par l'agent pour les transferts de fichiers
WORKLOAD_MAX_JOB : quantité maximale de ressources mises à disposition par l'agent pour les jobs
SET_TRACE : options de trace pour les processus de travail d'un système AE
SERVER_MODE : type de processus serveur
SERVER_OPTIONS : paramètres du serveur

Composant

Composant AE dont les paramètres système doivent être lus, en fonction du paramètre Paramètre.
Format : Nom AE, littéral de script ou variable de script

Pour WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB, WORKLOAD_MAX_FT et WORKLOAD_MAX_JOB : Nom de l'agent.
Pour SET_TRACE : Nom du système AE.
Pour SERVER_MODE : Nom du processus serveur.
Pour SERVER_OPTIONS : Aucun composant n'est indiqué.
Option

Option/statut de l'objet queue spécifié dont la valeur doit être lue.
Format : Nom AE, littéral de script ou variable de script

Ce paramètre ne doit être indiqué que si la valeur d'un objet queue doit être lue (Paramètre = QUEUE).

Valeurs autorisées : ACTIVE_COUNT, CONSIDER_ERT, MAX_SLOTS, PRIORITY, STATE

ACTIVE_COUNT : nombre de slots de queue occupés
CONSIDER_ERT : prise en charge de l'ERT pour les exceptions
MAX_SLOTS : nombre maximum de slots de queue
PRIORITY : priorité courante (en cas d'exceptions, la valeur peut diverger de la priorité par défaut)
STATE : statut courant de la queue

Codes retour

Pour WORKLOAD_ACTUAL_FT et WORKLOAD_ACTUAL_JOB :
Ressources actuellement utilisées que l'agent fournit pour les transferts de fichiers et les jobs.
UNKNOWN : les ressources ne sont pas limitées.

Pour WORKLOAD_MAX_FT et WORKLOAD_MAX_JOB :
Quantité maximale de ressources que l'agent fournit pour les transferts de fichiers et les jobs
UNLIMITED : les ressources sont illimitées.

Pour SET_TRACE :
Options de trace des processus de travail.
"0" : aucune option de trace n'a été définie.

Pour SERVER_MODE :
"C" : processus de communication (CP)
"P" : processus de travail primaire (PWP)
"W" : processus de travail (WP)
"D" : processus de dialogue (DWP)
"N" : processus non-stop (NWP)
" " : le processus serveur n'est pas actif.

Pour SERVER_OPTIONS :
chaîne de caractères contenant les options du serveur.

Pour QUEUE - ACTIVE_COUNT :
nombre de slots de queue utilisés

Pour QUEUE - CONSIDER_ERT :
"1" : l'ERT est pris en compte au démarrage des tâches en rapport des exceptions de queue
"2" : l'ERT n'est pas pris en compte

Pour QUEUE - MAX_SLOTS :
nombre maximal de slots de queue
UNLIMITED : les slots de queue sont illimités

Pour QUEUE - PRIORITY :
Priorité courante de la queue

Pour QUEUE - STATE :
"0" : démarrer
"1" : arrêter

Remarques

Les options de trace peuvent être définies dans la catégorie Serveur de la supervision système. La fonction de script GET_UC_SETTING retourne un nombre à seize chiffres où chaque chiffre correspond à une des 16 zones disponibles (par ex. TCP/IP).

L'administrateur peut définir les options du serveur dans la variable UC_SYSTEM_SETTINGS d'AE, à l'aide de la clé SERVER_OPTIONS. GET_UC_SETTING retourne la chaîne de caractères complète. Pour lire une option spéciale du serveur, vous pouvez utiliser les éléments de script MID, SUBSTR ou STR_CUT.

GET_UC_SETTING permet d'écrire toutes les transactions ouvertes dans la base de données AE.

Exemples

L'exemple suivant récupère la quantité maximale de ressources que l'agent WIN01 fournit pour les jobs. Le résultat est écrit dans le protocole d'activation.

:SET &RET# = GET_UC_SETTING(WORKLOAD_MAX_JOB, "WIN01")
:PRINT &RET#

Le deuxième exemple lit les options de trace du système AE AEPROD.

:SET &RET# = GET_UC_SETTING(SET_TRACE, "AEPROD")

Cet exemple récupère le type de processus serveur AE#WP003.

:SET &RET# = GET_UC_SETTING(SERVER_MODE, "AE#WP003")

Les lignes de script suivantes lisent le troisième chiffre des options du serveur. Ce paramètre définit si les enregistrements statistiques doivent être vérifiés en cas de démarrage à froid.

:SET &RET# = GET_UC_SETTING(SERVER_OPTIONS)
:SET &OPTION# = SUBSTR(&RET#,3,1)

L'exemple suivant récupère le statut courant d'un objet queue et l'affiche dans le protocole d'activation.

:SET &RET# = GET_UC_SETTING(QUEUE,QUEUE.JOBS,STATE)
:IF &RET# = 0
: PRINT "QUEUE.JOBS - Status = GO"
:ELSE
: PRINT "QUEUE.JOBS - Status = STOP"
:ENDIF

Le dernier exemple lit le maximum de slots courant d'un objet queue et l'écrit dans le rapport d'activation.

:SET &RET# = GET_UC_SETTING(QUEUE,QUEUE.JOBS,MAX_SLOTS)
: PRINT "Queue QUEUE.JOBS - Max Slots: &RET#"

 

Rubriques connexes :

Elément de script Description

:SET_UC_SETTING

Modifie les paramètres système au cours de l'exécution.

Eléments de script - Paramètres et statuts du système

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