FactFinder Suchparameter

Über die Suchparameter wird FACT-Finder mitgeteilt, welche Produkte zurückgeliefert werden sollen. Generell gibt es zwei unterschiedliche Möglichkeiten diese zu übergeben. Die XML und JSON-Schnittstellen reagieren jeweils auf eine Anfrage-URL mit entsprechenden Parametern. In der Webservice-Schnittstelle werden Programm-Objekte mit Eigenschaften übergeben.

Wann immer Daten über eine URL an FACT-Finder übergeben werden, ist es wichtig, dass das Encoding korrekt eingestellt ist. Ist dies nicht der Fall, so werden Sonderzeichen und Umlaute falsch verarbeitet. Das Standard-URL-Encoding für FACT-Finder ist UTF-8. Im Folgenden sind die möglichen Suchparameter aufgelistet:

Authentifizierungsparameter

	Beschreibung	URL-Parameter	Webservice/SOAP
Benutzername	Da Sie sich bei FACT-Finder Aufrufen autorisieren müssen, müssen Sie einen Benutzer übergeben.	Übergeben Sie den Namen des Benutzers, der verwendet werden soll, per Parameter `username`.	`AuthenticationToken.username`
Passwort	Zu dem übergebenen Benutzer muss das Passwort übertragen werden. Dieses muss nach vorher erklärtem Schema verschlüsselt werden.	`password=HASH`	`AuthenticationToken.password`
Zeitstempel	Sollten Sie die erweiterte Verschlüsselungsmethode verwenden, muss zusätzlich der für den Hash verwendete Zeitstempel übertragen werden.	`timestamp=ZEITSTEMPEL`	`AuthenticationToken.timestamp`

Basis Parameter

Diese Auflistung entspricht der Params-Klasse bei Webservice/SOAP-Verwendung.

	Beschreibung	URL-Parameter	Webservice/SOAP
