Needed Files

The settings for the search are allocated to two files. The first file is a XML file that contains necessary features for the search like the search SQL and the search components. The second file is a JSON file that contains optional features like the sheet title and statistic information for the infodrawer (the expandable/ collapsible right area in the FSM).

File structure

If a user requests a specific search with the URL http://<server><appname>/DynamicSearch/<searchtype>, the DynamicSearch framework checks the following (sub-) directories for a file with the name <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/<username>

The folders have different priorities. The priority determines which file is used, if the file is found in several folders. These are the folders listed from highest to lowest priority:

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

That means that if the target file <searchtype>.xml is in both folders /App_Data/DynamicSearch/Custom/Users/<username>/ and /App_Data/DynamicSearch/, then the framework chooses the file from the subfolder /Users.

Name conventions

Currently there are only name conventions for external users. If an external user wants to access the URL http://<server><appname>/DynamicSearch/<searchtype>, the framework looks for the file <searchtype>_external.xml first. The folder conventions from above still apply but the target file changes to <searchtype>_external.xml. If the framework cannot find a file with this name convention, the default file name without the suffix "_external" will be used.