Configuration Properties
Bold, italicized properties are very important and most likely must be changed from their defaults during installation.
Bold properties are likely to need modification during implementation.
All property files listed below are in src/main/resources within the KFS project.
Default Configuration Properties (kfs-default-config.properties)
| Property | Default | Notes |
|---|---|---|
| api.business.objects.max.results | 250 | The maxmium number of results returned by the business object REST API in a given request |
| app.code | kfs | Prefix used for building the application context. |
| app.context.name | ${app.code}-${environment} | The app context which will be used to deploy the application. |
| application.id | KFS | Used to identify the application as KFS on the Kuali service bus. This value is used when there are multiple nodes (servers) running KFS so that they are recognized as the same system to the KSB. |
| application.url | ${base.url}/${app.context.name} | The base url of the application. |
| b2b.environment | The environment to pass to the B2B service. | |
| b2b.punch.back.action.forwarding.url | /portal.do?channelTitle=Requisition&channelUrl=purapRequisition.do?methodToCall=displayB2BRequisition | The URL within KFS that the B2B system should redirect to, so it can start an order. |
| b2b.punch.back.url | The URL where the B2B system should punch back. | |
| b2b.punch.out.url | The URL within the B2B system where the Shop Catalogs button should redirect. | |
| b2b.purchase.order.url | The URL where approved purchase orders should be sent to actually accomplish the order. | |
| b2b.user.agent | kfs | The user agent of the B2B integration. |
| base.directory | \${user.home}/kuali/${project.artifactId} | Base directory during the build process to locate supporting files not in the KFS project. |
| base.url | http://localhost:8080 | The base URL that the application is being deployed to. |
| batch.file.lookup.root.directories | ${staging.directory};${reports.directory} | A list of parent directories to display the full contents of on the Batch File screen. |
| batch.quartz.thread.pool.size | 8 | The number of threads Quartz uses while executing jobs. |
| batch.quartz.trigger.check.interval | 30000 | Time, in milliseconds, that Quartz waits before polling to see if new triggers should be run. |
| batch.schedule.cron.expression | 00 00 23 ? * * | The Quartz cron expression for the scheduleJobTrigger (in KualiSpringBeansKfs.xml), i.e. when should the standard batch schedule run. |
| cache.service.bus.security.enabled | true | Kuali Service Bus implementation parameter |
| context.names.rice | ${rice.application}-${environment} | The application portion of the url where Rice functionality can be engaged. |
| contracts.grants.billing.enabled | false | Whether to include the configuration for the extra Contracts & Grants Billing functionality. |
| csrf.exempt.paths | A list of URL paths which are exempted from CSRF token checking. | |
| datasource.driver | com.mysql.jdbc.Driver | The class name of the JDBC driver to use for this application deployment. |
| datasource.ojb.platform | MySQL | Used by the build to configure OJB and determine the appropriate driver and KualiDBPlatform implementations to use |
| datasource.pool.class | The class to use for the JDBC connection pool. If empty, the underlying JDBC connection pool/transaction implementation will be responsible for providing. | |
| directoriesToCreateOnStartup | ${attachments.directory}, ${attachments.pending.directory}, ${staging.directory.sys.batchContainer}, ${temp.directory}, ${data.xml.root.location}, ${data.xml.loaded.location}, ${data.xml.pending.location}, ${data.xml.problems.location}, ${templates.directory}/ar | A list of directories which should be created on application startup, if they do not currently exist. |
| environment | dev | The name of the specific environment to deploy. |
| externalizable.static.content.url | ${application.url}/static | The base url for static content like images and help that could reside within the application or be maintained by other group(s) on other server(s). |
| feedback.link.url | URL for the feedback link that can be a way for users to provide feedback, report issues, etc. | |
| jwt.expiration.seconds | 86400 | The number of seconds JWT tokens created by Kuali Financials will be valid before expiring. |
| kc-kfs.kfs.service.namespace.uri | http://kfs.kuali.org/kc-kfs/v2_0 | Namespace for KFS KC-KFS integration services on the Kuali Service Bus. Changing this value is discouraged, as it may lead to functionality not being able to find services published by Kuali Coeus on the KSB. |
| kc.application.url | Kuali Coeus application server URL used for KFS/KC integration. | |
| kew.callback.service.bus.security.enabled | true | Kuali Service Bus implementation parameter |
| kfs.datasource.connection.timeout | 100000 | The number of milliseconds to wait to connect to the KFS database. |
| kfs.datasource.driver.name | ${datasource.driver} | The class name of the JDBC driver to use to contact the KFS database. |
| kfs.datasource.pool.accessToUnderlyingConnectionAllowed | true | Determines whether manipulation of the underlying JDBC connection to the KFS database is allowed by the application. |
| kfs.datasource.pool.initialSize | 5 | The initial size of the database connection pool for the KFS database. |
| kfs.datasource.pool.maxActive | 50 | The maximum number of active connections allowed to the KFS database. |
| kfs.datasource.pool.maxSize | 50 | The maximum number of connections - idle or active - allowed to the KFS database. |
| kfs.datasource.pool.maxWait | 30000 | The number of milliseconds a connection will wait while running a query or update against the KFS database. |
| kfs.datasource.pool.minIdle | 5 | The minimum number of idle connections allowed to the KFS database. |
| kfs.datasource.pool.minSize | 5 | The minimum number of connections - idle or active - allowed to the KFS database. |
| kfs.datasource.validating.query | select 1 | The simple query to run against the KFS database to confirm a heartbeat. |
| kfs.ehcache.config.location | classpath:kfs.ehcache.xml | Location of the configuration file for the EHCache settings for KFS objects. |
| kfs.externalizable.help.url | ${externalizable.static.content.url}/help/ | The base url for help content, referred to from workflow documentation. |
| kfs.locale | en_US | The name of the java.util.Locale to use for this deployment of KFS. |
| kfs.service.namespace.uri | http://kfs.kuali.org/kfs/v5_0 | Namespace for KFS services on the Kuali Service Bus. Changing this value is discouraged, as it may lead to functionality not being able to find services published on the KSB. |
| kfs.url | ${base.url}/${app.context.name} | The url which has the SessionInactivatePage.do to redirect to when a session times out. |
| kfs.version | ${version} | Current version of the KFS application, derived from the project.version property set in the Maven POM. Changing is discouraged, as this value is used when publishing services to the KSB. |
| kim.callback.service.bus.security.enabled | true | Kuali Service Bus implementation parameter |
| ksb.client.url | ${application.url}/ksb | The URL endpoint of the KSB client. |
| ksb.server.url | ${rice.server.url}/ksb | The URL endpoint of the KSB server. |
| kuali.coeus.integration.bus.security.enabled | false | Used to determine whether bus security is enabled for KFS / KC integration when using a shared Rice instance. |
| licensing.contact.email | legal@kuali.co | The e-mail address to contact regarding licensing issues. |
| log4j.reload.minutes | 5 | Determines how frequently the logging framework (Log4jConfigurer) will check for changes to log4j.properties. |
| log4j.settings.file | The file the server will look for to configure log4j | |
| login.filter.className | org.kuali.kfs.sys.web.filter.DevelopmentLoginFilter | The classname of the actual login filter to use. |
| login.filter.param.loginUser | khuntley | The logged in user (mainly for the use of DevelopmentLoginFilter); this should never be set in production. |
| logs.directory | ${base.directory}/logs/${environment}/${app.code} | The directory for the log files output by the application (application server user must have write access) |
| mail.smtp.connectiontimeout | 10000 | The amount of time to wait while contacting an e-mail server. |
| mail.smtp.timeout | 10000 | The amount of time to wait while attempting to send an e-mail message. |
| message.queue.url | MessageQueue.do | The Rice web page which displays the current KSB message queue. |
| module.access.security.enabled | false | Whether to include the configuration for the Access Security module. (sec) This module overrides pieces of the coa, gl, ld, and purap modules. |
| module.accounts.receivable.enabled | true | Whether to include the configuration for the Accounts Receivable module. |
| module.capital.asset.enabled | true | Whether to include the configuration for the Capital Asset and Capital Asset Builder Modules. |
| module.contracts.and.grants.enabled | true | Whether to include the configuration for the Contracts and Grants module. (cg) Only one of cg or kc can be set to true or both can be set to false. |
| module.external.kuali.coeus.enabled | false | Whether to include the configuration for the Kuali Coeus integration. (kc) Only one of cg or kc can be set to true or both can be set to false. |
| module.labor.distribution.enabled | true | Whether to include the configuration for the Labor Distribution module. |
| module.purchasing.enabled | true | Whether to include the configuration for the Purchasing/Accounts Payable module |
| periodic.thread.dump | true | Turns on a background process which logs the current thread state of the application to disk. |
| periodic.thread.dump.seconds | 300 | The number of seconds in between loggings of full thread dumps. |
| production.environment.code | prd | Determines which build.environment the ConfigurationService considers to be the production environment |
| project.build.timestamp | ${project.build.timestamp} | The timestamp when the project was built, which is displayed on every page with the version. |
| property.files | classpath:org/kuali/rice/krad/ApplicationResources.properties, classpath:org/kuali/rice/krad/KRAD-ApplicationResources.properties, classpath:org/kuali/rice/kew/ApplicationResources.properties, classpath:org/kuali/rice/ksb/ApplicationResources.properties, classpath:org/kuali/rice/kim/ApplicationResources.properties, classpath:org/kuali/rice/krms/ApplicationResources.properties, classpath:org/kuali/rice/core/web/cache/CacheApplicationResources.properties, classpath:org/kuali/kfs/coa/coa-resources.properties, classpath:org/kuali/kfs/fp/fp-resources.properties, classpath:org/kuali/kfs/gl/gl-resources.properties, classpath:org/kuali/kfs/pdp/pdp-resources.properties, classpath:org/kuali/kfs/sys/sys-resources.properties, classpath:org/kuali/kfs/sec/sec-resources.properties, classpath:org/kuali/kfs/vnd/vnd-resources.properties, classpath:org/kuali/kfs/module/ar/ar-resources.properties, classpath:org/kuali/kfs/module/bc/bc-resources.properties, classpath:org/kuali/kfs/module/cab/cab-resources.properties, classpath:org/kuali/kfs/module/cam/cam-resources.properties, classpath:org/kuali/kfs/module/cg/cg-resources.properties, classpath:org/kuali/kfs/module/ec/ec-resources.properties, classpath:org/kuali/kfs/module/ld/ld-resources.properties, classpath:org/kuali/kfs/module/tem/tem-resources.properties, classpath:org/kuali/kfs/module/external/kc/kc-resources.properties, classpath:org/kuali/kfs/module/purap/purap-resources.properties | All files which have properties to be made available through org.kuali.rice.core.api.config.property.ConfigurationService, including the properties listed on this page and system messages. |
| property.test.files | classpath:test-configuration.properties | A list of properties files (which may include overrides) to be used with unit tests. |
| remote.view.url | ${application.url}/remote | Location of URL which can wrap Rice views in an iframe. |
| report.writer.service.new.line.characters | \n | The character which text reports should use as a new line character. |
| reports.directory | ${work.directory}/reports | The base working directory for oltp and batch report generation |
| rice.application | kr | The name of the base rice application. |
| rice.datasource.connection.timeout | 100000 | The number of milliseconds to wait to connect to the Rice database. |
| rice.datasource.driver.name | ${datasource.driver} | The class name of the JDBC driver to use to contact the Rice database. |
| rice.datasource.pool.accessToUnderlyingConnectionAllowed | true | Determines whether the database connection pool allows direct access to Rice database connections. |
| rice.datasource.pool.initialSize | 5 | The initial size of the database connection pool for the Rice database. |
| rice.datasource.pool.maxActive | 50 | The maximum number of active connections allowed to the Rice database. |
| rice.datasource.pool.maxSize | 50 | The maximum number of connections - idle or active - allowed to the Rice database. |
| rice.datasource.pool.maxWait | 30000 | The number of milliseconds a connection will wait while running a query or update against the Rice database. |
| rice.datasource.pool.minIdle | 5 | The minimum number of idle connections allowed to the Rice database. |
| rice.datasource.pool.minSize | 5 | The minimum number of connections - idle or active - allowed to the Rice database. |
| rice.datasource.validating.query | select 1 | The simple query to run against the Rice database to confirm a heartbeat. |
| rice.server.url | ${application.url} | The base url of the server where the Rice application has been deployed. |
| security.property.file | The single secure property file currently used by the application. | |
| service.registry.url | ServiceRegistry.do | The Rice web page which displays all services currently registered with the KSB. |
| skip.batch.directory.initiation | false | Determines if the files listed in directoriesToCreate should be created when the application starts up or not. |
| soap.service.default.service.bus.security.enabled | true | Kuali Service Bus implementation parameter |
| spring.source.files | classpath:org/kuali/rice/core/CommonSpringBeans.xml,\ | The list of Spring bean definition files for KFS. |
| spring.test.files | classpath:org/kuali/kfs/sys/spring-test-env-beans.xml, classpath:org/kuali/kfs/sys/spring-sys-unit-test.xml, classpath:org/kuali/kfs/sys/spring-sys-test.xml, classpath:org/kuali/kfs/gl/spring-gl-test.xml, classpath:org/kuali/kfs/module/ar/spring-ar-test.xml, classpath:org/kuali/kfs/module/ar/spring-test-env-beans.xml, classpath:org/kuali/kfs/module/purap/spring-purap-test.xml, classpath:org/kuali/kfs/module/purap/spring-test-env-beans.xml, classpath:org/kuali/kfs/module/cam/spring-cam-test.xml, classpath:org/kuali/kfs/module/tem/spring-tem-test.xml | A list of Spring bean definition files for KFS unit tests. |
| staging.directory | ${work.directory}/staging | The base working directory for storage of batch input files |
| STRING_TO_DATE_FORMATS | yyyy-MM-dd;MM/dd/yyyy hh:mm a;MM/dd/yy;MM/dd/yyyy;MM-dd-yy;MM-dd-yyyy;MMddyy;MMMM dd;yyyy;MM/dd/yy HH:mm:ss;MM/dd/yyyy HH:mm:ss;MM-dd-yy HH:mm:ss;MMddyy HH:mm:ss;MMMM dd HH:mm:ss;yyyy HH:mm:ss | Valid formats to parse dates and date times from strings. |
| staging.directory.sys.batchContainer | ${staging.directory}/sys/batchContainer | The directory where batch container trigger files are placed and read. |
| temp.directory | ${work.directory}/temp | A directory for temporary file storage, e.g. during pdf generation |
| templates.directory | ${work.directory}/templates | A list of parent directories where PDF templates may be found. Currently, only used by Contacts & Grants Billing. |
| thread.pool.url | ThreadPool.do | The Rice web page which displays information about the KSB thread pool. |
| transaction.timeout | 100000 | Used in datasource configuration to force transactions to timeout if they have run for a problematic period of time. |
| use.quartz.jdbc.jobstore | false | This property will be set dynamically by the build script, but you can force it by setting it in your kfs-build.properties file. Avoid confusing with use.quartz.database, which is used by the KSB quartz scheduler. |
| use.quartz.scheduling | true | Determines whether quartz (SchedulerService and scheduleJob) should be used for batch job scheduling and execution - impacts whether the batch scheduling UI works. |
| version | ${kfs.version} | A synonym for kfs.version. |
| work.directory | ${base.directory}/work/${environment}/${app.code} | The directory that is the root for the base working directory that is external to the application |
| workflow.path | Not actually listed in kfs-deafult-config.properties, but read if updateWorkflowOnStartup is set to true; this sets the directories of all the workflow files which should be ingested by workflow if it is refreshing at startup. | |
directoriesToCreateOnStartup | ${attachments.directory}, ${attachments.pending.directory}, ${staging.directory.sys.batchContainer}, ${temp.directory}, ${data.xml.root.location}, ${data.xml.loaded.location}, ${data.xml.pending.location}, ${data.xml.problems.location}, ${templates.directory}/ar | A list of directories to create on startup of OLTP |
updateDatabaseOnStartup | false | Whether to call the update db hooks |
updateDatabaseFullRebuild | false | Whether to run all 5 phases of LiquiRational or just the 5th phase |
updateDatabaseContext | bootstrap | Which liquibase context(s) to run |
updateDatabasePackages | org/kuali/kfs/core, org/kuali/kfs/module/ar, org/kuali/kfs/module/bc, org/kuali/kfs/module/cam, org/kuali/kfs/module/cg, org/kuali/kfs/module/ec, org/kuali/kfs/module/kc, org/kuali/kfs/module/ld, org/kuali/kfs/module/purap, org/kuali/kfs/module/tem | Determines which modules to update |
updateDatabasePackagesRice | org/kuali/rice | Determines which modules to update |
updateWorkflowOnStartup | false | Whether to ingest workflow on startup |
Rice Configuration Properties (kfs-rice-default-config.properties)
Property | Default | Notes |
|---|---|---|
| STRING_TO_DATE_FORMATS | MM/dd/yyyy hh:mm a;MM/dd/yy;MM/dd/yyyy;MM-dd-yy;MM-dd-yyyy;MMddyy;MMMM dd;yyyy;MM/dd/yy HH:mm:ss;MM/dd/yyyy HH:mm:ss;MM-dd-yy HH:mm:ss;MMddyy HH:mm:ss;MMMM dd HH:mm:ss;yyyy HH:mm:ss;yyyy-MM-dd | A semi-colon delimited list of strings representing date formats that the DateTimeService will use to parse dates when DateTimeServiceImpl.convertToSqlDateString) or DateTimeServiceImpl.convertToDate(String) is called. Note that patterns will be applied in the order listed (and the first applicable one will be used). For a more technical description of how characters in the parameter value will be interpreted, please consult the javadocs for java.text.SimpleDateFormat. Any changes will be applied when the application is restarted. |
| actionlist.outbox | true | Globally disable or enable the outbox (screen to which there is a link in the action list that shows the documents a user has taken action on). |
| attachment.dir.location | ${work.directory}/attachments | Directory where attachments will be stored |
| attachments.directory | ${work.directory}/attachments | the base working directory for storage of note-associated attachments that are uploaded by users |
| attachments.pending.directory | ${attachments.directory}/pending | The directory that holds attachments before they've been fully processed. |
| classpath.resource.prefix | /WEB-INF/classes/ | Needed by DWR |
| connection.pool.impl | XAPool | The underlying JDBC connection pool/transaction implementation |
| context.names.app | ${app.context.name} | Unused. |
| core.mode | LOCAL | Determines how the Rice core module expects to run. Rice core currently runs bundled out of the box, therefore this is set to LOCAL. |
| core.url | ${rice.server.url}/core | The base URL for Rice core functionality exposed through web pages. |
| coreservice.mode | REMOTE | Determines how the CF core services module expects to run. CF coreservice currently runs Standalone out of the box, therefore this is set to REMOTE. |
| datasource.ojb.sequenceManager.className | org.apache.ojb.broker.platforms.Kuali${datasource.ojb.platform}SequenceManagerImpl | The class name of the OJB sequence provider. |
| datasource.platform | org.kuali.rice.core.framework.persistence.platform.${datasource.ojb.platform}DatabasePlatform | Rice class for handling Differences between database versions |
| datasource.pool.class.non.xa | bitronix.tm.resource.jdbc.lrc.LrcXADataSource | The non-transactional JDBC connection pool to use. |
| dev.mode | false | Determines where the KSB exposed services will be consumed from: if false, the KSB will look to the bus to consume services; otherwise, if true, it will look for services locally. |
| enable.nonproduction.data.unmasking | FALSE | Specifies whether data can be unmasked in non-production environments. Can be used to prevent access to sensitive data if loaded into a test environment. |
| externalizable.help.url | ${application.url}/static/help/ | The base url for help content. |
| externalizable.images.url | ${externalizable.static.content.url}/images/ | The base url for images that can reside outside the application |
| ken.mode | REMOTE | Determines how the Kuali Enterprise Notification module expects to run. Rice KEN currently runs on a standalone Rice out of the box, therefore this is set to REMOTE. |
| ken.url | ${rice.server.url}/ken | The base URL for Rice Kuali Enterprise Notifications functionality exposed through web pages. |
| kew.mode | EMBEDDED | Determines how the Rice Kuali Enterprise Workflow module expects to run. Rice KEW currently runs bundled out of the box, therefore this is set to EMBEDDED. |
| kew.url | ${rice.server.url}/kew | The base URL for other Rice Kuali Enterprise Workflow functionality exposed through web pages. |
| keystore.file | ${base.directory}/rice.keystore | the single keystore file currently used by the KSB to authenticate services |
| kim.mode | EMBEDDED | Determines how the Rice Kuali Identity Module expects to run. Rice KIM currently runs Standalone out of the box, therefore this is set to EMBEDDED. |
| kim.url | ${rice.server.url}/kim | The base URL for Rice Kuali Identity Management functionality exposed through web pages. |
| kns.css.files | kr/css/kuali.css,kr/scripts/jscalendar-1.0/calendar-win2k-1.css | A list of CSS files which KNS functionality (or extended web functionality) may use. |
| kns.javascript.files | krad/plugins/jquery/jquery-1.6.3.js, krad/plugins/cookie/jquery.cookie.js, kr/scripts/core.js,kr/scripts/dhtml.js, kr/scripts/my_common.js, kr/scripts/jscalendar-1.0/calendar.js, kr/scripts/jscalendar-1.0/lang/calendar-en.js, kr/scripts/jscalendar-1.0/calendar-setup.js, dwr/engine.js, dwr/util.js,dwr/interface/PersonService.js, kr/scripts/objectInfo.js,scripts/rice-overrides.js | A list of Javascript files which KNS functionality (or extended web functionality) may use. |
| kr.externalizable.images.url | ${application.url}/kr/static/images/ | The URL where images stored in the Rice war can be accessed from. |
| kr.incident.mailing.list | An email list to send incident emails to. | |
| kr.url | ${rice.server.url}/kr | The base URL for Rice Kuali Nervous System functionality exposed through web pages. |
| krad.externalizable.images.url | ${application.url}/krad/images/ | The URL where KRAD images stored in the Rice war can be accessed from |
| krad.url | ${rice.server.url}/krad | The base URL for Rice Kuali Rapid Application Development functionality exposed through web pages. |
| ksb.mode | REMOTE | Determines how the Rice Kuali Service Bus module expects to run. Rice currently runs bundled out of the box, therefore this is set to LOCAL. |
| KualiExceptionIncidentServiceImpl.REPORT_MAIL_LIST | mailing list for the exception incident report email to be sent to | |
| KualiFeedbackService.REPORT_MAIL_LIST | E-mail address (likely a mailing list) where the results of a feedback page entry are sent. | |
| location.mode | REMOTE | Determines how the Rice location module expects to run. Rice currently runs Standalone out of the box, therefore this is set to REMOTE. |
| mail.transport.protocol | smtp | The mail protocol to send e-mail messages through. |
| mailing.list.batch | kfs.notification.batch@kuali.org | The e-mail address where non-production e-mails should be sent. |
| memory.monitor.threshold | 0.85 | Determines when the MemoryMonitor considers the application to have exceeded reasonable memory usage (decimal represents percentage of tenured allocation). |
| nonproduction.notification.mailing.list | The e-mail address where non-production e-mails should be sent. | |
| portal.css.files | css/portal.css | The css files that should be available to the portal |
| portal.javascript.files | krad/plugins/jquery/jquery-1.6.3.js, krad/plugins/cookie/jquery.cookie.js, krad/plugins/scrollto/jquery.scrollTo-1.4.2-min.js, krad/plugins/blockUI/jquery.blockUI.js, kr/scripts/my_common.js, krad/plugins/easydrag/jquery.easydrag.js, krad/plugins/fancybox/jquery.fancybox-1.3.4.pack.js, krad/plugins/easing/jquery.easing-1.3.pack.js, krad/plugins/jgrowl/jquery.jgrowl.js, krad/scripts/portal.initialize.js, rice-portal/scripts/easyXDM/easyXDM.js | The javascript files that should be available to the portal. |
| rice.backLocation.allowed.regex | ^(${application.url}|${rice.url}|${appserver.url})(/.*|) | A regular expression which determines if a back location is valid. Used to promote security and prevent the hijacking of the user to non-appplication URLs. |
| rice.backLocation.default.url | ${application.url} | The url to use as a back location, if rules for the back location have failed. |
| rice.core.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice core definitions. | |
| rice.coreservice.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice core service definitions. | |
| rice.kew.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice Kuali Enterprise Workflow service definitions. | |
| rice.kew.enableKENNotification | TRUE | determines if notifications coming out of KEW should be forwarded to KEN |
| rice.kew.ignoreUnknownPrincipalIds | FALSE | If false, KEW will fail (throw to exception) documents with invalid principals in their route actions |
| rice.kim.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice Kuali Identity Management service definitions. | |
| rice.kr.additionalSpringFiles | classpath:spring-rice-krad-overrides.xml | A list of Spring bean definition files which override the out-of-the-box Rice Kuali Nervous System service definitions. |
| rice.ksb.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice Kuali Service Bus service definitions. | |
| rice.ksb.registry.serviceUrl | ${application.url}/remoting/soap/ksb/v2_0/serviceRegistry | should specify Rice standalone instance service registry |
| rice.ksb.web.forceEnable | TRUE | When TRUE, publish the KSB user interface components (such as the Message Queue, Thread Pool, Service Registry screens) even when the ksb.mode is not set to local. |
| rice.location.additionalSpringFiles | A list of Spring bean definition files which override the out-of-the-box Rice location service definitions. | |
| rice.portal.allowed.regex | ^${application.url}(/.*|)|^${rice.url}(/.*|) | A regular expression filter of valid links which the portal will display. |
| rice.struts.message.resources | org.kuali.rice.krad.ApplicationResources,org.kuali.rice.krad.KRAD-ApplicationResources, org.kuali.rice.kew.ApplicationResources,org.kuali.rice.ksb.ApplicationResources, org.kuali.rice.kim.ApplicationResources,org.kuali.rice.krms.ApplicationResources, org.kuali.rice.core.web.cache.CacheApplicationResources, org.kuali.kfs.coa.coa-resources,org.kuali.kfs.fp.fp-resources, org.kuali.kfs.gl.gl-resources,org.kuali.kfs.pdp.pdp-resources, org.kuali.kfs.sys.sys-resources,org.kuali.kfs.vnd.vnd-resources, org.kuali.kfs.sec.sec-resources,org.kuali.kfs.module.ar.ar-resources, org.kuali.kfs.module.bc.bc-resources,org.kuali.kfs.module.cab.cab-resources, org.kuali.kfs.module.cam.cam-resources,org.kuali.kfs.module.cg.cg-resources, org.kuali.kfs.module.ec.ec-resources,org.kuali.kfs.module.external.kc.kc-resources, org.kuali.kfs.module.ld.ld-resources,org.kuali.kfs.module.tem.tem-resources, org.kuali.kfs.module.purap.purap-resources | All the files containing user messages that will be displayed via struts tags in jsps for Rice web functionality bundled with KFS. |
| serviceServletUrl | ${application.url}/remoting | URL that maps to the KSB Servlet. It handles incoming |
| useQuartzDatabase | TRUE | When using the embedded quartz scheduler started by the KSB, indicates whether or not that quartz scheduler should store it's entries in the database. If this is true than other appropriate quartz properties (ksb.org.quartz.*) may need to be set as well (see KSB Module Configuration). |
| weeklyEmail.active | TRUE | turn on/off weekly workflow notifications |
| workflow.documentsearch.base.url | ${workflow.url}/DocumentSearch.do?docFormKey=88888888&returnLocation=${application.url}/portal.do&hideReturnLink=true | The base URL for the web page for the Rice document search. |
| workflow.url | ${rice.server.url}/kew | The base URL for Rice Kuali Enterprise Workflow functionality exposed through web pages. |
Security Configuration Properties (kfs-security-default-config.properties)
Property | Default | Notes |
|---|---|---|
| kfs.datasource.username | kfs | account that the application should use to access the KFS database |
| kfs.datasource.password | ${kfs.datasource.username} | password for the application database account |
| kfs.datasource.url | jdbc:mysql://localhost/${kfs.datasource.username} | JDBC URL that will be used by the application to access the KFS database |
| rice.datasource.url | ${kfs.datasource.url} | JDBC url for the Rice server components (KEW/KIM/KSB). It will also be used when configuring a local Rice standalone server. |
| rice.datasource.username | ${kfs.datasource.username} | account that the application should use to modify the Rice database schema |
| rice.datasource.password | ${kfs.datasource.password} | password for the Rice database account |
| kfs.datasource.ddl.username | kfs | account that the application should use to modify the KFS database schema |
| kfs.datasource.ddl.password | ${kfs.datasource.username} | password for the application database account |
| kfs.datasource.ddl.url | jdbc:mysql://localhost/${kfs.datasource.username} | JDBC URL that will be used by the application to access the KFS database |
| rice.datasource.ddl.url | ${kfs.datasource.url} | JDBC url for the Rice server components (KEW/KIM/KSB). It will also be used when configuring a local Rice standalone server. |
| rice.datasource.ddl.username | ${kfs.datasource.username} | account that the application should use to access the Rice database |
| rice.datasource.ddl.password | ${kfs.datasource.password} | password for the Rice database account |
| keystore.alias | rice | |
| keystore.password | r1c3pw | Password used to open the keystore. |
| encryption.key | 7IC64w6kAAAA | Used by the DemostrationGradeEncryptionService to encrypt / decrypt data in the database. |
| encryption.algorithm | DES | The code for the encryption algorithm. Out of the box, DES and DESede are supported. DES is demo grade only. |
| b2b.user.agent | B2B properties that only need to be configured if the environment will be connected to Sciquest B2B. | |
| b2b.purchase.order.identity | ||
| b2b.purchase.order.password | ||
| b2b.shopping.identity | ||
| b2b.shopping.password | ||
| jwt.signing.key | tLXG6Bn3kxG3RT2W8O7iyw== | The key used to sign Financials-generated jwts. |
Institution Configuration Properties (institutional-config.properties)
We've added another location that configuration can be loaded in from. This hook lets you put a file called institutional-config.properties in your war file that can be used for common institution configuration such as spring.source.files or other configuration that will be the same for your entire stack. If you are using a maven overlay, place the file in src/main/resources. If you decide not to use this hook, you will notice a message in the log on startup that it could not find the file, this will not effect operation of the system.
Properties and you
At a minimum, you will need to override the following properties:
Name | Description | Example |
base.url | Base URL to Financials | |
rice.server.url | Base URL to your standalone rice | |
rice.url | Same as rice.server.url | |
rice.ksb.registry.serviceUrl | URL to the KSB registry url on your rice instance | ${rice.server.url}/remoting/soap/ksb/v2_0/serviceRegistry |
keystore.file | Location of keystore file used to securely communicate with rice. | /opt/rice.keystore |
rice.datasource.url | JDBC url to rice database | |
rice.datasource.username | username to access rice database | RICE |
rice.datasource.password | password to access rice database | RICE |
Kuali documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.5 License.
Kuali software is licensed for use pursuant to the Affero General Public License, version 3.
Copyright © 2014 Kuali, Inc. All rights reserved.
Portions of Kuali are copyrighted by other parties as described in the Acknowledgments screen.
Kuali ® is a registered trademark of the Trustees of Indiana University.