Page Comparison

{composition-setup} {deck:id=Kuali OLE} {card:label=Overview} *Kuali Open Library Environment* is an open source enterprise software solution to fulfill libraries needs in terms of financial and content management. Financial management is implemented using the already developed *[Kuali Financial System|http://www.kuali.org/kfs]* which is bundled within OLE. Content management has been implemented using the Apache Jackrabbit and Apache Solr technologies, details of which can be found in subsequent sections or tabs on this main page. KOLE is a mix of ant style and maven style applications. There is a maven wrapper for the [ant|http://ant.apache.org/] part of the project (KFS) and so one can build the whole application using few maven commands. {gliffy:name=OLE|align=left|size=L|version=3} {card} \\ {card:label = Continuous Integration} {info}Continuous Integration (CI) is vital for any project as it ensures detection of issues with the code in a timely manner and also validity of a build. OLE follows a CI process as described below.{info} The Kuali configuration management pool manages deployments to DEV and TEST environments in the Amazon cloud.  # Dev Environment - Coming soon\! # [Test Environment|https://wiki.kuali.org/display/KULRICE/OLE+Deploy] {card} {card:label = OLE Release Documentation} OLE is still in the beta phase of development with an installable release expected to be during early 2013. There have been two releases for the user community to experiment with the feature set and performance of the system up to date and the documentation can be found in the sections below; # h4. [Overall Release Documentation|https://wiki.kuali.org/display/OLE/OLE+Release+Documentation] # h4. [OLE 0.8 Iteration Release Documentation|https://wiki.kuali.org/display/OLE/OLE+Release+Documentation+-+for+Milestone+0.8] {card} {card:label = Developer's Guide} h4. Developer Setup A developer's workstation can be setup by following the steps outlined below; # KIS account - In order to have read/write access to the OLE version control repository, one must have a valid KIS account. Please contact your project manager to have an account created.  # Required Software ## Java SDK - Currently OLE is developed and tested using JDK 1.6 (Java 6) and soon we will be moving to JDK 1.7 (Java 7). The software can be downloaded from [here|http://www.oracle.com/technetwork/java/javase/downloads/index.html]. ## Maven 3.x - OLE uses maven as the build management tool and the software can be downloaded from [here|http://maven.apache.org/download.cgi]. Maven uses this idea of pulling down the required artifacts (jar files) from a central repository. Sometimes the dependent jars may not be found in the central repository due to licensing issues and so Kuali also maintains a repository that has our own published artifacts. A common example would be oracle jar that is not published to the central repository. In order to download jars from the Kuali repository, the settings.xml under user.home/.m2 folder needs to be updated with the following entries:  {code:language=html/xml|title=Maven settings.xml|collapse=true}

Wiki Markup

Deck

id	Kuali OLE

Card

label	Overview

Kuali Open Library Environment is an open source enterprise software solution to fulfill libraries needs in terms of financial and content management. Financial management is implemented using the already developed Kuali Financial System which is bundled within OLE. Content management has been implemented using the Apache Jackrabbit and Apache Solr technologies, details of which can be found in subsequent sections or tabs on this main page.

KOLE is a mix of ant style and maven style applications. There is a maven wrapper for the ant part of the project (KFS) and so one can build the whole application using few maven commands.

Card

label	Continuous Integration

Info
Continuous Integration (CI) is vital for any project as it ensures detection of issues with the code in a timely manner and also validity of a build. OLE follows a CI process as described below.

The Kuali configuration management pool manages deployments to DEV and TEST environments in the Amazon cloud.

Dev Environment - Coming soon!
Test Environment

Card

label	OLE Release Documentation

OLE is still in the beta phase of development with an installable release expected to be during early 2013. There have been two releases for the user community to experiment with the feature set and performance of the system up to date and the documentation can be found in the sections below;

Card

label	Developer's Guide

Developer Setup

A developer's workstation can be setup by following the steps outlined below;

KIS account - In order to have read/write access to the OLE version control repository, one must have a valid KIS account. Please contact your project manager to have an account created.

Required Software

Java SDK - Currently OLE is developed and tested using JDK 1.6 (Java 6) and soon we will be moving to JDK 1.7 (Java 7). The software can be downloaded from here.

Maven 3.x - OLE uses maven as the build management tool and the software can be downloaded from here. Maven uses this idea of pulling down the required artifacts (jar files) from a central repository. Sometimes the dependent jars may not be found in the central repository due to licensing issues and so Kuali also maintains a repository that has our own published artifacts. A common example would be oracle jar that is not published to the central repository. In order to download jars from the Kuali repository, the settings.xml under user.home/.m2 folder needs to be updated with the following entries:

Code Block

language	html/xml
title	Maven settings.xml
collapse	true

<mirrors>
    <mirror>
      <id>kuali.private</id>
      <mirrorOf>*</mirrorOf>
      <url>http://nexus.kuali.org/content/groups/developer</url>
    </mirror>
  </mirrors>
  <servers>
    <server>
      <id>kuali.private</id>
      <username>developer</username>
      <password>[check with your project lead]</password>
    </server>
  </servers>

{code} ## Tomcat - OLE is deployed under Tomcat web container. The software can be downloaded from [here|http://tomcat.apache.org/download-70.cgi]. Ensure the following jars are in your

2. Tomcat - OLE is deployed under Tomcat web container. The software can be downloaded from here. Ensure the following jars are in your tomcat.home/lib

1. directory;

1. ojdbc6.jar

1. and

1. mysql-connector-java-5.1.13.jar.

1. These

1. jars

1. will

1. be

1. required

1. for

1. database

1. connectivity

1. when

1. the

1. applications

1. are

1. launched

1. in

1. tomcat.

##

2. MySQL/Oracle

1. -

1. OLE

1. supports

1. both

1. MySQL

1. and

1. Oracle

1. and

1. these

1. can

1. be

1. downloaded

1. from

[

1. here

|http://www.oracle.com/technetwork/indexes/downloads/index.html].  {info:title=Linux}Oracle installation is tricky on a mac/ubuntu workstations, and so as a temporary workaround, install a VM with Windows or Oracle's VirtualBox that comes with Oracle bundled.{info} {warning:title=MySQL version}At the moment the latest version of MySQL which is 5.6 wont work with the impex tool that we have. One must install the 5.5 version of the MySQL server.{warning} # Checking out the codebase - OLE codebase can be checked out from the following [SVN|https://svn.kuali.org/repos/ole/trunk/] location. # Building the OLE modules - OLE is made up of three modules namely OLEFS, OLELS and OLEDOCSTORE.  ## From the root directory of where the OLE codebase has been checked out run the following maven command  {noformat}

1. .
  Info
  title Linux
  Oracle installation is tricky on a mac/ubuntu workstations, and so as a temporary workaround, install a VM with Windows or Oracle's VirtualBox that comes with Oracle bundled.
  Warning
  title MySQL version
  At the moment the latest version of MySQL which is 5.6 wont work with the impex tool that we have. One must install the 5.5 version of the MySQL server.
Checking out the codebase - OLE codebase can be checked out from the following SVN location.
Building the OLE modules - OLE is made up of three modules namely OLEFS, OLELS and OLEDOCSTORE.
1. From the root directory of where the OLE codebase has been checked out run the following maven command
  No Format
  mvn clean install -DskipTests=true

{noformat} ## Building the OLEFS application - OLEFS is the financial module with KFS as the core. KFS is an ant style project, so even though it may look it has pom file and a maven build process, behind the scenes several ant targets are called to get the application ready for deployment. ### Database setup - The default database setup is MySQL and running the following maven command will setup a clean database for OLEFS. The default username and passwords are OLE/OLE. Also the default dba username is root and password is none. {noformat}

Building the OLEFS application - OLEFS is the financial module with KFS as the core. KFS is an ant style project, so even though it may look it has pom file and a maven build process, behind the scenes several ant targets are called to get the application ready for deployment.

Database setup - The default database setup is MySQL and running the following maven command will setup a clean database for OLEFS. The default username and passwords are OLE/OLE. Also the default dba username is root and password is none.

No Format

cd project-directory/ole-app/ole-fs
mvn initialize -Pdb

Alternatively if you have your MySQL server setup with a dba username/passoword, then update your maven command to the following and execute;
mvn initialize -Pdb -Dmysql.dba.username=[fill me] -Dmysql.dba.password=[fill me]

{noformat} ### Verify the database got created by; there should be an entry for OLE in MySQL ### Generating the war file - The war file would have been generated as part of 4.a and can be located under

1. 2. Verify the database got created by; there should be an entry for OLE in MySQL
  3. Generating the war file - The war file would have been generated as part of 4.a and can be located under project-root-directory/ole-app/ole-fs/target/

*

1. 1. olefs-

\

1. 1. [version

\

1. 1. ]-webapp.war

*;  ## Building the OLELS application ### Database setup - The default database setup is MySQL and can be done using the following maven command  {noformat}

1. ;

Building the OLELS application

Database setup - The default database setup is MySQL and can be done using the following maven command

No Format

cd project-directory/ole-rice2/ole-rice-db
mvn clean install -Pdb,mysql

Alternatively if you have your MySQL server setup with a dba username/password, then update your maven command to the following and execute;
mvn clean install -Pdb,mysql -Dimpex.dba.username=[fill me] -Dimpex.dba.password=[fill me]

{noformat} ### Verify the database got created; there should be an entry for OLERICE2 in MySQL.  ### Generating the war file - The war file would have been generated as part of 4.a and can be located under the

1. 2. Verify the database got created; there should be an entry for OLERICE2 in MySQL.
  3. Generating the war file - The war file would have been generated as part of 4.a and can be located under the project-root-directory/ole-rice2/ole-rice-webapp/target/

*

1. 1. ole-rice-webapp-

\

1. 1. [version

\

1. 1. ].war

* ###

1. 2. Module

1. 1. specific

1. 1. configuration

1. 1. file

1. 1. -

1. 1. This

1. 1. is

1. 1. a

1. 1. file

1. 1. that

1. 1. the

1. 1. Rice

1. 1. framework

1. 1. will

1. 1. look

1. 1. for

1. 1. under

1. 1. user.home/kuali/main/dev

1. 1. on

1. 1. the

1. 1. local

1. 1. machine

1. 1. and

1. 1. any

1. 1. properties

1. 1. such

1. 1. as

1. 1. db

1. 1. connection

1. 1. info,

1. 1. application

1. 1. urls

1. 1. etc

1. 1. will

1. 1. be

1. 1. overridden.

1. 1. Copy

1. 1. the

1. 1. following

1. 1. file

1. 1. to

1. 1. your

1. 1. user.home/kuali/main/

dev [^OLE

1. 1. dev OLE_Rice2-config.xml

]

1. 1. .

1. 1. Ensure

1. 1. the

1. 1. name

1. 1. of

1. 1. the

1. 1. file

1. 1. is

1. 1. similar

1. 1. to

1. 1. the

1. 1. module

1. 1. name

1. 1. and

1. 1. in

1. 1. this

1. 1. case

1. 1. it

1. 1. is

1. 1. set

1. 1. to

1. 1. OLE_Rice2.

##

2. Building

1. the

1. OLEDOCSTORE

1. application

###

1. 1. Database

1. 1. setup

1. 1. -

1. 1. OLEDOCSTORE

1. 1. is

1. 1. based

1. 1. on

1. 1. Apache

1. 1. Jackrabbit

1. 1. core

1. 1. and

1. 1. currently

1. 1. running

1. 1. the

1. 1. application

1. 1. sets

1. 1. up

1. 1. the

1. 1. db

1. 1. directly.

###

1. 2. Generating

1. 1. the

1. 1. war

1. 1. file

1. 1. -

1. 1. The

1. 1. war

1. 1. file

1. 1. would

1. 1. have

1. 1. been

1. 1. generated

1. 1. as

1. 1. part

1. 1. of

1. 1. step

1. 1. 4.a

1. 1. and

1. 1. can

1. 1. be

1. 1. located

1. 1. under

1. 1. the

1. 1. project-root-directory/ole-docstore/ole-docstore-webapp/target/

*

1. 1. oledocstore.war

* #

Deployment

to

tomcat

##

1. OLEFS

1. -

1. Rename

1. the

1. war

1. file

1. from

1. 4.b.iii

1. to

1. olefs.war

1. and

1. copy

1. it

1. to

1. your

1. local

1. tomcat's

webapps folder. ## OLELS - Rename the war file from

1. webapps folder.
2. OLELS - Rename the war file from 4.c.iii

1. to

1. olerice2.war

1. and

1. copy

1. it

1. to

1. your

1. local

1. tomcat'

s webapps

1. s webapps folder.

##

2. OLEDOCSTORE

1. -

1. Simply

1. copy

1. the

1. oledocstore.war

1. to

1. your

1. local

1. tomcat's

1. webapps

1. folder.

{

1. Code Block

:

1. title

=

1. If

1. you

1. dont

1. want

1. to

1. perform

1. steps

1. a,

1. b

1. and

1. c,

1. alternatively

1. you

1. can

1. point

1. your

1. local

1. tomcat

1. to

1. the

1. individual

1. modules.

1. The

1. following

1. lines

1. need

1. to

1. be

1. added

1. to

1. the

1. file

1. named

1. server.xml

1. under

1. the

1. tomcat.home.directory/conf

1. folder

1. and

1. within

1. the

1. <Host>

1. </Host>

1. tags.

}

<Context docBase="project-root-directory/ole-app/ole-fs/target/ole-fs-webapp" path="/olefs"/>

<Context docBase="project-root-directory/ole-rice2/ole-rice-webapp/target/ole-rice-webapp" path="/olerice2"/>

<Context docBase="project-root-directory/ole-docstore/ole-docstore-webapp/target/ole-docstore-webapp-webapp" path="/oledocstore"/>

{code} # Verify the applications are up and running: {info}Ensure the JAVA_OPTS have the following entry too for the memory settings; \-Xms512m \-Xmx1g \

Verify the applications are up and running:
Info
Ensure the JAVA_OPTS have the following entry too for the memory settings; -Xms512m -Xmx1g -XX:MaxPermSize=512m

{info} ##

1. localhost:8080/olefs

##

2. localhost:8080/olerice2

##

2. localhost:8080/

oledocstore  The above steps have been tested and verified to get a working OLE codebase on a local developer's machine

1. oledocstore

The above steps have been tested and verified to get a working OLE codebase on a local developer's machine (Mac/Ubuntu).

The

steps

should

be

very

similar

on

windows

too

and

if

there

are

any

issues,

contact

devops@ole.kuali.org.

There

are

few

scripts

attached

here

also

that

essentially

perform

the

steps

above

in

an

automated

fashion.

  {info:title=System Variables}Ensure the following system properties are set;

Info

title	System Variables

Ensure the following system properties are set;

OLE_WORKSPACE_ROOT

TOMCAT_HOME

On

a

Mac/Ubuntu

this

will

be

typically

found

in

the

.bashrc

or

the

.profile

files;

On

a

windows

machine

its

set

in

the

environment

variables

section

under

Advanced

Settings

in

the

Control

Panel{info} # [^ole.sh] \- Script to checkout codebase and build to produce the deployable artifacts. # [^db

Panel

ole.sh - Script to checkout codebase and build to produce the deployable artifacts.
db-refresh-mysql.sh

] \

-

Script

to

refresh

local

MySQL

DB

for

OLEFS

and

OLELS

(

Ensure

to

update

this

script

with

the

appropriate

impex.dba.password

(root

password

for

your

MySQL

installation)

) # [^InitializeAndStartTomcat.sh] \- Script to copy the deployable artifacts to local tomcat and bring up the applications. h4. IDE Setup \- Developers are free to use IDE of their choice, but in Kuali the two most common ones are [Eclipse|http://www.eclipse.org/downloads/] and [IntelliJ|http://www.jetbrains.com/idea/] h4. Overriding default properties  # *OLEFS* \- In order to override the default properties we need to have a property file created in the right place where the application knows to look for. ## From the console change into the project root directory  ## cd

)
InitializeAndStartTomcat.sh - Script to copy the deployable artifacts to local tomcat and bring up the applications.

