Modèles HTML (Formulaire HTMPL)

Cet article contient les rubriques suivantes :
casm173
Cet article contient les rubriques suivantes :
Les formulaires de l'interface Web de sont fournis comme modèles HTML, dans des fichiers portant le suffixe .htmpl. On les appelle formulaires HTMPL dans le reste de ce document.
Un formulaire HTMPL contient du code HTML standard (y compris JavaScript) plus des extensions de langage qui sont interprétés par un démon serveur (ou service) appelé moteur Web, lequel transmet le code HTML standard au navigateur. Ces extensions sont répertoriées ci-après.
  • Références à des variables serveur : celles-ci sont indiquées par un nom commençant par le symbole du dollar. Il peut s'agir de valeurs de colonnes de la base de données , de références aux propriétés de configuration du moteur Web ou d'autres informations de serveur.
  • Balises spéciales : celles-ci indiquent au moteur Web qu'il doit effectuer des tâches sur le serveur (par exemple, lire des informations de la base de données ). Ces balises portent des noms comme ou .
Il n'est pas nécessaire de maîtriser les extensions HTMPL ni même le langage HTML proprement dit pour personnaliser des formulaires CA SDM à l'aide du concepteur Web.
Conventions d'attribution des noms de modèles
Les conventions d'attribution de noms suivantes sont utilisées pour identifier les quatre principaux types de fichiers HTMPL (
xxx
représente l'objet).
Type de modèle
Nom
Liste (filtre de recherche et résultats)
list_
xxx
.htmpl
Formulaire détaillé combiné, en lecture seule et de modification (interface analyste)
detail_
xxx
.htmpl
Formulaire détaillé en lecture seule
detail_
xxx
_ro.htmpl
Formulaire détaillé de modification
detail_
xxx
_edit.htmpl
Vous pouvez trouver les définitions des objets et leurs propriétés aux emplacements suivants :
  • (UNIX) $NX_ROOT/bopcfg/majic/*.maj
  • (Windows)
    répertoire-installation
    \bopcfg\majic\*.maj
Pour plus d'informations sur les objets et attributs qui définissent CA SDM, reportez-vous à l'article Commandes de référence de CA Service Desk Manager.
Répertoires HTMPL
Vous disposez de plusieurs ensembles de fichiers HTMPL pour implémenter ces interfaces, comme indiqué dans le tableau suivant :
Système d'exploitation
Répertoire des fichiers HTMPL
Windows
répertoire-installation
\bopcfg\www\htmpl\web\
interface
UNIX
$NX_ROOT/bopcfg/www/htmpl/web/
interface
Dans ce tableau,
interface
désigne le nom de l'interface (analyste, client ou employé).
Il n'existe pas de répertoire distinct pour les fichiers de l'interface invité ; celle-ci utilise les fichiers de l'interface employé par défaut. Si vous souhaitez modifier l'interface utilisateur invité, modifiez le type d'accès associé à l'utilisateur System_Anonymous. Les fichiers client et employé se modifient dynamiquement en fonction de l'utilisateur actuel (invité ou utilisateur connu), à l'aide de la commande du modèle <PDM_IF> décrite dans ce document.
Le répertoire htmpl contient trois sous-répertoires d'interfaces supplémentaires :
  • default
    Contient les fichiers HTMPL communs à toutes les interfaces. Lors de la recherche d'un fichier, le moteur Web effectue d'abord une recherche dans le répertoire correspondant à l'interface de l'utilisateur actuel, puis dans le répertoire par défaut.
  • pda/analyst : (UNIX)
  • pda\analyst : (Windows)
    Contient les fichiers HTMPL utilisés par l'interface pour appareil mobile. Dans CA Service Desk Manager r11.0, l'interface pour appareil mobile est uniquement disponible pour les analystes.
  • web/
    interface
    /legacy : (UNIX)
  • web\
    interface
    \legacy : (Windows)
    Contient les fichiers HTMPL de votre version précédente de CA SDM qui ne sont plus utilisés. Ce répertoire est créé automatiquement lors de l'installation de CA SDM si vous effectuez une mise à niveau à partir d'une version précédente. Vous pouvez supprimer le répertoire legacy si vos fichiers personnalisés n'utilisent aucun de ses fichiers.
Il est fortement déconseillé de modifier directement les fichiers HTMPL fournis. Utilisez plutôt le concepteur Web ou copiez manuellement le fichier que vous voulez modifier dans le répertoire site mods, puis modifiez-le à cet emplacement. Le serveur Web de CA SDM recherche un nouveau formulaire dans le répertoire site mods approprié avant de vérifier le répertoire de distribution. Les répertoires site/mods standard de chaque interface sont les suivants :
Système d'exploitation
Répertoire des fichiers HTMPL modifiés par le site
Windows
répertoire-installation\site\mods\www\htmpl\interface\interface
UNIX
$NX_ROOT/site/mods/www/htmpl/
interface/interface
Si vous modifiez le formulaire, puis que vous l'enregistrez dans le répertoire
installation\site\mods\www\htmpl\interface
, tous les utilisateurs peuvent y accéder, quel que soit le groupe de formulaires auquel ils appartiennent. Si vous l'enregistrez sous
répertoire d'installation
\site\mods\www\htmpl\interface\
interface
, seuls les contacts définis comme appartenant à ce groupe de formulaires peuvent visualiser les formulaires modifiés.
Dans le tableau précédent,
interface
désigne le nom de l'interface (analyste, client ou employé). Il n'existe pas de répertoire distinct pour les fichiers de l'interface Invité ; celle-ci utilise les fichiers de l'interface Employé. Il est préférable de stocker les fichiers HTMPL modifiés dans le répertoire site mods, car ce répertoire n'est pas supprimé lorsque vous installez une mise à niveau ou une nouvelle version de CA SDM. De plus, en conservant d'une part les fichiers modifiés dans le répertoire site mods, de l'autre les fichiers d'origine, vous disposez en permanence d'une copie du fichier HTMPL original distribué.
Chaque page de l'interface Web est associée à une fonction principale, comme indiqué dans le tableau ci-dessous répertoriant les principaux modèles HTML. Cependant, vous pouvez ajouter des blocs à un modèle pour accéder directement à l'une des opérations prises en charge par l'interface Web. Par exemple, vous pouvez modifier le menu principal pour inclure des champs de soumission d'une demande client sans devoir passer par la page intermédiaire. Vous pouvez également ajouter des champs de critères de recherche et un bouton de recherche à un formulaire de liste :
Page Web
Modèle HTML
Formulaire principal
menu_frames.htmpl
Affichage/création/mise à jour d'une demande de changement
detail_chg.htmpl
Affichage de la liste des demandes de changement
list_chg.htmpl
Affichage/création/mise à jour d'une demande client
detail_iss.htmpl
Affichage de la liste des demandes client
list_iss.htmpl
Affichage/création/mise à jour d'une demande
detail_cr.htmpl
Affichage de la liste des demandes
list_cr.htmpl
Affichage des détails d'une annonce
detail_cnote_html
Affichage d'une liste d'annonces
list_cnote.html
Connexion
login.htmpl
Pour obtenir la liste complète des modèles, consultez le contenu des répertoires dans le tableau présenté au début de cette section.
Groupes de formulaires Web
Vous pouvez rassembler des pages Web personnalisées dans un ou plusieurs groupes de formulaires. Les répertoires de groupes de formulaires sont situés dans les répertoires suivants :
  • Windows
    répertoire-installation\site\mods\www\htmpl\web\
    interface
    répertoire-installation\site\mods\www\wwwroot\sous-répertoire
  • UNIX
    $NX_ROOT/site/mods/www/htmpl/web/
    interface
    $NX_ROOT/site/mods/www/wwwroot/sous-répertoire
Chaque groupe de formulaires correspond à un sous-répertoire de ces répertoires. Vous pouvez spécifier le répertoire de formulaires personnalisés dans le champ Groupe de formulaires de personnalisation du type d'accès.
Lorsqu'un utilisateur demande un formulaire, le moteur Web recherche d'abord dans le répertoire des groupes de formulaires personnalisés approprié, puis dans le répertoire standard de l'interface Web de l'utilisateur, et enfin dans le répertoire par défaut. Vous pouvez définir plusieurs types d'accès pour la même interface Web, chacun étant associé à un groupe de formulaires personnalisés différent. Ceci vous permet de définir quelques formulaires spécialisés pour différents types d'utilisateurs, tout en continuant à utiliser la majorité des formulaires de l'interface standard.
Un processus similaire intervient lorsqu'une page Web demande un fichier issu de l'un des sous-répertoires de wwwroot (css, html, img ou scripts). Le moteur Web examine une référence HTMPL du formulaire CAisd/img/xxx.gif et la convertit en l'un des fichiers GIF suivants, en sélectionnant le premier dans lequel il détecte xxx.gif :
  • /CAisd/sitemods/img/formgroup/xxx.gif
  • /CAisd/sitemods/img/xxx.gif
  • /CAisd/img/xxx.gif
Création d'un groupe de formulaires Web
Vous pouvez créer un groupe de formulaires.
Procédez comme suit :
  1. Si vous souhaitez disposer d'un groupe de formulaires en complément des groupes de formulaires Analyste, Client ou Employé prédéfinis, créez un groupe. Pour ce faire, sélectionnez Enregistrer sous dans le menu Fichier du concepteur Web, puis cliquez sur Ajouter un groupe de formulaires dans la boîte de dialogue Enregistrer le formulaire sous. Par exemple, pour offrir deux versions personnalisées de l'interface Analyste, vous pouvez créer des groupes de formulaires nommés Analyste1 et Analyste2 pour les gérer. Vous pouvez également définir un nouveau groupe de formulaires si l'interface que vous définissez n'a pas sa place, logiquement, dans l'un des groupes de formulaires prédéfinis.
  2. Dans l'interface Web (et non dans une session d'aperçu du concepteur Web), sélectionnez Sécurité, Types d'accès dans le menu Administration. Cliquez sur un type d'accès (ou créez-en un), puis utilisez la liste déroulante Groupe de formulaires de personnalisation dans la fenêtre Détail du type d'accès pour affecter un groupe de formulaires à un type d'accès. CA SDM détermine le type d'accès lorsqu'un contact se connecte et utilise un groupe de formulaires de personnalisation pour déterminer l'emplacement de recherche des formulaires personnalisés dans la structure du répertoire site mods. Si le moteur Web ne trouve pas de formulaire dans le répertoire du groupe de formulaires, il recherche le type d'accès de l'utilisateur d'abord dans le répertoire standard, puis dans le répertoire par défaut.
  3. Dans le concepteur Web, sélectionnez Enregistrer dans le menu Fichier, ou copiez manuellement les fichiers HTMPL personnalisés dans le répertoire suivant :
    Sous Windows :
    répertoire-installation
    \site\mods\www\htmpl\web\répertoire
    nom_groupe_formulaires
    Sous UNIX : $NX_ROOT/site/mods/www/htmpl/web/
    nom_groupe_formulaires
Après avoir défini un nouveau groupe de formulaires Web et copié les fichiers sous-jacents nécessaires dans les sous-répertoires appropriés, vous devez redémarrer le service Web pour que les changements soient appliqués.