| Use Case | Build Full Index |
| Description | Build new full search index of all searchable OLAT resources. |
| Trigger | At startup if no index exist. OLAT Administrator can trigger a build through admin gui. |
| Input | Configuration : Build Index-Directory Index-Directory |
| Output | Lucene Index-Dir with new index |
| Sequence | Loop over all searchable OLAT resources Create for each OLAT resource a Lucene Document with OLAT attributes Final : copy new index files to index-directory |
| Notes | Performance : Can the index build with 100% CPU or shoud it run in backround with low CPU load ? |
| Use Case | Search |
| Description | Search with query in all indexed OLAT resources. |
| Trigger | OLAT User press search button |
| Input | Query (Query fields : lastChange, title, description, document-type, author,content) |
| Output | List with search result. Show for each result in text-block : - Title - Description - Author - Type [Forum, Forum-Message, Visitcard etc] - Link to OLAT resource |
| Sequence | 1. Search for resources match with query 2. loop over result to check visibility (access) for the user 3. return list with all allowed resources |
| Notes | Ev. Gefundener Text highliten |
| Use Case | Open OLAT resource |
| Description | After a search, user can open the OLAT resource for a item in result list. |
| Trigger | OLAT User press more link in result list |
| Input | Link Parameter Resource-URL |
| Output | OLAT Resource will be open |
| Sequence | 1. Security check if resource can be open. 2. Open resource in new tab. |
| Notes | - |
| Use Case | Update OLAT Resource / Upate index |
| Description | The index date will be updated because a OLAT user changed something. |
| Trigger | A OLAT user updated a searchable resource. |
| Input | documentId of the changed document. New documents has no documentId. |
| Output | Index will be updated in backgroud. |
| Sequence | The index will not be updated immediately, update goes into q asynchron queue. |
| Notes | - |