IDE Setup

- Developers are free to use IDE of their choice, but in Kuali the two most common ones are Eclipse and IntelliJ

Overriding default properties

OLEFS - In order to override the default properties we need to have a property file created in the right place where the application knows to look for.
1. From the console change into the project root directory
2. cd ole-app/ole-fs

##

2. mvn

1. generate-resources

\

1. -Plocal

###

1. 1. This

1. 1. generates

1. 1. a

1. 1. file

1. 1. called

1. 1. ole-fs.properties

1. 1. under

1. 1. user.home/.kuali/ole

# *OLELS* # *OLEDOCSTORE* h4. Overriding default properties contd. || || OLEFS || OLELS || OLEDOCSTORE || | log4j.properties | Update

OLELS
OLEDOCSTORE

Overriding default properties contd.

	OLEFS	OLELS	OLEDOCSTORE
log4j.properties	Update ole-fs.properties

under

user.home/.kuali/ole

with

the

following

entries \\ \\

entries

ole.fs.log4j.override=true

\\

ole.fs.log4j=

\

[path

the

log4j.properties

file

\] \\ | Edit the

]	Edit the OLE_Rice2-connfig.xml

file

under

the

"Developer

Setup"

section

#4.b.iv

with

the

following

entry \\ \\ <param

entry

