Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Make sure
Info
Wiki Markup
h4. Guide to building Kuali OLE
# Make sure {{~/ole-build.properties}} and {{~/impex-build.properties}}, have been deleted from $\{user.home}

Commands

...

{
# Full build
{info}Run this from the root folder anytime anything (including the pom's) in {{ole-common}} changes.  For example, each iteration.

...

{info}
{noformat}mvn clean install -DskipTests=true

...

{noformat}
{info}CD into ole-app/ole-fs folder and run the subsequent commands from within.

...

{info}
# Generate the local configuration file configured with default values
{noformat}mvn generate-resources -Plocal

...

{noformat}
## The above command generates the file
{noformat}~/.kuali/ole/ole-fs.properties

...

{noformat}
## By default, the database vendor is MySQL with the {{root}} password set to {{NONE}}.

...


## You will need to update this file with the password for the MySQL {{root}} user on your system

...


# *[Reset an OLE FS

...

Property Loading

...

Info
titleProperty Loading Order
Order of property loading
1. the properties generated by the ant script (the old way and its still gets run as part of the ant script) - again not to be touched.
2.
 database|OLE:OLE Database Process]*

h4. Property Loading
{info:title=Property Loading Order}Order of property loading
1. the properties generated by the ant script (the old way and its still gets run as part of the ant script) - again not to be touched.
2. olefs-default.properties - Within the codebase and should not be touched as it is checked into SVN.


3. configuration.properties (~/.kuali/ole/fs/configuration.properties) - present on the local machine and generated during the {{generate-resources}} phase when the {{local}} profile is active. Can be modified.


4. If an external configuration file is present. - local to the developer and doesn't get checked in to SVN. So can point to anywhere in the local system where you hava a valid configuration.properties file.

...

  1. Properties pointing to other directories needed by OLE FS are expanded into their absolute path at runtime
  2. This way only a single property needs to be overridden (instead of all of them)
{info}
# Runtime property resolution is now possible for OLE FS\!
# This means the exact same war file can be used for development as well as deployment without altering the binary
# Automatically loaded external configuration files are used to reconfigure the binary with machine specific configuration
# The default external directory used by OLE FS is now based on the system property {{user.home}}
# To change this you only have to override one property - {{ole.fs.home}}
## Properties pointing to other directories needed by OLE FS are expanded into their absolute path at runtime
## This way only a single property needs to be overridden (instead of all of them)
# The following external property locations are automatically checked and loaded, in this order, if they exist
## {noformat}~/.kuali/ole/fs/configuration.properties

...

{noformat}
## If the system property {{olefs.configuration}} is set, the properties file it points to is automatically loaded

...


# If the property {{ole.fs.runtime.property.expansion=true}} the following actions are also taken

...


## After loading {{classpath:configuration.properties}} load {{classpath:olefs-default.properties

...

}}
## Expand any properties containing placeholders into their fully resolved equivalents

...

Logging

...



h4. Logging

# A default logging configuration is now bundled into OLE FS
# This means logging will work out of the box without requiring you to point OLE FS at an external log4j.properties file
# You can still override the default log4j configuration if desired
## set the property
{noformat}ole.fs.log4j.override=true

...

  1. This can be set as a system property
  2. Or as a property in one of the configuration files that gets automatically loaded

...

{noformat}
### This can be set as a system property
### Or as a property in one of the configuration files that gets automatically loaded
## create a log4j.properties containing your custom settings at
{noformat}~/.kuali/ole/fs/log4j.properties

...

Properties 

Info

System properties are set by specifying the -D parameter in the VM arguments.

Ex.
{noformat}
## OLE FS will use settings from the custom log4j.properties
## The custom properties file is also monitored by a background thread and reloaded if changes are made
# Going forward, any new logging statements added to OLE FS should use the SLF4J logging api
# If existing code is modified, log4j logging calls should be replaced by SLF4J logging calls

h4. Properties 
{info}System properties are set by specifying the \-D parameter in the VM arguments.

Ex. \-Dolefs.configuration=~/.kuali/ole/fs/custom-configuration.properties - This will tell the app to pick the properties from the above specified
location

...

Property

...

Default Value

...

Description

...

olefs.configuration

...

None

...

If this system property is set, properties are loaded from the location it points to. Properties supplied here, override internal properties

 location{info}

|| Property || Default Value || Description ||
| olefs.configuration | None | If this system property is set, properties are loaded from the location it points to.  Properties supplied here, override internal properties |
| ole.fs.runtime.property.expansion=true/false

...

false

...

 | false | If true, property expansion is performed at runtime instead of at build time. The resource {{classpath:olefs-default.properties}} is loaded if this property is set to true

...

 |
| ole.fs.log4j.override=true/false

...

false

...

 | false | Set this to true if you want to override the default log4j.properties supplied with the application.  This also allows you to alter the log4j configuration at runtime without restarting the application.  The log4j.properties file supplied here is monitored by a background thread.  It is automatically reloaded when changes are detected. |