Variables serveur

Cet article contient les rubriques suivantes :
casm173
Cet article contient les rubriques suivantes :
Les informations de CA SDM sont incluses dans le modèle HTML à l'aide de variables commençant par un symbole de dollar ($). Chaque page est créée à l'aide des variables décrites dans le modèle. Ces variables sont placées dans la page ou dans des instructions conditionnelles :
  • Variables simples
  • Variables de propriété
  • Variables d’environnement
  • Variables d'objet métier
  • Variables de liste
Variables simples
Les variables simples spécifient des indicateurs transmis à la page Web. Pour accéder à une variable simple, entrez son nom précédé du symbole du dollar ($). La valeur de la variable devient alors disponible. Par exemple, $CAisd et $cgi sont deux variables simples. Insérée dans un modèle, la variable $CAisd entraîne la substitution du répertoire d'installation principal du serveur Web CA SDM, tandis que $cgi correspond à l'adresse URL du programme pdmweb.exe. Les variables simples figurent dans la section supérieure du fichier HTMPL qui les utilise.
La liste suivante répertorie les variables que vous pouvez utiliser dans tous les fichiers HTMPL :
  • $ACCESS.
    groupe
    L'objet de droit d'accès utilisateur contient les paramètres de droit d'accès au groupe fonctionnel
    groupe
    pour l'utilisateur actuellement connecté. Par exemple, $ACCESS.admin contient la valeur de droit d'accès pour le groupe fonctionnel admin. Un droit peut prendre les valeurs suivantes :
    • 0-AUCUN ACCES
    • 1-AFFICHAGE
    • 2-MODIFICATION
    Cette variable n'est pas disponible dans le formulaire de connexion.
  • $cgi
    Adresse URL du programme pdmweb.exe.
  • $cst
    Objet de données pour l'utilisateur actuellement connecté. Cette variable n'est pas disponible dans le formulaire de connexion. Vous pouvez indiquer des attributs de cet objet sous la forme $cst.
    nom-attr
    (par exemple, $cst.first_name).
  • $CAisd
    URL du répertoire d'installation principal du serveur Web CA SDM.
  • $MachineName
    Le MachineName défini dans le fichier web.cg.
  • $ProductName
    Nom du produit tel qu'il est défini dans le fichier NX.env.
  • $SESSION
    L'objet de session enregistre toutes les variables de session y compris l'ID de session ($SESSION.SID) et toutes les variables définies dans le fichier web.cfg.
  • $USER_STATE
    Informations d'état définies par l'utilisateur.
