Definieren der Parameter für einen Suchvorgang und eine Ergebnisliste

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.

Parameter

Beschreibung

objectdefinitionids

Legt fest, auf welche Kategorien sich die Suche beziehen soll. Sie können mindestens eine Kategorie definieren. Geben Sie die ID einer Kategorie an. Wird keine Angabe gemacht, erfolgt die Suche in allen Kategorien eines d.3-Repositorys.

Beispiele (nicht encodiert):

  • objectdefinitionids=["RECH"]: für die Suche in der Kategorie Rechnung ("RECH").

  • objectdefinitionids=["RECH","AUFT"]: für die Suche in den Kategorien Rechnung ("RECH") und Aufträge ("AUFT").

fulltext

Gibt einen Volltextsuchbegriff an.

properties

Gibt eine Sucheinschränkung nach Eigenschaften der Dokumente und Akten an. Mit folgenden Kriterien können Sie einen Suchvorgang einschränken:

  • Dokument-ID: property_document_id

  • Dateityp: property_filetype

  • Dokumentnummer: property_document_number

  • Dokumentstatus: property_state (Mögliche Werte sind Be für Bearbeitung, Pr für Prüfung, Fr für Freigabe und Ar für Archiv)

  • Bearbeiter: property_editor (d.3-Benutzerkennung)

  • Dateiname: property_filename

  • Importdatum: property_creation_date

  • Dateigröße: property_size (Bei der Suche nach der Dateigröße muss die Größe in Bytes als Ganzzahl angegeben werden. Bereichssuchen mit dem Trennzeichen Pipe- und Minus-Zeichen (|-) sind ebenfalls möglich: Mit dem Ausdruck {"property_size":["|-1024"]} suchen Sie nach Dokumenten, deren Nutzdatei kleiner oder gleich 1024 Bytes ist.

  • Geändert am: property_last_modified_date

  • Datei geändert am: property_last_alteration_date

  • Zugriff am: property_access_date

  • Bemerkung: property_remark

  • Farbmarkierung: property_colorcode (Ist eine Ganzzahl zwischen 1 und 24, die der Nummer des gewünschten Farbcodes entspricht).

  • Variantennummer: property_variant_number

Sie können je Eigenschaft mindestens einen Wert definieren.

Beispiele (nicht encodiert):

  • properties={"property_filetype":["docx"]}: für die Suche nach dem Dateityp "docx".

  • properties={"property_filetype":["docx","pdf"]}: für die Suche nach Elementen mit dem Dateityp "docx" oder "pdf".

Einschränkung in Bezug auf die Definition eines Suchvorgangs: Sie können zu einem Parameter mehrere Werte definieren, sofern für die zugehörige Eigenschaft Facetten konfiguriert wurden. Falls keine Facetten für die Eigenschaft zum Anzeigen konfiguriert wurden, wird immer der letzte Wert für den Suchvorgang übernommen.

Sie können die Ergebnisliste und den Suchvorgang auch anhand einer erweiterten Eigenschaft einschränken. 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).

Beispiele (nicht encodiert):

  • properties={"227":["KND001"]}: für die Suche nach Elementen, die die erweiterte Eigenschaft mit der ID "227" besitzen und diese Eigenschaft den Wert "KND001" hat.

  • properties={"227":["KND001","KND002"]}: für die Suche nach Elementen, die die erweiterte Eigenschaft mit der ID "227" besitzen und diese Eigenschaft den Wert "KND001" oder "KND002" hat.

Sie können auch mehrere Eigenschaften gleichzeitig als Sucheinschränkung verwenden:

Beispiele (nicht encodiert):

  • properties={"227":["KND001"],"231":["|-100"]}: für die Suche nach Elementen mit der Kundennummer (erweiterte Eigenschaft mit der ID "227") "KND001" und einem Rechnungsbetrag (erweiterte Eigenschaft mit der ID "231") kleiner oder gleich 100.

  • properties={"227":["KND001"],"property_filetype":["pdf"]}: für die Suche nach Elementen mit der Kundennummer (erweiterte Eigenschaft mit der ID "227") "KND001" und dem Dateityp "pdf".

Anmerkung

Spezielle Angaben für den properties-Parameter in Bezug auf verschiedene Einschränkungsmöglichkeiten, um gezielt zum Ergebnis zu gelangen:

  1. Suche nach einem numerischen Wert oder einem Geldwert:

    Geben Sie den Wert ohne Tausendertrennzeichen an. Als Dezimaltrennzeichen gilt der Punkt (.). Beispiel: Für den Wert 1.000,20 EUR geben Sie 1000.20 an.

  2. Suche nach einem Datum und Uhrzeit:

    Geben Sie das Datum im Format YYYY-MM-DD an. Beispiel: Für den 05.12.2014 (DD.MM.YYYY) geben Sie 2014-12-05 an.

    Zeitangaben werden nach dem Format YYYY-MM-DDTHH:mm:ss+01:00 durchführt. Das Pluszeichen (+) müssen Sie mit %2b encodieren. Beispiel: 2015-02-18T23:59:59%2b01:00 für den 18.02.2015 um 23:59 Uhr und 59 Sekunden in der Zeitzone UTC+1 für Winterzeit in Deutschland.

  3. Suche nach Elementen, die sich in einem bestimmten Bereich befinden:

    Für die Bereichssuche verwenden Sie als Trennzeichen eine Kombination aus einem Pipe- und Minuszeichen (|-). Beispiele für ein numerisches Feld mit der ID "231":

  • Werte größer oder gleich 100: {"231":["100|-"]}

  • Werte kleiner oder gleich 100: {"231":["|-100"]}

  • Werte zwischen 100 und 200: {"231":["100|-200"]}