Freigegeben: HTML-Seite 

Mit dem Feature Suche können Sie die im Repository gespeicherten Elemente finden, vorausgesetzt, Sie verfügen über die entsprechenden Berechtigungen. Aufgrund ihres Aufgabenbereichs suchen Anwender häufig nach denselben Elementen, die sie mithilfe von ausgewählten Eigenschaften und Kategorien schnell finden. Sie können den Suchvorgang vereinfachen, indem Sie den Anwendern die Möglichkeit bieten, einen bereits definierten Suchvorgang zu verwenden. Im Suchvorgang haben Sie bereits die Werte definiert, die ihre Anwender andernfalls immer wieder eingeben müssen.

Um einen definierten Suchvorgang bereitzustellen, übergeben Sie die Parameter der URL.

Sie haben zwei Möglichkeiten, den Suchvorgang aufzurufen:

Suchen, ohne ein Repository anzugeben 

Wenn Sie den Suchvorgang ohne Angabe eines Repositorys definieren möchten, müssen Sie wie folgt vorgehen:

Wenn Sie die URL /dms aufrufen, wird Ihnen mit folgender HTTP-Antwort die URL für den Suchvorgang inklusive verfügbarer Parameter mitgeteilt:

Request 

GET /dms
Accept: application/hal+json

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

Response 

{
        _links: {
                search: {
                        href: "/dms/s/{?objectdefinitionids,fulltext,properties,showresultlist,repositoryid}"
                        templated: true
                }
        }
}

Suchen in einem definierten Repository 

Wenn Sie einen Suchvorgang speziell für ein Repository definieren möchten, müssen Sie zunächst die URL zu einem Repository ermitteln. Im Kapitel Ermitteln eines Repositorys können Sie nachlesen, wie Sie die URL zu einem Repository ermitteln.

Wenn Sie die URL zu einem Repository ermittelt haben (beispielsweise: /dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27) und die URL per HTTP GET aufrufen, dann erhalten Sie folgendes Ergebnis, das die repositoryspezifische URL für den Suchvorgang enthält:

Request 

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

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

Response 

{
        _links: {
                search: {
                        href: "/dms/r/dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27/s/{?objectdefinitionids,fulltext,properties,showresultlist}"
                        templated: true
                }
        },
        id: "dee1f3d3-eae8-5d9d-84d8-2d758c5ddc27"
}

Angeben von verhaltenssteuernden Parametern 

Das Verhalten beim Suchen und Anzeigen steuern Sie mit den folgenden Parametern:

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 den Suchvorgang 

Wenn Sie eine URL für den Suchvorgang erzeugt haben, dann können Sie die Ergebnisse mit den entsprechenden Anforderungen aufrufen.

Anforderung ohne Repository-ID: 

Request 

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

Anforderung mit Repository-ID: 

Request 

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

Als Ergebnis wird dann der Suchvorgang im Feature Suche mit den übergebenen Parametern geladen.

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:

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:

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.

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.

Wenn Sie beispielsweise Ihren Anwendern einen definierten Suchvorgang oder eine Ergebnisliste bereitstellen möchten, können Sie verschiedene Parameter angeben. In der Regel ist die Volltextsuche in einem d.3-Repository zu unspezifisch. Deshalb können Sie die Suchanfrage mithilfe von Abfrageparametern einschränken.

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