Anzeigen der Ergebnisse eines Suchvorgangs

Freigegeben: HTML-Seite

Sie können beim Definieren von Suchvorgängen festlegen, dass nur die Ergebnisliste angezeigt wird. Ihre Anwender können dann direkt die Ergebnisse einer Suche sehen und müssen nicht mehr die einzelnen Eigenschaften angeben. Mit der Ergebnisliste können Ihre Anwender einfach weiterarbeiten. Die Anwender können jedoch die Suchkriterien, die zum Ergebnis geführt haben, nicht mehr ändern.

Um nur die Ergebnisse eines Suchvorgangs anzuzeigen, müssen Sie folgende Schritte durchführen:

  • Ermitteln der URL zu einem Repository

  • Ermitteln der Linkrelation zum Abrufen der Ergebnisse eines Suchvorgangs

  • Angeben von verhaltenssteuernden Parametern

  • Aufrufen der URL für die Ergebnisse

Wenn Sie eine Zuordnung für eine Quelle erstellt haben, können Sie die Ergebnisse eines Suchvorgangs auch auf andere Weise anzeigen. Weitere Informationen finden Sie im Kapitel Abrufen und Anzeigen der Ergebnisse eines Suchvorgangs.

Ermitteln der URL zu einem Repository

Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln.

Ermitteln der Linkrelation zum Abrufen der Ergebnisse eines Suchvorgangs

Rufen Sie die URL zu einem Repository wie folgt auf:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27
Accept: application/hal+json

Das JSON-Objekt zu einem Repository enthält die Linkrelation searchresult mit Platzhaltern für die Werte, mit deren Hilfe die Suche nach DMS-Objekten durchgeführt wird.

Response

{
        _links: {
                searchresult: {
                        href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/sr/{?objectdefinitionids,fulltext,properties,propertysort,ascending,showdetails}"
                        templated: true
                }
        },
        id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Angeben von verhaltenssteuernden Parametern

Das Verhalten beim Anzeigen der Ergebnisse steuern Sie mit folgenden Parametern:

Parameter

Beschreibung

showdetails

Legt fest, wenn der Suchvorgang ein einzelnes Dokument findet, ob dieses Dokument direkt in der Detailansicht angezeigt wird (Standardwert: false).

propertysort

Gibt die ID der Eigenschaft an, nach der sortiert wird. Ist keine Sortiereigenschaft angegeben, erfolgt die Sortierung gemäß Standardsortierung anhand des Sortierungskriteriums Geändert am.

  • Caption/Titel: property_caption

  • Besitzer: property_owner

  • Dateiendung: property_filetype

  • Bemerkung: property_remark

  • Zugriffsdatum: property_access_date

  • Bearbeiter: property_editor

  • Dokument-ID: property_document_id

  • Dokumentnummer: property_document_number

  • Dateigröße: property_size

  • Dokumentstatus: property_state

  • Geändert am: property_last_modified_date

  • Datei geändert am: property_last_alteration_date

  • Farbmarkierung: property_colorcode

  • Kategorie: property_category

  • Erstellt am: property_creation_date

  • Zugriffsdatum: property_access_date

Sie können die Ergebnisliste auch anhand einer erweiterten Eigenschaft sortieren. Die ID der Eigenschaft entspricht der Kennung (RID) einer Eigenschaft, die Sie in d.3 admin für jede erweiterte Eigenschaft ermitteln können.

Weitere Informationen zur Kennung einer Eigenschaft (RID) finden Sie in der Dokumentation zu d.3 admin (d3admin.pdf).

ascending

Gibt die Richtung der Sortierreihenfolge an.

  • ascending=true: führt zu einer aufsteigenden Sortierung (von klein nach groß (A-Z) und von alt nach jung).

  • ascending=false: führt zu absteigenden Sortierung (von groß nach klein (Z-A) und von jung nach alt).

Wird der ascending-Parameter nicht explizit angegeben, wird eine aufsteigende Sortierung vorgenommen. Davon ausgenommen ist die Standardsortierung: Wird nach dem Kriterium Geändert am sortiert und ist die Sortierreihenfolge nicht angegeben, wird in diesem Fall absteigend sortiert.

Außerdem werden in der Ergebnisliste zunächst die Akten und dann die Dokumente angezeigt. Innerhalb von Dokumenten und Akten wird nach dem Sortierkriterium sortiert.

children_of

Gibt die Dokument-ID an, zu der die verknüpften direkten untergeordneten Elemente gesucht werden.

Die Beschreibungen zu den Parametern objectdefinitionids, fulltext und properties finden Sie im Kapitel Definieren der Parameter für einen Suchvorgang und eine Ergebnisliste.

Aufrufen der URL für die Ergebnisse

Wenn Sie eine URL erzeugt haben, dann können Sie die Ergebnisse wie folgt aufrufen:

Request

GET /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/sr/?objectdefinitionids=["RECH"]&fulltext=Mustermann&properties={"227":["KND001"]}
Accept: text/html

Als Ergebnis wird dann das Ergebnis des Suchvorgangs geladen.

Anmerkung

Sie müssen die Parameter der URL encodieren (z.B. Leerzeichen in %20). Die Länge des encodierten Abfrageparameters darf 2000 Zeichen nicht überschreiten.

Anwendungsbeispiele für verschiedene Ergebnislisten (nicht encodiert):

  • Suchen in einer Kategorie: Ergänzen Sie die URL um den Teil objectdefinitionids=["<ID der Kategorie>"].

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?fulltext=5353&objectdefinitionids=["RECH"]

  • Suchen in mehreren Kategorien: Ergänzen Sie die URL um den Teil objectdefinitionids=["<ID der Kategorie>","<ID der Kategorie>"].

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?fulltext=5353&objectdefinitionids=["RECH","AUFT"]

  • Suchen nach PDF-Dokumenten mit Einschränkungen auf den Dateityp: Ergänzen Sie die URL um den Teil properties={"property_filetype":["<Dateierweiterung>"]}.

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?fulltext=test&properties={"property_filetype":["pdf"]}

  • Suchen nach einer alphanumerischen Eigenschaft: Ergänzen Sie den properties-Parameter in der URL um properties={"227":["KND001"]} (nicht encodiert), um das Eigenschaftsfeld mit der RID 227 (Kundennummer) und dem Wert "KND001" als Kundennummer zu suchen.

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?objectdefinitionids=["RECH"]&fulltext=&properties={"227":["KND001"]}

  • Suchen nach mehreren Eigenschaften: Ergänzen Sie den properties-Parameter in der URL um properties={"227":["KND001"],"231":["|-100"]} (nicht encodiert), um das Eigenschaftsfeld mit der RID 227 (Kundennummer) mit dem Wert "KND001" und das Eigenschaftsfeld mit der RID 231 (Rechnungsbetrag) mit dem Wert kleiner oder gleich 100 zu suchen.

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?objectdefinitionids=["RECH"]&fulltext=&properties={"227":["KND001"],"231":["|-100"]}

  • Definieren der Sortierung der Ergebnisliste nach Titel: Ergänzen Sie die URL um den Teil propertysort=property_caption.

https://<Basisadresse>/dms/r/<RepositoryID>/sr/?fulltext=&objectdefinitionids=["RECH"]&propertysort=property_caption

Sie erhalten als Antwort (Response) die HTML-Seite mit der Ergebnisliste. Im Fehlerfall erhalten Sie eine HTML-Seite, die den Fehler genauer beschreibt. Wenn Fehler auftreten, müssen Sie die fehlerhafte Anforderung (Request) korrigieren.