HTML-Vorlagen (HTMPL-Formular)

Dieser Artikel enthält die folgenden Themen:
casm173
Dieser Artikel enthält die folgenden Themen:
Formulare werden in der Web-Schnittstelle von als HTML-Vorlagen in Dateien mit dem Suffix ".htmpl" bereitgestellt. Diese werden in diesem Dokument als HTMPL-Formulare bezeichnet.
Ein HTMPL-Formular enthält standardmäßige HTML-Tags (einschließlich JavaScript) plus Spracherweiterungen, die von einem -Server-Daemon (oder Dienst) interpretiert werden, der standardmäßigen HTML-Code an den Browser liefert. Diese Erweiterungen sind:
  • Verweise auf Servervariablen. Diese sind durch einen Namen, der mit einem Dollarzeichen beginnt, gekennzeichnet. Es kann sich dabei um die Werte von Spalten in der -Datenbank, Referenzen auf Konfigurationseigenschaften des Webmoduls oder andere Serverinformationen handeln.
  • Besondere Tags, welche das Webmodul leiten, um Aufgaben auf dem Server (z. B. das Lesen von Informationen aus der -Datenbank) auszuführen. Diese Tags weisen Namen im Format <PDM_...> oder <pdm_...> auf.
Für Anpassungen der CA SDM-Formulare mit WSP müssen Sie weder mit den HTMPL-Erweiterungen noch mit HTML selbst vertraut sein.
Vorlagenbenennungskonventionen
Mit Hilfe der folgenden Benennungskonventionen werden die vier grundlegenden Arten von HTMPL-Dateien gekennzeichnet, wobei
xxx
das Objekt ist:
Vorlagentyp
Name
Liste (Suchfilter und Ergebnisse)
list_
xxx
.htmpl
Kombiniertes Detailformular, das schreibgeschützt ist und bearbeitet werden kann (Analytikerschnittstelle)
detail_
xxx
.htmpl
Schreibgeschütztes Detailformular
detail_
xxx
_ro.htmpl
Zu bearbeitendes Detailformular
detail_
xxx
_edit.htmpl
Definitionen von Objekten und deren Eigenschaften finden Sie in folgenden Verzeichnissen:
  • (UNIX) $NX_ROOT/bopcfg/majic/*.maj
  • Windows:
    installation-directory
    \bopcfg\majic
Informationen zu den Objekten und Attributen, die CA SDM definieren, finden Sie unter CA Service Desk Manager-Informationen zu den Referenzbefehlen.
HTMPL-Verzeichnisse
Es gibt verschiedene Sätze von HTMPL-Dateien zum Implementieren dieser Schnittstellen, die in der folgenden Tabelle aufgeführt sind:
Betriebssystem
Verzeichnis, das HTMPL-Dateien enthält
Windows
Installationsverzeichnis
\bopcfg\www\htmpl\web\
interface
UNIX
$NX_ROOT/bopcfg/www/htmpl/web/
interface
In dieser Tabelle entspricht
interface
dem Namen der Schnittstelle (Analytiker, Kunde oder Mitarbeiter).
Für Dateien der Gastschnittstelle gibt es kein separates Verzeichnis. Gastanwender greifen standardmäßig auf die Dateien der Mitarbeiterschnittstelle zu. Sie können die Benutzerschnittstelle für Gäste ändern, indem Sie den Zugriffstyp ändern, der dem Anwender System_Anonymous zugeordnet ist. Sowohl die Kunden- als auch die Mitarbeiterdateien ändern sich selbst dynamisch in Abhängigkeit davon, ob der aktuelle Anwender ein bekannter Anwender oder ein Gast ist, indem der in diesem Dokument beschriebene Vorlagenbefehl <PDM_IF> verwendet wird.
Unter dem htmpl-Verzeichnis sind drei zusätzliche interface-Unterverzeichnisse verfügbar:
  • default:
    Enthält HTMPL-Dateien, von allen Schnittstellen verwendet werden. Wenn Sie nach einer Datei suchen, sieht das Webmodul zunächst in dem Verzeichnis nach, das der Schnittstelle des aktuellen Anwenders entspricht, und anschließend im Standardverzeichnis.
  • pda/analyst: (UNIX)
  • pda\analyst: (Windows)
    Enthält HTMPL-Dateien, die von der Schnittstelle für mobile Geräte verwendet werden. In CA Service Desk Manager r11.0 wird die Schnittstelle für mobile Geräte nur für Analysten zur Verfügung gestellt.
  • web/
    interface
    /legacy: (UNIX)
  • web\
    interface
    \legacy: (Windows)
    Enthält HTMPL-Dateien aus Ihrem vorherigen Release von , die nicht mehr verwendet werden. Dieses Verzeichnis wird automatisch erstellt, wenn Sie bei der Installation von von einem vorherigen Release migrieren. Sie können das Verzeichnis "legacy" löschen, wenn keine der von Ihnen angepassten Dateien auf die Dateien in dem Verzeichnis verweist.
Es wird empfohlen, dass Sie die gelieferten HTMPL-Dateien nicht direkt modifizieren. Verwenden Sie stattdessen entweder WSP, oder kopieren Sie die Dateien, die Sie ändern möchten, in das Verzeichnis "site mods", und bearbeiten Sie sie hier. Der -Webserver sucht im entsprechenden Verzeichnis "site mods" nach einem neuen Formular, bevor er das Verteilungsverzeichnis prüft. Das standardmäßige Verzeichnis "site mods" für jede der Schnittstellen lautet wie folgt:
Betriebssystem
Verzeichnis für standortmodifizierte HTMPL-Dateien
Windows
Installationsverzeichnis\site\mods\www\htmpl\interface\interface
UNIX
$NX_ROOT/site/mods/www/htmpl/
interface/interface
Wenn Sie das Formular ändern und unter
install directory\site\mods\www\htmpl\interface
speichern, können alle Anwender dieses Formular sehen, unabhängig von der Formulargruppe, der sie angehören. Wenn Sie es unter "
Installationsverzeichnis
\site\mods\www\htmpl\interface\
Schnittstelle
" speichern, können nur die Kontakte die Änderungen anzeigen, die als zugehörig zu der Formulargruppe definiert sind.
In der vorherigen Tabelle entspricht
interface
dem Namen der Schnittstelle (Analytiker, Kunde oder Mitarbeiter). Es gibt kein separates Verzeichnis für Schnittstellendateien für Gäste. Diese Schnittstelle verwendet die Dateien der Mitarbeiterschnittstelle. Der Vorteil für das Speichern von geänderten HTMPL-Dateien im Verzeichnis "site mods" besteht darin, dass dieses Verzeichnis beibehalten wird, wenn Sie die -Wartung oder eine neue Version installieren. Darüber hinaus wird durch das Verwahren der geänderten Dateien im Verzeichnis "site mods" unter Beibehaltung der Originale sichergestellt, dass Sie immer über eine korrekte Kopie der ursprünglich verteilten HTMPL-Datei verfügen.
Jede Web-Schnittstellenseite weist eine Primärfunktion auf, wie in der folgenden Tabelle angegeben, welche die Haupt-HTML-Vorlagen aufführt. Sie können jedoch <PDM_FORM>-Blöcke zu einer Vorlage hinzufügen, um direkt auf einen von der Web-Schnittstelle unterstützten Vorgang zuzugreifen. Sie können z. B. das Hauptmenü ändern, um Felder zum Einreichen eines Issue einzuschließen, ohne die zwischenliegende Seite zu verwenden, oder Sie können Suchkriterienfelder und eine Schaltfläche "Suchen" zu einem Listenformular hinzufügen:
Webseite
HTML-Vorlage
Hauptformular
menu_frames.htmpl
Change anzeigen/erstellen/aktualisieren
detail_chg.htmpl
Liste von Changes anzeigen
list_chg.htmpl
Issue anzeigen/erstellen/aktualisieren
detail_iss.htmpl
Liste von Issues anzeigen
list_iss.htmpl
Request anzeigen/erstellen/aktualisieren
detail_cr.htmpl
Liste von Requests anzeigen
list_cr.htmpl
Detailinformationen einer Ankündigung anzeigen
detail_cnote_html
Liste von Ankündigungen anzeigen
list_cnote.html
Anmeldung
login.htmpl
Eine vollständige Liste der Vorlagen finden Sie in den Verzeichnissen, die in der Tabelle am Anfang dieses Abschnitts aufgeführt sind.
Webformulargruppen
Sie können angepasste Webseiten in einer oder mehreren Formulargruppen zusammenfassen. Die Verzeichnisse von Formulargruppen befinden sich in den folgenden Verzeichnissen:
  • Windows
    Installationsverzeichnis\site\mods\www\htmpl\web\
    interface
    Installationsverzeichnis\site\mods\www\wwwroot\subdirectory
  • UNIX
    $NX_ROOT/site/mods/www/htmpl/web/
    interface
    $NX_ROOT/site/mods/www/wwwroot/subdirectory
Jede Formulargruppe bildet ein Unterverzeichnis in diesen Verzeichnissen. Sie geben das angepasste Formularverzeichnis im Feld „Anpassung der Formulargruppe“ für den Zugriffstyp an.
Wenn ein Anwender ein Formular anfordert, sucht das Webmodul zunächst im entsprechenden Verzeichnis für das angepasste Formular, dann im Standardverzeichnis für die Web-Schnittstelle des Anwenders und schließlich im Standardverzeichnis. Sie können für dieselbe Web-Schnittstelle mehrere Zugriffstypen mit jeweils einer anderen angepassten Formulargruppe definieren. Auf diese Weise können Sie spezielle Formulare für verschiedene Arten von Anwendern definieren und dennoch die meisten Formulare von der Standardschnittstelle verwenden.
Ein ähnliches Verfahren wird ausgeführt, wenn eine Webseite eine Datei aus einem der Unterverzeichnisse von wwwroot (css, html, img oder scripts) anfordert. Die Web-Engine prüft eine HTMPL-Referenz des Formulars "CAisd/img/xxx.gif" und konvertiert es in eine der folgenden GIF-Dateien, wobei die erste Datei ausgewählt wird, in der "xxx.gif" gefunden wird:
  • /CAisd/sitemods/img/formgroup/xxx.gif
  • /CAisd/sitemods/img/xxx.gif
  • /CAisd/img/xxx.gif
Erstellen von Webformulargruppen
Sie können eine Formulargruppe erstellen, um anzugeben, welche Formulare für die Gruppenmitglieder sichtbar sind.
Gehen Sie folgendermaßen vor:
  1. Wenn Sie außer den vordefinierten Formulargruppen "Analyst", "Kunde" oder "Mitarbeiter" weitere Formulargruppen benötigen, erstellen Sie eine neue Formulargruppe. Wählen Sie dazu in WSP im Menü "Datei" die Option "Speichern unter", und klicken Sie im Dialogfeld "Formular speichern unter" auf die Schaltfläche "Formulargruppe hinzufügen". Wenn Sie z. B. zwei separate angepasste Versionen der Schnittstelle „Analytiker“ bereitstellen möchten, können Sie hierfür die Formulargruppen „Analytiker1“ und „Analytiker2“ erstellen. Sie können auch eine neue Formulargruppe definieren, wenn die Schnittstelle, die Sie gerade definieren, logisch nicht in eine der vordefinierten Formulargruppen passt.
  2. Wählen Sie auf der Web-Schnittstelle (keine -Vorschausitzung) im Menü "Administration" die Option "Sicherheit" und "Zugriffstypen" aus. Klicken Sie dann auf einen Zugriffstyp (oder erstellen Sie einen neuen), und verwenden Sie die Dropdown-Liste "Anpassungsformulargruppe" im Fenster "Zugriffstyp - Detail", um einem Zugriffstyp eine Formulargruppe zuzuweisen. bestimmt den Zugriffstyp, wenn sich ein Kontakt anmeldet, und verwendet die Anpassungsformulargruppe, um zu bestimmen, wo in der Verzeichnisstruktur "site mods" nach angepassten Formularen zu suchen ist. Wenn das Webmodul keine Formulare im Formulargruppenverzeichnis findet, sucht es erst im Standardverzeichnis für den Zugriffstyp des Anwenders und dann im Standardverzeichnis.
  3. Wählen Sie in WSP im Menü "Datei" die Option "Speichern", oder kopieren Sie die angepassten HTMPL-Dateien manuell in das folgende Verzeichnis:
    Unter Windows:
    installationsverzeichnis
    \site\mods\www\htmpl\web\
    form_group_name
    Unter UNIX: $NX_ROOT/site/mods/www/htmpl/web/
    form_group_name
Nachdem Sie eine neue Webformulargruppe eingerichtet und alle unterstützenden Dateien in die entsprechenden Unterverzeichnisse kopiert haben, müssen Sie den Webservice erneut starten, damit die Änderungen wirksam werden.