Show TOC

 Suchhilfe-ExitLocate this document in the navigation structure

Verwendung

Eine Suchhilfe beschreibt den Standardablauf einer Eingabehilfe. In Ausnahmefällen kann es notwendig sein, von diesem Standard in einigen Punkten abzuweichen. Über ein Suchhilfe-Exit implementieren Sie eine solche Abweichung.

Achtung

Der Ablauf der Eingabehilfe muss sich dem Endbenutzer systemweit möglichst eindeutig präsentieren. Aus diesem Grund dürfen Suchhilfe-Exits nur für Ausnahmen verwendet werden.

Funktionsumfang

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.

Tipp

Das Suchhilfe-Exit F4UT_OPTIMIZE_COLWIDTH passt 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), aber mit deutlich kürzeren Werten gefüllt sind.

Achtung

Jedes Suchhilfe-Exit muss 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.

Suchhilfe-Exit aufrufen

Ist einer Suchhilfe ein Suchhilfe-Exit zugeordnet, 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 kontextabhängig eingeschränkt werden.

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

    Der Aufruf wird unabhängig davon ausgelöst, ob das Dialogfenster zur Eingabe der Suchbedingungen erscheint oder die Auswahl sofort ausgeführt wird (z. B. wenn in 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 beeinflusst oder ganz übersprungen werden. Es ist auch möglich, das Aussehen des Selektionsbildes zu beeinflussen. Der Aufruf wird nur ausgelöst, wenn keine direkte Selektion vorhanden ist, d. h., wenn in 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 ist notwendig, falls die Datenselektion nicht über eine SELECT-Anweisung 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 beeinflusst 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 ist sinnvoll, wenn die Steuerung des weiteren Ablaufs der Transaktion vom gewählten Wert abhängen muss. Ein typisches Beispiel ist das Setzen von Set-/Get-Parametern.

Im Ablauf der Eingabehilfe wird zuerst das Suchhilfe-Exit für diese Ereignis aufgerufen, danach die Bearbeitung des Ereignisses durchgeführt und erst dann der nächste Schritt ermittelt. Wenn innerhalb des Suchhilfe-Exits ein neuer, nächster Schritt ermittelt wurde, wird das Suchhilfe-Exit für diesen Schritt nicht noch einmal aufgerufen.

Beispiel

Die Suchhilfe SFLIGHT dient der Suche nach Flugdaten. Mitarbeiter in Reisebüros benötigen bei der Suche nach Flügen Informationen über freie Plätze auf dem entsprechenden Flug. Diese Informationen sind in der Selektionsmethode der Suchhilfe (View der 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 muss nur eine Aktion für den Aufruf vor dem Anzeigen der Trefferliste programmiert werden.

Die folgende Abbildung zeigt den Funktionsumfang des Suchhilfe-Exits. Sie sehen die Reihenfolge der verschiedenen Schritte, die bei der Verwendung eines Suchhilfe-Exits ausgeführt werden.