Dynamische Stichwortlisten

Transkript

1 Dynamische Stichwortlisten [Stand: Programmversion: ] In diesem Dokument wird die client-übergreifende Handhabung und das Scripting für dynamische Stichwortlisten erklärt. Hinweis: Die Erweiterung von dynamischen Stichwortlisten für Map-Felder ist noch nicht veröffentlicht. Inhalt 1 Einführung Motivation Grundidee Verwendung Indexserver Besonderheiten Konfiguration in der Verschlagwortungsmaske im ELOwf Verwendung aus Maskendefinition wie in anderen Clients Verwendung von dynamischen Stichwortlisten für Map-Felder (nicht veröffentlicht)... 7 ELO Digital Office GmbH 1

2 1 Einführung 1.1 Motivation Eine der meist gescripteten Komponenten in den Rich-Clients ist die Verschlagwortung. Hier sollen automatisch Werte gesetzt und Stichwortlisten angepasst werden. Gängige Use-Cases sind: Filtern anhand vorheriger Werte: Ein Benutzer füllt eine Indexzeile aus und soll für eine zweite eine Stichwortliste angezeigt bekommen, die je nach dem Eingabewert der ersten angepasst ist. Beispiel: Der Benutzer wählt eine Niederlassung anhand einer Stichwortliste und soll im zweiten Feld eine Liste der Mitarbeiter aus der gewählten Niederlassung bekommen. Dynamisch Stichwortlisten: Der Benutzer ruft eine Stichwortliste auf, die sich aus Werten in einer Datenbank dynamisch zusammensetzt. Beispiel: Der Benutzer bekommt eine Auswahl der aktuell offenen Projekte geliefert. Bulk Einträge: Wählt der Benutzer in einer Indexzeile einen bestimmten Wert aus, sollen weitere Indexzeilen mit zusammenhängenden Werten gefüllt werden. Beispiel: Der Benutzer wählt aus einer Liste einen Kundennamen aus und die Felder Kundennummer, Adresse usw. werden entsprechend gefüllt. 1.2 Grundidee Beim Öffnen einer Stichwortliste werden die Daten dynamisch zusammengestellt und zurückgeliefert. Ein solcher Datensatz kann man sich als Tabelle vorstellen, wobei die erste Spalte dem Benutzer zur Auswahl präsentiert wird (diese enthält also für den Benutzer lesbare Werte). Optional kann die Tabelle weitere Spalten besitzen wobei deren Spaltennamen, Gruppennamen der offenen Verschlagwortungsmaske sind, und die Werte dann gültige Werte für die Indexzeilen mit dem entsprechenden Gruppennamen. Trifft ein Benutzer eine Auswahl wird die Reihe der Tabelle in die Verschlagwortungsmaske eingegeben. ELO Digital Office GmbH 2

