| 1 | CQL Search Installation |
|---|
| 2 | (The part of the text about context.xml and web.xml files |
|---|
| 3 | can be used to build NetBeans projects as well.) |
|---|
| 4 | ------------------------------------ |
|---|
| 5 | |
|---|
| 6 | Contents: |
|---|
| 7 | - Requirements |
|---|
| 8 | - Installation and Configuration of CQLSearch |
|---|
| 9 | -- placing war-file |
|---|
| 10 | -- The fragment web.txt to be present in Tomcat's web.xml file |
|---|
| 11 | - Testing URI's file. |
|---|
| 12 | - For the developer: information about Federated-Content-Search subproject of |
|---|
| 13 | CLARIN and over the external library that |
|---|
| 14 | supplies interfaces and parent classes |
|---|
| 15 | |
|---|
| 16 | = Requirements = |
|---|
| 17 | |
|---|
| 18 | * cqlsearch2-XXX package |
|---|
| 19 | * Tomcat >=5, with the Trova search engine deployed |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | = Installation and Configuration of CQLSearch = |
|---|
| 24 | ========================================================================================= |
|---|
| 25 | == PLACING WAR-file == |
|---|
| 26 | |
|---|
| 27 | You must deploy the cqlsearch2's .war file to the Tomcat instance where Trova search engine |
|---|
| 28 | is deployed. E.g. on lux16 it is tomcat-webuser. |
|---|
| 29 | |
|---|
| 30 | |
|---|
| 31 | ============================================================================================= |
|---|
| 32 | == web.xml === |
|---|
| 33 | |
|---|
| 34 | Find the following in this tar-ball: |
|---|
| 35 | -- DeploymentSettings/web.txt |
|---|
| 36 | |
|---|
| 37 | Check if you have listed there parameters in TomCat's web.xml and re-set them properly if necessary. |
|---|
| 38 | |
|---|
| 39 | Th file consist of two parts: the first part contains the parameters shared by Trova, Annex, |
|---|
| 40 | cqlsearch. The second part consists of the server-dependent parameters specific only for |
|---|
| 41 | CQLSearch. There are comments near these parameters on how to set the values. Read these comments. |
|---|
| 42 | |
|---|
| 43 | |
|---|
| 44 | ============================================================================================= |
|---|
| 45 | |
|---|
| 46 | = Testing URI's = |
|---|
| 47 | |
|---|
| 48 | You need to run a couple of url-requests to see if the things work after installation. Take the |
|---|
| 49 | url's from the corresponding file DeploymentSettings/TestURIs.txt. |
|---|
| 50 | |
|---|
| 51 | The base URI depends on a server, so read the first sentence where the base URI's for all |
|---|
| 52 | three srevers lux16, lux17 and corpus1 are listed. |
|---|
| 53 | |
|---|
| 54 | If you are a deploying sysadmin, you do not have to analyse and report the search or scan results, |
|---|
| 55 | you just have to check if there are no exceptions, errors and warnings and report about them |
|---|
| 56 | if necessary. |
|---|
| 57 | |
|---|
| 58 | ============================================================================================= |
|---|
| 59 | |
|---|
| 60 | = For the developer: information over the external library |
|---|
| 61 | (supplies interfaces and parent classes) = |
|---|
| 62 | |
|---|
| 63 | CQL search is a part of the Federated (aggregated) search project with the idea that via one common |
|---|
| 64 | interface a user can make a SRU/CQL request which is dispatched across all the institutions |
|---|
| 65 | participating in the project. See http://weblicht.sfs.uni-tuebingen.de/Aggregator/. |
|---|
| 66 | |
|---|
| 67 | As a result the user obtains hits from all the participants, including |
|---|
| 68 | MPI. Each participant implements its own search engine, and responsible to make it compatible |
|---|
| 69 | with the common interface. That's why all the participants are using the same library of interfaces |
|---|
| 70 | and parent classes, created in Mannheim by Oliver Schoenefeld. The commented sources are available |
|---|
| 71 | (for reading only!!!) at https://svn.clarin.eu/ (e.g. SRUServer). |
|---|
| 72 | |
|---|
| 73 | |
|---|