Variables de propriété
Les variables de propriété représentent une propriété du fichier de configuration web.cfg. Vous pouvez accéder à une entrée dans le fichier web.cfg (y compris celles définies par l'utilisateur) dans un fichier de modèle HTML en lui ajoutant le préfixe "$prop."
Par exemple, la ligne suivante de web.cfg spécifie le nombre d'entrées affichées dans une page d'un formulaire de liste, comme suit :
ListPageLength 10
Pour désigner cette variable dans un modèle HTML, utilisez la spécification suivante :
$prop.ListPageLength
Si vous utilisez la balise spéciale pour insérer un autre fichier dans un modèle, vous pouvez spécifier des propriétés supplémentaires en tant qu'attributs de la balise . Vous pouvez désigner ces propriétés dans le fichier inséré de la même manière que pour les propriétés web.cfg. Une propriété définie en tant qu'attribut et portant le même nom qu'une propriété de web.cfg remplace cette dernière dans le fichier inséré.
Par exemple, la balise suivante crée la propriété $prop.menubar, qui peut être indiquée dans le fichier std_body.htmpl :
<PDM_INCLUDE FILE=std_body.htmpl menubar=no>
Vous pouvez appeler la propriété de fichier de configuration
xxx
de deux façons : $prop.
xxx
ou $SESSION.
xxx
. Les deux renvoient la même valeur. La syntaxe $prop.
xxx
est toutefois préférable, car elle entraîne moins de surcharge pour le serveur.
En plus des propriétés de web.cfg, $prop vous permet d'accéder à d'autres propriétés prédéfinies Il s'agit de :
  • $prop.browser
    Chaîne identifiant le navigateur utilisé. Il s'agira de "IE" pour Internet Explorer.
  • $prop.combo_name
    Chaîne contenant le nom de l’utilisateur actuel, sous la forme « nom, prénom second_prénom ».
  • $prop.factory
    Chaîne contenant le sous-objet associé au formulaire actuel, par exemple "cr" pour les demandes ou "iss" pour les demandes client.
  • $prop.FID
    Chaîne contenant l'ID numérique du formulaire actuel.
  • $prop.form_name
    Chaîne contenant le nom du modèle HTML actuel, sous la forme
    xxx
    .htmpl.
  • $prop.form_name_1
    Chaîne contenant la partie du nom de formulaire placée avant le premier trait de soulignement. Par exemple, pour le formulaire detail_chg_edit.htmpl, form_name_1 correspond à « detail ».
  • $prop.form_name_2
    Chaîne contenant la partie du nom de formulaire placée après le premier trait de soulignement et avant le dernier (ou avant le point). Par exemple, pour le formulaire detail_chg_edit.htmpl, form_name_2 correspond à « chg ».
  • $prop.form_name_3
    Chaîne contenant la partie du nom de formulaire placée entre le dernier trait de soulignement et le point. Par exemple, pour le formulaire detail_chg_edit.htmpl, form_name_3 serait "edit". Pour le formulaire détaillé de la combinaison, qui a un nom de fichier de formulaire de type detail_
    xxx
    .htmpl, $prop.form_name_3 est défini sur le mode actuel ou sur "ro" ou "edit".
  • $prop.release
    Chaîne contenant le niveau de la version du formulaire. L'instruction PDM_PRAGMA contient plus de détails sur cette propriété.
  • $prop.SID
    Chaîne contenant l'ID numérique de la session actuelle.
  • $prop.sitemod
    Chaîne contenant le nom de modification défini par le site du formulaire. L'instruction PDM_PRAGMA contient plus de détails sur cette propriété.
  • $prop.user_type
    Chaîne contenant le texte « analyste », « client », « employé » ou « invité ».
  • $prop.version
    Chaîne contenant la version du formulaire. L'instruction PDM_PRAGMA contient plus de détails sur cette propriété.
Variables d’environnement
Les variables d'environnement correspondent à une entrée du fichier de configuration NX.env. Pour désigner une entrée de ce type dans un modèle HTMPL, ajoutez-lui le préfixe $env.
Par exemple, l'une des lignes de NX.env, qui spécifie le nom d'hôte du serveur CA SDM se présente comme suit :
@NX_SERVER=hostname
Pour désigner cette variable dans un modèle HTML, utilisez la spécification suivante :
$env.NX_SERVER
Variables d'objet métier
Les variables BusinessObject représentent un objet CA SDM, par exemple une demande client ou une demande. Pour accéder à un objet, indiquez le nom de la variable suivi d'un point (.) et des noms d'attributs à afficher. Par exemple, pour une demande client dont l'objet est conventionnellement représenté par la variable args, vous pouvez afficher la description, la date d'ouverture, le numéro de téléphone de la personne assignée, le nombre d'activités pour la demande client et la description de la première activité, comme suit :
$args.description $args.open_date $args.assignee.phone_number $args.act_log.length $args.act_log.0.description
Vous pouvez délimiter le nom de la variable par des accolades s'il n'est pas déjà entouré par des espaces. Par exemple, $foo bar et ${foo}bar sont deux syntaxes valides. Vous pouvez également utiliser la variable args pour accéder à des valeurs autres que des valeurs d'attributs (par exemple, $args.KEEP.
nom
comme décrit dans la section Opérations prises en charge).
Il est possible qu'une variable autre qu'un attribut ne soit pas définie. Par exemple, il peut être possible d'obtenir un formulaire à partir de deux emplacements, dont un seul d'entre eux fournit une valeur pour $args.KEEP.foo. Vous pouvez indiquer une valeur par défaut pour une référence $args à l'aide de la syntaxe suivante, où la chaîne après le signe deux-points remplace la référence si
variable
n'est pas définie :
${args.variable:default}
  • Variables de date de fuseau horaire
    Les variables de date de fuseau horaire sont une forme particulière de variables d'objet métier. Elles permettent de convertir les dates universelles (UTC) numériques en dates de type chaîne ajustées au fuseau horaire du navigateur de l'utilisateur. Les dates numériques sont représentées par la variable suivante :
    $args.attr_name_INT_DATE
    Exemple :
    $args.open_date_INT_DATE
  • Variables de données du sous-objet
    Les variables de données du sous-objet sont une forme particulière de variables d'objet métier. Une variable de données de sous-objet est remplacée par des informations sur un objet référencé. Sept variables de ce type sont disponibles :
    • $args.
      attr_name
      .COMMON_NAME
      Nom commun (chaîne lisible à l'extérieur) de la table référencée par l'attribut. Par exemple, dans le formulaire Détail de la demande, la valeur de $args.assignee.COMMON_NAME est le nom combiné de la personne assignée (« nom, prénom, second prénom »).
    • $args.attr_name.COMMON_NAME_ATTR
      Nom d'attribut du nom commun dans la table référencée par l'attribut. Par exemple, dans le formulaire Détail de la demande, la valeur de $args.assignee.COMMON_NAME_ATTR est « combo_name ».
    • $args.FACTORY_
      attr_name
      Nom du sous-objet associé à l'attribut spécifié. Par exemple, dans le formulaire Détail de l’appel, la valeur de $args.FACTORY_assignee est « agt ».
    • $args.LENGTH_
      attr_name
      Longueur maximale de l'attribut. Par exemple, dans le formulaire Détail de la demande, la valeur de $args.LENGTH_summary est 240.
    • $args.
      attr_name
      .REL_ATTR
      Attr-rel (clé étrangère) de l'attribut. Par exemple, dans le formulaire Détail de la demande, la valeur de $args.assignee.REL_ATTR est la valeur du champ ID de la personne assignée.
    • $args.
      attr_name
      .REL_ATTR_ATTR
      Nom d'attribut de l'attr-rel dans la table référencée par l'attribut. Par exemple, dans le formulaire Détail de la demande, la valeur de $args.assignee.REL_ATTR_ATTR est « id ».
    • $args.REQUIRED_
      attr_name
      Chaîne, « 0 » ou « 1 » indiquant si l’attribut référencé est obligatoire.
    • $args.
      attr_name
      .SELECTIONS
      Liste de sélections valides pour
      attr_name
      . La valeur est une chaîne vide si
      attr_name
      n'est pas une référence à une autre table ou si la taille de la table désignée par
      attr_name
      est supérieure à la valeur de la propriété du fichier de configuration SelListCacheMax. Sinon, la variable SELECTIONS est une chaîne contenant le nom commun et l'attr-rel de toutes les entrées de la table référencée. Les valeurs successives sont séparées par la chaîne « @,@ », de sorte que la valeur de la variable se présente sous la forme suivante :
      "[email protected],@[email protected],@[email protected],@rel_attr2"
    • $args.
      sous-objet
      _SEL_UNDER_LIMIT
      Chaîne, "0" ou "1", indiquant si le nombre actuel de lignes dans la table correspondant au
      sous-objet
      est inférieur à la valeur de la propriété du fichier de configuration SelListCacheMax. Cette variable est déconseillée par rapport à la variable SELECTIONS qu'il est préférable d'utiliser dans tous les nouveaux formulaires.
    Vous pouvez utiliser les variables de données de sous-objet incluant une référence contenant des points (COMMON_NAME, REL_ATTR et SELECTIONS) avec une référence contenant des points d'une longueur quelconque. Par exemple, dans le formulaire Détail de la demande, $args.assignee.organization.COMMON_NAME est remplacé par le nom externe de l'organisation de la personne assignée.
Variables de liste
Les variables de liste permettent de répéter des opérations dans les données. On y accède à l'aide des balises de liste comme décrit dans PDM_LIST : Mettre en forme une liste de lignes d'une base de données.