Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Info

Maven 3 is required for the installation below.

1.Getting the Source Code from SVN

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

              oleOLE-utilityDiscovery -UTILITYDISCOVERY_PROJ

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

              ole-docstore             Assume  Assume that the code is checked out into the following folders:

                          \projects\OLE-SVN\ole-trunk\ole-docstorediscovery\ole-discovery- DOCSTOREcore -- DISCOVERY_CORE_PROJ

                          \projects\OLE-SVN\ole-trunk\ole-docstorediscovery\ole-discovery-docstorewebapp -engine DOCSTOREDISCOVERY_ENGINEWEBAPP_PROJ           

             \projects\OLE-SVN\ole-trunk\ole-docstorediscovery\oleOLE-docstore-search SOLR -- DOCSTORESOLR_SEARCHCONFIG_PROJ

  • Check out the DocumentStore directory from the following SVN Repository:

           OLE-Documentstore

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

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

            \projects\OLE-SVN\ole-docstore-webapp -trunk\DocumentStore\ documentstore-engine DOCSTORE_WEBAPPENGINE_PROJ

                        \projects\OLE-SVN\ole-trunk\ole-docstore\DocumentStore\ documentstore-utility -- DOCSTORE_UTILITY_PROJ

            \projects\OLE-SVN\ole-solr-config trunk\DocumentStore\ documentstore-webapp -- DOCSTORE_SOLR_CONFIGWEBAPP_PROJ

2.Building the Code

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

...

  •  %DOCSTORE_PROJ%

          Run “mvn clean install”.

          It creates documentstore-webapp.war in %DOCSTORE_WEBAPP_PROJ%\target directory.

          Rename it to oledocstore.war

  • Open command prompt and go to the folder: %DOCSTORE% DISCOVERY_PROJ%

...

  • PROJ %

           Run “mvn clean install”.

          It creates oledocstore.war in %DOCSTORE  It creates ole-discovery-webapp.war in %DISCOVERY_WEBAPP_PROJ%PROJ%\target directory

           Rename it to ole-discovery. war

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 catalinaCreate/open setenv.bat file under %TOMCAT_HOME%\bin directory

Define the following variables in catalinasetenv.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 Set JAVA_OPTS after the line: as below.

set JAVA_OPTS=%JAVA_OPTS%

...

set JAVA_OPTS=%JAVA_OPTS%  -Xms512m -Xmx1g -XX:MaxPermSize=256m 256m
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Dapp.environment=local local
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Dsolr.solr.home="%OLE_DISCOVERY_CONFIG_HOME%" 
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Ddiscovery.properties.file="%OLE_DISCOVERY_PROP_HOME%\ole-discovery.properties" 
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Dolebibeditor.properties.home="%OLE_DOCSTORE_PROP_HOME%" 
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Ddocstore.properties.home="%OLE_DOCSTORE_PROP_HOME%" 
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Dorg.apache.jackrabbit.repository.home="%OLE_DOCSTORE_HOME%\jackrabbit" 
 set set JAVA_OPTS=%JAVA_OPTS% OPTS% -Dorg.apache.jackrabbit.repository.conf="%OLE_DOCSTORE_PROP_HOME%\repository.xml"    set JAVA_OPTS=%JAVA_OPTS% -Dlog4j.configuration="file:%OLE_DOCSTORE_PROP_HOME%\log4j.properties"

Save the file catalinasetenv.bat                                         

  •      Copy the contents of DOCSTORE_SOLR_CONFIG_PROJ to OLE_ DISCOVERY_CONFIG_HOME.
  •      Copy       Copy ole-discovery.properties from DOCSTOREDISCOVERY_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/oledocstoreole-discovery/

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

...

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

local.docSearchURL=http://localhost:8080/oledocstoreole-discovery/

3.2 Deploying the War files to Tomcat

  •    Copy ole-discovery.war file

...

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

...

Navigate to the following URLs.

5

...

Open a browser.

...

.

...

        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.

...

Bulk Ingest

Copy the following sample data files to the folder specified by the property  local.batch.upload.dirbulkIngestDir (only this property) in the file %OLE%DOCSTORE_DISCOVERY_PROP_HOME%documentstoreENGINE_PROJ%\src\main\resources\org\kuali\ole\directory-path.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.dirbulkIngestDir in the documentstoredirectory-path.properties file.

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

 Open a browser.

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

             Click on 'BulkIngest' button‘Submit’ button to run the bulk ingest. Need to click only once.

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

            http://localhost:8080/oledocstore

           Click 'Refresh Summary' ‘Refresh Summary’ button in the Summary tab.

...

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

         http://localhost:8080/oledocstore/ole-discovery

         Click 'Refresh' ‘Refresh’ button in the Summary tab.

         Note for the count for each DocType.

6.String Ingest

Open a browser.

        Go to URL http://localhost:8080/oledocstoreand 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.

 7.LOG Files

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

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

8.

...

Discovery within OLE(Optional)

Copy the ole-discovery.war and oledocstore.war files into the Tomcat running OLE.

...

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

...

 Open a browser.

      Go to URL

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

       Click on 'Search' ‘Search’ button.