Der InterAction Web Client kann durch das Bearbeiten von XML-Konfigurationsdateien konfiguriert werden. InterAction verwendet eine Reihe von XML-Dateien, um festzulegen, welche Seiten den Nutzern im Web Client angezeigt werden. Diese Dateien werden auf dem Anwendungsserver gespeichert.
XML (Extensible Markup Language) ist eine Auszeichnungssprache, die HTML ähnelt. Der Hauptunterschied besteht darin, dass XML strukturierter und erweiterbar ist – ein XML-Dokument kann eine eigene Menge an Auszeichnungstags verwenden. Weitere Informationen zu XML im Allgemeinen finden Sie unter Überblick über das Bearbeiten von XML-Dateien.
Es gibt drei Haupttypen von XML-Dateien, die Sie typischerweise bei der Konfiguration des Web Client verwenden:
- Page Method Declarations definieren die eigentlichen Seiten, die Sie im Web Client sehen. Eine Page Method legt das generelle Layout und den Inhalt der Seite fest.
- Nugget List Declarations definieren Listen von Links, die auf einer Seite platziert werden können.
- Search List Declarations definieren ebenfalls Listen von Links. Sie werden in der Regel für einfachere Listen als Nugget-Listen verwendet, zum Beispiel für die Links auf der Startseite.
In dieser Referenz werden alle XML-Elemente (auch Tags genannt) beschrieben, die in den Konfigurationsdateien zur Verfügung stehen.
Ein weiterer Deklarationstyp wird für die Konfiguration von Menüs verwendet. Menü-Deklarationen werden in dieser Referenz nicht behandelt. Informationen zur Konfiguration des Menüs auf der linken Seite finden Sie unter Überblick über die Anpassung des Web Client Hauptmenüs.
Bevor Sie diese Referenz verwenden und den Web Client konfigurieren, sollten Sie mit den Grundlagen von XML vertraut sein. Sie sollten die folgenden Begriffe und Konzepte kennen:
- Elemente und Tags
- Der Unterschied zwischen öffnenden und schließenden Tags
- Verschachtelung eines Tags innerhalb eines anderen Tags
- Attribute
- Zuweisung von Werten zu Attributen
- Ein XML-Dokument wohlgeformt machen
Wenn Sie mit diesen Konzepten nicht vertraut sind, lesen Sie Überblick über das Bearbeiten von XML-Dateien für eine Einführung. Beachten Sie, dass Sie sich im Umgang mit XML wohlfühlen sollten, um den InterAction Web Client zu konfigurieren.
Beachten Sie, dass Sie die XML-Dateien nicht bearbeiten müssen, um Web Client-Profile oder Suchformulare zu erstellen oder zu bearbeiten.
Verwendung der XML-Referenz
Es gibt verschiedene Möglichkeiten, Informationen über die XML-Dateien zu erhalten, die für die Konfiguration des InterAction Web Client verwendet werden.
Für einen Überblick über die drei Haupttypen von XML-Deklarationsdateien lesen Sie die folgenden Abschnitte:
- Überblick über Page Method Declarations
- Überblick über Nugget List Declarations
- Überblick über Search List Declarations
Für Details zu den einzelnen Elementen und Attributen, die Sie in jedem dieser Dateitypen verwenden können, siehe:
- Elemente und Attribute für eine Page Method Declaration
- Elemente und Attribute für eine Nugget List Declaration
- Elemente und Attribute für eine Search List Declaration
Diese Abschnitte bieten Codebeispiele und detaillierte Informationen zu den Elementen und Attributen. Für jedes Element enthält die Referenz Folgendes:
- Name und Beschreibung des Elements.
- Die Liste anderer Elemente, die innerhalb des Elements verschachtelt werden können.
- Die Attribute, die für das Element festgelegt werden können.
- Alle weiteren notwendigen Hinweise oder Beispiele.
Nachschlagen von XML-Informationen
Sie können XML-Tags in den folgenden Abschnitten nachschlagen. Verwenden Sie diese Informationen zu XML, um Folgendes zu finden:
-
XML-Elemente (Tags), die Sie in den Konfigurationsdateien verwenden können. Sie können zum Beispiel <description> nachschlagen. Da Page Methods, Nugget Lists und Search List Declarations Tags mit identischen Namen verwenden, sind sie im Index mit dem Deklarationstyp in Klammern aufgeführt, zum Beispiel:
<description> (Nugget Lists)
<description> (Page Methods)
-
Attribute, die Sie für ein XML-Tag festlegen können. Die Tags, für die ein Attribut gilt, werden unter dem Namen angezeigt. Zum Beispiel kann das Attribut class für drei verschiedene Tags festgelegt werden, daher erscheint es wie folgt:
-
Schlüsselwörter, die Sie beim Festlegen von Tag- oder Attributwerten verwenden können. Diese sind ähnlich wie Attribute formatiert. Zum Beispiel kann das Schlüsselwort modal mit zwei verschiedenen Tags verwendet werden, daher erscheint es wie folgt:
- Nuggets und Nugget-Parameter, die in den verschiedenen Referenzabschnitten behandelt werden. Beachten Sie, dass dieses Handbuch keine vollständige Referenz aller verfügbaren Nuggets bietet, aber häufig verwendete Nuggets werden in den Referenzabschnitten behandelt.
Eingabe von URLs in Application Server-Deklarationen
Mehrere Application Server-Deklarationen erfordern, dass Sie URLs zu anderen Web Client-Seiten eingeben. Zum Beispiel geben Sie in einer Search List Declaration eine URL für die Seite an, die ein Link anzeigen soll.
Um die URL für eine andere Web Client-Seite zu verwenden, geben Sie normalerweise einen Wert wie den folgenden an:
$(PAGE_SERVER)/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All
Dieser Wert setzt sich wie folgt zusammen:
- $(PAGE_SERVER) ist eine Variable, die durch den tatsächlichen Speicherort des Page Servers in Ihrer Umgebung ersetzt wird.
- contact-lists-home ist der Name der Page Method für die anzuzeigende Seite.
- Die übrigen Werte nach dem Fragezeichen (?) sind Parameter, die Informationen an die Seite übergeben. Dies wird als Query String bezeichnet.
Wenn Ihr Application Server zum Beispiel „AppServer1“ heißt, würde die obige URL wie folgt aufgelöst werden:
http://AppServer1/InterAction/contact-lists-home?folderclass=1&
searchdescription=Contact+Types&folderType=All