Docstore - OLE 0.6

 1.Getting the Source Code from SVN

• Check out the code for ole-utility project from the following SVN Repository:

              ole-utility -UTILITY_PROJ

• Check out the ole-docstore directory from the following SVN Repository:

           ole-docstore

             Assume that the code is checked out into the following folders:

            \projects\OLE-SVN\ole-trunk\ole-docstore\ -- DOCSTORE_PROJ

            \projects\OLE-SVN\ole-trunk\ole-docstore\ole-docstore-engine - DOCSTORE_ENGINE_PROJ

            \projects\OLE-SVN\ole-trunk\ole-docstore\ole-docstore-search -- DOCSTORE_SEARCH_PROJ

            \projects\OLE-SVN\ole-trunk\ole-docstore\ole-docstore-webapp -- DOCSTORE_WEBAPP_PROJ

            \projects\OLE-SVN\ole-trunk\ole-docstore\ole-solr-config -- DOCSTORE_SOLR_CONFIG_PROJ

2.Building the Code

• Open command prompt and go to the folder: % UTILITY_PROJ %

           Run "mvn clean install".

• Open command prompt and go to the folder: %DOCSTORE_PROJ%

          Run "mvn clean install".

          It creates oledocstore.war in %DOCSTORE_WEBAPP_PROJ%\target directory.

3.Deployment

3.1  Setting up properties

Create the following directories in the same drive as %TOMCAT_HOME% directory. 

• \opt\docstore\discovery\properties
• \opt\docstore\discovery\solr-config
• \opt\docstore\properties 

Go to %TOMCAT_HOME%\bin directory.

Open catalina.bat file

Define the following variables in catalina.bat file after the line :doneSetArgs 

•        set OLE_DISCOVERY_HOME=\opt\docstore\discovery
•        set OLE_DISCOVERY_PROP_HOME=%OLE_DISCOVERY_HOME%\properties
•        set OLE_DISCOVERY_CONFIG_HOME=%OLE_DISCOVERY_HOME%\solr-config
•        set OLE_DOCSTORE_HOME=\opt\docstore
•        set OLE_DOCSTORE_PROP_HOME=%OLE_DOCSTORE_HOME%\properties

Set the following JAVA_OPTS after the line:set JAVA_OPTS=%JAVA_OPTS% %LOGGING_CONFIG%

Save the file catalina.bat                                         

•      Copy the contents of DOCSTORE_SOLR_CONFIG_PROJ to OLE_ DISCOVERY_CONFIG_HOME.

•      Copy ole-discovery.properties from DOCSTORE_WEBAPP_PROJ/src/main/resources to OLE_ DISCOVERY_PROP_HOME.

•      Copy log4j.properties from DOCSTORE_WEBAPP_PROJ/src/main/resources to OLE_DOCSTORE_PROP_HOME

Modify the port in the following property in the above file to match the Tomcat port. (Default is 8080)

                  docSearchURL=http://localhost:8080/oledocstore

•       Copy DOCSTORE_WEBAPP_PROJ /repository-derby.xml to OLE_DOCSTORE_PROP_HOME.and rename it as  repository.xml

•       Copy DOCSTORE_ENGINE_PROJ/src/main/resources/org/kuali/ole/utility/documentstore.properties to OLE_DOCSTORE_PROP_HOME

Modify the port in the following property in the above file to match the Tomcat port. (Default is 8080)

local.docSearchURL=http://localhost:8080/oledocstore/

3.2 Deploying the War file to Tomcat

•     Copy oledocstore.war file from %DOCSTORE_WEBAPP_PROJ%target to %TOMCAT_HOME%\webapps folder

4.Running Docstore and Discovery

Start the Tomcat Server.

Open a browser.

Navigate to the following URLs.

•    http://localhost:8080/oledocstore     
•    http://localhost:8080/oledocstore/discovery.do
•    http://localhost:8080/oledocstore/discovery

5.Ingest

Open a browser.

        Go to URL [http://localhost:8080/oledocstore/discovery|http://localhost:8080/oledocstore/discovery] and click on "Ingest String Content" tab.

        Copy the sample xml provided in the screen.

        Click Submit button.

The response xml in the browser gives the result of the stream ingest process.

 The data can also be verified using the URLs given in the previous section.

6.Bulk Ingest

Copy the following sample data files to the folder specified by the property  local.batch.upload.dir (only this property) in the file %OLE_DISCOVERY_PROP_HOME%documentstore.properties. This property should be changed to a directory suitable to the local user's system. (e.g. /ole-test-data/bulkingest). Create this folder if it does not exist.

Please note: There may be issues with file/folder permissions with this directory. Make sure this directory is fully accessible by all users.

•  %DOCSTORE_ENGINE_PROJ%src\test\resources\org\kuali\ole\bulkIngest\files\bulkIngest-Work-Bib-Marc-20.xml    --- This is a sample test data file
• %DOCSTORE_ENGINE_PROJ%src\test\resources\org\kuali\ole\bulkIngest\files\bulkIngest-Work-Inst-OleML-20.xml   --- This is a sample test data file

Copy the first file (Bib data) to the destination folder specified by the property local.batch.upload.dir in the documentstore.properties file.

After the first file is ingested, copy the second file (Instance data).

 Open a browser.

             Go to URL http://localhost:8080/oledocstore/admin.jsp

             Click on 'BulkIngest' button. Need to click only once.

 To verify that the data is stored in DocStore, go to URL

            http://localhost:8080/oledocstore

           Click 'Refresh Summary' button in the Summary tab.

           Note for the count for each DocType.

To verify that the data is indexed in DocStore, go to URL

         http://localhost:8080/oledocstore/discovery

         Click 'Refresh' button in the Summary tab.

         Note for the count for each DocType.

 7.LOG Files

The log files will be written to the following locations by default.

•  DocStore - %TOMCAT_HOME%/bin/logs/ole-docstore.log
•  DocStore - %TOMCAT_HOME%/bin/logs/ole-docstore-error.log

8.DocStore within OLE(Optional)

Copy the oledocstore.war files into the Tomcat running OLE.

Before building OLE make sure the following properties are correctly set in local-build.properties file in %OLE_HOME% directoty.

•  ole.docstoreapp.url=http://localhost:8080/oledocstore/document
•  ole.discovery.app.url=http://localhost:8080/oledocstore/discovery/

Copy the file 'olebibeditor.properties' provided along with this document in to your %USER_HOME% directory.

Modify the following property in the above file as per your local environment.

•  local.docstore.checkout.url=http://localhost:8080/oledocstore/checkout
•  local.docstore.checkin.url=http://localhost:8080/oledocstore/document
•  local.discovery.url=http://localhost:8080/oledocstore/bib

 Open a browser.

      Go to URL

       http://localhost:8080/ole-local/portal.do?channelTitle=DocumentStoreSearch&channelUrl=discovery.do

       Click on 'Search' button.