<param name="log4j.settings.path">

path

to

the

log4j.properties

file

</param> \\ | | | | | | | | | | | | h4. [Database Refresh Process/Changes|OLE:OLE DB Refresh Process & Changes] \\ \\ h4. Database Swaps (MySQL/Oracle)\\ \\ \\ h4. Performance Tuning {card} \\ \\ \\ {card:label = Development Best Practices} Current coding standards and best practices can be found at [

</param>

Database Refresh Process/Changes

Database Swaps (MySQL/Oracle)

Performance Tuning

Card

label	Development Best Practices

Current coding standards and best practices can be found at https://wiki.kuali.org/display/OLE/Coding+Standards

]

.

Even

though

developers

are

expected

to

know

these,

sometimes

the

use

of

code

metric

tools

like

PMD,

Checkstyle

and

FIndBugs

makes

it

relatively

easy

and

often

aids

in

code

reviews

and

quick

turn

around

times

in

identifying

potential

coding

violations.

[

Sonar

|http://www.sonarsource.org/]

is

an

open

source

platform

that

just

does

that

i.e.

monitors

code

quality

by

combining

tools

such

as

PMD,

FindBugs

and

Checkstyle

etc.

\\ \\ OLE is hooked into Sonar via maven and currently all the modules under [OLE|http://svn.kuali.org/repos/ole/trunk/] get executed on Sonar and metrics reported [here |http://sonar.kuali.org/dashboard/index/25877]\\ \\ \\ \\ \\ \\ There are few things to look out for that absolutely need to be addressed on a regular basis; # *Violations* : These are indicators in code that need to be reviewed and corrected as soon as possible. Few examples are "empty if stmt", "broken null check" etc. # *Duplications* : As the name suggests, this metric reports redundancy in code and needs to be taken seriously for a reusable and robust codebase. # *Complexity* : This often indicates the level of nesting in a particular method and for readability purposes the lower the number the better it is. There are several design patterns that address this and one of the most common one is the strategy pattern to replace several if-else blocks. \\ {card} \\ \\ \\ {card:label = OLE Installation} {info}\\ OLE currently comprises of three applications (war files) that have to be deployed individually. These are the olefs.war, rice2.war and the docstore.war.{info} {info:title=Required Software}In order to install OLE, following software is needed; \\ \\ 1. maven 3.x \\ 2. java jdk 1.6.x \\ 3. tomcat 6.x \\ 4. mysql server or oracle{info}\# h4. Check out the codebase  ## Trunk location: [

OLE is hooked into Sonar via maven and currently all the modules under OLE get executed on Sonar and metrics reported here

There are few things to look out for that absolutely need to be addressed on a regular basis;

Violations : These are indicators in code that need to be reviewed and corrected as soon as possible. Few examples are "empty if stmt", "broken null check" etc.
Duplications : As the name suggests, this metric reports redundancy in code and needs to be taken seriously for a reusable and robust codebase.
Complexity : This often indicates the level of nesting in a particular method and for readability purposes the lower the number the better it is. There are several design patterns that address this and one of the most common one is the strategy pattern to replace several if-else blocks.

Card

label	OLE Installation

Info
OLE currently comprises of three applications (war files) that have to be deployed individually. These are the olefs.war, rice2.war and the docstore.war.

Info

title	Required Software

In order to install OLE, following software is needed;

1. maven 3.x
2. java jdk 1.6.x
3. tomcat 6.x
4. mysql server or oracle

# h4. Check out the codebase

1. Trunk location: https://svn.kuali.org/repos/ole/trunk

|https://svn.kuali.org/repos/ole/trunk] # h4. Building Artifacts ## Run the following from the root of the folder where the project was checked out {noformat}

Building Artifacts
1. Run the following from the root of the folder where the project was checked out
  No Format
  mvn clean install -DskipTests=true

{noformat} ## Copy the following artifacts and place it in the webapps directory of your tomcat installation folder ###   {noformat}

2. Copy the following artifacts and place it in the webapps directory of your tomcat installation folder
  1. No Format
    ole/target/ole-fs-[particular iteration value]-webapp.war; Rename the war to olef.war

{

1. 2. No Format

} ### {noformat}


ole-rice2/ole-rice-webapp/target/ole-rice-webapp-[particular iteration value].war; Rename the war to olerice2.war

{noformat} ### {noformat}

No Format
ole-docstore/ole-docstore-webapp/target/oledocstore.war; Rename the way to oledocstore.war

{noformat} # h4. Generating the default configuration properties file ## Navigate to the ole folder under the main project ## Run the following command {noformat}

Generating the default configuration properties file
1. Navigate to the ole folder under the main project
2. Run the following command
  No Format
  mvn generate-resources -Plocal

{noformat} ## This will generate a default

2. This will generate a default configuration.properties

1. file

1. under

{

1. No Format

}


~/.kuali/ole/fs/configuration.properties

{noformat} ## {info}The default database is mysql and the root password is set to none. You will need to change the root password to the appropriate password as set for your mysql server.{info} # h4. Setting up the Database ## olefs - navigate to the {{ole-app}} folder under the root of the project and run the following command {info}The db instance chosen will be the one specified in the configuration.properties under

2. Info
  The default database is mysql and the root password is set to none. You will need to change the root password to the appropriate password as set for your mysql server.
Setting up the Database
1. olefs - navigate to the ole-app folder under the root of the project and run the following command
  Info
  The db instance chosen will be the one specified in the configuration.properties under user.home/.kuali/olefs;

1. By

1. default

1. its

1. MySQL.

{info} {noformat}

1. No Format
  mvn clean install -Pdb

{noformat} ##

2. ole-rice2

1. -

1. navigate

1. to

1. the

{{

1. ole-rice2/ole-rice-db

}}

1. folder

1. under

1. the

1. project

1. and

1. run

1. the

1. following

1. command

{

1. Info

}

1. Ensure

1. the

1. impex.dba.password

1. entry

1. in

1. the

1. mysql.properties

1. under

1. ole-rice2/ole-rice-db/src/main/resources

1. is

1. appropriately

1. set

1. to

1. whatever

1. the

1. password

1. for

1. your

1. mysql

1. server

1. is.

1. By

1. default

1. its

1. set

1. to

1. root.

{info} {noformat}

1. No Format
  mvn clean install -Pdb,mysql

{noformat} ##

2. ole-docstore

1. -

1. The

1. database

1. schema

1. and

1. appropriate

1. tables

1. gets

1. created

1. when

1. the

1. docstore

1. application

1. starts

1. up

1. as

1. apache

1. jackrabbit

1. manages

1. the

1. setup.

# h4. Configuration Files - Rice2 You will need to create a file called

Configuration Files - Rice2
You will need to create a file called common-config.xml

under

user.home/kuali/main/dev

with

the

following

entry

{

Info

}

Paths

to

the

keystore

file

and

the

log4j.properties

files

will

need

to

be

updated

to

reflect

a

more

appropriate

location

in

your

system.

{info} {warning}Ensure you change the entry for

Warning
Ensure you change the entry for application.url

from

localhost

to

the

host

ip

of

the

server

where

you

are

running

the

application

{warning} {code:language=

Code Block
language html/xml

|title=Rice2 Config File|collapse=true|linenumbers=true|theme=Confluence}


theme	Confluence
title	Rice2 Config File
linenumbers	true
collapse	true


<\!-\-
\\
&nbsp;&nbsp;&nbsp; Copyright 2005-2012 The Kuali Foundation
\\
\\
&nbsp;&nbsp;&nbsp; Licensed under the Educational Community License, Version 2.0 (the "License");
\\
&nbsp;&nbsp;&nbsp; you may not use this file except in compliance with the License.
\\
&nbsp;&nbsp;&nbsp; You may obtain a copy of the License at
\\
\\
&nbsp;&nbsp;&nbsp; [http://www.opensource.org/licenses/ecl2.php]\\
\\
&nbsp;&nbsp;&nbsp; Unless required by applicable law or agreed to in writing, software
\\
&nbsp;&nbsp;&nbsp; distributed under the License is distributed on an "AS IS" BASIS,
\\
&nbsp;&nbsp;&nbsp; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\\
&nbsp;&nbsp;&nbsp; See the License for the specific language governing permissions and
\\
&nbsp;&nbsp;&nbsp; limitations under the License.
\\
\\
\-->
\\
<config>
\\
&nbsp;
\\
&nbsp;&nbsp;&nbsp; &nbsp;<param name="rice.logging.configure">true</param>
\\
&nbsp;&nbsp;&nbsp; &nbsp;
\\
&nbsp;&nbsp; &nbsp;<\!-\- App specific parameters -->
\\
&nbsp;&nbsp; &nbsp;<param name="application.id">olerice2</param>
\\
&nbsp;&nbsp; &nbsp;<param name="app.code">olerice2</param>
\\
&nbsp;&nbsp; &nbsp;<param name="app.context.name">${app.code}</param>
\\
&nbsp;&nbsp; &nbsp;<param name="application.url">[http://localhost:8080/$]{app.context.name}</param>
\\
&nbsp;&nbsp; &nbsp;<param name="production.environment.code">PRD</param>
\\
\\
&nbsp;&nbsp; &nbsp;<\!-\- Misc parameters -->
\\
&nbsp;&nbsp; &nbsp;<param name="institution">rice</param>
\\
&nbsp;&nbsp; &nbsp;<param name="version">03/19/2007 01:59 PM</param>
\\
&nbsp;&nbsp; &nbsp;<param name="transaction.timeout">3600</param>
\\
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.url">jdbc:mysql://localhost:3306/OLERICE2</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.username">OLERICE2</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.password">OLERICE2</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.ojb.platform">MySQL</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.platform">org.kuali.rice.core.framework.persistence.platform.MySQLDatabasePlatform</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.driver.name">com.mysql.jdbc.Driver</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.pool.maxWait">30000</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.pool.maxSize">20</param>
\\
&nbsp;&nbsp; &nbsp;<param name="datasource.pool.minSize">5</param>
\\
\\
&nbsp;&nbsp; &nbsp;<param name="keystore.alias">rice</param>
\\
&nbsp;&nbsp; &nbsp;<param name="keystore.file">${user.home}/kuali/main/dev/rice.keystore</param>
\\
&nbsp;&nbsp; &nbsp;<param name="keystore.password">r1c3pw</param> \|

&nbsp;&nbsp; &nbsp;<param name="dev.mode">false</param>
&nbsp;&nbsp; &nbsp;<param name="useQuartzDatabase">false</param>
&nbsp;&nbsp; &nbsp;<param name="Routing.ImmediateExceptionRouting">true</param>
&nbsp;&nbsp; &nbsp;<\!-\- Kuali parameters -->
&nbsp;&nbsp; &nbsp;<param name="encryption.key">7IC64w6ksLU</param>
&nbsp;&nbsp; &nbsp;<param name="kfsLocator.useAppContext">true</param>
&nbsp;&nbsp; &nbsp;
&nbsp;&nbsp; &nbsp;<\!-\- Change Configurer Modes to LOCAL -->
&nbsp;&nbsp;&nbsp; <param name="location.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="coreservice.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="ken.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="kim.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="kew.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="krms.mode">LOCAL</param>
&nbsp;&nbsp;&nbsp; <param name="ksb.mode">LOCAL</param>

<param name="data.xml.root.location">[enter the user.home directory here]/kuali/main/dev/olerice2/workflow</param>
<param name="data.xml.pending.location">${data.xml.root.location}/pending</param>
<param name="data.xml.loaded.location">${data.xml.root.location}/loaded</param>
<param name="data.xml.problem.location">${data.xml.root.location}/problem</param>
&nbsp;&nbsp; &nbsp;
&nbsp;&nbsp;&nbsp; <param name="filter.login.class">org.kuali.rice.kew.web.DummyLoginFilter</param>
&nbsp;&nbsp; &nbsp;<param name="filtermapping.login.1">/*</param>
&nbsp;&nbsp; &nbsp;<param name="config.location">classpath:META-INF/common-config-defaults.xml</param>

</config>

{code} {noformat} # h4. [OLE:Property Files] # h4. Running the applications ## Now that all the three application war files are copied to your tomcat folder, and the database has been set up for olefs and olerice2, its time to start tomcat ## Ensure the JAVA_OPTS have the following entry too for the memory settings; \-Xms512m \-Xmx1g \

No Format

Property Files
Running the applications
1. Now that all the three application war files are copied to your tomcat folder, and the database has been set up for olefs and olerice2, its time to start tomcat
2. Ensure the JAVA_OPTS have the following entry too for the memory settings; -Xms512m -Xmx1g -XX:MaxPermSize=512m

##

2. Accessing

1. the

1. applications

###

1. 1. OLEFS

1. 1. -

[

1. 1. http://hostip:8080/olefs

] ###

1. 2. OLERICE2

1. 1. -

[

1. 1. http://hostip:8080/olerice2

] ###

1. 2. OLEDOCSTORE

1. 1. -

[

1. 1. http://hostip:8080/oledocstore

] # h4. Sample Data and Permissions In order for the OLE application to be fully functional, there are permissions and sample data files that need to be ingested. This process is automated and every time the applications are brought up (after a fresh install), the following data is ingested; a. [Workflows/Permissions|https://svn.kuali.org/repos/ole/trunk/ole-rice2/ole-rice-workflow/src/main/resources/org/kuali/ole/] b. [Patrons|https://jira.kuali.org/browse/OLE-3404] c. [Locations|https://jira.kuali.org/browse/OLE-3406] d. [Circulation Policies|https://jira.kuali.org/browse/OLE-3407] e. [YPB Ingest Profile |https://jira.kuali.org/browse/OLE-3403] {card} {card:label = OLE System Architecture} {card}{deck}

Sample Data and Permissions
In order for the OLE application to be fully functional, there are permissions and sample data files that need to be ingested. This process is automated and every time the applications are brought up (after a fresh install), the following data is ingested;
a. Workflows/Permissions
b. Patrons
c. Locations
d. Circulation Policies
e. YPB Ingest Profile

Card

label	OLE System Architecture

Versions Compared

Old Version 5

New Version 6

Key

Overall Release Documentation

OLE 0.8 Iteration Release Documentation

Developer Setup

IDE Setup

Overriding default properties

Overriding default properties contd.

Database Refresh Process/Changes

Database Swaps (MySQL/Oracle)

Performance Tuning

Building Artifacts

Generating the default configuration properties file

Setting up the Database

Configuration Files - Rice2

Property Files

Running the applications

Sample Data and Permissions