1 Themenübersicht
Die Anwendung „Entwicklungsobjekte“ dient der Erfassung und Ansicht von Entwicklungsobjekten verschiedenster Typen. In dieser Dokumentation wird der Typ „Sucherweiterung“ beschrieben.
Allgemeine Informationen zur Anwendung „Entwicklungsobjekte“, beispielsweise die Beschreibung der anwendungsbezogenen Aktionen oder des Identifikationsbereichs, finden Sie in dieser Dokumentation „Entwicklungsobjekte“.
2 Beschreibung
Feld „Suche“
Geben Sie den vollqualifizierten Namen der Suche ein, die durch die Sucherweiterung erweitert wird.
Die Suche darf nicht auf dem Entwicklungssystem entstanden sein, auf dem Sie die Sucherweiterung erfassen. aus einer anderen App stammen, sofern diese App referenziert werden darf.
Präfix
Da auf Folgesystemen mehrere Sucherweiterungen für eine Suche gelten können, müssen die Aliasdefinitionen eindeutig sein. Daher ist das Präfix für Aliasnamen von Business Objects und für Attributnamen vorgegeben.
Auf Entwicklungssystemen entspricht das Präfix dem Entwicklungspräfix des Systems. Auf App-Entwicklungsystemen besteht das Präfix aus dem Entwicklungspräfix und dem Namen der App.
Beispiel:
TCDV_: ein Entwicklungsystem mit dem Entwicklungspäfix TCDV
TCDV_APP1_: ein App-Entwicklungssystem mit dem Entwicklungspräfix TCDV; die Sucherweiterung gehört zu der App „APP1“.
2.1 Unterer Karteireiter „From“
Unter dem Karteireiter „From“ können Sie für die Sucherweiterung Business Objects und OQL-Views und deren Beziehungen untereinander definieren. Die Definition muss sich mit einem REMOVABLE LEFT JOIN an die Definition der zugrunde liegenden Suche anschließen. Jedes Objekt muss über einen eindeutigen Alias referenziert werden.
Folgende Felder stehen zur Verfügung:
Feld | Erläuterung |
REMOVABLE LEFT JOIN | Sie können für eine Sucherweiterung eigene Business Objects oder OQL-Views definieren. Geben Sie dazu die Definition der Business Objects oder der OQL-Views in diesem Feld ein.
Die Sucherweiterung wird in den Verwendungsnachweis der verwendeten Business Objects und OQL-Views aufgenommen. Stellen Sie sicher, dass sich die Definition mit REMOVABLE LEFT JOIN an die FROM-Klausel der zugrunde liegenden Suche anschliessen lässt. |
FROM | Dieses Feld zeigt die Definition der FROM-Klausel der zugrunde liegenden Suche an. Die FROM-Klausel enthält die beteiligen Business Objects und OQL-Views und deren Beziehungen untereinander. Diese Beziehungen werden als JOIN ausgedrückt. |
2.2 Unterer Karteireiter „Attribute“
Unter dem Karteireiter „Attribute“ können Sie in einer Liste diejenigen Attribute aus den verwendeten Business Objects und OQL-Views angeben, die in einem anpassbaren Cockpit zur Verfügung stehen sollen.
Sie können die Attribute manuell hinzufügen oder die Aktion „Attribute auswählen“ verwenden. Weitere Informationen zu dieser Aktion finden Sie im Abschnitt „Aktion „Attribute auswählen““.
In der Liste stehen die folgenden Spalten zur Verfügung:
Spalte | Erläuterung |
Name | Geben Sie einen Namen für das Attribut ein. Der Name muss mit dem vorgegebenen Präfix beginnen. Der Name muss innerhalb der Sucherweiterung eindeutig sein und dient als Identifikation für den Zugriff auf die Attribute einer Suche.
Soll ein Attribut zu einem virtuellen Attribut gehören, muss das Attribut mit dem Namen des virtuellen Attributs, gefolgt von einem Punkt, beginnen. |
Ausdruck | Geben Sie ein Attribut eines Business Objects oder eines OQL-Views aus der FROM-Klausel der Sucherweiterung oder der zugrunde liegenden Suche ein oder geben Sie einen von der Datenbank zu berechnenden Ausdruck ein, der ein oder mehrere solcher Attribute verwendet. Der Name eines Attributs muss über den angegebenen Alias referenziert werden und der Syntax „Alias:Attributname“ folgen.
Der zu berechnende Ausdruck darf nur die OQL-Aggregatfunktionen UPPER, AVG, MAX, MIN, SUM, COUNT, die Operatoren „*“, „/“, „+“, „-“ und Attribute enthalten. Alle Operanden müssen denselben Typ haben, d. h. entweder sind alle Operanden Funktionen oder Attribute. Das Argument einer Funktion darf nur aus einem Attribut bestehen. Beispiele für berechnete Ausdrücke: boAlias1:attr1 + boAlias1:attr2 Sum(boAlias1:attr1) – SUM(boAlias2:attr1) Wenn das Attribut als Business Object gekennzeichnet ist, dann können Sie den Attributnamen ggf. weglassen. Wenn das Attribut als virtuell gekennzeichnet ist, dann dürfen Sie keinen Ausdruck angeben. Die verwendeten Attribute werden in den Verwendungsnachweis des Business Objects oder des OQL-Views aufgenommen. |
Virtuell | Attribute können gruppiert werden, d. h. mehrere Attribute können unter einem Attribut zusammengefasst werden. Dieses zusammenfassende Attribut muss als virtuell gekennzeichnet werden. Ein virtuelles Attribut besitzt keinen Bezug zu einem Attribut eines Business Objects oder eines OQL-Views auf der Datenbank und hat deshalb auch keinen Ausdruck eingetragen. Die Attribute, die zu einem virtuellen Attribut gehören, müssen mit dem Namen des virtuellen Attributs, gefolgt von einem Punkt, beginnen.
Wird ein virtuelles Attribut als sortierbar gekennzeichnet, so muss genau ein Attribut der Gruppe als sortierbar gekennzeichnet sein. Nach diesem Attribut wird stellvertretend für das virtuelle Attribut sortiert. Wenn ein virtuelles Attribut als filterbar gekennzeichnet ist, so muss mindestens ein Attribut der Gruppe ebenfalls als filterbar gekennzeichnet sein. Es werden nur die Attribute für die Einschränkung der Datenbankanfrage verwendet, die in der Gruppe als filterbar gekennzeichnet sind,. Weitere Attribute der Gruppe werden nicht verwendet. Gleiches gilt für die Kennzeichnung eines Attributs als anzeigbar. Sie müssen mindestens ein Attribut der Gruppe als anzeigbar kennzeichnen. Nur die so gekennzeichneten Attribute werden, bei Verwendung des virtuellen Attributes in der Anzeige, in die Rückgabemenge der Datenbankanfrage aufgenommen. Für ein virtuelles Attribut müssen Sie einen logischen Datentyp eingeben, über den eine Data-Description ermittelt werden kann, die einen Editor und/oder Renderer für die Visualisierung bereitstellt. Eine Schachtelung von virtuellen Attributen ist nicht möglich. Ein virtuelles Attribut kann nicht als Business Object oder als programmierter Filter gekennzeichnet sein. |
Business Object | Wenn ein Attribut als Business Object gekennzeichnet ist, so wird in einem anpassbaren Cockpit auf diesem Attribut die Link-Funktion sichtbar. Das Kontextmenü wird bezogen auf das referenzierte Business Object erstellt. Dadurch kann ein Kontextmenü auf einem beliebigen Attribut des Business Objects erstellt werden.
Darüber hinaus gelten folgende Regeln und Einschränkungen, wenn ein Attribut als Business Object gekennzeichnet wird: · Das Attribut kann in der Abfrage „objektwertig“ behandelt werden: Neben der Möglichkeit den Wert des Attributes abzufragen, kann auch das ganze Business Object abgefragt werden. · Der verwendete Ausdruck kann auf den Alias reduziert werden. In diesem Fall kann nur das Objekt abgefragt werden. Dies hat allerdings Einfluss auf die anderen Eigenschaften des Attributes: das Attribut kann dann nicht als filterbar oder sortierbar gekennzeichnet werden. Wenn das Attribut zudem als anzeigbar gekennzeichnet ist, dann muss ein logischer Datentyp angegeben werden. Dieser sollte auf eine Data-Description verweisen, die einen Renderer eingetragen hat. · Innerhalb eines virtuellen Attributes ist es nicht notwendig, einen logischen Datentyp einzutragen, da das virtuelle Attribut für die Visualisierung verantwortlich ist. · Das Attribut kann nicht zusätzlich als virtuell oder als programmierter Filter gekennzeichnet sein. |
Programmierter Filter | In einer Sucherweiterung kann kein Attribut als programmierter Filter gekennzeichnet werden. |
Datentyp | In dieser Spalte wird angezeigt, welcher Datentyp für das Attribut ermittelt wurde. Dieser Datentyp wird für das generische Erstellen von Suchmerkmalfeldern, Anzeigespalten etc. verwendet. |
Filterbar | Um nach einem Attribut filtern zu können, muss dieses als filterbar gekennzeichnet werden. Für diese Attribute wird ein Suchfeld im Abfragebereich des anpassbaren Cockpits erstellt.
Für folgende Attribute werden jedoch keine Suchfelder erstellt: · Attribute, die als programmierter Filter gekennzeichnet sind. · Attribute, die in einer Gruppe eines virtuellen Feldes sind Für diese Attribute wird am zugehörigen virtuellen Attribut der Filterausdruck abgefragt. Wenn ein virtuelles Attribut als filterbar gekennzeichnet ist, dann muss mindestens ein Attribut der zugehörigen Gruppe ebenfalls als filterbar gekennzeichnet sein. Nach diesem Attribut wird stellvertretend für das virtuelle Attribut gefiltert. |
Sortierbar | Um ein Attribut in der Sortierung nutzen zu können, muss es als sortierbar gekennzeichnet werden.
Wenn ein virtuelles Attribut als sortierbar gekennzeichnet ist, dann muss genau ein Attribut der zugehörigen Gruppe ebenfalls als sortierbar gekennzeichnet sein. Nach diesem Attribut wird stellvertretend für das virtuelle Attribut sortiert. |
Anzeigbar | Um ein Attribut in der Anzeige verwenden zu können, muss es als anzeigbar gekennzeichnet werden.
Wenn ein virtuelles Attribut als anzeigbar gekennzeichnet ist, so muss mindestens ein Attribut der zugehörigen Gruppe ebenfalls als anzeigbar gekennzeichnet sein. Diese gekennzeichneten Attribute werden von der Datenbank gelesen, wenn das virtuelle Attribut in die Anzeige aufgenommen wird. |
Rückgabeschlüssel | In einer Sucherweiterung kann kein Attribut als Rückgabeschlüssel gekennzeichnet werden. |
Logischer Datentyp | Durch Angabe eines logischen Datentyps können Sie die Eigenschaften eines Attributes verändern, beispielsweise das Label, die Wertehilfe, spezielle Renderer oder Editoren.
Für virtuelle Attribute und für als Business Object gekennzeichnete Attribute, die als Ausdruck nur den Alias besitzen, müssen Sie einen logischen Datentyp eingeben. Andernfalls ist die Angabe optional. Der logische Datentyp muss auf demselben Datentyp wie das Attribut basieren. Bei einem virtuellen Attribut ist dies nicht erforderlich, da kein Bezug zum einem Attribut auf der Datenbank besteht. |
2.2.1 Button „Suchattribute“
Mit Hilfe des Buttons „Suchattribute“ können Sie die Attribute ein- und ausblenden, die in der zugrunde liegenden Suche angegeben sind.
2.2.2 Aktion „Attribute auswählen“
Wenn Sie die Aktion „Attribute auswählen“ ausführen, dann wird ein Dialogfenster angezeigt, in dem Sie in einer Liste die Attribute derjenigen Business Objects oder OQL-Views auswählen können, die in der FROM-Klausel der Sucherweiterung und der zugrunde liegenden Suche definiert sind.
Folgende Suchfelder stehen zur Verfügung:
Feld | Erläuterung |
Alias | Wählen Sie den Alias des Objekts aus, dessen Attribute Sie in der Liste angezeigt bekommen möchten. Zur Auswahl stehen alle Aliase, die in der FROM-Klausel der Sucherweiterung und der zugrunde liegenden Suche definiert sind. Zu jedem Alias wird der Objektname angezeigt. |
Präfix | Geben Sie ein Präfix ein, der dem Attributnamen in der Liste vorangestellt wird. Weitere Informationen finden Sie im Abschnitt „Präfix“. |
Mit dem Button „Aktualisieren“ in der Symbolleiste der Liste können Sie sich die Ergebnisse zu den Suchmerkmalen anzeigen lassen.
Die folgenden Spalten stehen zur Verfügung:
Spalte | Erläuterung |
Attributpfad | In dieser Spalte wird der Pfad zu einem Attribut im gewählten Business Object oder OQL-View angezeigt. Handelt es sich um ein Attribut innerhalb eines Parts, dann wird der Name des Parts mit einem Punkt vom Namen des Attributes getrennt. |
Name | In dieser Spalte wird der Attributname angezeigt. Der Name setzt sich aus dem Präfix und dem Attributpfad zusammen. Alle Punkte im Attributpfad werden entfernt und der nachfolgende Buchstabe wird durch einen Großbuchstaben ersetzt.
Wenn ein Präfix angegeben wurde, so wird dieses vorangestellt. Endet das Präfix auf einen Punkt, so bleibt der restliche Name unverändert. Endet das Präfix nicht auf einen Punkt, so wird der erste Buchstabe des restlichen Namens durch den zugehörigen Großbuchstaben ersetzt. |
Ausdruck | In dieser Spalte wird der Ausdruck angezeigt, der sich aus dem Alias des gewählten Objektes gefolgt von einem Doppelpunkt und dem Attributpfad zusammensetzt. |