Mit dem Tool „Mit Suchen arbeiten“ (wrksrh) können Sie die Suchanpassungen von anpassbaren Cockpits anzeigen, exportieren, importieren und reorganisieren.
Zielgruppe
- Anwendungsentwickler
- System-Administratoren
Beschreibung
Befehl
Nachfolgend finden Sie den Befehl inklusive aller möglichen Parameter.
| wrksrh | [-db:<id>] [-all] [-o:<str-1> … -o:<str-n>] [-lastInstallation:<str>]
[-check] [-export] [-import:<str-1> … -import:<str-n>]
[-delete] [-display] [-reorganize] [-migrate:<str>] [-log:<str>] [-verbose] [-batchJobs] |
Parameter
Die Parameter des Befehls werden in der folgenden Tabelle erläutert. Die in eckigen Klammern gesetzten Parameter sind optional, die anderen hingegen sind Pflichtparameter. Für einige Parameter kann ein Stern (*) als Platzhalter angegeben werden, um damit alle möglichen Werte ausgeben zu können. Nicht alle Parameter können mehrfach genannt werden. Nur die, die folgenden Zusatz an den Parametervariablen aufweisen, sind für die Mehrfachnennung zugelassen: „<str-1> … <str–n>“.
| Parameter | Erläuterung |
| -db | Mit dem Parameter können Sie die gewünschte Operation für eine Datenbank ausführen. |
| -all | Mit allen alle Suchen der ausgewählten Datenbanken arbeiten. |
| -o:<str-1> … -o:<str-n> | Die Suchen mit bestimmten technischen Namen auswählen. |
| -lastInstallation | Die betroffenen Suchen werden aus der letzten Installation für die angegebene Code-Klasse bestimmt. |
| -check | Die ausgewählten Suchen werden auf Kompatibilität bzgl. ihrer Sucherweiterungen geprüft und die Ergebnisse werden in eine Ausgabedatei geschrieben (siehe Parameter log).
Wenn der Parameter verbose angegeben ist, dann werden alle Ergebnisse der Kompatibilitätsprüfung ausgegeben. Wenn der Parameter verbose nicht angegeben ist, dann werden nur Einträge für diejenigen Suchen und Sucherweiterungen in die Datei geschrieben, für die bei der Kompatibilitätsprüfung Änderungen festgestellt wurden. |
| -export | Die Suchanpassungen aller ausgewählten Suchen werden exportiert.
(siehe Kapitel „Suchanpassungen exportieren“) |
| -import:<str-1> …
-import:<str-n> |
Die angegebenen Dateien mit exportierten Suchanpassungen werden in die ausgewählte Datenbank importiert. Falls auf dieser Datenbank zu den importierten Suchen bereits Suchanpassungen existieren, dann werden diese Suchanpassungen überschrieben. |
| -delete | Die Suchanpassungen der ausgewählten Suchen löschen. |
| -display | Die Daten der Suchanpassungen der ausgewählten Suchen anzeigen. |
| -reorganize | Prüfen, ob die Suchanpassungen der ausgewählten Suchen noch gültig sind. Ungültige Suchanpassungen werden entweder für die aktuelle Version der Suche überführt oder, falls dies nicht möglich ist, gelöscht.
(siehe Kapitel „Suchanpassungen überführen“) |
| -migrate:<str> | Die Suchanpassungen werden für alle ausgewählten Suchen in die aktive Version der Suche überführt. Geben Sie bei dem Parameter den Namen der HTML-Log-Datei an.
(siehe Kapitel „Suchanpassungen überführen“). |
| -log:<str> | Die Resultate werden im html-Format in die angegebene Datei geschrieben. |
| -verbose | Wenn der Parameter gesetzt ist, dann werden ausführlichere Ausgaben gemacht.
Wenn der Parameter angegeben ist, dann werden alle Ergebnisse der Kompatibilitätsprüfung ausgegeben. Wenn der Parameter nicht angegeben ist, dann werden nur Einträge für diejenigen Suchen und Sucherweiterungen in die Datei geschrieben, für die bei der Kompatibilitätsprüfung Änderungen festgestellt wurden. |
| -batchJobs | Gibt aus, welche Hintergrundverarbeitungsaufträge welche Suche verwenden. |
Suchanpassungen überführen
Suchen können mithilfe von Suchanpassungen um neue Felder erweitert werden. Eine Suchanpassung wird für die jeweils aktive Version der Suche erstellt. Wenn eine neue Version dieser Suche beispielsweise durch eine Softwareaktualisierung aktiviert wird, dann ist möglich, dass die Suchanpassung nicht mehr zu der neuen Version der Suche passt. In diesem Fall werden beim Überführen der Suchanpassung, die Teile der Suchanpassung gelöscht, die mit der neuen Version der Suche nicht mehr fehlerfrei zusammenarbeiten können. Abhängig von den Änderungen zwischen der Version der Suche, mit der die Suchanpassung erstellt wurde, und der neuen Version der Suche kann in diesem Schritt die Suchanpassung auch vollständig gelöscht werden.
Die folgenden Beispiele erläutern, wie Suchanpassungen überführt werden. Die Suchanpassung bleibt bei den folgenden Änderungen unverändert:
- Ein Attribut wurde in der neuen Version der Suche gelöscht. Dieses Attribut wurde in der Suchanpassung nicht verwendet.
- Ein neues Attribut wurde in der neuen Version der Suche hinzugefügt.
- Ein Attribut der Suche wurde inhaltlich geändert.
- Ein neues Business Object wurde in der neuen Version der Suche hinzugefügt.
- Ein Business Object wurde aus der neuen Version der Suche entfernt. Das Business Object wurde in der Suchanpassung nicht verwendet.
Teile der Suchanpassung werden bei den folgenden Änderungen gelöscht:
- Ein Attribut wurde in der neuen Version der Suche gelöscht. Das Label dieses Attributs wurde in der Suchanpassung verändert.
- Nur das geänderte Attribut wird aus der Suchanpassung gelöscht. Alle anderen Attribute der Suchanpassung werden nicht verändert.
- Ein Business Object wurde aus der neuen Version der Suche entfernt. Das Business Object wurde in der Suchanpassung verwendet.
- Alle Attribute dieses Business Objects und die Attribute aller abhängigen Business Objects werden aus der Suchanpassung gelöscht.
In einem Cockpit können Sie Verarbeitungsaufträge erzeugen, die auf der Suchanpassung basieren. Wenn in der aktiven Version der Suche bestehende Attribute oder verwendete Business Objects der Suche geändert oder gelöscht werden, dann besteht das Risiko, dass Verarbeitungsaufträge mit anderen Daten ausgeführt werden als vom Benutzer beabsichtigt war, oder dass es bei der Ausführung zu Fehlern kommt. Noch nicht verarbeitete Verarbeitungsaufträge, die die Suchanpassung verwenden, werden daher in diesem Fall abgebrochen.
Suchanpassungen exportieren
Sie können Suchanpassungen mit dem Parameter –export explizit exportieren. Suchanpassungen werden aber auch automatisch exportiert, bevor diese durch den Parameter –migrate oder durch den Befehl upgaps -release überführt werden.
Jede Suchanpassung wird in binärer Form in eine Datei exportiert. Die Dateien werden in den Ordner servers/_etc/SearchExtensions/{Datenbank} relativ zum Installationsverzeichnis exportiert. Der Dateiname setzt sich aus dem Namen der Suche und einem Zeitstempel zusammen.
Alle Suchanpassungen überführen
Mit dem Parameter–migrate oder durch den Befehl upgaps –release werden alle Suchanpassungen auf allen Datenbanken in die aktive Version der Suche überführt. Bevor eine Suchanpassung verändert wird, wird der Zustand vor der Änderung exportiert und dieser Zustand kann jederzeit wieder importiert werden. Jede Änderung einer Suchanpassung wird einer HTML-Log-Datei protokolliert. In der Log-Datei werden alle betroffenen Cockpit-Anwendungen aufgeführt. Wenn dies der Fall ist, dann müssen Sie die Layouts der betroffenen Cockpit-Anwendungen kontrollieren und korrigieren.
Nach dem Abschluss der Überführung aller Suchanpassungen wird das Workflowereignis com.cisag.pgm.search.SearchMigration ausgelöst. In der ausgelieferten Aktivitätsdefinition cis.sys.SearchExtension finden Sie ein Beispiel für die Verwendung dieses Ereignisses. Aktivieren Sie diese Aktivitätsdefinition, um benachrichtigt zu werden, wenn Suchanpassungen überführt wurden.