Wiki source code of Solr Search Use Cases (5.2)
Last modified by Vincent Massol on 2024/11/19 16:13
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{velocity}} | ||
| 2 | $xwiki.ssx.use("Improvements.WebHome") | ||
| 3 | $xwiki.ssx.use("Standards.WebHome") | ||
| 4 | $xwiki.ssx.use("Improvements.SearchFeedback50") | ||
| 5 | {{/velocity}} | ||
| 6 | |||
| 7 | This page contains the requirements for the SOLR Search feature, gathering uses cases, issues reports and test cases for the planned functionality. | ||
| 8 | |||
| 9 | ((( | ||
| 10 | == Use Cases, JIRAs and Test Cases == | ||
| 11 | |||
| 12 | (% style="width: 99%;" class='table-bordered' %) | ||
| 13 | |= Use Cases |= JIRAs |= Test Cases|= Status |=\\ | ||
| 14 | |(% width="25%%" %)((( | ||
| 15 | {{usecase}} | ||
| 16 | {{status group='P1'/}} Configure the search from the administration | ||
| 17 | {{/usecase}} | ||
| 18 | )))|(% width="45%%" %)((( | ||
| 19 | {{jiraIssues}} | ||
| 20 | XWIKI-8741, | ||
| 21 | XWIKI-9294, | ||
| 22 | XWIKI-8689 | ||
| 23 | {{/jiraIssues}} | ||
| 24 | )))|(% width="20%%" %)((( | ||
| 25 | * TC: Verify changing Default Search engine | ||
| 26 | [[Tests/Switch+To+Lucene+Search>>http://test.xwiki.org/xwiki/bin/view/Administration+Tests/Switch+To+Lucene+Search]] | ||
| 27 | * TC: Verify index status and progress | ||
| 28 | [[Tests/Solr+Add+to+Index>>http://test.xwiki.org/xwiki/bin/view/Administration+Tests/Solr+Add+to+Index]] | ||
| 29 | [[Tests/Solr+Delete+from+Index>>http://test.xwiki.org/xwiki/bin/view/Administration+Tests/Solr+Delete+from+Index]] | ||
| 30 | [[Tests/Solr+Reindex>>http://test.xwiki.org/xwiki/bin/view/Administration+Tests/Solr+Reindex]] | ||
| 31 | * TC: Modify/Add documents and search for them | ||
| 32 | [[Tests/Create+Page+And+Search>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Create+Page+And+Search]] | ||
| 33 | [[Tests/Modify+Page+And+Search>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Modify+Page+And+Search]] | ||
| 34 | )))|(% width="5%%" %)((( | ||
| 35 | {{status group="WD"/}} | ||
| 36 | )))|((( | ||
| 37 | {{status group=""/}} | ||
| 38 | ))) | ||
| 39 | |((( | ||
| 40 | {{usecase}} | ||
| 41 | {{status group='P1'/}} Display: | ||
| 42 | * Page Name | ||
| 43 | * Location: wiki > space > page | ||
| 44 | * Language | ||
| 45 | * Occurrences and the location type of them (content, object) | ||
| 46 | * (?) Modified by | ||
| 47 | * (?) Relevance | ||
| 48 | {{/usecase}} | ||
| 49 | )))|((( | ||
| 50 | {{jiraIssues}} | ||
| 51 | XWIKI-9273 | ||
| 52 | {{/jiraIssues}} | ||
| 53 | )))|((( | ||
| 54 | * TC: Display and locate multiple entries (in content and objects associated) | ||
| 55 | [[Tests/Search+For+Attachments>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Attachments]] | ||
| 56 | [[Tests/Search+For+Comments>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Comments]] | ||
| 57 | [[Tests/Search+For+Content>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Content]] | ||
| 58 | [[Tests/Search+For+Page+Name>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Page+Name]] | ||
| 59 | [[Tests/Search+For+Raw+Content>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Raw+Content]] | ||
| 60 | [[Tests/Search+For+Title>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Title]] | ||
| 61 | )))|((( | ||
| 62 | {{status group="WD"/}} | ||
| 63 | )))|((( | ||
| 64 | {{status group=""/}} | ||
| 65 | ))) | ||
| 66 | |(% rowspan="6" %)((( | ||
| 67 | {{usecase}} | ||
| 68 | {{status group='P1'/}} Filter for: | ||
| 69 | * wikis | ||
| 70 | * spaces | ||
| 71 | * language | ||
| 72 | * type: document, attachment, object, object property | ||
| 73 | * filetype: text, audio, image, video | ||
| 74 | * author, creator | ||
| 75 | * date, creation date | ||
| 76 | (((---))) | ||
| 77 | * Advanced Search | ||
| 78 | * Faceted Search | ||
| 79 | ** visible options for clarifying and refining queries | ||
| 80 | ** map that provides insight into the content and its organization | ||
| 81 | ** principles of: progressive disclosure and incremental construction, by taking a series of small, simple steps | ||
| 82 | (((---))) | ||
| 83 | {{/usecase}} | ||
| 84 | |||
| 85 | {{usecase}} | ||
| 86 | Ex1. Allow filtering by criteria which correspond to fields in the class that defines the type of documents | ||
| 87 | {{/usecase}} | ||
| 88 | |||
| 89 | {{usecase}} | ||
| 90 | Ex2. Search for attachments in documents that have an object of type X | ||
| 91 | {{/usecase}} | ||
| 92 | |||
| 93 | {{usecase}} | ||
| 94 | Ex3. Filter documents by language and by the author that last edited them | ||
| 95 | {{/usecase}} | ||
| 96 | )))|((( | ||
| 97 | {{jiraIssues}} | ||
| 98 | XWIKI-9076, | ||
| 99 | {{/jiraIssues}} | ||
| 100 | )))|((( | ||
| 101 | * TC Advanced: | ||
| 102 | [[Tests/Advanced+Search>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Advanced+Search]] | ||
| 103 | [[Tests/File+Type+Search>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/File+Type+Search]] | ||
| 104 | [[Tests/Search+And+Filter+Language>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+And+Filter+Language]] | ||
| 105 | )))|((( | ||
| 106 | {{status group="WD"/}} | ||
| 107 | )))|((( | ||
| 108 | {{status group=""/}} | ||
| 109 | ))) | ||
| 110 | |((( | ||
| 111 | {{jiraIssues}} | ||
| 112 | XWIKI-8444, | ||
| 113 | XWIKI-9193, | ||
| 114 | XWIKI-9537, | ||
| 115 | XWIKI-9510, | ||
| 116 | XWIKI-9512, | ||
| 117 | XWIKI-9514, | ||
| 118 | XWIKI-9309, | ||
| 119 | XWIKI-9417 | ||
| 120 | {{/jiraIssues}} | ||
| 121 | )))|((( | ||
| 122 | * TC Facets: | ||
| 123 | [[Tests/Faceted+Search>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Faceted+Search]] | ||
| 124 | )))|((( | ||
| 125 | {{status group="WP"/}} | ||
| 126 | )))|((( | ||
| 127 | |||
| 128 | ))) | ||
| 129 | |((( | ||
| 130 | {{jiraIssues}} | ||
| 131 | XWIKI-9508 | ||
| 132 | {{/jiraIssues}} | ||
| 133 | )))|((( | ||
| 134 | |||
| 135 | )))|((( | ||
| 136 | {{status group="WN"/}} | ||
| 137 | )))|((( | ||
| 138 | |||
| 139 | ))) | ||
| 140 | |((( | ||
| 141 | {{jiraIssues}} | ||
| 142 | XWIKI-8579, | ||
| 143 | XWIKI-9255 | ||
| 144 | {{/jiraIssues}} | ||
| 145 | )))|((( | ||
| 146 | * TC: Test Suite mixing fields (expected vs. actual results) | ||
| 147 | )))|((( | ||
| 148 | {{status group="WP"/}} | ||
| 149 | )))|((( | ||
| 150 | {{status group=""/}} | ||
| 151 | ))) | ||
| 152 | |((( | ||
| 153 | {{jiraIssues}} | ||
| 154 | XWIKI-9533 | ||
| 155 | {{/jiraIssues}} | ||
| 156 | )))|((( | ||
| 157 | * TC: | ||
| 158 | )))|((( | ||
| 159 | {{status group="NP"/}} | ||
| 160 | )))|((( | ||
| 161 | |||
| 162 | ))) | ||
| 163 | |((( | ||
| 164 | {{jiraIssues}} | ||
| 165 | XWIKI-454 | ||
| 166 | {{/jiraIssues}} | ||
| 167 | )))|((( | ||
| 168 | * TC: | ||
| 169 | )))|((( | ||
| 170 | {{status group="NP"/}} | ||
| 171 | )))|((( | ||
| 172 | |||
| 173 | ))) | ||
| 174 | |((( | ||
| 175 | {{usecase}} | ||
| 176 | {{status group='P1'/}} Sort for: | ||
| 177 | * Relevance | ||
| 178 | * Title | ||
| 179 | * Last Author | ||
| 180 | * Date | ||
| 181 | {{/usecase}} | ||
| 182 | )))|((( | ||
| 183 | {{jiraIssues}} | ||
| 184 | XWIKI-8807 | ||
| 185 | {{/jiraIssues}} | ||
| 186 | )))|((( | ||
| 187 | * TC: Sort | ||
| 188 | [[Tests/Sort+Search+Results>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Sort+Search+Results]] | ||
| 189 | )))|((( | ||
| 190 | {{status group="WD"/}} | ||
| 191 | )))|((( | ||
| 192 | {{status group=""/}} | ||
| 193 | ))) | ||
| 194 | |((( | ||
| 195 | {{usecase}} | ||
| 196 | {{status group='P1'/}} Highlight query text occurrences | ||
| 197 | {{/usecase}} | ||
| 198 | )))|((( | ||
| 199 | {{jiraIssues}} | ||
| 200 | XWIKI-8795 | ||
| 201 | {{/jiraIssues}} | ||
| 202 | )))|((( | ||
| 203 | * TC: Verify one and multiple highlights for a word (consecutive appearances, different paragraphs) | ||
| 204 | * TC: Test 'Highlight all matches' link | ||
| 205 | [[Tests/Search+And+Highlight+All+Matches>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+And+Highlight+All+Matches]] | ||
| 206 | )))|((( | ||
| 207 | {{status group="WD"/}} | ||
| 208 | )))|((( | ||
| 209 | {{status group=""/}} | ||
| 210 | ))) | ||
| 211 | |((( | ||
| 212 | {{usecase}} | ||
| 213 | {{status group='P1'/}} Adjust relevance scoring for certain types of resources | ||
| 214 | * pages should have higher relevance than attachments | ||
| 215 | * Query boost | ||
| 216 | * Relevance | ||
| 217 | * Customization | ||
| 218 | {{/usecase}} | ||
| 219 | )))|((( | ||
| 220 | {{jiraIssues}} | ||
| 221 | XWIKI-6221, | ||
| 222 | XWIKI-9530, | ||
| 223 | XWIKI-9322 | ||
| 224 | {{/jiraIssues}} | ||
| 225 | )))|((( | ||
| 226 | * TC: Test query boost values | ||
| 227 | )))|((( | ||
| 228 | {{status group="WP"/}} | ||
| 229 | )))|((( | ||
| 230 | |||
| 231 | ))) | ||
| 232 | |((( | ||
| 233 | {{usecase}} | ||
| 234 | {{status group='P1'/}} | ||
| 235 | Make sure the first n(3) entries are the most relevant ones, although SOLR Search doesn't display the Result Scores anymore | ||
| 236 | * Relevance | ||
| 237 | {{/usecase}} | ||
| 238 | )))|((( | ||
| 239 | {{jiraIssues}} | ||
| 240 | XWIKI-9268 | ||
| 241 | {{/jiraIssues}} | ||
| 242 | )))|((( | ||
| 243 | * TC: Verify the relevance of results | ||
| 244 | )))|((( | ||
| 245 | {{status group="WD"/}} | ||
| 246 | )))|((( | ||
| 247 | {{status group=""/}} | ||
| 248 | ))) | ||
| 249 | |((( | ||
| 250 | {{usecase}} | ||
| 251 | {{status group='P2'/}} Explicitly say in which fields you don't want to search | ||
| 252 | * Customization | ||
| 253 | {{/usecase}} | ||
| 254 | )))|((( | ||
| 255 | {{jiraIssues}} | ||
| 256 | XWIKI-454, | ||
| 257 | XPLUCENE-25 | ||
| 258 | {{/jiraIssues}} | ||
| 259 | )))|((( | ||
| 260 | * TC: Restrict searching in some fields | ||
| 261 | * TC: Search for a password field | ||
| 262 | )))|((( | ||
| 263 | {{status group="WN"/}} | ||
| 264 | )))|((( | ||
| 265 | {{status group=""/}} | ||
| 266 | ))) | ||
| 267 | |((( | ||
| 268 | {{usecase}} | ||
| 269 | {{status group='P2'/}} Ability to customize the search from Administration, choosing the what filters and sorting types are accessible to the user | ||
| 270 | * Customization | ||
| 271 | {{/usecase}} | ||
| 272 | )))|((( | ||
| 273 | {{jiraIssues}} | ||
| 274 | XWIKI-9413, | ||
| 275 | XWIKI-9509, | ||
| 276 | XWIKI-9538, | ||
| 277 | XWIKI-9513 | ||
| 278 | {{/jiraIssues}} | ||
| 279 | )))|((( | ||
| 280 | * TC: Limit the number of displayed entries for facet categories | ||
| 281 | * TC: Choose the categories shown in the "Refine your search" panel | ||
| 282 | )))|((( | ||
| 283 | {{status group="WN"/}} | ||
| 284 | )))|((( | ||
| 285 | |||
| 286 | ))) | ||
| 287 | |((( | ||
| 288 | {{usecase}} | ||
| 289 | {{status group='P1'/}} Allow special characters in queries, like 'Première', 'AL_CL' (underscore), | ||
| 290 | * Language analyzers | ||
| 291 | {{/usecase}} | ||
| 292 | )))|((( | ||
| 293 | {{jiraIssues}} | ||
| 294 | XWIKI-8815, | ||
| 295 | XWIKI-8548, | ||
| 296 | XWIKI-7394 | ||
| 297 | {{/jiraIssues}} | ||
| 298 | )))|((( | ||
| 299 | * TC: Tests for special characters from different languages and special characters | ||
| 300 | [[Tests/Search+For+Special+Characters>>http://test.xwiki.org/xwiki/bin/view/Search+Tests/Search+For+Special+Characters]] | ||
| 301 | )))|((( | ||
| 302 | {{status group="WD"/}} | ||
| 303 | )))|((( | ||
| 304 | {{status group=""/}} | ||
| 305 | ))) | ||
| 306 | |((( | ||
| 307 | {{usecase}} | ||
| 308 | {{status group='P1'/}} Search for substrings of the initial query string | ||
| 309 | * 'SonySR35' search for 'SR35' | ||
| 310 | * 'café' does not return docs containing 'cafe' or 'cafés' | ||
| 311 | * Language analyzers | ||
| 312 | {{/usecase}} | ||
| 313 | )))|((( | ||
| 314 | {{jiraIssues}} | ||
| 315 | XWIKI-6222 | ||
| 316 | {{/jiraIssues}} | ||
| 317 | )))|((( | ||
| 318 | * TC: Test for substrings | ||
| 319 | )))|((( | ||
| 320 | {{status group="WD"/}} | ||
| 321 | )))|((( | ||
| 322 | {{status group=""/}} | ||
| 323 | ))) | ||
| 324 | |((( | ||
| 325 | {{usecase}} | ||
| 326 | {{status group='P3'/}} Document what syntax is allowed in the query: | ||
| 327 | ",',AND,?, etc. | ||
| 328 | {{/usecase}} | ||
| 329 | )))|((( | ||
| 330 | {{jiraIssues}} | ||
| 331 | XINFRA-110 | ||
| 332 | {{/jiraIssues}} | ||
| 333 | )))|((( | ||
| 334 | * Documentation: Update [[Search Application Query Syntax>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Search+Application+Query+Syntax]] | ||
| 335 | )))|((( | ||
| 336 | {{status group="WP"/}} | ||
| 337 | )))|((( | ||
| 338 | {{status group=""/}} | ||
| 339 | ))) | ||
| 340 | |((( | ||
| 341 | {{usecase}} | ||
| 342 | {{status group='P3'/}} Internationalization | ||
| 343 | {{/usecase}} | ||
| 344 | )))|((( | ||
| 345 | {{jiraIssues}} | ||
| 346 | XWIKI-8441, | ||
| 347 | XWIKI-8535 | ||
| 348 | {{/jiraIssues}} | ||
| 349 | )))|((( | ||
| 350 | * TC: Test the translations keys for our supported languages | ||
| 351 | [[Tests/Administration+Languages>>http://test.xwiki.org/xwiki/bin/view/Administration+Tests/Administration+Languages]] | ||
| 352 | )))|((( | ||
| 353 | {{status group="WD"/}} | ||
| 354 | )))|((( | ||
| 355 | {{status group=""/}} | ||
| 356 | ))) | ||
| 357 | |((( | ||
| 358 | {{usecase}} | ||
| 359 | {{status group='P3'/}} RSS feed on search terms | ||
| 360 | {{/usecase}} | ||
| 361 | )))|((( | ||
| 362 | {{jiraIssues}} | ||
| 363 | XWIKI-9082 | ||
| 364 | {{/jiraIssues}} | ||
| 365 | )))|((( | ||
| 366 | * TC: Test RSS feed content | ||
| 367 | )))|((( | ||
| 368 | {{status group="NP"/}} | ||
| 369 | )))|((( | ||
| 370 | {{status group=""/}} | ||
| 371 | ))) | ||
| 372 | |((( | ||
| 373 | {{usecase}} | ||
| 374 | {{status group='P2'/}} Synchronize results from Search Suggest with the Search Results page | ||
| 375 | {{/usecase}} | ||
| 376 | )))|((( | ||
| 377 | {{jiraIssues}} | ||
| 378 | XWIKI-9392 | ||
| 379 | {{/jiraIssues}} | ||
| 380 | )))|((( | ||
| 381 | * TC: Verify concordance between the top suggestion provided by suggest and the results page | ||
| 382 | )))|((( | ||
| 383 | {{status group="WD"/}} | ||
| 384 | )))|((( | ||
| 385 | {{status group=""/}} | ||
| 386 | ))) | ||
| 387 | |((( | ||
| 388 | {{usecase}} | ||
| 389 | {{status group='P3'/}}Have suggest when writing query words and/or provide spellcheking | ||
| 390 | {{/usecase}} | ||
| 391 | )))|((( | ||
| 392 | {{jiraIssues}} | ||
| 393 | XWIKI-9278 | ||
| 394 | {{/jiraIssues}} | ||
| 395 | )))|((( | ||
| 396 | * TC: Suggest search keywords if the user misspelled them | ||
| 397 | )))|((( | ||
| 398 | {{status group="NP"/}} | ||
| 399 | )))|((( | ||
| 400 | {{status group=""/}} | ||
| 401 | ))) | ||
| 402 | |((( | ||
| 403 | {{usecase}} | ||
| 404 | {{status group='P3'/}} Have a ##search## macro with various parameters and that can be used by the user in any page | ||
| 405 | {{/usecase}} | ||
| 406 | )))|((( | ||
| 407 | |||
| 408 | )))|((( | ||
| 409 | |||
| 410 | )))|((( | ||
| 411 | |||
| 412 | |||
| 413 | {{status group="NP"/}} | ||
| 414 | )))|((( | ||
| 415 | {{status group=""/}} | ||
| 416 | ))) | ||
| 417 | ))) | ||
| 418 | |||
| 419 | (% class="clearfloats" %) | ||
| 420 | ((( | ||
| 421 | |||
| 422 | ))) |