Sie können die Startseite des Web Client ändern, indem Sie die home-Seitenmethode bearbeiten. Diese Methode ist in der Konfigurationsdatei pages.xml gespeichert, die sich im etc-Verzeichnis der Application Server-Maschine befindet.
Bevor Sie die home-Seitenmethode bearbeiten, sollten Sie sie in die Datei localPages.xml im lokalen Verzeichnis der Application Server-Maschine kopieren. In einer Standardinstallation befindet sich das lokale Verzeichnis unter C:\Program Files\LexisNexis\InterAction\AppServer\iahome\etc\local. Sie müssen nur die home-Seitenmethode kopieren.
Eine vollständige Liste der XML-Tags, die in einer Seitenmethode verwendet werden können, finden Sie unter Übersicht über Seitenmethoden-Deklarationen. Die folgenden Abschnitte zeigen, wie die Tags auf der standardmäßigen Startseite verwendet werden:
- Tags, die die Startseite beginnen
- Spalten der Startseite
- Nuggets auf der Startseite platzieren
- Kopie der Home-Seitenmethode erstellen
- Layout und Nuggets auf der Startseite anpassen
Tags, die die Startseite beginnen
Jede Seitendeklaration benötigt mehrere Anfangstags, um die Seite zu starten und Informationen wie den Titel bereitzustellen. Das Tag, das eine neue Seite beginnt, ist das methodDeclaration Tag. Nach diesem Tag definieren die folgenden zusätzlichen Tags „globale“ Einstellungen für die Startseite:
Alle Seitendeklarationen in einer XML-Konfigurationsdatei müssen innerhalb des declarations Tag verschachtelt sein.
-
Das
methodName Tagdefiniert den Namen der Methode. Für die Startseite ist dies einfach home:<methodName>home</methodName> -
Das
methodAgent Tagdefiniert den Typ der Methode. Für alle Seitenmethoden muss dies auf page gesetzt werden:<methodAgent>page</methodAgent> - Das
methodDescription Tagkann eine Textbeschreibung der Seite enthalten. Diese ist für Endnutzer nicht sichtbar, erscheint aber in der Liste der verfügbaren Seiten im Page Method-Bericht. -
Das
title Tagenthält den Text, der im Titelbereich der Seite und in der Titelleiste des Browserfensters angezeigt werden soll:<title>Home</title>
Es gibt weitere ähnliche Tags für Seitenmethoden – eine Liste aller Tags finden Sie unter Elemente und Attribute für die Deklaration einer Seitenmethode.
Das folgende Codebeispiel zeigt den Anfang der Startseite.
Start der Startseite — XML-Beispiel
<!-- Diese Zeile startet die Deklaration der Startseite. Kopieren Sie diesen gesamten Block bis zum schließenden methodDeclaration-Tag in die localPages.xml und bearbeiten Sie dann diese Version der Seite. -->
<methodDeclaration>
<methodName>home</methodName>
<methodAgent>page</methodAgent>
<methodDescription>
Diese Seite bietet den Nutzern einen Startpunkt beim Anmelden am InterAction Web Client. Die Seite enthält das quickSearch.jsp-Nugget für die schnelle Kontaktsuche und mehrere Instanzen des formatSearchList.jsp-Nuggets, um Links zu anderen Bereichen des Systems anzuzeigen. LexisNexis empfiehlt, diese Seite mit für Ihre Organisation nützlichen Links anzupassen.
</methodDescription>
<!-- Lassen Sie dieses Tag unverändert, um zu verhindern, dass ein Titel oben auf der Seite angezeigt wird -->
<title>Home</title>
<!-- Die restlichen Tags bestimmen das Layout der Abschnitte/Spalten und die Nuggets, die die Seite anzeigt. Siehe Spalten der Startseite.
<\methodDeclaration> <!-- Dies beendet die Seitendeklaration -->
Spalten der Startseite
Die Startseite des Web Client ist in Spalten unterteilt. Eine Spalte kann ein oder mehrere Nuggets enthalten.
Die Startseite hat drei Spalten:
- Die erste Spalte zeigt die Nuggets Erweiterte Suche (quickSearch.jsp) und Suchen nach (formatSearchList.jsp) an.
- Die zweite Spalte zeigt die Nuggets Neu hinzufügen..., Message Center, Anzeigen und Über an. Alle verwenden formatSearchList.jsp, außer Über; dieses verwendet ein Nugget namens about.jsp.
- Die dritte Spalte zeigt das Nugget Schnellreferenz (formatSearchList.jsp) mit häufigen Hilfethemen an.
Im XML-Code der Seitenmethode wird jede Spalte mit dem column Tag definiert. Siehe column Tag für Details.
Das folgende Codebeispiel für die Startseite zeigt dieses Layout. Beachten Sie, dass die Tags zum Einfügen von Nuggets (normalerweise nuggetTag-Tags, die unterhalb der column Tag-Tags verschachtelt sind) zur besseren Lesbarkeit entfernt wurden. Weitere Kommentare zum XML finden Sie in der tatsächlich auf Ihrem Application Server installierten Seitenmethode.
Struktur der Startseite — XML-Beispiel
<!-- Diese Zeile startet die Deklaration der Startseite-->
<methodDeclaration>
<methodName>home</methodName>
<methodAgent>page</methodAgent>
<!--Weitere Tags erscheinen hier-->
<title>Home</title>
<!-- Alle Spalten sind in einem einzigen Abschnitt enthalten -->
<section isHeader="true" topSpacing="false">
<!-- Dies ist die erste Spalte-->
<column width="31%">
<!-- Tags zur Definition der anzuzeigenden Nuggets würden hier eingefügt -->
</column>
<!-- Dies ist die zweite Spalte -->
<column width="31%">
<!-- Tags zur Definition der anzuzeigenden Nuggets würden hier eingefügt -->
</column>
<!-- Dies ist die letzte Spalte -->
<column width="35%">
<!-- Tags zur Definition der anzuzeigenden Nuggets würden hier eingefügt -->
</column>
</section>
<!--
Ein zusätzlicher Abschnitt, der für die korrekte Funktionalität nach den Spalten erforderlich ist
-->
</methodDeclaration>
Wenn Sie das gesamte Layout ändern möchten, passen Sie die column Tag-Blöcke entsprechend an. Wenn Sie zusätzliche Nuggets hinzufügen möchten, können Sie diese zu den bestehenden Spalten hinzufügen oder weitere Spalten für die Nuggets anlegen.
Nuggets auf der Startseite platzieren
Sie definieren Nuggets mit dem nugget Tag. Siehe nugget Tag für Details.
Das nugget Tag identifiziert Folgendes:
- Den Speicherort des Nuggets, das Sie platzieren möchten. Dies ist im Wesentlichen die URL Ihres Nugget-Servers. Sie legen dies mit dem Attribut
baseUrlfest. Sie können die Variable $(NUGGET_SERVER) verwenden, um die URL Ihres Nugget-Servers automatisch einzufügen. - Den Dateinamen des Nuggets, das Sie platzieren möchten (meist eine JSP-Datei). Dies wird mit dem Attribut methodName festgelegt.
- Optionen für das Erscheinungsbild des Nuggets, wie Überschrift und Kopfzeilenbild. Sie können hierfür die Attribute
headerundheaderImageverwenden; weitere Attribute finden Sie unter nugget Tag. - Eine Beschreibung des Zwecks des Nuggets. Dies wird mit dem
description Tagfestgelegt. - Alle Parameterwerte, die an das Nugget übergeben werden sollen. Diese werden über das verschachtelte
parameters Taginnerhalb des nugget Tag übergeben. Weitere Informationen finden Sie unter parameters Tag.
Zum Beispiel platziert das folgende Codebeispiel die beiden Nuggets in der ersten Spalte der Startseite:
- Das „Schnellsuche“-Nugget hat den Überschriftentext „Erweiterte Suche“. Es verwendet die Nugget-Datei quickSearch.jsp und übergibt keine Parameter.
- Das „Suchlisten“-Nugget hat den Überschriftentext „Suchen nach...“. Es verwendet die Nugget-Datei formatSearchList.jsp und übergibt drei Parameter – searchListId, columns und userName. Der Parameter searchListId identifiziert die Suchlistendeklaration, die die anzuzeigenden Links definiert. Die Bearbeitung der Suchlistendeklarationen der Startseite wird unter Adding Links to the Web Client Home Page behandelt.
Wenn Sie ein weiteres Nugget zur ersten Spalte „Häufige Aktionen“ hinzufügen möchten, fügen Sie den Code direkt nach dem schließenden Tag des Suchlisten-Nuggets ein, wie im Beispiel gezeigt.
Beachten Sie, dass der XML-Code hier umgebrochen dargestellt wird; normalerweise steht jedes Tag in einer eigenen Zeile.
Nuggets auf der Startseite platzieren — XML-Beispiel
<!-- Diese Spalte enthält zwei Nuggets. Das quickSearch.jsp-Nugget zeigt das Suchformular „Kontakt finden“ an. Das searchList.jsp-Nugget zeigt die Links an, die in der Suchlistendeklaration mit der ID „home-search“ definiert sind. Um diese Links zu ändern, bearbeiten Sie die Suchliste „home-search“. -->
<column width="31%">
<nugget topSpacing="false" margin="true" headerImage="$(IMAGE_URL)/icon-h-search.gif" header="Erweiterte Suche" borders="true" baseUrl="$(NUGGET_SERVER)" methodName="quickSearch.jsp">
<description>Nugget zur Anzeige eines Schnellsuche-Formulars</description>
</nugget>
<nugget topSpacing="true" margin="true" headerImage="$(IMAGE_URL)/icon-h-search.gif" header="Suchen nach..." baseUrl="$(NUGGET_SERVER)" borders="true" methodName="formatSearchList.jsp">
<description>Links zu anderen häufigen Suchformularen anzeigen</description>
<parameters>
<field id="searchListId" force="home-search"/>
<field id="columns" force="2"/>
<field id="userName"/>
</parameters>
</nugget>
<!-- Wenn Sie hier ein neues <nugget>-Tag hinzufügen, wird direkt nach dem Suchlisten-Nugget ein drittes Nugget eingefügt -->
</column>
Auf der Startseite verwendete Nuggets
Die Standard-Startseite des Web Client verwendet drei Nuggets:
Hinweis: Beachten Sie, dass eine Seite mehrere Instanzen desselben Nuggets enthalten kann.
- Das
quickSearch.jsp-Nugget zeigt ein einfaches Suchformular zur Kontaktsuche an. - Das
formatSearchList.jsp-Nugget zeigt eine Reihe von Links an, die in einer separaten Suchlistendeklaration definiert sind. Die Links werden als Aufzählungsliste dargestellt. - Das
about.jsp-Nugget zeigt Versionsinformationen an.
Die meisten Änderungen, die Sie auf der Startseite vornehmen, betreffen die Verwendung dieser Nuggets. Sie können den Bericht „Nugget Declarations“ nutzen, um Details und Parameter zu diesen Nuggets zu erhalten. Weitere Informationen finden Sie unter Seitendeklarationen und Nuggets.
Kopie der Home-Seitenmethode erstellen
Beachten Sie, dass Sie dieses Vorgehen nur einmal durchführen müssen, bevor Sie irgendwelche Änderungen an der Startseite vornehmen.
-
Suchen Sie auf Ihrer InterAction Application Server-Maschine das etc-Verzeichnis. In einer Standardinstallation ist dies normalerweise:
C:\Program Files\LexisNexis\InterAction\AppServer\iahome\etc
- Öffnen Sie im etc-Verzeichnis die Datei pages.xml in einem XML-Editor.
-
Suchen Sie die Zeilen, die die Deklaration der Startseite beginnen. Diese sehen wie folgt aus:
<!-- Diese Zeile startet die Deklaration der Startseite. Kopieren Sie diesen gesamten Block bis zum schließenden methodDeclaration-Tag in die localPages.xml und bearbeiten Sie dann diese Version der Seite. -->
<methodDeclaration>
<methodName>home</methodName>
- Kopieren Sie ab der oben genannten Zeile den gesamten Block des XML-Codes für die Seite. Die Seitendeklaration endet mit dem Tag
<\methodDeclaration>. - Öffnen Sie die Datei
localPages.xmlund fügen Sie die Menüdeklaration nach dem öffnenden<declarations>-Tag ein. - Aktualisieren Sie diese kopierte Version der Startseitendeklaration mit Ihren Änderungen.
Layout und Nuggets auf der Startseite anpassen
- Falls noch nicht geschehen, erstellen Sie eine Kopie der Startseitendeklaration wie unter Kopie der Startseiten-Methode erstellen beschrieben.
- Öffnen Sie die Datei
localPages.xmlin einem XML-Editor. - Suchen Sie die Startseitendeklaration. Wie der Anfang der Deklaration aussieht, erfahren Sie unter Tags, die die Startseite einleiten.
- Passen Sie die Tags nach Bedarf an. Sie können neue Bereiche oder Spalten hinzufügen, die vorhandenen Nuggets umsortieren oder neue Nuggets ergänzen.
- Das mitgelieferte XML für die Startseite enthält mehrere Kommentare (eingeschlossen zwischen <!-- und --> Tags). Diese helfen Ihnen dabei, zu erkennen, wo Sie Code hinzufügen oder ändern können.
- Weitere Informationen zu Spalten finden Sie unter Startseitenspalten.
- Details zu den Tags für Nuggets finden Sie unter Nuggets auf der Startseite platzieren.
- Eine vollständige Referenz zu den Tags, die Sie in einer Seitenmethode verwenden können, finden Sie unter XML-Referenz für Seitenmethoden-Deklarationen.
- Wenn Sie fertig sind, speichern Sie die Datei
localPages.xml. Ihre Änderungen werden nach der nächsten Aktualisierung der Deklaration im Web Client angezeigt.