Benötigte Dateien

Die Einstellungen für die Suche sind auf zwei Dateien verteilt. Bei der ersten Datei handelt es sich um eine XML-Datei, die die notwendigen Eigenschaften für die Suche, wie z.B.: das Such-SQL und die Suchparameter, beinhaltet. Bei der zweiten Datei handelt es sich um eine JSON-Datei, die optionale Eigenschaften für die Suche beinhaltet, wie z.B.: der Sheettitle oder Statistikinformationen für den Infodrawer (der auf-/zuklappbare rechte Bereich im FSM).

Dateistruktur

Wenn ein angemeldeter Benutzer eine bestimmte Suche über die URL http://<server><appname>/DynamicSearch/<searchtype> anfordert, überprüft das DynamicSearch-Framework die folgenden (Unter-) Verzeichnisse auf eine Datei mit dem Namen <searchtype>.xml

App_Data/DynamicSearch

App_Data/DynamicSearch /Custom

App_Data/DynamicSearch /Custom/Groups /<usergroupnr>

App_Data/DynamicSearch /Custom/MainGroups/<usermaingroupnr>

App_Data/DynamicSearch /Custom/Users/<Benutzername>

Die Ordner haben unterschiedliche Prioritäten. Die Priorität legt fest, welche Datei verwendet werden soll, wenn sie sich in mehreren Ordnern befindet. Hier sind die Ordner aufgelistet, die von der höchsten bis zur niedrigsten Priorität reichen:

App_Data/DynamicSearch/Custom/Users/<username>

App_Data/DynamicSearch/Custom/Groups/<usergroupnr>

App_Data/DynamicSearch/Custom/MainGroups/<usermaingroupnr>

App_Data/DynamicSearch/Custom/Custom

App_Data/DynamicSearch

Dies bedeutet, dass, wenn sich beispielsweise die Zieldatei <searchtype>.xml in den beiden Ordnern /App_Data/DynamicSearch/Custom/Users/<username>/ und /App_Data/DynamicSearch/ befindet, das Framework die Datei auswählt, die sich derzeit im Unterordner /Users befindet.

Namenskonventionen

Derzeit gibt es eine Namenskonvention nur für externe Benutzer. Wenn ein externer Benutzer auf die URL http://<server><appname>/DynamicSearch/<searchtype> zugreifen möchte, sucht das Framework zunächst nach der Datei <searchtype>_external.xml. Die im oberen Abschnitt definierten Ordnerkonventionen gelten weiterhin, aber die Zieldatei ändert sich zu <searchtype>_external.xml. Wenn das Framework eine Datei mit dieser Namenskonvention nicht findet, wird der Standarddateiname ohne den Suffix "_external" verwendet.