Externalizable Parameters

Owned by Peri Subrahmanya (Unlicensed)
Last updated: Feb 24, 2016 by Julian LadischVersion comment

OLE comes with several defaults for various parameters. The following page talks about the defaults and how they can be overridden. There are four files that gets loaded in a hierarchal order and are as follows;

  1. url-rice-properties.xml (ole-common/ole-utility/src/main/resources/org/kuali/ole): Consists of base application URLs along with URLs for the environments.
  2. jdbc-rice-properties.xml (ole-common/ole-utility/src/main/resources/org/kuali/ole): Consists of default MySQL and Oracle connection information.
  3. olefs-config-defaults.xml (ole-app/olefs): Consists of base defaults.
  4. Bootstrap.xml: Consists of defaults that are filtered during the build process. 
  5. common-config.xml (lives under ${user.home}/kuali/main/local): This file gets loaded last and any overrides should be placed in this file. 

 

url-rice-properties.xml:

Parameter Name
Default Value
Purpose
ole.url.basehttp://localhost:8080Default application URL
ole.docstore.url.base${ole.url.base}/oledocstoreDefault docstore URL
ole.fs.url.base${ole.url.base}/olefsDefault olefs URL

jdbc-rice-properties.xml: Defaults for MySQL and Oracle which are localhost.

 

olefs-config-defaults:

Parameter Name
Default Value
Purpose
environmentdevThis is used to determine the environment. The value is also used to determine to look for external configuration file for both olefs, and oledocstore. Ex. ${user.home}/kuali/main/${environment} 
dev.modefalseThis value when set to false triggers the xml polling services.

application.url

appserver.url

rice.server.url

docSearchURL

${ole.fs.url.base}

${application.url}

${application.url}

${ole.docstore.url.base}

Default olefs url

Default app server url

This can be updated to point to the standalone server if necessary.

docsearch url; for searching records in docstore.

locations.xml.root.location${project.home}/locationsThis is for any location.xml files that needs to be discovered by the xml polling services and auto ingested into OLE (polling interval is 1 min).
rules.directory${project.home}/rulesDrools rule file directory
circ.xml.root.location${project.home}/circulation-policiesThis is for any circulation-policy.xml files that needs to be discovered by the xml polling service and auto ingested into OLE (polling interval is 1 min).
staffupload.xml.root.location${project.home}/staff-uploadThe batch upload profile for order imports to be discovered by the xml polling service and auto ingested into OLE (polling interval is 1 min).
patrons.xml.root.location${project.home}/patronsThe patrons.xml file to be discovered by the xml polling service and auto ingested into OLE (polling interval is 1 min).
autoIngestDefaultstrueThis controls the loading of default locations, policies, patrons, e-license files and drools rules during application startup. This should be set to "false" for institutional builds.
log4j.settings.file Can be used to point to an external log4j file
log4j.settings.path Path to the external log4j
logs.directory Path to the logs directory

 

BootStrapConfig.xml: 

Parameter Name
Default Value
Purpose
project.home\${user.home}/kuali/main/${environment}/${project.artifactId}This sets the project.home value during the maven build cycle. Used by other parameters specially for auto ingest of xml files and their root folder locations.

 

common-config.xml:

Parameter Name
Default Value
Purpose
appserver.urlIP addressOverride the default url and can be set to the server IP for public access.
ole.url.base${appserver.url}App url
application.url${appserver.url}/olefsolefs url
sru.ole.fs.url.base added because of a problem in version 1.6.2 with using https with the SRU API
ole.docstore.url.basehttp://localhost:8080/oledocstoreoledocstore url
docSearchURL${ole.docstore.url.base}docsearch url
externalizable.help.urlhttp://site.kuali.org/ole/1.5.0-M2-SNAPSHOTThis is for help links for the various screens.
uuidCheckServiceURL{ole.fs.url.base}

/remoting/oleUuidCheckWebService

This parameter is used to determine if a PO exists for a particular BIB during the Bib delete process.
common-config.xml is the file that will need to be updated in order to override any default settings. 

 

 

 

Operated as a Community Resource by the Open Library Foundation