Suchbegriff	Der Suchbegriff gibt an, nach welchem Begriff in der FACT-Finder Datenbank gesucht werden soll. Zusammen mit dem Channel Parameter sind das die einzigen Pflicht-Parameter.	Der Parametername lautet `query`	Wird im `Params`-Objekt über `setQuery` gesetzt.
Channel	Falls Ihre Suchumgebung mehrere Channels umfasst, müssen Sie über diesen Parameter angeben, welchen Sie durchsuchen wollen. Ist kein Channel explizit angegeben, so wird der erste Channel in der Channel-Liste verwendet.	`channel=NAME`	`Params.channel`
Seite	Falls ein Suchergebnis viele Ergebnisse beinhaltet, werden diese in Seiten unterteilt. So wird die zu übertragende Menge kleingehalten. Hierüber können Sie angeben, welche Seite zurückgegeben werden soll, die Zählung beginnt bei 1.	`page=NUMMER`	`Params.page`
Ergebnisse pro Seite	Sie können im FACT-Finder Management Interface definieren, wie viele Ergebnisse per Standard auf einer Seite zurückgeliefert werden sollen. Möchten Sie eine andere Anzahl anzeigen, können Sie dies mit diesem Parameter einstellen.	`productsPerPage= ANZAHL`	`Params.resultsPerPage`
Sortierung	Per Standard wird das Ergebnis nach Relevanz sortiert zurückgegeben, soll es anders sortiert werden, kann dies hierüber eingestellt werden. Es ist auch möglich mehrere Sortierungen zu verwenden, diese werden der Reihe nach angewendet.	Der Parameter ist ein Konstrukt aus dem Prefix `sort` und dem Feldnamen, nach dem sortiert werden soll (`sortFELDNAME`). Als Wert wird die Sortierrichtung angegeben, `asc` für aufsteigend und `desc` für absteigend. Soll bei mehreren übergebenen Sortierungen auch nach Ähnlichkeit sortiert werden, so lautet der Parameter `sortRelevancy=desc`	Eine Sortierung wird durch ein `SortItem`-Objekt beschrieben. Den `Params` kann eine Liste dieser Objekte gesetzt werden.
Filterung	Durch die Übergabe eines Filter-Parameters liefert FACT-Finder nur Suchergebnisse zurück, die dem angegebenen Filter entsprechen. Der Filterwert trifft nicht, wenn dieser nur teilweise enthalten ist. Es besteht zudem die Möglichkeit, Filter in einem Feld mit UND bzw. ODER zu verknüpfen. Es ist auch möglich, einen Filter zu übergeben, der ausschließend angewandt werden soll. Beispielsweise werden alle Produkte zurückgegeben, die NICHT rot sind.	Der Name des Parameters ist wie die Sortierung ein Konstrukt aus Präfix und Feldname, hier lautet das Präfix jedoch `filter`. Als Wert wird der Filterwert übergeben. Falls eine Mehrfachfilterung angewandt werden soll, muss zwischen den Werten ein Trenner übergeben werden. Im Normalfall sind dies für eine UND-Verknüpfung 3 Unterstriche (`___)`, für eine ODER-Verknüpfung sind dies 3 Tilden (`~~~`). Beispiel: `Rot~~~Blau`. Diese Trenn-Strings können in der config.xml konfiguriert werden. Soll der Filter ausschließend wirken, so übergeben Sie vor den Filterwert ein Prefix, per Standard ist dies ein Ausrufezeichen(`!`). Beispiel: `!Rot`. Der String wird ebenso in der config.xml konfiguriert.	Ein `Filter`-Objekt symbolisiert einen Filter je Feld. Dieses Objekt kann mehrere `FilterValue`-Objekte enthalten. Neben einem Filterwert ist in diesen die Information, wie mehrere `FilterValues` verknüpft werden (`type`). Die Objekt-Eigenschaft `exclude` besagt, ob der Filter ausschließend angewandt werden soll, oder nicht. Dem `Params`-Objekt können wiederum mehrere Filter-Objekte hinzugefügt werden.
Suchfeld	Im Normalfall durchsucht FACT-Finder alle als durchsuchbar definierten Felder. Es ist jedoch auch möglich, nur in einem bestimmten Feld zu suchen.	`searchField=FELDNAME`	`Params.searchField`
Artikelnummernsuche	Normalerweise wird eine Artikelnummernsuche durchgeführt, falls der Suchbegriff einem oder mehreren Schemas entspricht. Sie können aber per Parameter verhindern, dass die Artikelnummernsuche ausgeführt wird.	Wenn Sie als Parameter `noArticleNumberSearch` und den Wert `true` übergeben, so wird die Artikelnummernsuche nicht ausgeführt.	Das `Params`-Objekt besitzt ein Attribut `noArticleNumberSearch;` über dieses lässt sich die Artikelnummernsuche verhindern. Zudem können Sie über das Attribut `isArticleNumber` explizit sagen, dass eine Artikelnummernsuche ausgeführt werden soll.
Session-ID		Der Parametername für die Session-ID ist `sid`.	`TrackingInformation.sessionID`

Parameter bei der Steuerung des Such-Ablaufs

	Beschreibung	URL-Parameter	Webservice/SOAP
ASN Erstellung	Steuert die Erzeugung der ASN. `true` = ASN wird erstellt, `false` = ASN wird nicht erstellt. Default ist `true`.	`useAsn=true`	`SearchControlParams.useAsn`
Gefundene Wörter zurückliefern	FACT-Finder ist in der Lage zu den gefundenen Datensätzen die Wörter zurückzuliefern, die zum Fund des Datensatzes geführt haben. Die Ermittlung dieser Wörter kostet Rechenzeit. Daher ist diese per Default deaktiviert. `true` = Wörter werden erzeugt, `false` = Wörter werden nicht erzeugt. Default ist `false`.	`useFoundWords=true`	`SearchControlParams.useFoundWords`
Kampagnen unterdrücken	Falls Sie verhindern wollen, dass der Kampagnen-Manager überprüft, ob für diese Suchanfrage eine Kampagne vorliegt, verwenden Sie diesen Parameter. `true` = Kampagnen werden ausgewertet und zurückgeliefert, `false` = Kampagnen werden ignoriert. Nähere Informationen zum Kampagnen-Manager finden Sie in dessen Dokumentation.	`useCampaigns=true`	`SearchControlParams.useCampaigns`
Shopnavigation	Über FACT-Finder lässt sich auch Ihre komplette Shopnavigation abbilden. Hierfür benötigen Sie keinen Suchbegriff, sondern übergeben lediglich die Anfrage entsprechend.	Der `query`-Parameter ist hier überflüssig, Sie benötigen nur den Parameter `navigation=true`.	`CustomParameter` "`navigation`" der im `Params`-Objekt gesetzt wird.
Datensätze nicht übertragen	In der Rückgabe erhalten Sie normalerweise alle Feldinformationen der gefundenen Produkte. Sollten Sie nur die IDs benötigen, können Sie die Übertragung der Feldinhalte deaktivieren und so Bandbreite sparen. `true` = Feldinhalte nicht übergeben. Default-Wert ist `false`.	`idsOnly=true`	`SearchControlParams.idsOnly`
SEO-Schlüsselwörter erzeugen	FACT-Finder ist in der Lage zu Produkten Schlüsselwörter zu generieren, die für Search Engine Optimization verwendet werden können. `true` = SEO-Schlüsselwörter werden ausgewertet und an die Produkt-Datensätze angehängt, `false` = SEO-Schlüsselwörter werden nicht zurückgeliefert. Default ist `false`.	`useKeywords=false`	`SearchControlParams.useKeywords`
Vollständigen Frage-Antwort-Baum für Berater-Kampagnen zurückliefern	Bitte beachten Sie, dass dieser Parameter keinen Einfluss hat und nur noch aus Kompatibilitätsgründen vorhanden ist. Der damit ursprünglich generierte AdvisorTree wird immer erstellt und mit dem Suchergebnis ausgeliefert, so denn eine Beraterkampagne aktiv ist.	`generateAdvisorTree=false`	`SearchControlParams.generateAdvisorTree`
Cache-Kontrolle	Steuert die Verwendung des Such-Ergebnis-Caches. `true` = Cache wird ignoriert, `false` = Cache wird verwendet. Default ist `false`.	`disableCache=false`	`SearchControlParams.disableCache`
Beschränkung weiterführender Anfragen	Der Parameter followSearch wird automatisch allen Parametersätzen weiterführender Anfragen eines Suchergebnises angehängt. Dieser Parameter muss nicht den Initialsuchen angepasst werden. Aus internen Gründen muss er bei allen nach der Suche verwendeten Parametern eingebunden werden. (Sortierung, Filterung, etc.)	Bitte den Parameter wie empfangen einbinden: z. B. `followSearch=9680`	`Params.followSearch`
Personalisierungverwenden	Erlaubt das Aktivieren/Deaktivieren der Personalisierung der Anfragen. `true` = das Suchergebnis wird personalisiert, wenn das Personalisierungs-Modul aktiviert ist und alle anderen Anforderungen erfüllt sind; `false` = das Suchergebnis wird nicht personalisiert. Der Standardwert ist `true`.	`usePersonalization=false`	`SearchControlParams.usePersonalization`
Semantic Enhancer verwenden	Erlaubt das Aktivieren/Deaktivieren der semantischen Anreicherung der Anfragen. `true` = das Suchergebnis wird semantisch angereichert, wenn das Enhancer Modul aktiviert ist und wenn alle anderen Anforderungen erfüllt sind. `false` = das Suchergebnis wird nicht angereichert. Der Standardwert ist `true`.	`useSemanticEnhancer=false`	`SearchControlParams.useSemanticEnhancer`
Automatic Search Optimization verwenden	Erlaubt das Aktivieren/Deaktivieren der automatischen Such-Optimierung. `true` = das Suchergebnis wird automatisch optimiert. `false` = das Suchergebnis wird nicht optimiert. Standardwert ist `true`.	`useAso=false`	`SearchControlParams.useAso`

Sonstige Parameter

	Beschreibung	URL-Parameter	Webservice / SOAP
Rückgabeformat	Da die XML- und JSON-Schnittstellen per URL aufgerufen werden, wird ein Parameter benötigt, der angibt, in welchem Format die Rückgabe geliefert werden soll.	Der Parameter hat den Namen `format`. Wird dieser nicht mit einem Wert belegt, handelt es sich um die HTML-Rückgabe. Als Werte können `xml`, `json` und `jsonp` angegeben werden.	-
Rückgabeversion	Um den Umstieg auf neue Versionen zu erleichtern, besitzt FACT-Finder versionierte Rückgabe-APIs. Damit können zB neuere FACT-Finder Versionen mit älterem Integrationscode betrieben werden, so dass dieser bei Bedarf zeitversetzt aktualisiert werden könnte.	Die gewünschte Rückgabeversion, wird über den Parameter `version` mitgegeben. In der FACT-Finder Version 7.2 können die Werte `6.11`, `7.0`, `7.1` und `7.2` verwendet werden. Beachten Sie, dass per Anwendungskonfiguration eine Standard-Version definiert wird, im Normalfall müssen Sie daher diesen Parameter nicht setzen.	Die Version der Webservicerückgabe wird durch Wahl des Endpunktes festgelegt.
Anwendungsnamen verbergen	Die zurückgelieferten Suchparameter-URLs fangen im Normalfall mit dem Namen der FACT-Finder Serverapplikation an. Dies kann jedoch deaktiviert werden. Dies ist z. B. bei Installationen mit Lastverteilung sinnvoll, bei denen die unterschiedlichen FACT-Finder-Applikationen unterschiedliche Namen tragen. Das kann aber auch in „normalen“ Einsatzszenarien verwendet werden, um Übertragungsvolumen zu sparen.	Wenn Sie `omitContextName=true` übergeben, beginnen die URLs mit dem Action- anstatt des Anwendungsnamens.	-
Beschreibung von Logfiles	Manchmal ist es sinnvoll, Logfiles eine Beschreibung hinzuzufügen. Etwa, wenn nur bestimmte Suchanfragen ausgewertet werden sollen. Eine derartige Beschreibung kann dann beispielsweise in der Logfileanalyse eingesehen werden. Der Wert darf nur Buchstaben und Ziffern enthalten.	Der hierfür notwendige zusätzliche Parameter hat den Namen `log` und muss beim Suchaufruf mit übergeben werden. Der Wert des Parameters ist dann die Beschreibung des Logfiles.	`Custom-Parameter` "`log`”, der im `Params`-Objekt gesetzt wird.