Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titlebuild.properties file is only used with building/compiling DSpace

It is worth noting that the [dspace-source]/build.properties file (or custom properties file) is ONLY used in the act of building/installing/upgrading DSpace. During that build/install/upgrade process, any settings in your "setting currently available in the build.properties will be inherited (copied) to the dspace.cfg file. However, if you need to add new settings to your build.properties" file (or custom properties file) are automatically copied over to the "dspace.cfg" file. file, you will need to modify your dspace.cfg file in order for it to be inherited (see the note below titled "You may add new settings to your build.properties or custom *.properties").

Once DSpace is installed, it the system only uses the settings in your [dspace]/config/dspace.cfg file.  So, the build.properties file will not be copied into your installation directory, and all runtime configurations are pulled from the final dspace.cfg file.

Warning
titleDo not remove or comment out settings in build.properties

When you edit the "build.properties" file (or a custom *.properties file), take care not to remove or comment out any settings.  Doing so, may cause your final "dspace.cfg" file to be misconfigured with regards to that particular setting.  Instead, if you wish to remove/disable a particular setting, just clear out its value.  For example, if you don't want to be notified of new user registrations, ensure the "mail.registration.notify" setting has no value, e.g.

mail.registration.notify=

...

If you are unfamiliar with the Event System in DSpace, and require additional information with terms like "Consumer" and "Dispatcher" please refer to :http://wiki.dspace.org/index.php/EventSystemPrototype EventSystemPrototype.

Property:

event.dispatcher.default.class

Example Value:

event.dispatcher.default.class = org.dspace.event.BasicDispatcher

Informational Note:

This is the default synchronous dispatcher (Same behavior as traditional DSpace).

Property:

event.dispatcher.default.consumers

Example Value:

event.dispatcher.default.consumers = search, browse, eperson

Informational Note:

This is the default synchronous dispatcher (Same behavior as traditional DSpace).

Property:

event.dispatcher.noindex.class

Example Value:

event.dispatcher.noindex.class = org.dspace.event.BasicDispatcher

Informational Note:

The noindex dispatcher will not create search or browse indexes (useful for batch item imports).

Property:

event.dispatcher.noindex.consumers

Example Value:

event.dispatcher.noindex.consumers = eperson

Informational Note:

The noindex dispatcher will not create search or browse indexes (useful for batch item imports).

Property:

event.consumer.search.class

Example Value:

event.consumer.search.class = org.dspace.search.SearchConsumer

Informational Note:

Consumer to maintain the search index.

Property:

event.consumer.search.filters

Example Value:

{{event.consumer.search.filters = }}
Community | Collection | Item | Bundle+Add | Create | Modify | Modify_Metadata | Delete | Remove

Informational Note:

Consumer to maintain the search index.

Property:

event.consumer.browse.class

Example Value:

event.consumer.browse.class = org.dspace.browse.BrowseConsumer

Informational Note:

Consumer to maintain the browse index.

Property:

event.consumer.browse.filters

Example Value:

event.consumer.browse.filters =
Community | Collection | Item | Bundle+Add | Create | Modify | Modify_Metadata | Delete | Remove

Informational Note:

Consumer to maintain the browse index.

Property:

event.consumer.eperson.class

Example Value:

event.consumer.eperson.class = org.dspace.eperson.EPersonConsumer

Informational Note:

Consumer related to EPerson changes

Property:

event.consumer.eperson.filters

Example Value:

event.consumer.eperson.filters = EPerson+Create

Informational Note:

Consumer related to EPerson changes

Property:

event.consumer.test.class

Example Value:

event.consumer.test.class = org.dspace.event.TestConsumer

Informational Note:

Test consumer for debugging and monitoring. Commented out by default.

Property:

event.consumer.test.filters

Example Value:

event.consumer.test.filters = All+All

Informational Note:

Test consumer for debugging and monitoring. Commented out by default.

Property:

testConsumer.verbose

Example Value:

testConsumer.verbose = true

Informational Note:

Set this to true to enable testConsumer messages to standard output. Commented out by default.

...