Anfang des InhaltsbereichsHintergrunddokumentation Suchhilfe-Exit Dokument im Navigationsbaum lokalisieren

Eine Suchhilfe beschreibt den Standardablauf einer Eingabehilfe. In Ausnahmefällen kann es notwendig sein, von diesem Standard in einigen Punkten abzuweichen. Eine solche Abweichung vom Standard kann über ein Suchhilfe-Exit realisiert werden.

Hinweis

Der Ablauf der Eingabehilfe sollte sich dem Endbenutzer systemweit möglichst eindeutig präsentieren. Deshalb sollten Suchhilfe-Exits nur in Ausnahmefällen verwendet werden!

Ein Suchhilfe-Exit ist ein Funktionsbaustein, der eine vordefinierte Schnittstelle besitzt. Ein Suchhilfe-Exit wird vom Hilfeprozessor zu festgesetzten Zeitpunkten aufgerufen. Über die Schnittstelle werden dem Suchhilfe-Exit dabei die Verwaltungsdaten des Hilfeprozessors übergeben.

Im Suchhilfe-Exit kann eigene Programmlogik hinterlegt werden, die diese Verwaltungsdaten manipuliert. Über ein Suchhilfe-Exit können auch einzelne Schritte des Ablaufs der Eingabehilfe übersprungen werden.

Beispiel

Das Suchhilfe-Exit F4UT_OPTIMIZE_COLWIDTH paßt die Spaltenbreiten auf der Trefferliste an den Spalteninhalt an. Der Einsatz dieses Suchhilfe-Exits ist sinnvoll, wenn die Spalten der Trefferliste für extreme Fälle sehr breit angelegt werden müssen (z.B. für Namensfelder), in der Regel aber mit deutlich kürzeren Werten gefüllt sind.

Jedes Suchhilfe-Exit muß die gleiche Schnittstelle wie der Funktionsbaustein F4IF_SHLP_EXIT_EXAMPLE (dient als Muster für alle anzulegenden Suchhilfe-Exits) besitzen. Genauere Informationen zur Schnittstelle können Sie der Dokumentation dieses Funktionsbausteins entnehmen.

Aufruf des Suchhilfe-Exits

Ist einer Suchhilfe ein Suchhilfe-Exit zugeordnet, so wird dieses zu folgenden Zeitpunkten vom Hilfeprozessor aufgerufen:

Vor der Anzeige des Dialogfensters zur Auswahl des gewünschten Suchpfades.

Der Aufruf erfolgt nur für Sammelsuchhilfen. Über das Suchhilfe-Exit kann hier z.B. die Menge der zur Verfügung stehenden elementaren Suchhilfen kontextsensitiv eingeschränkt werden.

Vor dem Start des F4-Ablaufs für die elementare Suchhilfe

Der Aufruf erfolgt unabhängig davon, ob das Dialogfenster zur Eingabe der Suchbedingungen erscheint oder ob sofort selektiert wird (z.B. weil bei der Kurzanwahl der elementaren Suchhilfe Sofortige Werteanzeige eingestellt ist).

Vor der Anzeige des Dialogfensters zur Eingabe der Suchbedingungen.

Hier kann der Dialog zur Eingabe der Suchbedingungen entweder beeinflußt oder ganz übersprungen werden. Es ist auch möglich, das Aussehen des Selektionsbildes zu beeinflussen. Der Aufruf erfolgt nur, wenn nicht direkt selektiert wird (d.h. bei der Kurzanwahl der elementaren Suchhilfe nicht Sofortige Werteanzeige eingestellt ist).

Vor der Datenselektion.

Die Datenselektion kann teilweise oder vollständig vom Suchhilfe-Exit übernommen werden. Dies kann notwendig sein, falls die Datenselektion nicht über ein SELECT-Statement auf eine Tabelle oder einen View realisiert werden kann.

Vor der Anzeige der Trefferliste.

Die Anzeige der Trefferliste kann in diesem Schritt durch den Suchhilfe-Exit beeinflußt werden. Hier kann die Menge der angezeigten Werte reduziert werden. Beispielsweise können nur die Werte angezeigt werden, für die der Aufrufer der Eingabehilfe eine Berechtigung besitzt. Die Anzeige der Trefferliste kann aber auch vollständig vom Suchhilfe-Exit übernommen werden.

Vor dem Zurückstellen der vom Benutzer gewählten Werte in die Eingabemaske.

Ein Eingriff zu diesem Zeitpunkt kann sinnvoll sein, wenn die Steuerung des weiteren Ablaufs der Transaktion vom gewählten Wert abhängig gemacht werden soll. Ein typisches Beispiel ist das Setzen von Set-/Get-Parametern.

Beispiel

Die Suchhilfe SFLIGHT dient zur Suche nach Flugdaten. Mitarbeiter in Reisebüros benötigen in der Regel bei der Suche nach Flügen auch eine Information darüber, ob auf dem entsprechenden Flug noch Plätze frei sind. Diese Information ist in der Selektionsmethode der Suchhilfe (View über die Tabellen SCARR, SFLIGHT und SPFLI) nicht direkt enthalten. Die Selektionsmethode enthält lediglich die Informationen, wie viele Plätze auf dem Flug zur Verfügung stehen und wie viele Plätze schon belegt sind.

Das Suchhilfe-Exit SAPBC_GLOBAL_F4_SFLIGHT berechnet aus diesen Informationen die noch freien Plätze und stellt das Resultat in einen Parameter der Suchhilfe zurück. Damit kann die Anzahl der noch freien Plätze dann auf der Trefferliste dargestellt werden.

Im Suchhilfe-Exit muß also nur eine Aktion für den Aufruf vor dem Anzeigen der Trefferliste programmiert werden.

Diese Grafik wird im zugehörigen Text erklärt

Im Ablauf der Eingabehilfe wird zu einem Zeitpunkt zuerst das Suchhilfe-Exit aufgerufen, dann wird die Verarbeitung zu diesem Zeitpunkt ausgeführt und danach der Folgeschritt bestimmt. Wenn innerhalb des Suchhilfe-Exits ein neuer Folgeschritt bestimmt wird, wird für diesen Folgeschritt das Suchhilfe-Exit also nicht erneut aufgerufen.

Ende des Inhaltsbereichs