Opérations de serveur prises en charge

Cet article contient les rubriques suivantes :
casm173
Cet article contient les rubriques suivantes :
Les opérations suivantes sont prises en charge pour vous permettre d'intégrer les pages Web CA SDM dans vos pages Web :
  • CREATE_NEW
    Fournit une interface générique permettant à l'utilisateur de créer une ligne dans une table spécifiée. Vous devez entrer le nom d'objet. Par défaut, un modèle nommé
    detail_xxx
    _edit.htmpl est utilisé pour l'objet
    xxx
    . Vous pouvez remplacer le fichier .htmpl en spécifiant la propriété HTMPL.
    • Identificateurs obligatoires :
      FACTORY=
      nom
      -
      objet
    • Identificateurs facultatifs :
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL=preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=zdetailxxx_
      factory
      .htmplKEEP
      .attr_name=value
      PRESET=
      preset_expression
      PRESET_REL=
      preset expression
      SET
      .attr_name=value
      use_template=1 | 0 (0 is the default)
    Pour que vous puissiez utiliser l'indicateur HTMPL avec CREATE_NEW, le nom du formulaire référencé doit respecter la convention d'affectation de noms zdetailxxx_
    factory
    .htmpl. Le nom doit commencer par la chaîne « zdetail » puis être suivi de caractères alphanumériques (y compris une chaîne nulle), d'un caractère de soulignement et du nom du sous-objet.
  • ENDSESSION ou LOGOUT
    Termine la session en cours. Il est conseillé d'utiliser l'opération ENDSESSION.
  • GENERIC_LIST
    Fournit une interface générique permettant à l'utilisateur d'afficher une liste à partir d'une table de la base de données. Vous devez entrer le nom d'objet. Par défaut, un modèle nommé list_
    xxx
    .htmpl est utilisé pour l'objet
    xxx
    . Vous pouvez remplacer le fichier .htmpl en spécifiant la propriété HTMPL.
    • Identificateurs obligatoires :
      FACTORY=
      nom
      -
      objet
      KEEP
      .attr_name=valeur
  • DISPLAY_FORM
    Fournit une interface générique permettant à l'utilisateur d'afficher un formulaire personnalisé.
    • Identificateurs obligatoires :
      HTMPL=
      fichier_htmpl
    DISPLAY_FORM remplace JUST_GRONK_IT. Les implémentations existantes peuvent continuer à utiliser JUST_GRONK_IT, qui fonctionne exactement comme DISPLAY_FORM. Il est conseillé d'utiliser l'opération DISPLAY_FORM.
  • MENU
    Affiche la page de menu principale, qu'est définie dans le fichier web.cfg de la propriété Menu.
    • Identificateurs facultatifs :
      HTMPL=
      fichier-de-menu
      fichier-de-menu
      correspond au nom d'un fichier de menu principal de remplacement.
  • PAGE_EXTENSION
    Permet à l'administrateur Web de spécifier des extensions supplémentaires pour l'interface.
    • Identificateurs obligatoires :
      NAME=
      fichier_html
      fichier_html
      est l'un des noms de fichiers répertoriés dans la directive UserPageExtensions du fichier de configuration.
    • Identificateurs facultatifs :
      REQUIRES_LOGIN=1
      S'il est présent, une page de connexion apparaît d'abord si l'utilisateur n'est pas connecté actuellement. S'il est omis ou défini sur zéro, le fichier est affiché sans vérifier si l'utilisateur est connecté actuellement.
  • RELOG
    Affiche la page de connexion.
  • SEARCH
    Fournit une interface générique pour permettre les recherches dans les tables de la base de données. Cette opération suppose qu'un search_
    xxx
    .htmpl approprié a été créé, où
    xxx
    est le
    nom d'objet
    , comme défini dans les fichiers .maj dans le répertoire majic dans bopcfg.
    Pour plus d'informations, reportez-vous à l'articles Commandes de référence de CA Service Desk Manager. Par défaut, les résultats de cette recherche sont affichés dans list_
    xxx
    .htmpl, mais vous pouvez modifier cette option en spécifiant la propriété HTMPL.
    • Identificateurs obligatoires :
      FACTORY=
      nom-objet
      QBE.
      op
      .
      attr_name
      =
      valeur
    • Identificateurs facultatifs :
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      list_htmpl_file
      KEEP
      .attr_name=valeur
  • SEC_REFRESH
    Actualise les informations d'accès utilisateur à partir du sous-système de sécurité. Pour ce faire, les utilisateurs bénéficiant des droits de modification (pour le groupe fonctionnel admin) sur l'écran de menu ont accès à un lien hypertexte. Après la mise à jour des droits d'accès d'un utilisateur à l'aide du programme de sécurité, cette opération permet d'actualiser les informations d'accès (cette actualisation s'étend à tous les utilisateurs).
    L'actualisation de la sécurité est un processus asynchrone. Une fois l'actualisation terminée, un message s'affiche dans le journal standard (stdlog).
  • SET_MENU
    Cette opération est identique à l'opération MENU lorsque vous utilisez MENU avec la variable HTMPL, à la différence près qu'elle définit également le formulaire de menu par défaut au formulaire spécifié à l'aide de la propriété HTMPL.
    • Identificateurs obligatoires :
      HTMPL=
      fichier_htmpl
    La définition de MENU dans le fichier web.cfg sera alors ignorée jusqu'au redémarrage du service Web.
  • SHOW_DETAIL
    Fournit une interface générique permettant à l'utilisateur d'afficher en lecture seule le détail d'une ligne dans une table spécifiée. Le nom d'ID persistant doit être spécifié (il permet de déterminer le nom d'objet). Par défaut, un modèle nommé detail_
    xxx
    _ro.htmpl est utilisé pour l'objet
    xxx
    . Vous pouvez remplacer le fichier .htmpl en spécifiant la propriété HTMPL.
    • Identificateurs obligatoires :
      PERSID=
      ID
      -
      persistant
    • Identificateurs facultatifs :
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      readonly_detail_htmpl_file
  • UPDATE
    Fournit une interface générique pour modifier une table. L'ID et le nom d'objet doivent être transmis, et un formulaire détaillé susceptible d'être modifié s'affiche pour l'utilisateur. Par défaut, l'utilisateur a un accès exclusif à l'enregistrement pendant deux minutes et est certain que ses changements seront appliqués s'ils sont soumis pendant ce délai.
    • Identificateurs obligatoires :
      PERSID=
      ID-persistant
      orSET.id=
      ID-ligne-à-mettre-à-jour
      FACTORY=
      nom-objet
    • Identificateurs facultatifs :
      NEXT_PERSID=
      ID
      -
      persistant
      (de l'enregistrement à afficher une fois la mise à jour réussie)KEEP
      .attr_name=valeur
      KEY
      .attr_name=valeur
      HTMPL=zdetailxxx_
      factory
      .htmpl
    Pour que vous puissiez utiliser l'indicateur HTMPL avec UPDATE, le nom du formulaire référencé doit respecter la convention d'affectation de noms zdetailxxx_
    factory
    .htmpl. Le nom doit commencer par la chaîne « zdetail » puis être suivi de caractères alphanumériques (y compris une chaîne nulle), d'un caractère de soulignement et du nom du sous-objet.
Pour plus d'informations sur web.cfg, reportez-vous à l'article Configuration de l'interface Web.
Variables d'opération
Le tableau suivant répertorie les variables pouvant être définies pour chacune des opérations prises en charge :
Variables
Description
Service Opérations
ALG_PRESET
ALG_PRESET_REL
Spécifie les valeurs d'un ou plusieurs attributs du journal d'activité créé suite à l'utilisation de la variable CREATE_ALG. Si la variable CREATE_ALG n'est pas spécifiée, les variables ALG_PRESET et ALG_PRESET_REL sont ignorées.
CREATE_NEWSEARCHSHOW_DETAIL
CREATE_ALG
Spécifie le type de journal d'activité à créer en tant qu'effet secondaire de l'opération. Utilisez les variables ALG_PRESET ou ALG_PRESET pour spécifier les valeurs des attributs du nouveau journal d'activité.
Le moment de la création du journal d'activité dépend de l'opération, comme suit :
CREATE_NEW
Le journal d'activité est créé lors de la sauvegarde de l'enregistrement. Si le nouvel enregistrement n'est pas enregistré, aucun journal d'activité n'est créé.
SEARCH
Le journal d'activité est créé lors de la sélection d'un enregistrement dans le formulaire de liste. Si l'enregistrement est consulté plutôt que sélectionné (c'est-à-dire, si l'utilisateur sélectionne de façon explicite la commande Affichage dans le menu contextuel du formulaire de liste), aucun journal d'activité n'est créé.
SHOW_DETAIL
Le journal d'activité est créé avant l'affichage de l'enregistrement.
CREATE_NEWSEARCHSHOW_DETAIL
FACTORY
Spécifie la classe d'objets à rechercher, à créer ou à mettre à jour. Vous pouvez spécifier le nom de votre choix comme OBJECT dans les fichiers *.maj figurant dans le répertoire $NX_ROOT/bopcfg, comme indiqué dans l'article Commandes de référence de CA Service Desk Manager.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
HTMPL
Permet à l'auteur HTMPL d'ignorer les conventions d'affectation des noms de modèles par défaut et de spécifier explicitement le fichier HTMPL à afficher à la place du modèle par défaut.
Remarque :
Lorsque l'indicateur HTMPL est utilisé avec CREATE_NEW ou UPDATE, le nom du formulaire référencé doit respecter la convention d'affectation de noms zdetailxxx_factory.htmpl, où xxx représente les caractères, et
factory
est le nom du sous-objet.
CREATE_NEWDISPLAY_FORMJUST_GRONK_ITMENUSEARCHSET_MENUSHOW_DETAIL
UPDATE
KEEP.
nom
Spécifie la valeur pouvant être enregistrée et transmise entre des pages.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
KEY.
attr_name
Similaire à la variable SET.
attr_name
mais spécifie une recherche sur
attr_name
qui doit désigner une autre table ou un autre objet.
UPDATE
NEXT_PERSID
Spécifie l'ID persistant du prochain enregistrement à afficher.
UPDATE
PERSID
Spécifie l'ID persistant d'un enregistrement à afficher. Vous pouvez spécifier cette variable de l'une des manières suivantes :
Directement, avec un ID persistant composé d'un nom de sous-objet, du signe deux points (:) et d'un ID de base de données unique sous la forme d'un nombre entier. Par exemple, PERSID=chg:1234 spécifie la demande de changement avec l'ID de base de données 1234.
Indirectement, avec un ID persistant composé d'un nom de sous-objet, du signe deux-points (:), d'un nom d'attribut, d'un second signe deux-points (:) et d'une valeur. Cette forme de PERSID spécifie l'enregistrement du sous-objet spécifié dont l'attribut a la valeur définie. Par exemple, PERSID=chg:chg_ref_num:demo:3 spécifie la demande de changement dont le numéro de référence est demo:3.
SHOW_DETAILUPDATE
PRESET
PRESET_REL
Spécifie les valeurs d'un ou plusieurs attributs de l'enregistrement créé suite à l'utilisation de la variable CREATE_NEW. Si la variable CREATE_NEW n'est pas spécifiée, la variable PRESET est ignorée.
CREATE_NEW
QBE.
op
.
attr_name
Spécifie les valeurs à utiliser lors d'une recherche. Ces valeurs sont identifiées à l'aide d'un mot clé QBE, où
attr_name
désigne un nom d'attribut définissable d'un ticket et
op
indique de rechercher si l'attribut :
EQ est égal à la valeur
NE est différent de la valeur
GT est supérieur à la valeur
LT est inférieur à la valeur
GE est supérieur ou égal à la valeur
LE est inférieur ou égal à la valeur
NU est nul
NN n'est pas nul
IN correspond à l'expression SQL LIKE
KY contient le texte entré
Si vous ne définissez aucune variable QBE, c'est la fenêtre de recherche standard qui s'affiche.
SEARCH
SET.
attr_name
Spécifie le nom de l'attribut à utiliser lors de la création d'un ticket, où
attr_name
identifie un attribut définissable dans un ticket. Les noms d'attributs varient en fonction de l'objet sous-jacent. Tous les objets et leurs attributs se trouvent dans les fichiers *.maj du répertoire majic dans bopcfg, comme indiqué dans l'article Commandes de référence de CA Service Desk Manager.
CREATE_NEWUPDATE
SET.
id
Spécifie l'ID de la base de données de la ligne à mettre à jour.
UPDATE
SKIPLIST
Si cette variable est définie à 1, la liste des résultats de la recherche ne s'affiche pas lorsqu'un seul résultat est renvoyé, mais le détail correspondant en lecture seule s'affiche directement.
SEARCH
use_template
Si cette variable est définie à 1, l'opération SEARCH renvoie une liste de modèles. Le modèle renvoyé sélectionné sera utilisé dans l'opération CREATE_NEW pour renseigner un nouvel enregistrement. Cette variable est valide pour les demandes de changement, les demandes client et les demandes.
CREATE_NEWSEARCH
Syntaxe des variables PRESET, PRESET_REL, ALG_PRESET et ALG_PRESET_REL
Les mots clés PRESET, PRESET_REL, ALG_PRESET et ALG_PRESET_REL dans l'adresse URL spécifient les valeurs initiales respectivement pour les attributs du ticket et son journal d'activité. Il existe deux formats :
  • [ALG_]PRESET=
    attr
    :
    value
    Indique que l'attribut spécifié du ticket ou du journal d'activité doit être défini à la valeur spécifiée. Par exemple, la spécification suivante définit la description du nouveau ticket à « Bonjour ».
    PRESET=description:Hello
  • [ALG_]PRESET_REL=attr:obj.attr-rel:attr-test:valeur
    Indique que l'attribut spécifié du ticket ou du journal d'activité doit être défini à une valeur copiée d'une autre table de base de données. La valeur est copiée de l'attribut
    attr-rel
    de l'
    objet
    dont le paramètre
    attr-test
    a la
    valeur
    spécifiée. Par exemple, la spécification suivante définit l'attribut analyste du nouveau ticket à l'ID du contact dont l'ID d'utilisateur est xyz123 :
    PRESET_REL=analyst:cnt.id:userid:xyz123
    Lorsque ce format est utilisé, la requête doit extraire un seul enregistrement. Si plusieurs contacts (ou aucun) ont l'ID d'utilisateur xyz123, l'exemple de spécification PRESET est sans effet.
Les mots clés PRESET, PRESET_REL, ALG_PRESET et ALG_PRESET_REL peuvent figurer autant de fois que vous le souhaitez dans une adresse URL, ce qui permet de définir plusieurs attributs. Autrement, un opérande à un seul mot clé peut spécifier plusieurs valeurs séparées par les signes @@. Si vous utilisez le séparateur "@@", vous ne pouvez pas mélanger les formats de valeur pour les mots clés [ALG_]PRESET et [ALG_]PRESET_REL. L'exemple suivant présente deux manières de spécifier des valeurs pour la description du ticket, le résumé et l'analyste :
PRESET=description:Hello+PRESET=summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123 PRESET=description:[email protected]@summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123
Pour les demandes, les demandes client, les incidents, les problèmes et les demandes de changement, PRESET et PRESET_REL gèrent un attribut de mot clé ASSET permettant de lier un objet à un actif. L'attribut ASSET met à jour l'attribut affected_resource d'une demande, d'un incident ou d'un problème, ou l'actif LREL d'une demande client ou d'une demande de changement.
Exemples de liens
Les exemples de lien suivants n'incluent pas le chemin d'accès à CA SDM. Toutes les URL de CA SDM commencent avec un codage sous la forme suivante :
http://
nom-hôte
[:
port
]/CAisd/pdmweb.exe
Dans cet exemple,
nom-hôte
est le nom de votre serveur, et
port
(facultatif) est le numéro de port si vous utilisez Tomcat. Ce codage est représenté par des points de suspension (…) dans les exemples d'adresses URL suivants :
  • Pour créer une demande avec un utilisateur concerné avec l'ID d'utilisateur tooda01, utilisez l'exemple d'URL suivant :
    ...?OP=CREATE_NEW+FACTORY=cr+PRESET_REL=customer:cnt.id:userid:tooda01
  • Pour afficher la liste de toutes les demandes affectées à l'ID d'utilisateur tooda01, utilisez l'exemple d'URL suivant :
    ...?OP=SEARCH+FACTORY=cr+QBE.EQ.assignee.userid=tooda01
  • Pour afficher le formulaire détaillé pour la demande 1234, utilisez les exemples d'URL suivants :
    ...?OP=SHOW_DETAIL+FACTORY=cr+PERSID=cr:ref_num:1234 (read-only view) ...?OP=UPDATE+FACTORY=cr+PERSID=cr:ref_num:1234 (update view)
Vous pouvez ignorer le protocole de contrôle de connexion en utilisant les services Web pour l'authentification. Pour plus d'informations sur la méthode getBopsid(), reportez-vous à l'article Commandes de référence de CA Service Desk Manager.