Page History

...

Configuration File Syntax/Sources: All DSpace configurations are loaded via Properties files (using the Configuration File Syntax detailed above)
- Note: Apache Commons Configuration does support other configuration sources such as XML configurations or database configurations (see its Overview documentation). At this time, DSpace does not utilize these other sorts of configurations by default. However, it would be possible to customize your local config-definition.xml to load settings from other locations.
Configuration Files/Sources: By default, only two configuration files are loaded into Apache Commons Configuration for DSpace:
- local.cfg (see The local.cfg Configuration Properties File documentation below)
- dspace.cfg (NOTE: all modules/*.cfg are loaded by dspace.cfg via "include=" statements at the end of that configuration file. They are essentially treated as sub-configs which are embedded/included into the dspace.cfg)
Configuration Override Scheme: The configuration override scheme is defined as follows. Configurations specified in earlier locations will automatically override any later values:
- System Properties (-D[setting]=[value]) override all other options
- Environment Variables.
  - DSpace provides a custom environment variable syntax as follows:
    - All periods (.) in configuration names must be translated to "__P__" (two underscores, capital P, two underscores), e.g. "dspace__P__dir" environment variable will override the "dspace.dir" configuration in local.cfg (or other *.cfg files)
    - All dashes (-) in configuration names must be translated to "__D__" (two underscores, capital D, two underscores), e.g. "authentication__D__ip__P__groupname" environment variable will override the "authentication-ip.groupname" configuration in local.cfg (or other *.cfg files)
- local.cfg
- dspace.cfg (and all modules/*.cfg files) contain the default values for all settings.
Configuration Auto-Reload: By default, all configuration files are automatically checked every 5 seconds for changes. If they have changed, they are automatically reloaded.

...

Property:	`dspace.dir`
Example Value:	`/dspace`
Informational Note:	Root directory of DSpace installation. Omit the trailing slash '/'. Note that this setting is used by default in other settings, e.g. `assetstore.dir` . (On Windows be sure to use forward slashes for the directory path! For example: "C:/dspace" is a valid path for Window.)
Property:	`dspace.server.url`
Example Value:	http://dspacetest.myu.edu:8080
Informational Note:	Main URL at which DSpace backend ("server" webapp) is publicly available. If using port 80 (HTTP) or 443 (HTTPS), you may omit the port number. Otherwise the port number must be included. Do not include a trailing slash ('`/`'). In Production, you must use HTTPS if you wish to access the REST API from a different server/domain.
Property:	`dspace.ui.url`
Example Value:	`dspace.ui.url = http://dspacetest.myu.edu:4000`
Informational note	Main URL at which the DSpace frontend (Angular User Interface) is publicly available. If using port 80 (HTTP) or 443 (HTTPS), you may omit the port number. Otherwise the port number must be included. Do not include a trailing slash ('`/`'). In Production, you should be using HTTPS for security purposes. This URL should match the URL you type in the browser to access your User Interface. In the backend, this URL is primarily used to build UI-based URLs in sitemaps, email messages, etc. Therefore, it need not be set on initial installation, but it should be configured as soon as your user interface is installed. If you are not using the DSpace UI (and running the backend "headless"), this may be set to the URL of whatever you consider your primary "user interface".
Property:	`dspace.name`
Example Value:	`dspace.name = DSpace at My University`
Informational Note:	Short and sweet site name, used in e-mails, exports and machine interfaces (e.g. OAI-PMH). It is not currently used by the Angular UI.

...

General Solr Configuration

DSpace uses Solr for various indexing purposes, and uses a pool of open connections to manage communication with Solr. These properties configure the connections between DSpace and Solr.

See also the additional Solr configuration properties for specific indexes such as search, statistics, authority and OAI PMHMany of the database configurations are software-dependent. That is, it will be based on the choice of database software being used. Currently, DSpace properly supports PostgreSQL and Oracle.

dburldbusernamedbpassworddbschema

Property:	`solr.`	`server`
Example Value:	db`solr.`url `server =` jdbc`http:`postgresql:`//localhost:`5432`8983/`dspace`solr`
Informational Note:The	above value is the default value when configuring with PostgreSQL. When using Oracle, use this value: `jbdc.oracle.thin:@//host:port/dspace`Base URL to the Solr server. Specific indexes append to this value.
Property:	`solr.client.`	`maxTotalConnections`
Example Value:	`dbsolr.client.username maxTotalConnections = dspace20`
Informational Note:	In the installation directions, the administrator is instructed to create the user "dspace" who will own the database "dspace"The maximum number of connections that will be opened between DSpace and Solr.
Property:	`solr.client.`	`maxPerRoute`
Example Value:	db`solr.client.`password `maxPerRoute =` dspacepassword`15`
Informational Note:	This is the password that was prompted during the installation process (cf. 3.2.3. Installation)The maximum number of connections that will be opened between DSpace and a specific Solr instance (if you have more than one).
Property:	`solr.client.`	`keepAlive`
Example Value:	db`solr.client.`schema `keepAlive =` public`5000`
Informational Note:	If your database contains multiple schemas, you can avoid problems with retrieving the definitions of duplicate objects by specifying the schema name here that is used for DSpace by uncommenting the entry. This property is optional. For PostgreSQL databases, this is often best set to "public" (default schema). For Oracle databases, the schema is usually equivalent to the username of your database account. So, for Oracle, this may be set to `${db.username}` in most scenarios.	The default amount of time that a connection in use will be held open, in milliseconds. Solr may specify a different keep-alive interval and it will be obeyed.
Property:	`solr.client.timeToLive`
Example Value:	`solr.client.timeToLive = 600`
Informational Note:	The maximum amount of time before an open connection will be closed when idle, in seconds. New connections will be opened as needed, subject to the above limits.

DSpace Database Configuration

Many of the database configurations are software-dependent. That is, it will be based on the choice of database software being used. Currently, DSpace properly supports PostgreSQL and Oracle.

Note

title	Oracle Support Deprecated - Will no longer be supported in 2023

Oracle support has been deprecated in DSpace. It will no longer be supported as of June/July 2023. See https://github.com/DSpace/DSpace/issues/8214

We recommend all users install DSpace on PostrgreSQL (see above)

Property:	`db.url`
Property:	`db.maxconnections`
Example Value:	`db.maxconnections = 30`
Informational Note:	Maximum number of Database connections in the connection pool
Property:	`db.maxwait`
Example Value:	`db.maxwait = 5000`
Informational Note:	Maximum time to wait before giving up if all connections in pool are busy (in milliseconds).
Property:	`db.maxidle`
Example Value:	`db.maxidle = -1url = jdbc:postgresql://localhost:5432/dspace`
Informational Note:Maximum number of idle connections in pool. (-1 = unlimited)	The above value is the default value when configuring with PostgreSQL. When using Oracle, use this value: `jbdc.oracle.thin:@//host:port/dspace`
Property:	`db.cleanDisabledusername`
Example Value:	`db.cleanDisabled username = truedspace`
Informational Note:	This is a developer-based setting which determines whether you are allowed to run "./dspace database clean" to completely delete all content and tables in your database. This should always be set to "true" in Production to protect against accidentally deleting all your content by running that command. (Default is set to true)

To provide the database connection pool externally

Alternately, you may supply a configured connection pool out of JNDI. The object must be named jdbc/dspace (the full path is java:comp/env/jdbc/dspace). DSpace will always look up this name and, if found, will use the returned object as its database connection pool. If not found, the above db.* properties will be used to create the pool.

If you are using Tomcat, then the object might be defined using a <Resource> element, or connected to a <Resource> child of <GlobalNamingResources> using a <ResourceLink> element. See your Servlet container's documentation for details of configuring the JNDI initial context. For example, Tomcat provides a useful JNDI Datasource How-to

Earlier releases of DSpace provided a configuration property db.jndi to specify the name to be looked up, but that has been removed. The name is specified in config/spring/api/core-hibernate.xml if you really need to change it.

DSpace Email Settings

The configuration of email is simple and provides a mechanism to alert the person(s) responsible for different features of the DSpace software.

DSpace will look up a javax.mail.Session object in JNDI and, if found, will use that to send email. Otherwise it will create a Session using some of the properties detailed below.

In the installation directions, the administrator is instructed to create the user "dspace" who will own the database "dspace".
Property:	`db.password`
Example Value:	`db.password = dspacepassword`
Informational Note:	This is the password that was prompted during the installation process (cf. 3.2.3. Installation)
Property:	`db.schema`
Example Value:	`db.schema = public`
Informational Note:	If your database contains multiple schemas, you can avoid problems with retrieving the definitions of duplicate objects by specifying the schema name here that is used for DSpace by uncommenting the entry. This property is optional. For PostgreSQL databases, this is often best set to "public" (default schema). For Oracle databases, the schema is usually equivalent to the username of your database account. So, for Oracle, this may be set to `${db.username}` in most scenarios.
Property:	`db.maxconnections`
Example Value:	`db.maxconnections = 30`
Informational Note:	Maximum number of Database connections in the connection pool
Property:	`db.maxwait`
Example Value:	`db.maxwait = 5000`
Informational Note:	Maximum time to wait before giving up if all connections in pool are busy (in milliseconds).
Property:	`db.maxidle`
Example Value:	`db.maxidle = -1`
Informational Note:	Maximum number of idle connections in pool. (-1 = unlimited)
Property:	`db.cleanDisabled`
Example Value:	`db.cleanDisabled = true`
Informational Note:	This is a developer-based setting which determines whether you are allowed to run "./dspace database clean" to completely delete all content and tables in your database. This should always be set to "true" in Production to protect against accidentally deleting all your content by running that command. (Default is set to true)

To provide the database connection pool externally

Alternately, you may supply a configured connection pool out of JNDI. The object must be named jdbc/dspace (the full path is java:comp/env/jdbc/dspace). DSpace will always look up this name and, if found, will use the returned object as its database connection pool. If not found, the above db.* properties will be used to create the pool.

If you are using Tomcat, then the object might be defined using a <Resource> element, or connected to a <Resource> child of <GlobalNamingResources> using a <ResourceLink> element. See your Servlet container's documentation for details of configuring the JNDI initial context. For example, Tomcat provides a useful JNDI Datasource How-to

Earlier releases of DSpace provided a configuration property db.jndi to specify the name to be looked up, but that has been removed. The name is specified in config/spring/api/core-hibernate.xml if you really need to change it.

DSpace Email Settings

The configuration of email is simple and provides a mechanism to alert the person(s) responsible for different features of the DSpace software.

DSpace will look up a javax.mail.Session object in JNDI and, if found, will use that to send email. Otherwise it will create a Session using some of the properties detailed below.

Property:

mail.server

Example Value:

mail.server = smtp.my.edu

Informational Note:

The address on which your outgoing SMTP email server can be reached.

Property:

mail.server.username

Example Value:

mail.server.username = myusername

Informational Note:

SMTP mail server authentication username, if required. This property is optional.

Property:

mail.server.password

Example Value:

mail.server.password = mypassword

Informational Note:

SMTP mail server authentication password, if required. This property is optional.

Property:

mail.server.port

Example Value:

mail.server.port = 25

Informational Note:

The port on which your SMTP mail server can be reached. By default, port 25 is used. Change this setting if your SMTP mailserver is running on another port. This property is optional.

Property:

mail.from.address

Example Value:

mail.from.address = dspace-noreply@myu.edu

Informational Note:

The "From" address for email. Change the 'myu.edu' to the site's host name.

Property:

feedback.recipient

Example Value:

feedback.recipient = dspace-help@myu.edu

Informational Note:

When a user clicks on the feedback link/feature, the information will be sent to the email address of choice. This configuration is currently limited to only one recipient. This is also the email address displayed on the contacts page.

Property:

mail.admin

Example Value:

mail.admin = dspace-help@myu.edu

Example Value:

Email address of the general site administrator (Webmaster). System notifications/reports and other sysadmin emails are sent to this email address.

Property: mail.admin.name

Example Value: mail.admin.name = DSpace Administrator

Example Value: Name associated with the mail.admin email address.

Property:

alert.recipient

Example Value:

alert.recipient = john.doe@myu.edu

Informational Note:

Enter the recipient for server errors and alerts. This property is optional and defaults to the ${mail.admin} setting

Property:

registration.notify

Example Value:

registration.notify = mike.smith@myu.edu

Informational Note:

Enter the recipient that will be notified when a new user registers on DSpace. This property is optional & defaults to no value.

Property:

mail.charset

Example Value:

mail.charset = UTF-8

Informational Note:

Set the default mail character set. This may be over-ridden by providing a line inside the email template '#set($charset = "encoding")'. Otherwise this default is used.

Property:

mail.allowed.referrers

Example Value:

mail.allowed.referrers = localhost

Informational Note:

A comma separated list of hostnames that are allowed to refer browsers to email forms. This property is optional. UNSUPPORTED in DSpace 7.0

Property:

mail.extraproperties

Example Value:

Code Block

# Example which can fix "Could not convert socket to TLS" errors (i.e. SMTP over TLS)
mail.extraproperties = mail.smtp.socketFactory.port=587, \
                       mail.smtp.starttls.enable=true, \
                       mail.smtp.starttls.required=true, \
                       mail.smtp.ssl.protocols=TLSv1.2

# Different example of using SSL for your Mail libary
mail.extraproperties = mail.smtp.socketFactory.port=465, \
       mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory, \
       mail.smtp.socketFactory.fallback=false

Informational Note:

If you need to pass extra settings to the Java mail library. Comma separated, equals sign between the key and the value. This property is optional.

Property:

mail.server.disabled

Example Value:

mail.server.disabled = false

Informational Note:

An option is added to disable the mailserver. By default, this property is set to 'false'. By setting value to 'true', DSpace will not send out emails. It will instead log the subject of the email which should have been sent. This is especially useful for development and test environments where production data is used when testing functionality. This property is optional.

Property:

mail.session.name

Example Value:

mail.session.name = myDSpace

Informational Note:

Specifies the name of a javax.mail.Session object stored in JNDI under java:comp/env/mail. The default value is "Session".

Property:

default.language

Example Value:

default.language = en_US

Informational Note:

If no other language is explicitly

Property:

mail.server

Example Value:

mail.server = smtp.my.edu

Informational Note:

The address on which your outgoing SMTP email server can be reached.

Property:

mail.server.username

Example Value:

mail.server.username = myusername

Informational Note:

SMTP mail server authentication username, if required. This property is optional.

Property:

mail.server.password

Example Value:

mail.server.password = mypassword

Informational Note:

SMTP mail server authentication password, if required. This property is optional.

Property:

mail.server.port

Example Value:

mail.server.port = 25

Informational Note:

The port on which your SMTP mail server can be reached. By default, port 25 is used. Change this setting if your SMTP mailserver is running on another port. This property is optional.

Property:

mail.from.address

Example Value:

mail.from.address = dspace-noreply@myu.edu

Informational Note:

The "From" address for email. Change the 'myu.edu' to the site's host name.

Property:

feedback.recipient

Example Value:

feedback.recipient = dspace-help@myu.edu

Informational Note:

When a user clicks on the feedback link/feature, the information will be sent to the email address of choice. This configuration is currently limited to only one recipient. This is also the email address displayed on the contacts page.

Property:

mail.admin

Example Value:

mail.admin = dspace-help@myu.edu

Example Value:

Email address of the general site administrator (Webmaster). System notifications/reports and other sysadmin emails are sent to this email address.

Property: mail.admin.name

Example Value: mail.admin.name = DSpace Administrator

Example Value: Name associated with the mail.admin email address.

Property:

alert.recipient

Example Value:

alert.recipient = john.doe@myu.edu

Informational Note:

Enter the recipient for server errors and alerts. This property is optional and defaults to the ${mail.admin} setting

Property:

registration.notify

Example Value:

registration.notify = mike.smith@myu.edu

Informational Note:

Enter the recipient that will be notified when a new user registers on DSpace. This property is optional & defaults to no value.

Property:

mail.charset

Example Value:

mail.charset = UTF-8

Informational Note:

Set the default mail character set. This may be over-ridden by providing a line inside the email template '#set($charset = "encoding")'. Otherwise this default is used.

Property:

mail.allowed.referrers

Example Value:

mail.allowed.referrers = localhost

Informational Note:

A comma separated list of hostnames that are allowed to refer browsers to email forms. This property is optional. UNSUPPORTED in DSpace 7.0

Property:

mail.extraproperties

Example Value:

Code Block
mail.extraproperties = mail.smtp.socketFactory.port=465, \ mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory, \ mail.smtp.socketFactory.fallback=false

Informational Note:

If you need to pass extra settings to the Java mail library. Comma separated, equals sign between the key and the value. This property is optional.

Property:

mail.server.disabled

Example Value:

mail.server.disabled = false

Informational Note:

An option is added to disable the mailserver. By default, this property is set to 'false'. By setting value to 'true', DSpace will not send out emails. It will instead log the subject of the email which should have been sent. This is especially useful for development and test environments where production data is used when testing functionality. This property is optional.

Property:

mail.session.name

Example Value:

mail.session.name = myDSpace

Informational Note:

Specifies the name of a javax.mail.Session object stored in JNDI under java:comp/env/mail. The default value is "Session".

Property:

default.language

Example Value:

default.language = en_US

Informational Note:

If no other language is explicitly stated in the submission-forms.xml, the default language will be attributed to the metadata values. See also Multilingual Support

Property:mail.message.headersExample Value:

mail.message.headers = subject

mail.message.headers = charset

Informational Note:When processing a message template, setting a Velocity variable whose name is one of the values of this configuration property will add or replace a message header of the same name, using the value of the variable as the header's value. See "Templates can set message headers"name, using the value of the variable as the header's value. See "Templates can set message headers".Property:mail.welcome.enabledExample Value:mail.welcome.enabled = trueInformational Note:Enable a "welcome letter" to the newly-registered user. By default this is false. See the welcome email template.

Wording of E-mail Messages

...

Community Administration: Subcommunities and Collections

Property:

core.authorization.community-admin.create-subelement

Example Value:

core.authorization.community-admin.create-subelement = true

Informational Note:

Authorization for a delegated community administrator to create subcommunities or collections.

Property:

core.authorization.community-admin.delete-subelement

Example Value:

core.authorization.community-admin.delete-subelement = true

Informational Note:

Authorization for a delegated community administrator to delete subcommunities or collections.

Community Administration: Policies and The group of administrators

Property:

core.authorization.community-admin.policies

Example Value:

core.authorization.community-admin.policies = true

Informational Note:

Authorization for a delegated community administrator to administrate the community policies.

Property:

core.authorization.community-admin.admin-group

Example Value:

core.authorization.community-admin.admin-group = true

Informational Note:

Authorization for a delegated community administrator to edit the group of community admins.

Community Administration: Collections in the above Community

Property:

core.authorization.community-admin.collection.policies

Example Value:

core.authorization.community-admin.collection.policies = true

Informational Note:

Authorization for a delegated community administrator to administrate the policies for underlying collections.

Property:

core.authorization.community-admin.collection.template-item

Example Value:

core.authorization.community-admin.collection.template-item = true

Informational Note:

Authorization for a delegated community administrator to administrate the item template for underlying collections.

Property:

core.authorization.community-admin.collection.submitters

Example Value:

core.authorization.community-admin.collection.submitters = true

Informational Note:

Authorization for a delegated community administrator to administrate the group of submitters for underlying collections.

Property:

core.authorization.community-admin.collection.workflows

Example Value:

core.authorization.community-admin.collection.workflows = true

Informational Note:

Authorization for a delegated community administrator to administrate the workflows for underlying collections.

Property:

core.authorization.community-admin.collection.admin-group

Example Value:

core.authorization.community-admin.collection.admin-group = true

Informational Note:

Authorization for a delegated community administrator to administrate the group of administrators for underlying collections.

Community Administration: Items Owned by Collections in the Above Community

Property:

core.authorization.community-admin.item.delete

Example Value:

core.authorization.community-admin.item.delete = true

Informational Note:

Authorization for a delegated community administrator to delete items in underlying collections.

Property:

core.authorization.community-admin.item.withdraw

Example Value:

core.authorization.community-admin.item.withdraw = true

Informational Note:

Authorization for a delegated community administrator to withdraw items in underlying collections.

Property:

core.authorization.community-admin.item.reinstate

Example Value:

core.authorization.community-admin.item.reinstate = true

Informational Note:

Authorization for a delegated community administrator to reinstate items in underlying collections.

Property:

core.authorization.community-admin.item.policies

Example Value:

core.authorization.community-admin.item.policies = true

Informational Note:

Authorization for a delegated community administrator to administrate item policies in underlying collections.

Community Administration: Bundles of Bitstreams, related to items owned by collections in the above Community

Property:

core.authorization.community-admin.item.create-bitstream

Example Value:

core.authorization.community-admin.item.create-bitstream = true

Informational Note:

Authorization for a delegated community administrator to create additional bitstreams in items in underlying collections.

Property:

core.authorization.community-admin.item.delete-bitstream

Example Value:

core.authorization.community-admin.item.delete-bitstream = true

Informational Note:

Authorization for a delegated community administrator to delete bitstreams from items in underlying collections.

Property:

core.authorization.community-admin.item.cc-license

Example Value:

core.authorization.community-admin.item.cc-license = true

Informational Note:

Authorization for a delegated community administrator to administer licenses from items in underlying collections.

Collection Administration:
The properties for collection administrators work similar to those
of community administrators,
with respect to collection administration.

Code Block

core.authorization.collection-admin.policies
core.authorization.collection-admin.template-item
core.authorization.collection-admin.submitters
core.authorization.collection-admin.workflows
core.authorization.collection-admin.admin-group

Collection Administration:
Item owned by the above Collection. The properties for collection
administrators work similar to those of
community administrators,
with respect to administration of
items in underlying collections.

Code Block

core.authorization.collection-admin.item.delete
core.authorization.collection-admin.item.withdraw
core.authorization.collection-admin.item.reinstatiate
core.authorization.collection-admin.item.policies

Collection Administration:
Bundles of bitstreams, related to items owned by collections in the
above Community. The properties for collection administrators
work similar to those of community administrators, with respect to
administration of bitstreams related to items in underlying collections.

Code Block
core.authorization.collection-admin.item.create-bitstream core.authorization.collection-admin.item.delete-bitstream core.authorization.collection-admin.item-admin.cc-license

Item Administration.
The properties for item administrators work similar to those
of community and collection administrators, with respect to administration of
items in underlying collections.

core.authorization.item-admin.policies

Item Administration:
Bundles of bitstreams, related to items owned by collections in the
above Community. The properties for item administrators work
similar to those of community and collection administrators,
with respect to administration of bitstreams
related to items in underlying collections.

Code Block

core.authorization.item-admin.create-bitstream
core.authorization.item-admin.delete-bitstream
core.authorization.item-admin.cc-license-bitstream
core.authorization.item-admin.delete-bitstream
core.authorization.item-admin.cc-license

Inheritance of collection default policy (since 7.1)

Property:	core.authorization.installitem.inheritance-read.append-mode
Example Value:	core.authorization.installitem.inheritance-read.append-mode = false
Informational Note:	Determine if the DEFAULT READ policies of the collection should be always appended to the policies of the new item (property set to true) or used only when no other READ policy has been defined in the submission process (property set to false). Please note that also in append mode an open access default policy will be NOT inherited if other policies have been defined in the submission (i.e. if the item was restricted)

Login as feature

Property:	`webui.user.assumelogin`
Example Value:	`webui.user.assumelogin = true`
Informational Note:	Determine if super administrators (those whom are in the Administrators group) can login as another user from the "edit eperson" page. This is useful for debugging problems in a running DSpace instance, especially in the workflow process. The default value is false, i.e., no one may assume the login of another user.

...

Property:	`eperson.subscription.onlynew`
Example Value:	`eperson.subscription.onlynew = true`
Informational Note:	For backwards compatibility, the subscription emails by default include any modified items. The property key is COMMENTED OUT by default.

Hiding Metadata

It is now possible to hide metadata from public consumption, so that is it's only available to users with WRITE permissions on the Item. (NOTE: Prior to 7.6.1, Administrator privileges were required for hidden metadata. This was modified to allow users to submit hidden metadata fields, as well as allow Community/Collection Admins to see hidden metadata.)

Property:

metadata.hide.dc.description.provenance

Example Value:

metadata.hide.dc.description.provenance = true

Informational Note:

Hides the metadata in the property key above except to the administrator. Fields named here are hidden in the following places UNLESS the logged-in user is an Administrator:has WRITE permissions on the Item:

REST API (and therefore the User Interface)
RDF (everywhere as there is currently no possibility to authenticate)
XMLUI metadata XML view, and Item splash pages (long and short views).
JSPUI Item splash pages
OAI-PMH server .(everywhere as there is currently no possibility to authenticate)

To designate a field as hidden, add a property here in the form: metadata.hide.SCHEMA.ELEMENT.QUALIFIER = true. This default configuration hides the dc.description.provenance field, since that usually contains email addresses which ought to be kept private and is mainly of interest to administrators.

...

Property:	`cc.api.rooturl`
Example Value:	`cc.api.rooturl =` `http://api.creativecommons.org/rest/1.5`
Informational Note:	Generally will never have to assign a different value - this is the base URL of the Creative Commons service API.
Property:	`cc.license.uri`
Example Value:	`cc.license.uri = dc.rights.uri`
Informational Note:	The field that holds the Creative Commons license URI. If you change from the default value (dc.rights.uri), you will have to reconfigure the XMLUI for proper display of license datathe Creative Commons license URI.
Property:	`cc.license.name`
Example Value:	`cc.license.name = dc.rights`
Informational Note:	The field that holds the Creative Commons license Name. If you change from the default value (dc.rights), you will have to reconfigure the XMLUI for proper display of license data
Property:	`cc.submit.setname`
Example Value:	`cc.submit.setname = true`
Informational Note:	If true, the license assignment will add the field configured with the "cc.license.name" with the name of the CC license; if false, only "cc.license.uri" field is added.
Property:	`cc.submit.addbitstream`
Example Value:	`cc.submit.addbitstream = true`
Informational Note:	If true, the license assignment will add a bitstream with the CC license RDF; if false, only metadata field(s) are added.
Property:	`cc.license.classfilter`
Example Value:	`cc.license.classfilter = recombo,mark`
Informational Note:	This list defines the values that will be excluded from the license (class) selection list, as defined by the web service at the URL: http://api.creativecommons.org/rest/1.5/classes
Property:	`cc.license.jurisdiction`
Example Value:	`cc.license.jurisdiction = nz`
Informational Note:	Should a jurisdiction be used? If so, which one? See http://creativecommons.org/international/ for a list of possible codes (e.g. nz = New Zealand, uk = England and Wales, jp = Japan) Commenting out this field will cause DSpace to select the latest, unported CC license (currently version 4.0). However, as Creative Commons 4.0 does not provide jurisdiction specific licenses, if you specify this setting, your DSpace will continue to use older, Creative Commons 3.0 jurisdiction licenses.
Property	`cc.license.locale`
Example Value:	`cc.license.locale` = en
Informational Note:	Locale to be used (in the form: language or language_country), e.g. "en" or "en_US" If no default locale is defined the Creative Commons default locale will be used.

...

Property:	`webui.licence_bundle.show`
Example Value:	`webui.licence_bundle.show = false`
Informational Note:	Sets whether to display the contents of the license bundle (often just the deposit license in the standard DSpace installation). UNSUPPORTED in DSpace 7.0
Property:	`thumbnail.maxwidth`
Example Value:	`thumbnail.maxwidth = 80`
Informational Note:	This property sets the maximum width of generated thumbnails that are being displayed on item pages.
Property:	`thumbnail.maxheight`
Example Value:	`thumbnail.maxheight = 80`
Informational Note:	This property sets the maximum height of generated thumbnails that are being displayed on item pages.
Property:	`webui.preview.maxwidth`
Example Value:	`webui.preview.maxwidth = 600`
Informational Note:	This property sets the maximum width for the preview image. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.maxheight`
Example Value:	`webui.preview.maxheight = 600`
Informational Note:	This property sets the maximum height for the preview image. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.brand`
Example Value:	`webui.preview.brand = My Institution Name`
Informational Note:	This is the brand text that will appear with the image. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.brand.abbrev`
Example Value:	`webui.preview.brand.abbrev = MyOrg`
Informational Note:	An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.brand.height`
Example Value:	`webui.preview.brand.height = 20`
Informational Note:	The height (in px) of the brand. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.brand.font`
Example Value:	`webui.preview.brand.font = SansSerif`
Informational Note:	This property sets the font for your Brand text that appears with the image. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.brand.fontpoint`
Example Value:	`webui.preview.brand.fontpoint = 12`
Informational Note:	This property sets the font point (size) for your Brand text that appears with the image. Only used for BrandedPreviewJPEGFilter
Property:	`webui.preview.dc`
Example Value:	`webui.preview.dc = rights`
Informational Note:	The Dublin Core field that will display along with the preview. This field is optional. Only used for BrandedPreviewJPEGFilter. This field is optional. Only used for BrandedPreviewJPEGFilter

Item Counts in user interface

Info
Available in 7.6 or later

Optionally, you can enable item counts to be displayed in the user interface for every Community and Collection. This uses the same configuration that was in place for DSpace 6 and earlier.

Property:	`webui.strengths.show`
Example Value:	`webui.strengths.show = false`
Informational Note:	When "true" this will display the count of archived items (in the User Interface's browse screens). By default this is "false" (disabled). When enabled, the counts may be counted in real time, or fetched from the cache (see next option).
Property:	`webui.strengths.cache`
Example Value:	`webui.strengths.cache = false`
Informational Note:	When showing the strengths (i.e. item counts), should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the index contents every time a page with this feature is requested, which may not scale. If you set the property key is set to cache ("true"), the counts will be cached on first load. UNSUPPORTED in DSpace 7.0

Browse Index Configuration

...

Property:	`webui.browse.index.<n>`
Example Value:	`webui.browse.index.1 = dateissued:item:dateissued webui.browse.index.2 = author:metadata:dc.contributor.*\,dc.creator:text`
Informational Note:	This is an example of how one "Defines the Indexes". See "Defining the Indexes" in the next sub-section.
Property:	`webui.itemlist.sort-option.<n>`
Example Value:	`webui.itemlist.sort-option.1 = title:dc.title:title`
Informational Note:	This is an example of how one "Defines the Sort Options". See "Defining Sort Options" in the following sub-section.

...

Code Block

webui.browse.index.1 = dateissued:item:dateissued
webui.browse.index.2 = author:metadata:dc.contributor.*\,dc.creator:text
webui.browse.index.3 = title:item:title
webui.browse.index.4 = subject:metadata:dc.subject.*:text
#webui.browse.index.5 = dateaccessioned:item:dateaccessioned

...

Element	Definition and Options (if available)
`webui.browse.index.<n>`	n is the index number. The index numbers must start from 1 and increment continuously by 1 thereafter. Deviation from this will cause an error during install or a configuration update. So anytime you add a new browse index, remember to increase the number. (Commented out index numbers may be used over again).
`<index-name>`	The name by which the index will be identified. In order for the DSpace UI to display human-friendly description for this index, you'll need to update either your Messages.properties (JSPUI) or messages.xml (XMLUI) with new message keys referencing this <index-name>.JSPUI Example (Messages.properties)the UI's language packs (e.g. `src/assets/i18n/en.json5`) to include a key using this index name, for example: `browse.type.metadata.<index-name> = My New Field` XMLUI Example (messages.xml): `<message key=` "xmlui.ArtifactBrowser`.`Navigation.browse_`<index-name>` " `>My New Fields</message>` `<message key=` `"xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.<index-name>"` `>Browsing {` `0` `} by My New Field {` `1` `}</message>` `<message key=` `"xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.<index-name>"` `>Browsing {` `0` `} by My New Field</message>` `= "MyField",` `browse.metadata<message key=` "xmlui.ArtifactBrowser.ConfigurableBrowse`.<index-name>.`column_heading" `>My New Field</message>breadcrumbs = "Browse by MyField",`
`(metadata\|item)`	Only two options are available: "`metadata`" or "`item`" "`metadata`" indexes allow you to index all items based on one or more metadata fields. The list of fields should be provided as part of the "metadata" configuration. Only items which have values for these fields will appear in this index (e.g. if you have a "metadata" index for "`dc.subject.`", an item will not appear in that browse/search if it doesn't have a "`dc.subject.`" value). The browse index will have to parts: first it lists all values of the specified metadata fields. If the user select one of these values the index lists all items in which the specified metadata field is assigned with the selected value. Note: If you set a <sort-type> to be used, this sort type is not used on the values of the metadata fields but on the order of the items when listing all items that have a specific value of the metadata field. "`item`" indexes provide you with a browseable list of ALL items in the site, sorted by a particular metadata field. The field this index is sorted by is referenced by `<sort-option-name>` (which should refer to a corresponding "`webui.itemlist.sort-option.<n>`" setting... see Defining Sort Options below for more information)
`<schema-prefix>`	(Only for "metadata" indexes) The schema used for the field to be index. First part of a metadata field name. The default is dc (for Dublin Core).
`<element>`	(Only for "metadata" indexes) The schema element. Second part of a metadata field name. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A.
`<qualifier>`	(Only for "metadata" indexes) This is the qualifier to the <element> component. Third part of a metadata field name. The user has two choices: an asterisk "" or a proper qualifier of the element. The asterisk is a wildcard and causes DSpace to index all types of the schema element. For example, if you have the element "contributor" and the qualifier "" then you would index all contributor data regardless of the qualifier. Another example, you have the element "subject" and the qualifier "lcsh" would cause the indexing of only those fields that have the qualifier "lcsh". (This means you would only index Library of Congress Subject Headings and not all data elements that are subjects.)
`<sort-type>`	(Optional, should be set for "item" indexes) This refers to the sort type / data type of the field: `date` the index type will be treated as a date object and sorted as such `text` the index type will be treated as plain text and sorted as such (any other value refers to a custom <sort-type> which should be defined in a corresponding `webui.itemlist.sort-option.<n>` setting. See Defining Sort Options below for more information.)
`<sort-order>`	(Optional) The default sort order. Choose `asc` (ascending) or `desc` (descending). Ascending is the default value, but descending may be useful for date-based indexes (e.g. to display most recent submissions first)

...

Element	Definition and Options (if available)
`webui.itemlist.sort-option.<n>`	n is an arbitrary number you choose.
`<sort-type-name>`	The name by which the sort option will be identified. This is the name by which it is referred in the "webui.browse.index" settings (see Defining the Indexes).
`<schema-prefix>`	The schema used for the field to be sorted on in the index. The default is dc (for Dublin Core).
`<element>`	The schema element. In Dublin Core, for example, the author element is referred to as "Contributor". The user should consult the default Dublin Core Metadata Registry table in Appendix A.
`<qualifier>`	This is the qualifier to the <element> component. The user has two choices: an asterisk "*" or a proper qualifier of the element.
`<datatype>`	This refers to the datatype of the field: `date` the sort field will be treated as a date object `text` the sort field will be treated as plain text. `title` the sort field will be treated like a title, which will include a link to the item page

Other Browse Options

We set other browse values in the following section.

...

Property:

...

plugin.named.org.dspace.sort.OrderFormatDelegate

...

Example Value:

Code Block
plugin.named.org.dspace.sort.OrderFormatDelegate = \ org.dspace.sort.OrderFormatTitleMarc21=title

...

Informational Note:

...

This sets the option for how the indexes are sorted. All sort normalizations are carried out by the OrderFormatDelegate. The plugin manager can be used to specify your own delegates for each datatype. The default datatypes (and delegates) are:

Code Block
author = org.dspace.sort.OrderFormatAuthor title = org.dspace.sort.OrderFormatTitle text = org.dspace.sort.OrderFormatText

If you redefine a default datatype here, the configuration will be used in preferences to the default. However, if you do not explicitly redefine a datatype, then the default will still be used in addition to the datatypes you do specify. As of DSpace release 1.5.2, the multi-lingual MARC21 title ordering is configured as default, as shown in the example above. To use the previous title ordering (before release 1.5.2), comment out the configuration in your dspace.cfg file.

date object
text the sort field will be treated as plain text.
title the sort field will be treated like a title, which will include a link to the item page

Hierarchical Browse Indexes

No configuration is necessary for hierarchical browse indexes (Browse by Subject Category). These are automatically generated based on the used controlled vocabularies in your submission forms. Default DSpace has one hierarchical browse index (Browse by Subject Category), since "srsc" is the only vocabulary used in the default submission-forms.xml.

Please note that when using another vocabulary, the UI's language packs (e.g. src/assets/i18n/en.json5) will need to be updated as well, e.g.:

"menu.section.browse_global_by_srsc": "By Subject Category"
"browse.metadata.srsc.breadcrumbs": "Browse by Subject Category"
"browse.comcol.by.srsc": "By Subject Category"

Starting with DSpace 7.6.1, these Hierarchical "Browse By" options can be disabled via the below configuration:

Browse Index Authority Control Configuration

index<n>index5 = lcAuthor:metadataAuthority:dc.contributor.author:authority

Property:	`webui.browse.`
`vocabularies.`
`disabled`
Example Value:	`webui.browse.`
`vocabularies.`
`disabled = srsc`
Informational Note:

Apart from the single (type=metadata) and full (type=item) browse pages, tag cloud is a new way to display the unique values of a metadata field.

By default, all controlled vocabularies used within your submission forms (submission-forms.xml) will be enabled in the Browse By menu of the User Interface. If you wish to disable any from display in the UI, you can list them in this configuration. Multiple values can be comma separated (or this config can be repeated). Changes to this configuration will not take effect until your servlet engine (e.g. Tomcat) is restarted.

Other Browse Options

We set other browse values in the following section.To enable “tag cloud” browsing for a specific index you need to declare it in the dspace.cfg configuration file using the following option:

indextagcloud.<n> indextagcloud true

Property: webui.browse. metadata. show-freq.< n >

Example Value: webui.browse. metadata. show-freq.1 = false

Informational Note:

Enable/Disable tag cloud in browsing for a specific index. ‘n’ is the index number of the specific index which needs to be of type ‘metadata’.

Possible values: true, false

Default value is false.

If no option exists for a specific index, it is assumed to be false.

You do not have to re-index discovery when you change this configuration

UNSUPPORTED in DSpace 7.0

Links to Other Browse Contexts

We can define which fields link to other browse listings. This is useful, for example, to link an author's name to a list of just that author's items. The effect this has is to create links to browse views for the item clicked on. If it is a "single" type, it will link to a view of all the items which share that metadata element in common (i.e. all the papers by a single author). If it is a "full" type, it will link to a view of the standard full browse page, starting with the value of the link clicked on.

...

Property:

...

webui.browse.link.<n>

...

Example Value:

...

webui.browse.link.1 = author:dc.contributor.*

...

Informational Note:

...

This is used to configure which fields should link to other browse listings. This should be associated with the name of one of the browse indexes (webui.browse.index.n) with a metadata field listed in webui.itemlist.columns above. If this condition is not fulfilled, cross-linking will not work. Note also that crosslinking only works for metadata fields not tagged as title in webui.itemlist.columns.

The format of the property key is webui.browse.link.<n> = <index name>:<display column metadata> Please notice the punctuation used between the elements.

Element	Definition and Options (if available)
`webui.browse.link.` `n`	{{n is an arbitrary number you choose
`<index name>`	This need to match your entry for the index name from webui.browse.index property key.
`<display column metadata>`	Use the DC element (and qualifier)

Examples of some browse links used in a real DSpace installation instance:

...

Column

width	60%

webui.browse.link.1 = author:dc.contributor.*

Column

width	40%

Creates a link for all types of contributors (authors, editors, illustrators, others, etc.)

...

Column

width	60%

webui.browse.link.2 = subject:dc.subject.lcsh

Column

width	40%

Creates a link to subjects that are Library of Congress only. In this case, you have a browse index that contains only LC Subject Headings

...

Column

width	60%

webui.browse.link.3 = series:dc.relation.ispartofseries

Column

width	40%

Creates a link for the browse index "Series". Please note this is again, a customized browse index and not part of the DSpace distributed release.

Submission License Substitution Variables

...

Property:

Code Block
plugin.named.org.dspace.content.license. LicenseArgumentFormatter

(property key broken up for display purposes only)

...

Example Value:

Code Block

plugin.named.org.dspace.content.license.LicenseArgumentFormatter = \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = collection, \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = item, \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = eperson

...

Informational Note:

...

It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation.

This enable/disable the show of frequencies (count) in metadata browse <n> refers to the browse configuration. As default frequencies are shown for all metadata browse

Property:

plugin.named.org.dspace.sort.OrderFormatDelegate

Example Value:

Code Block
plugin.named.org.dspace.sort.OrderFormatDelegate = \ org.dspace.sort.OrderFormatTitleMarc21=title

Informational Note:

This sets the option for how the indexes are sorted. All sort normalizations are carried out by the OrderFormatDelegate. The plugin manager can be used to specify your own delegates for each datatype. The default datatypes (and delegates) are:

Code Block
author = org.dspace.sort.OrderFormatAuthor title = org.dspace.sort.OrderFormatTitle text = org.dspace.sort.OrderFormatText

If you redefine a default datatype here, the configuration will be used in preferences to the default. However, if you do not explicitly redefine a datatype, then the default will still be used in addition to the datatypes you do specify. As of DSpace release 1.5.2, the multi-lingual MARC21 title ordering is configured as default, as shown in the example above. To use the previous title ordering (before release 1.5.2), comment out the configuration in your dspace.cfg file.

Browse Index Authority Control Configuration

Property:	`webui.browse.index.<n>`
Example Value:	`webui.browse.index.5 = lcAuthor:metadataAuthority:dc.contributor.author:authority`
Informational Note:

Apart from the single (type=metadata) and full (type=item) browse pages, tag cloud is a new way to display the unique values of a metadata field.

To enable “tag cloud” browsing for a specific index you need to declare it in the dspace.cfg configuration file using the following option:

Property:

webui.browse.index.tagcloud.<n>

Example Value:

webui.browse.index.tagcloud.1 = true

Informational Note:

Enable/Disable tag cloud in browsing for a specific index. ‘n’ is the index number of the specific index which needs to be of type ‘metadata’.

Possible values: true, false

Default value is false.

If no option exists for a specific index, it is assumed to be false.

You do not have to re-index discovery when you change this configuration

UNSUPPORTED in DSpace 7.0

Links to Other Browse Contexts

We can define which fields link to other browse listings. This is useful, for example, to link an author's name to a list of just that author's items. The effect this has is to create links to browse views for the item clicked on. If it is a "single" type, it will link to a view of all the items which share that metadata element in common (i.e. all the papers by a single author). If it is a "full" type, it will link to a view of the standard full browse page, starting with the value of the link clicked on.

Property:	`webui.browse.link.<n>`
Example Value:	`webui.browse.link.1 = author:dc.contributor.*`
Informational Note:	This is used to configure which fields should link to other browse listings. This should be associated with the name of one of the browse indexes (`webui.browse.index.n`) with a metadata field listed in `webui.itemlist.columns` above. If this condition is not fulfilled, cross-linking will not work. Note also that crosslinking only works for metadata fields not tagged as `title` in `webui.itemlist.columns`.

The format of the property key is webui.browse.link.<n> = <index name>:<display column metadata> Please notice the punctuation used between the elements.

Element	Definition and Options (if available)
`webui.browse.link.` `n`	{{n is an arbitrary number you choose
`<index name>`	This need to match your entry for the index name from webui.browse.index property key.
`<display column metadata>`	Use the DC element (and qualifier)

Examples of some browse links used in a real DSpace installation instance:

Section

Column

width	60%

webui.browse.link.1 = author:dc.contributor.*

Column

width	40%

Creates a link for all types of contributors (authors, editors, illustrators, others, etc.)

Section

Column

width	60%

webui.browse.link.2 = subject:dc.subject.lcsh

Column

width	40%

Creates a link to subjects that are Library of Congress only. In this case, you have a browse index that contains only LC Subject Headings

Section

Column

width	60%

webui.browse.link.3 = series:dc.relation.ispartofseries

Column

width	40%

Creates a link for the browse index "Series". Please note this is again, a customized browse index and not part of the DSpace distributed release.

Submission License Substitution Variables

Property:

Code Block
plugin.named.org.dspace.content.license. LicenseArgumentFormatter

(property key broken up for display purposes only)

Example Value:

Code Block

plugin.named.org.dspace.content.license.LicenseArgumentFormatter = \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = collection, \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = item, \
	org.dspace.content.license.SimpleDSpaceObjectLicenseFormatter = eperson

Informational Note:

It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation.

Syndication Feed (RSS) Settings

Note
Supported as of 7.3 and above.

Please note that Syndication (RSS/Atom) feeds require that OpenSearch is enabled to function. When enabled, a syndication feed will be available on the DSpace homepage (for entire site), and on each community/collection homepage (specific to that community/collection). Because Syndication Feeds use OpenSearch, all OpenSearch settings also apply to Syndication Feeds.

Property:	`websvc.opensearch.enable`
Example Value:	`webui.opensearch.enable = true`
Informational Note:	By default, OpenSearch & Syndication feeds are set to true (on) . Change key to "false" to disable. NOTE this setting affects OpenSearch Support as well

Syndication Feed (RSS) Settings

Note
UNSUPPORTED in 7.0. Will be added in a later release

This will enable syndication feeds‚ links display on community and collection home pages. This setting is not used by the XMLUI, as you enable feeds in your theme.

Property:

webui.feed.enable

Example Value:

webui.feed.enable = true

Informational Note:

By default, RSS feeds are set to true (on) . Change key to "false" to disable.

Property:

webui.feed.items

Example Value:

webui.feed.items = 4

Informational Note:

Defines the number of DSpace items per feed (the most recent submissions)

Property:

webui.feed.cache.size

Example Value:

webui.feed.cache.size = 100

Informational Note:

Defines the maximum number of feeds in memory cache. Value of "0" will disable caching.

Property:

webui.feed.cache.age

Example Value:

webui.feed.cache.age = 48

Informational Note:

Defines the number of hours to keep cached feeds before checking currency. The value of "0" will force a check with each request.

Property:

webui.feed.formats

Example Value:

webui.feed.formats = rss_1.0,rss_2.0,atom_1.0

Informational Note:

Defines which syndication formats to offer. You can use more than one; use a comma-separated list. The following list are the available values: rss_0.90, rss_0.91, rss_0.92, rss_0.93, rss_0.94, rss_1.0, rss_2.0, atom_1.0.

Property:

webui.feed.localresolve

Example Value:

webui.feed.localresolve = false

Informational Note:

By default, (set to false), URLs returned by the feed will point at the global handle resolver (e.g. http://hdl.handle.net/123456789/1). If set to true the local server URLs are used (e.g. http://myserver.myorg/handle/123456789/1).

Property:

webui.feed.item.title

Example Value:

webui.feed.item.title = dc.title

Informational Note:

This property customizes each single-value field displayed in the feed information for each item. Each of the fields takes a single metadata field. The form of the key is <scheme prefix>.<element>.<qualifier> In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element.

Property:

webui.feed.item.date

Example Value:

webui.feed.item.date = dc.date.issued

Informational Note:

This property customizes each single-value field displayed in the feed information for each item. Each of the fields takes a single metadata field. The form of the key is <scheme prefix>.<element>.<qualifier> In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element.

Property:

webui.feed.item.description

Example Value:

Code Block
webui.feed.item.description = dc.title, dc.contributor.author, \ dc.contributor.editor, dc.description.abstract, \ dc.description

Informational Note:

One can customize the metadata fields to show in the feed for each item's description. Elements are displayed in the order they are specified in dspace.cfg.Like other property keys, the format of this property key is: webui.feed.item.description = <scheme prefix>.<element>.<qualifier>. In place of the qualifier, one may leave it blank to exclude any qualifiers or use the wildcard "*" to include all qualifiers for a particular element.

Property:

webui.feed.item.author

Example Value:

webui.feed.item.author = dc.contributor.author

Informational Note:

The name of field to use for authors (Atom only); repeatable.

Property:

webui.feed.logo.url

Example Value:

webui.feed.logo.url = ${dspace.url}/themes/mysite/images/mysite-logo.png

Informational Note:

Customize the image icon included with the site-wide feeds. This must be an absolute URL.

Property:

webui.feed.item.dc.creator

Example Value:

webui.feed.item.dc.creator = dc.contributor.author

Informational Note:

This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc.

Property:

webui.feed.item.dc.date

Example Value:

webui.feed.item.dc.date = dc.date.issued

Informational Note:

This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc.

Property:

webui.feed.item.dc.description

Example Value:

webui.feed.item.dc.description = dc.description.abstract

Informational Note:

This optional property adds structured DC elements as XML elements to the feed description. They are not the same thing as, for example, webui.feed.item.description. Useful when a program or stylesheet will be transforming a feed and wants separate author, description, date, etc.

Property:

webui.feed.podcast.collections

Example Value:

webui.feed.podcast.collections = 1811/45183,1811/47223

Informational Note:

This optional property enables Podcast Support on the RSS feed for the specified collection handles. The podcast is iTunes compatible and will expose the bitstreams in the items for viewing and download by the podcast reader. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds

Property:

webui.feed.podcast.communities

Example Value:

webui.feed.podcast.communities = 1811/47223

Informational Note:

This optional property enables Podcast Support on the RSS feed for the specified community handles. The podcast is iTunes compatible and will expose the bitstreams in the items for viewing and download by the podcast reader. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds

Property:

webui.feed.podcast.mimetypes

Example Value:

webui.feed.podcast.mimetypes = audio/x-mpeg,application/pdf

Informational Note:

This optional property for Podcast Support, allows you to choose which MIME types of bitstreams are to be enclosed in the podcast feed. Multiple values are separated by commas. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds

Property:

webui.feed.podcast.sourceuri

Example Value:

webui.feed.podcast.sourceuri = dc.source.uri

Informational Note:

This optional property for the Podcast Support will allow you to use a value for a metadata field as a replacement for actual bitstreams to be enclosed in the RSS feed. A use case for specifying the external sourceuri would be if you have a non-DSpace media streaming server that has a copy of your media file that you would prefer to have the media streamed from. For more on using/enabling Media RSS Feeds to share content via iTunesU, see: Enable Media RSS Feeds

OpenSearch Support

OpenSearch is a small set of conventions and documents for describing and using "search engines", meaning any service that returns a set of results for a query. See extensive description in the Business Layer section of the documentation.

Please note that RSS/Atom feeds require that OpenSearch is enabled to function.

for result data formatting, OpenSearch uses Syndication Feed Settings (RSS). So, even if Syndication Feeds are not enable, they must be configured to enable OpenSearch. OpenSearch uses all the configuration properties for DSpace RSS to determine the mapping of metadata fields to feed fields. Note that a new field for authors has been added (used in Atom format only).

Property:	`websvc.opensearch.enable`
Example Value:	`websvc.opensearch.enable = true/false`
Informational Note:	Whether or not OpenSearch is enabled. By default, the feature is disabled. Change the property key to "true" to enable.enabled to support RSS/Atom feeds. Change to "false" to disable.
Property:	`websvc.opensearch.svccontext`
Example Value:	`websvc.opensearch.svccontext = opensearch`
Informational Note:	The URL path where OpenSearch is made available on the backend. For example, "opensearch" means it is available at `${dspace.server.url}/opensearch`
Property:	`websvc.opensearch.uicontext`
Example Value:	`websvc.opensearch.uicontext = simple-search`
Informational Note:	Context for HTML request URLs. Change only for non-standard servlet mapping.
Property:	`websvc.opensearch.autolink`
Example Value:	`websvc.opensearch.autolink = true`
Informational Note:	Present autodiscovery link in every page head.
Property:	`websvc.opensearch.validity`
Example Value:	`websvc.opensearch.validity = 48`
Informational Note:	Number of hours to retain results before recalculating. This applies to the Manakin interface only.
Property:	`websvc.opensearch.shortname`
Example Value:	`websvc.opensearch.shortname = DSpace`
Informational Note:	A short name used in browsers for search service. It should be sixteen (16) or fewer characters.
Property:	`websvc.opensearch.longname`
Example Value:	`websvc.opensearch.longname = ${dspace.name`}
Informational Note:	A longer name up to 48 characters.
Property:	`websvc.opensearch.description`
Example Value:	`websvc.opensearch.description = ${dspace.name} DSpace repository`
Informational Note:	`Brief service description`
Property:	`websvc.opensearch.faviconurl`
Example Value:	_`websvc.opensearch.faviconurl = http://www.dspace.org/images/favicon.ico`_
Informational Note:	Location of favicon for service, if any. They must by 16 x 16 pixels. You can provide your own local favicon instead of the default.
Property:	`websvc.opensearch.samplequery`
Example Value:	`websvc.opensearch.samplequery = photosynthesis`
Informational Note:	Sample query. This should return results. You can replace the sample query with search terms that should actually yield results in your repository.
Property:	`websvc.opensearch.tags`
Example Value:	`websc.opensearch.tags = IR DSpace`
Informational Note:	Tags used to describe search service.
Property:	`websvc.opensearch.formats`
Example Value:	`websvc.opensearch.formats = html,atom,rss`
Informational Note:	Result formats offered. Use one or more comma-separated from the list: html, atom, rss. Please note that html is required for auto discovery in browsers to function, and must be the first in the list if present.

...

Property:

webui.html.max-depth-guess

Example Value:

webui.html.max-depth-guess = 3

Informational Note:

When serving up composite HTML items in the JSP UI, how deep can the request be for us to serve up a file with the same name? For example, if one receives a request for "foo/bar/index.html" and one has a bitstream called just "index.html", DSpace will serve up the former bitstream (foo/bar/index.html) for the request if webui.html.max-depth-guess is 2 or greater. If webui.html.max-depth-guess is 1 or less, then DSpace would not serve that bitstream, as the depth of the file is greater. If webui.html.max-depth-guess is zero, the request filename and path must always exactly match the bitstream name. The default is set to 3.

UNSUPPORTED IN DSpace 7.0

...

displayScore	Should display the score of each tag next to it? Default: false
shouldCenter	Should display the tag as center aligned in the page or left aligned? Possible values: true \| false. Default: true
totalTags	How many tags will be shown. Value -1 means all of them. Default: -1
cloudCase	The letter case of the tags. Possible values: Case.LOWER \| Case.UPPER \| Case.CAPITALIZATION \| Case.PRESERVE_CASE \| Case.CASE_SENSITIVE Default: Case.PRESERVE_CASE
randomColors	If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true \| false . Default: true
fontFrom	The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1
fontTo	The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2
cuttingLevel	The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0
ordering	The ordering of the tags (based either on the name or the score of the tag) Possible values: Tag.NameComparatorAsc \| Tag.NameComparatorDesc \| Tag.ScoreComparatorAsc \| Tag.ScoreComparatorDesc Default: Tag.GreekNameComparatorAsc

Class	Note
tagcloud	General class for the whole tagcloud
tagcloud_1	Specific tag class for tag of type 1 (based on score)
tagcloud_2	Specific tag class for tag of type 2 (based on score)
tagcloud_3	Specific tag class for tag of type 3 (based on score)

displayScore	Should display the score of each tag next to it? Default: false
shouldCenter	Should display the tag as center aligned in the page or left aligned? Possible values: true \| false. Default: true
totalTags	How many tags will be shown. Value -1 means all of them. Default: -1
cloudCase	The letter case of the tags. Possible values: Case.LOWER \| Case.UPPER \| Case.CAPITALIZATION \| Case.PRESERVE_CASE \| Case.CASE_SENSITIVE Default: Case.PRESERVE_CASE
randomColors	If the 3 css classes of the tag cloud should be independent of score (random=yes) or based on the score. Possible values: true \| false . Default: true
fontFrom	The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 1.1
fontTo	The font size (in em) for the tag with the lowest score. Possible values: any decimal. Default: 3.2
cuttingLevel	The score that tags with lower than that will not appear in the rag cloud. Possible values: any integer from 1 to infinity. Default: 0
ordering	The ordering of the tags (based either on the name or the score of the tag) Possible values: Tag.NameComparatorAsc \| Tag.NameComparatorDesc \| Tag.ScoreComparatorAsc \| Tag.ScoreComparatorDesc Default: Tag.GreekNameComparatorAsc

Class	Note
tagcloud	General class for the whole tagcloud
tagcloud_1	Specific tag class for tag of type 1 (based on score)
tagcloud_2	Specific tag class for tag of type 2 (based on score)
tagcloud_3	Specific tag class for tag of type 3 (based on score)

All Versions

DSpace Documentation

Page tree

Versions Compared

Old Version 24

New Version Current

Key

General Solr Configuration

DSpace Database Configuration

To provide the database connection pool externally

DSpace Email Settings

To provide the database connection pool externally

DSpace Email Settings

Wording of E-mail Messages

Inheritance of collection default policy (since 7.1)

Login as feature

Hiding Metadata

Item Counts in user interface

Browse Index Configuration

Other Browse Options

Hierarchical Browse Indexes

Browse Index Authority Control Configuration

Other Browse Options

Links to Other Browse Contexts

Submission License Substitution Variables

Browse Index Authority Control Configuration

Links to Other Browse Contexts

Submission License Substitution Variables

Syndication Feed (RSS) Settings

Syndication Feed (RSS) Settings

OpenSearch Support

All Versions

DSpace Documentation

Page tree

Page History

Versions Compared

Old Version 24

New Version Current

Key

General Solr Configuration

DSpace Database Configuration

To provide the database connection pool externally

DSpace Email Settings

To provide the database connection pool externally

DSpace Email Settings

Wording of E-mail Messages

Inheritance of collection default policy (since 7.1)

Login as feature

Hiding Metadata

Item Counts in user interface

Browse Index Configuration

Other Browse Options

Hierarchical Browse Indexes

Browse Index Authority Control Configuration

Tag cloud

Other Browse Options

Links to Other Browse Contexts

Submission License Substitution Variables

Browse Index Authority Control Configuration

Tag cloud

Links to Other Browse Contexts

Submission License Substitution Variables

Syndication Feed (RSS) Settings

Syndication Feed (RSS) Settings

OpenSearch Support