Changeset 26391 for gs3-extensions/fedora/README

Timestamp:

2012-10-25T14:15:39+13:00 (11 years ago)

Author:

ak19

Message:

1. Added index.properties.in template file in order to set the indexwritelocktimeout (which had been defaulting to 0 until then), which build.xml then uses to write out the index.properties file with the placeholder string replaced. 2. README updated, including with instructions on manually deleting pids from the fedora repository and gsearch index.

File:

• gs3-extensions/fedora/README (modified) (4 diffs)

gs3-extensions/fedora/README

@@ -188 +188 @@
 Deleting a Fedora GS3 collection is accomplished with the following 2 steps:
 - Run the g2f-deletecol.pl script over the collection to be deleted. Assuming the collection is called fedora1, you'd run:
-    g2f-deletecol.pl -hostname localhost -port 8383 -password pounamu -removeold -collectdir /<GS3>/web/sites/localsite/collect fedora1
+    g2f-deletecol.pl -hostname localhost -port 8383 -password pounamu -collectdir /<GS3>/web/sites/localsite/collect fedora1
 - manually delete the Greenstone collection directory from the filesystem
 
+
+To run this manually, 
+- first remove the pids from the GSearch index:
+/<GS3>/packages/tomcat/webapps/fedoragsearch/client>/<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex deletePID greenstone:fedora1-HASH010313b14474bc72b296b15f
+
+It will ask for the fedoragsearch username and password, which by default are fedoraAdmin and pounamu, respectively.
+
+- then purge the necessary documents (pids) from the fedora repository:
+/<GS3>/ext/fedora3/client/bin>./fedora-purge.sh localhost:8383 fedoraAdmin pounamu greenstone:fedora1-HASHe14e36cba08bd41c663237 http "purging"
+
+- You can check it's all been deleted by visiting http://localhost:8383/fedora/search 
+and searching for:
+
+greenstone:*
+or greenstone:<colname>*
+
+Visit http://localhost:8383/fedoragsearch/rest?operation=browseIndex
+and browse the PID field
+
+You can also visit http://localhost:8383/fedoragsearch/rest?operation=gfindObjects
+then you can search for a query term by prefixing the index field to it, e.g ds.fulltext:computers 
 
 
@@ -222 +243 @@
 - @tomcatshutdownport@
 - @fedorapassw@
-Except for the first, which needs to be set when running the Fedora extension's ant targets, all the remaining ones can be specified 
+- @indexwritelocktimeout@
+
+Except for the first, which needs to be set when running the Fedora extension's ant targets, all the remaining ones can be specified in Greenstone 3's toplevel build.properties.
 
 
@@ -231 +254 @@
 - adjust_war_files/fedoragsearch/FgsConfig/FgsConfigIndexTemplate/Lucene/foxmlToLucene.xslt 
 - adjust_war_files/fedoragsearch/FgsConfig/FgsConfigIndexTemplate/Lucene/foxmlToLuceneGenerated.xslt
+- adjust_war_files/fedoragsearch/FgsConfig/FgsConfigIndexTemplate/Lucene/index.properties
 - adjust_war_files/fedoragsearch/client/runRESTClient.sh
 - adjust_war_files/fedoragsearch/client/runSOAPClient.sh
 - adjust_war_files/fedoragsearch/client/runSOAPClient.bat
+
 
 All these files will get copied into the same locations within <GS3>/packages/tomcat/webapps/fedoragsearch. The file fgsconfig-basic.properties.in will get copied as fgsconfig-basic.properties but with the previously-listed placeholder strings replaced.
@@ -333 +358 @@
 Further datastreams and metadata sets can be indexed by adding similar namespace declarations and xml elements to these 2 XSLT files. 
 If the changes are not meant to apply for all Greenstone users, individual Greenstone users can add fields for indexing by making such changes to just the file fedoragsearch/FgsConfig/FgsConfigIndexTemplate/Lucene/foxmlToLuceneGenerated.xslt
+
+
+d. By default, Lucene's lock obtain timeout is set to 0 in its properties file, which is not acceptable for all but the smallest documents. The lock timeout can be customised in build.properties and by default is set to 10000 (or 1000), which can be adjusted before starting the Fedora extension installation process.
+
+The installation process will write out this property into GSearch's FgsConfig/FgsConfigIndexTemplate/Lucene/index.properties: 
+    fgsindex.defaultWriteLockTimeout = 1000
+
+When fedoragsearch then gets deployed, this value will be propagated into: 
+    <GS3>/packages/tomcat/webapps/fedoragsearch/WEB-INF/classes/fgsconfigFinal/index/FgsIndex/index.properties