GET_UC_SETTING

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

Syntaxe

GET_UC_SETTING (Setting,Component,Option)

Syntaxe	Description / format
Setting	Paramètre système devant être lu Format: Nom AE, littéral de script ou variable de script Valeurs autorisées : WORKLOAD_ACTUAL_FT : Ressources actuellement utilisées, fournies par l'agent pour les transferts de fichiers. WORKLOAD_ACTUAL_JOB : Ressources actuellement utilisées, fournies par l'agent pour les jobs. WORKLOAD_MAX_FT : quantité maximale de ressources fournies par l'agent pour les transferts de fichiers. WORKLOAD_MAX_JOB : quantité maximale de ressources fournies 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 serveur. QUEUE : paramètres de l'objet Queue.
Component	Le paramètre système d’un composant à lire en fonction du paramètre Setting 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 du serveur. Pour SERVER_OPTIONS : Aucun composant n'est indiqué.
Option	Valeur d'une option ou statut d'un objet Queue spécifié à lire. Format: Nom AE, littéral de script ou variable de script Ne spécifiez ce paramètre que si le paramètre est QUEUE et que la valeur d'un objet Queue doit être lue. Valeurs autorisées : ACTIVE_COUNT : nombre d'emplacements de queue actuellement utilisés. CONSIDER_ERT : ERT pris en compte 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. Ne spécifiez ce paramètre que si le paramètre est SET_TRACE et le composant est un processus serveur AE. Valeurs autorisées : TRACE_TARGET : Les traces cibles y sont consignées. MAX_BUFFER_SIZE : Taille de mémoire disponible en écriture. SEARCH_KEY : Texte à rechercher dans les traces.

Syntaxe

Description / format

Setting

Paramètre système devant être lu

Format: Nom AE, littéral de script ou variable de script

Valeurs autorisées :

WORKLOAD_ACTUAL_FT : Ressources actuellement utilisées, fournies par l'agent pour les transferts de fichiers.
WORKLOAD_ACTUAL_JOB : Ressources actuellement utilisées, fournies par l'agent pour les jobs.
WORKLOAD_MAX_FT : quantité maximale de ressources fournies par l'agent pour les transferts de fichiers.
WORKLOAD_MAX_JOB : quantité maximale de ressources fournies 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 serveur.
QUEUE : paramètres de l'objet Queue.

Component

Le paramètre système d’un composant à lire en fonction du paramètre Setting

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 du serveur.

Pour SERVER_OPTIONS :

Aucun composant n'est indiqué.

Option

Valeur d'une option ou statut d'un objet Queue spécifié à lire.

Format: Nom AE, littéral de script ou variable de script

Ne spécifiez ce paramètre que si le paramètre est QUEUE et que la valeur d'un objet Queue doit être lue.

Valeurs autorisées :

ACTIVE_COUNT : nombre d'emplacements de queue actuellement utilisés.
CONSIDER_ERT : ERT pris en compte 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.

Ne spécifiez ce paramètre que si le paramètre est SET_TRACE et le composant est un processus serveur AE.

Valeurs autorisées :

TRACE_TARGET : Les traces cibles y sont consignées.
MAX_BUFFER_SIZE : Taille de mémoire disponible en écriture.
SEARCH_KEY : Texte à rechercher dans les traces.

Codes retour

WORKLOAD_ACTUAL_FT et WORKLOAD_ACTUAL_JOB

Ressources actuellement utilisées par l'agent pour les transferts de fichiers et les jobs.
UNKNOWN : les ressources ne sont pas limitées.

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.

SERVER_MODE

"A" : processus de communication Java (JCP)
"C" : processus de communication (CP)
"D" : processus de dialogue (DWP)
"J" : Processus de travail Java (JWP)
"N" : processus non-stop (NWP)
"P" : processus de travail primaire (PWP)
"W" : processus de travail (WP)
" " : le processus serveur n'est pas actif.

SERVER_OPTIONS

Chaîne de caractères contenant les options du serveur.

QUEUE - ACTIVE_COUNT

Nombre d'emplacements de queue utilisés.

QUEUE - CONSIDER_ERT

"0" : ERT non pris en compte.
"1" : ERT pris en compte au démarrage des tâches selon les exceptions de queues.

QUEUE - MAX_SLOTS

Nombre maximal de slots de queue.
UNLIMITED : les slots de queue sont illimités.

QUEUE - PRIORITY

Priorité courante de la queue.

QUEUE - STATE

"0" : démarrer
"1" : arrêter

SET_TRACE

Options de trace des processus de travail.
"0" : aucune option de trace définie.

SET_TRACE - TRACE_TARGET

"FILE"
"MEMORY"

SET_TRACE - MAX_BUFFER_SIZE

Taille de la mémoire disponible en écriture.

SET_TRACE - SEARCH_TEXT

Texte de recherche.

Les options de trace sont spécifiées dans la catégorie Serveur de Perspective Administration. La fonction de script GET_UC_SETTING renvoie un numéro à 16 chiffres, chaque chiffre se référant à l'une des 16 zones disponibles (par exemple 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.

L'instruction de script écrit toutes les transactions ouvertes du script dans la base de données AE. Pour plus d'informations, voir Traitement du script.

Exemples

L'exemple suivant illustre l'extraction de la quantité maximale de ressources que l'agent WIN01 fournit pour les jobs. Le résultat est écrit dans le rapport 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)

Dans l'exemple suivant, le statut actuel d'un objet Queue est extrait et consigné dans le rapport 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

Dans l'exemple suivant, l'emplacement maximum d'un objet Queue est lu et consigné dans le rapport d'activation.

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

Ces derniers exemples illustrent la lecture d'options de trace supplémentaires pour un système AE actuel.

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, TRACE_TARGET)
: PRINT "Traces are being written into &RET#"

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, MAX_BUFFER_SIZE)
: PRINT "The maximum buffer size for the memory trace is defined as followed: &RET#"

:SET &RET# = GET_UC_SETTING(SET_TRACE, &$SYSTEM#, SEARCH_TEXT)
: PRINT "The AE system has to search for the following text: &RET#"

Voir aussi :

Éléments de script associés

SYS_TIMESTAMP_PHYSICAL

SYS_TIME

SYS_ACT_CLIENT, SYS_USER_CLIENT

SYS_ACT_CLIENT_TEXT