3 2 Verwendung Um eine dynamische Stichwortliste zu verwenden muss ein Indexserver Script geschrieben werden, dass die Daten vom Client auswertet, filtert und eine Treffermenge zur Verfügung stellt. Das Indexserver Script muss in der Maskendefinition für die Verschlagwortungszeile konfiguriert werden. Für den Einsatz im ELOwf kann eine dynamische Stichwortliste auch auf Basis von Map- Feldern agieren. 2.1 Indexserver Wird eine dynamische Stichwortliste im Client aufgerufen (der Benutzer startet eine Eingabe in dem Entsprechenden Feld der Verschlagwortung oder klickt auf den Button der dynamischen Stichwortliste wird die aktuell im Dialog stehende Verschlagwortung und das aktive Feld an den Indexserver gesendet. Dieser übergibt die Daten an ein in der Maskendefinition konfigurierten Script. Das Script muss im Ordner Administration des ELO Archivs abgelegt werden (siehe Dokumentation Indexserver Scripting). Der Aufbau eines Scripts für eine dynamische Stichwortliste sieht wie folgt aus: importpackage(packages.de.elo.ix.jscript); importpackage(packages.de.elo.ix.scripting); function getdataiterator() { try { log.info("getdataiterator(mydynamickeywordscript "); return new DynamicKeywordDataProvider(new MyDynamicKeywordScript()); } finally { log.info(")getdataiterator"); } } function MyDynamicKeywordScript () { this.open = function(ec, sord, groupname) {...} this.openmap = function(ec, map, focusname) {...} this.getkeynames = function() {...} this.getheader = function() {...} this.gettitle = function() {...} this.hasmorerows = function() {...} this.getnextrow = function() {...} this.getmessage = function() {...} this.close = function() {...} } ELO Digital Office GmbH 3

4 Der Indexserver ruft die Funktion getdataiterator auf. Diese liefert die Instanz eines DynamicKeywordDataProvider zurück. DynamicKeywordDataProvider ist eine Interface-Klasse die in ihrem Konstruktor die Instanz einer Implementierungsklasse erwartet. Die Implementierungsklasse (hier MyDynamicKeywordScript) muss folgende Methoden implementieren: open(ec, sord, groupname): Diese Methode wird mit den Daten aus dem Client aufgerufen. Das Objekt ec ist ein ScriptExecContext (weitere Informationen dazu finden sie in der Dokumentation über Indexserver Scripting). Das Objekt sord enthält die aktuell in der Verschlagwortung stehenden Sord-Information, die der Client beim Aufrufen der dynamische Stichwortliste übergeben hat. Der String groupname bezieht sich auf die Indexzeile, für die die dynamische Stichwortliste aufgerufen wurde. In dieser Methode wird die Hauptarbeit erledigt. Die Daten aus dem Sord können als Filter ausgelesen werden, eine Datenbankanfrage könnte entsprechende Daten sammeln. this.openmap = function(ec, map, focusname): Diese Methode ist für den alternativen Gebrauch der dynamischen Stichwortlisten für Map-Felder bestimmt (derzeit ausschließlich im ELOwf eingesetzt). Hier wird anstelle des Sord Objekts ein JavaScript Objekt map übergeben in dem beliebige Mapfelder oder Indexfelder stecken können (siehe unten). Der String focusname gibt anstelle des Gruppennamen an, welches Feld im Formular die dynamische Stichwortliste angefragt hat. Sowohl die Map-Keys als auch focusname kann sich wie folgt zusammensetzen: Beginnt er mit IX_MAP_ bezieht er sich auf einen Key in der Map des Sord Objektes, beginnt er mit WF_MAP_ bezieht er sich auf ein einen Key in der Map des Workflows, ansonsten auf einen Gruppennamen in der Maskendefinition des Sord Objektes. (Theoretisch können auch beliebige andere Werte in der Map mitgesendet werden. Der Zweck dieser Methode ist ansonsten gleich dem von open. getkeynames: Diese Methode verlangt als Rückgabewert ein String-Array in dem die Gruppennamen der einzelnen Tabellenspalten stehen. Für den Einsatz von dynamischen Stichwortlisten über Map Feldern (derzeit ausschließlich im ELOwf eingesetzt) können als Rückgabewert auch IX_MAP_<name> und WF_MAP_<name> verwendet werden. Im Formular werden die Werte mit diesen Namen dann in die Sord- bzw. Workflow-Map eingetragen (Beispiel: IX_MAP_KTO3 füllt den Wert in der Sord-Map mit dem Key KTO3). getheader: Diese Methode verlangt als Rückgabewert ein String-Array mit den Namen der Tabellenspalten. Diese werden dem Benutzer angezeigt. Zu beachten ist, dass die Länge des Arrays mit der Länge aus getkeynames übereinstimmen muss. gettitle: Diese Methode liefert einen String zurück, der den Inhalt der Tabelle benennt (z.b: Kunden, Rechnungspositionen, Niederlassungen o.ä.) Dieser Name wird derzeit ausschließlich im Java Client angezeigt und besitzt keine weitere Funktion. ELO Digital Office GmbH 4

5 hasmorerows: Diese Methode erwartet einen booleschen Rückgabewert. Solange true zurückgegeben wird, wird die Tabelle mit getnextrow erweitert. getnextrow: Diese Methode liefert ein String-Array mit den Werten aus einer Tabellenzeile zurück. getmessage: Falls ein Fehler auftritt oder der Benutzer die Stichwortliste falsch verwendet (z.b.: falls der Benutzer zuerst eine andere Zeile in der Verschlagwortung füllen soll, über die dann in der dynamischen Stichwortliste gefiltert werden muss oder die anderweitig benötigt wird) kann hier eine Textnachricht zurückgegeben werden. Die Datentabelle wird dann verworfen und die Nachricht wird im Client angezeigt. close: Diese Methode wird aufgerufen, nachdem die komplette Stichwortliste abgeholt wurde. Hier können noch offene Datenverbindungen geschlossen werden Besonderheiten Um eine Spalte in der Tabelle anzuzeigen, ohne dass diese eine Repräsentation in der Verschlagwortung besitzt kann für die Spalte der Key-Name mit null ausgegeben werden. Umgekehrt um eine Indexzeile zu füllen, ohne dass der Wert als Spalte in der Tabelle dem ELO Digital Office GmbH 5

6 Benutzer angezeigt wird, kann an dem entsprechenden Index der Header-Name mit null ausgegeben werden. 2.2 Konfiguration in der Verschlagwortungsmaske Das Indexserver Script muss in der Indexzeile der Maskendefinition angegeben werden. Der Name ergibt sich über die Kurzbezeichnung des Scriptes in der Indexserver Scripting Base. Tragen sie in der AdminConsole den Scriptnamen in das Feld Dynamische Stichwortliste ein. 2.3 im ELOwf Verwendung aus Maskendefinition wie in anderen Clients Im ELOwf können dynamische Stichwortlisten für die Verschlagwortung wie in anderen Clients verwendet werden. Dazu muss das Eingabefeld wie mit einer normalen Stichwortliste konfiguriert und der Gruppenname als Listenname verwendet werden. Voraussetzung hierfür ist wie bei den anderen Clients die Konfiguration des Scriptes in der Indexzeile der Maskendefinition (siehe oben). ELO Digital Office GmbH 6

7 Wird solch ein Feld im Formular verwendet, sendet dieses wie andere Clients die aktuelle Verschlagwortung aus dem Formular als Sord an den Server und bekommt eine Tabelle mit Werten für einzelne Indexzeilen Verwendung von dynamischen Stichwortlisten für Map-Felder (nicht veröffentlicht) Im ELOwf können zusätzlich zur herkömmlichen Anwendung dynamische Stichwortlisten auch für Mapfelder definiert werden. Der Variablenname wird als focusname an das Indexserver Script übergeben, sobald die dynamische Stichwortliste für dieses Feld aufgerufen wird. Als Stichwortliste muss Dynamic Keyword Map verwendet werden. Es erscheinen die Felder Skriptname und Filter. In Skriptname wird der Name (Kurzbezeichnung des Indexserver Scriptes eingesetzt (bitte beachten Sie dass in diesem Fall die Methode openmap im Script aufgerufen wird. Unter Filter können alle Felder eingetragen werden, die beim Aufrufen der dynamischen Stichwortliste in die Map übernommen und an das Script übergeben werden sollen. Auch hier gilt das Namensschema mit IX_MAP_ und WF_MAP_ für die Map Felder, sowie ELO_PARAMS_ um Werte aus dem statischen ELO_PARAMS Objekt zu übertragen (z.b: ELO_PARAMS_ELO_OBJID überträgt die Objekt-Id des Eintrages). Die Map wird ohne Änderungen als Objekt map an das Script übergeben. ELO Digital Office GmbH 7

8 Beim Aufrufen der dynamischen Stichwortliste wird das fokussierte Eingabefeld als focusname und die Map mit allen in Filter definierten Feldern inklusive dem fokussierten Feld als map übergeben Besonderheiten Für die Funktionalität JS_ADDLINE können im Filterfeld Platzhalter {i} für den Index eingetragen werden. In diesem Fall wird beim Aufruf der dynamischen Indexzeile der Index des Fokusfeldes ausgelesen und anstelle des Platzhalters gesetzt. Wird im obigen Bild zum Beispiel für die 4. Spalte die dynamische Stichwortliste im Feld IX_MAP_KST4 aufgerufen, wird IX_MAP_KST4 als focusname an das Script übergeben. In der Map werden die Werte für IX_MAP_BEZ4 und IX_MAP_KTO4 sowie der Wert des fokussierten Feldes (IX_MAP_KST4) übergeben. Ebenfalls kann über den Platzhalter {*} alle Indexfelder an die Map übergeben werden. Als Beispiel wird im Filter IX_MAP_KTO{*} definiert und die dynamische Indexzeile von Feld IX_MAP_KST4 aufgerufen werden für alle existierenden JS_ADDLINE Zeilen das Feld IX_MAP_KTO übertragen, also IX_MAP_BEZ1, IX_MAP_BEZ2, usw. ELO Digital Office GmbH 8