Wie verwende ich die Live-Suche?

Die Volltextsuche kann über eine API oder via Command-Line-Interface aufgerufen werden. Damit die Live-Suche genutzt werden kann, muss die Anwendung Suchen installiert sein.

Live-Suche anwenden

Die Live-Suche ist über die folgende URL erreichbar: https://<website>.cloudrexx.com/api/Search

Folgende URL-Argumente könnten übermittelt werden:

`term=<keyword>`	Suchbegriff
`locale=<sprachversion>`	Sprachversion z.B. de
`nodeId=<id>`	Optionale ID (oder https://dev.cloudrexx.com/Content/#nodes) einer Content Node, um die Suche auf dessen Seitenbaum einzuschränken. Siehe dazu den entsprechenden Eintrag https://cloudrexx.atlassian.net/l/cp/0Yv2L6Bv
`options[mode]=<value>`	Diese Option wird aktuell nur von der Anwendung Medienverzeichnis unterstützt. Beeinflusst das Ausgabeformat der Suchergebnisse. Mögliche Werte für `<value>`: `command` (Standard) `frontend` `backend` `minimal` Das Ausgabeformat der Einträge aus dem Medienverzeichnis kann über ein FieldTemplate definiert werden.
`options[zipLookup]=<zipCode>`	Diese Option wird aktuell nur von der Anwendung Medienverzeichnis unterstützt. Beschränkt die Resultate der Anwendung Medienverzeichnis auf Einträge von Formularen mit einem Eingabefeld des Kontext-Typs `PLZ`. Das Ausgabeformat kann über ein spezifisches FieldTemplate mit dem Kontext `Zip` definiert werden.

Die Suche liefert ein JSON-Objekt zurück, welches die folgende Struktur aufweist:

[
  <result>,
  ...
]

Jedes <result> stellt ein Suchresultat dar und weisst die folgende Struktur auf:

{
  Score: <score>,
  Title: '<title>',
  Content: '<content>',
  Image: '<image>',
  Link: '<url>',
  Component: '<component>',
  Date: '<changelog>',
  AdditionalData: {additionalData},
  Categorization: [
    {object},
    ...
  ],
  OtherRelations: {
    <properyName>: [
      {object},
      ...
    ],
    ...
  }
}

Erläuterung:

Schlüssel	Beschreibung	Beispiel

Schlüssel	Beschreibung	Beispiel
`<score>`	Trefferquote (0-100%)	`100`
`<title>`	Titel des Suchergebnis	`Willkommen`
`<content>`	Auszug des Suchergebnis	`Willkommen bei ...`
`<image>`	Bild-URL des Suchergebnis	`/images/content/welcome.png`
`<url>`	URL zum Suchergebnis	`/de/home`
`<component>`	Name der Anwendung, aus welcher das Suchergebnis stammt	`ContentManager`
`<changelog>`	Unix-Zeitstempel der letzten Bearbeitung Nicht alle Suchresultate verfügen über diese Angabe.	`1656652849`
`{additionalData}`	Anwendungsspezifische Zusatzangaben mit folgender Struktur: `{ <key>: <value>, ... }`	`{ "Type": { "image": "Bild" } },`
`<key>`	Anwendungsspezifischer Schlüssel	`Type`
`<value>`	Anwendungspezifischer Wert	`{ "image": "Bild" }`
`{object}`	`{ Title: <title>, Class: <class>, Id: <id> }`	`{ "Class": "Cx\\Modules\\Downloads\\Controller\\Category", "Id": 2, "Title": "Aktuelles" }`
`<class>`	PHP-Klasse des Suchergebnis	`Cx\\Modules\\Calendar\\Controller\\CalendarEvent`
`<id>`	ID des Suchergebnis	`3`
`<properyName>`	Spezifische Eigenschaft des Suchresultats	`Form`

Integration

Platziere den folgenden Code in die Anwendungsseite der Search-Anwendung. Damit erhält die Such-Box eine Live-Suche (Autovervollständigung).

<script>
cx.ready(function(){
    jQuery( ".searchbox" ).autocomplete({
        source: function( request, response ) {
            url="/api/Search";
            data = {
                term: request.term
            }
            lang = cx.variables.get('language');
            if (lang != undefined) {
                data.locale = lang;
            }
            jQuery.getJSON(
                url,
                data,
                function( data ) {
                    var result = new Array();
                    for (id in data) {
                        result.push({
                            id: id,
                            value: data[id].Title,
                            url: data[id].Link
                        });
                    }
                    response(result);
                }
            );
        },
        minLength: 2,
        select: function(event, ui) {
            window.location = ui.item.url;
        }
    } );
});
</script>