Page History
...
- General Configuration - addresses general conventions used with configuring not only the dspace.cfg file, but other configuration files which use similar conventions.
- The build.properties Configuration Properties File - specifies the basic
build.properties
file settings (these basic settings are used when building/installing/upgrading DSpace) - The dspace.cfg Configuration Properties File - specifies the basic
dspace.cfg
file settings (these settings are used when DSpace is actually running) Optional or Advanced Configuration Settings - contain other more advanced settings that are optional in the dspace.cfg configuration file.
Info As of version 1.8 much of the DSpace configuration has been moved to discrete configuration files related to specific functionality and is documented in subsequent sections of this document.
...
Things you should know about editing dspace.cfg
files.
It is important to remember that there are * two multiple dspace.cfg
files in serveral places after an installation of DSpace.* The only two you should notice are:
- The "source" file that is found in
[dspace-source]/dspace/config/dspace.cfg
- The "runtime" file that is found in
[dspace]/config/dspace.cfg
The runtime file is supposed to be the copy of the source file, which is considered the master version. However, the DSpace server and command programs only look at the runtime configuration file, so when you are revising your configuration values, it is tempting to only edit the runtime file. DO NOT do this. Always make the same changes to the source version ofdspace.cfg
in addition to the runtime file. The two files should always be identical, since the sourcedspace.cfg
will be the basis of your next upgrade.
...
Please note that there are in fact two options available, choose whichever you prefer :-
- '"ant update_configs' " ==> Moves existing configs in
[dspace]/config/
to *.old files and replaces them with what is in[dspace-srcsource]/dspace/config/
- '"ant -Doverwrite=false update_configs' " ==> Leaves existing configs in
[dspace]/config/
intact. Just copies new configs from
[dspace-srcsource]/dspace/config/
over to *.new files.
The build.properties
Configuration Properties File
The primary way As of configuring DSpace is to edit the dspace.cfg, however, the 3.0, we now provide a [dspace-srcsource]/build.properties
file exists to provide as an easy means of configuring configuration a subset of properties . Typically this would be done to allow different developers to maintain their own build.properties files outwith [dspace-src]
. Each developer would need to edit [dspace-src]
/pom.xml to reference their own build.properties file. Any common changes could be applied directly to dspace.cfg.
The dspace.cfg
Configuration Properties File
before you build DSpace (by running "mvn package" or similar). Any properties set in this build.properties
file will be automatically copied over to your final dspace.cfg
file as part of the Maven build process.
Users/Developers may also choose to copy the build.properties
under a different name for different environments (e.g. development, test & production), and choose which environment to build DSpace for by passing a "-Denv" (environment) flag to the Maven build process (e.g. "mvn package -Denv=test" would build DSpace using a custom "test.properties" file).
Here's a basic example of how build.properties (or any *.properties) file may be used to simplify installation & development:
- A developer or user downloads a copy of DSpace to build & install
- He/She can edit the
[dspace-source]/build.properties
to specify the very basic settings for building & installing DSpace- OR, alternatively he/she can copy/rename the "build.properties" to a different "*.properties" file & edit it. For example, you could choose to create a separate properties file for each environment (dev.properties, test.properties, prod.properties)
- He/She can then build the DSpace Installation Package using the *.properties file they choose
- Running simply "mvn package" will always use the default "build.properties" settings.
- Passing in the "-Denv" (environment) flag, will cause the build process to use a custom properties file. Some examples:
- "mvn package -Denv=test" would build DSpace using a custom file named
[dspace-source]/test.properties
- "mvn package -Denv=local" would build DSpace using a custom file named
[dspace-source]/local.properties
- "mvn package -Denv=john" would build DSpace using a custom file named
[dspace-source]/john.properties
- "mvn package -Denv=test" would build DSpace using a custom file named
- No matter which build options are used, the values in the enabled properties file will be automatically copied over to your
[dspace-source]/dspace/target/dspace-[version]-build/
dspace.cfg
Note | ||
---|---|---|
| ||
It is worth noting that the |
Warning | ||
---|---|---|
| ||
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.
|
The dspace.cfg
Configuration Properties File
The dspace
dspace.cfg
contains basic information about a DSpace installation, including system path information, network host information, and other like items. It is the primary configuration file for DSpace, used by DSpace when it is actively running.
Main DSpace Configurations
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | This is Asset (bitstream) store number 0 (Zero). You need not place your assetstore under the /dspace directory, but may want to place it on a different logical volume on the server that DSpace resides. So, you might have something like this: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property specifies extra asset stores like the one above, counting from one (1) upwards. This property is commented out (#) until it is needed. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Informational Note: Specify the number of the store to use for new bitstreams with this property. The default is 0 [zero] which corresponds to the 'assestore.dir' above. As the asset store number is stored in the item metadata (in the database), always keep the assetstore numbering consistent and don't change the asset store number in the item metadata. |
...
The CNRI Handle system is a 3rd party service for maintaining persistent URL's. For a nominal fee, you can register a handle prefix for your repository. As a result, your repository items will be also available under the links http://handle.net/<<handle prefix>>/<<item id>>. As the base url of your repository might change or evolve, the persistent handle.net URL's secure the consistency of links to your repository items. For complete information regarding the Handle server, the user should consult Section 3.4.4.. The Handle Server section of Installing DSpace.
...
Authorization to execute the functions that are allowed to user with WRITE permission on an object will be attributed to be the ADMIN of the object (e.g. community/collection/admin will be always allowed to edit metadata of the object). The default will be "true" for all the configurations.
Community Administration: Subcommunities and Collections | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to create subcommunities or collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete subcommunities or collections. | ||
Community Administration: Policies and The group of administrators | |||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the community policies. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to edit the group of community admins. | ||
Community Administration: Collections in the above Community |
| ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the policies for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the item template for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the group of submitters for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administrate the workflows for underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
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: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to withdraw items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to reinstate items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
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: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to create additional bitstreams in items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to delete bitstreams from items in underlying collections. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Authorization for a delegated community administrator to administer licenses from items in underlying collections. | ||
Community Administration: |
| ||
Collection Administration: |
| ||
Collection Administration: |
| ||
Item Administration. |
| ||
Item Administration: |
| .authorization.item-admin.cc-license
Restricted Item Visibility Settings
By default RSS feeds, OAI-PMH and subscription emails will include ALL items regardless of permissions set on them. If you wish to only expose items through these channels where the ANONYMOUS user is granted READ permission, then set the following options to false.
In large repositories, setting harvest.includerestricted.oai to false may cause performance problems as all items will need to have their authorization permissions checked, but because DSpace has not implemented resumption tokens in ListIdentifiers, ALL items will need checking whenever a ListIdentifers request is made.
...
Property:
...
harvest.includerestricted.rss
...
Example Value:
...
harvest.includerestricted.rss = true
|
Restricted Item Visibility Settings
By default RSS feeds and subscription emails will include ALL items regardless of permissions set on them. If you wish to only expose items through these channels where the ANONYMOUS user is granted READ permission, then set the following options to false.
...
Informational Note:
...
Property: |
|
Example Value: |
|
Informational Note: | When set to 'true' (default), items that haven't got the READ permission for the ANONYMOUS user, will be included in OAI sets RSS feeds anyway. |
Property: |
|
Example Value: |
|
Informational Note: | When set to true (default), items that haven't got the READ permission for the ANONYMOUS user, will be included in Subscription emails anyway. |
...
The MODS crosswalk properties file is a list of properties describing how DSpace metadata elements are to be turned into elements of the MODS XML output document. The property name is a concatenation of the metadata schema, element name, and optionally the qualifier. For example, the contributor.author element in the native Dublin Core schema would be: dc.contributor.author. The value of the property is a line containing two segments separated by the vertical bar ("|
"_): The first part is an XML fragment which is copied into the output document. The second is an XPath expression describing where in that fragment to put the value of the metadata element. For example, in this property:
Code Block | ||
---|---|---|
| ||
dc.contributor.author = <mods:name> <mods:role> <mods:role> <mods:roleTerm type="text">author</mods:roleTerm> </mods:role> <mods:namePart>%s</mods:namePart> </mods:name> |
Some of the examples include the string "%s
" in the prototype XML where the text value is to be inserted, but don't pay any attention to it, it is an artifact that the crosswalk ignores. For example, given an author named Jack Florey, the crosswalk will insert
Code Block | ||
---|---|---|
| ||
<mods:name> <mods:role> <mods:roleTerm type="text">author</mods:roleTerm> </mods:role> <mods:namePart>Jack Florey</mods:namePart> </mods:name> |
...
As shown above, there are three (3) parts that make up the properties "key":
Code Block |
---|
crosswalk.submission.submissionPluginNamePluginName.stylesheet = 1 2 3 4 |
crosswalk
first part of the property key.
submission
second part of the property key.
PluginName
is the name of the plugin. The path value is the path to the file containing the crosswalk stylesheet (relative to /[dspace]/config
).
Here is an example that configures a crosswalk named "LOM" using a stylesheet in [dspace]/config/crosswalks/d-lom.xsl
:
crosswalk.submission.LOM.stylesheet = crosswalks/d-lom.xsl
A dissemination crosswalk can be configured by starting with the property key crosswalk.dissemination. Example:
crosswalk.dissemination.PluginName.stylesheet = path
The PluginName is the name of the plugin (!) . The path value is the path to the file containing the crosswalk stylesheet (relative to /[dspace]/config
).
...
Code Block |
---|
crosswalk.dissemination.qdc.namespace.dc = http://purl.org/dc/elements/1.1/ crosswalk.dissemination.qdc.namespace.dcterms = http://purl.org/dc/terms/ crosswalk.dissemination.qdc.schemalocation = http://purl.org/dc/elements/1.1/ \ http://dublincore.org/schemas/xmls/qdc/2003/04/02/qualifieddc.xsd |
Testing XSLT Crosswalks
The XSLT crosswalks will automatically reload an XSL stylesheet that has been modified, so you can edit and test stylesheets without restarting DSpace. You can test a dissemination crosswalk by hooking it up to an OAI-PMH crosswalk and using an OAI request to get the metadata for a known item.
Testing XSLT Crosswalks
The XSLT crosswalks will automatically reload an XSL stylesheet that has been modified, so you can edit and test stylesheets without restarting DSpace. You can test a crosswalk by using a command-line utitlity. With DSpace Version 3.0 only ingestion crosswalks can be tested (see below). From DSpace version 3.1 on you can use the following command to test a dissemination crosswalk:
Code Block | ||
---|---|---|
| ||
[dspace]/bin/dspace dsrun org.dspace.content.crosswalk.XSLTDisseminationCrosswalk <plugin name> <handle> [output-file] |
For example, you can test the marc plugin on the handle 123456789/3 with:
Code Block | ||
---|---|---|
| ||
[dspace]/bin/dspace dsrun org.dspace.content.crosswalk.XSLTDisseminationCrosswalk marc 123456789/3 |
Informations from the script will be printed to stderr while the XML output of the dissemination crosswalk will be printed to stdout. You can give a third parameter containing a filename to write the output into a file, but be careful: the file will be overwritten if it exists.
Testing a submission crosswalk works quite the same way. Use the following command-line utility, it Testing the submission crosswalk is more difficult, so we have supplied a command-line utility to help. It calls the crosswalk plugin to translate an XML document you submit, and displays the resulting intermediate XML (DIM). Invoke it with:
Code Block |
---|
[dspace]/bin/dspace dsrun org.dspace.content.crosswalk.XSLTIngestionCrosswalk [-l] <plugin pluginname> input<input-filefile> |
where plugin <plugin name> is the name of the crosswalk plugin to test (e.g. "LOM"), and <input-filefile> is a file containing an XML document of metadata in the appropriate format.
...
DSpace embargoes utilize standard metadata fields to hold both the '"terms' " and the '"lift date'". Which fields you use are configurable, and no specific metadata element is dedicated or predefined for use in embargo. Rather, you specify exactly what field you want the embargo system to examine when it needs to find the terms or assign the lift date.
...
Property: |
|
Example Value: |
|
Informational Note: | Controls whether or not that the UI blocks submission should be marked as a thesis. |
Property: |
|
Example Value: |
|
Informational Note: | Whether or not a file is required to be uploaded during the "Upload" step in the submission process. The default is true. If set to "false", then the submitter (human being) has the option to skip the uploading of a file. |
...
This enables the Creative Commons license step in the submission process of either the JSP or XML User Interface (JSP UI or XML UI). Submitters are given an opportunity to select a Creative Common license to accompany the item. Creative Commons licenses govern the use of the content. For further details, refer to the Creative Commons website at http://creativecommons.org . Creative Commons licensing is enabled as one step of the configurable submission process, and therefore may be configured for any given collection that has a defined submission sequence, or be part of the '"default' " submission process. This process is described in the '"Customizing and Configuring Submission User Interface' section " section of this manual. There is a Creative Commons step already defined (step 5), but it is commented out, so enabling Creative Commons licensing is typically just a matter of uncommenting the CC License step. For the JSP UI, Creative Commons licensing is effected by opening an Iframe to the Creative Commons site and capturing the selection result in several bitstreams, but the XML UI utilizes a more flexible web service. By default, when a license is selected in the interface, the URI for the license is stored in the 'dc.rights.uri' metadata field for the Item, and a representation of the license text is stored in a license bundle. In addition, the following properties in [dspace]/config/dspace.cfg
may be customized for use:
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
Example Value: |
|
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) |
...
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). |
Property: |
|
Example Value: |
|
Informational Note: | Controls whether to display thumbnails on browse and search result pages. If you have customized the Browse columnlist, then you must also include a "thumbnail" column in your configuration. _(This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them)._ |
Property: |
|
Example Value: |
|
Informational Note: | This property determines the maximum height of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. |
Property: |
|
Example Value: |
|
Informational Note: | This determines the maximum width of the browse/search thumbnails in pixels (px). This only needs to be set if the thumbnails are required to be smaller than the dimensions of thumbnails generated by MediaFilter. |
Property: |
|
Example Value: |
|
Informational Note: | This determines whether or not to display the thumbnail against each bitstream. (This configuration property key is not used by XMLUI. To show thumbnails using XMLUI, you need to create a theme which displays them). |
Property: |
|
Example Value: |
|
Informational Note: | This determines where clicks on the thumbnail in browse and search screens should lead. The only values currently supported are "item" or "bitstream", which will either take the user to the item page, or directly download the bitstream. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height of generated thumbnails that are being displayed on item pages. |
Property: |
|
Example Value: |
|
Informational Note: | Whether or not the user can "preview" the image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum width for the preview image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the maximum height for the preview image. |
Property: |
|
Example Value: |
|
Informational Note: | This is the brand text that will appear with the image. |
Property: |
|
Example Value: |
|
Informational Note: | An abbreviated form of the full Branded Name. This will be used when the preview image cannot fit the normal text. |
Property: |
|
Example Value: |
|
Informational Note: | The height (in px) of the brand. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font for your Brand text that appears with the image. |
Property: |
|
Example Value: |
|
Informational Note: | This property sets the font point (size) for your Brand text that appears with the image. |
Property: |
|
Example Value: |
|
Informational Note: | The Dublin Core field that will display along with the preview. This field is optional. |
Property: |
|
Example Value: |
|
Informational Note: | Determines if communities and collections should display item counts when listed. The default behavior if omitted, is true. (This configuration property key is not used by XMLUI. To show thumbnails strengths using XMLUI, you need to create a theme which displays them). |
Property: |
|
Example Value: |
|
Informational Note: | When showing the strengths, should they be counted in real time, or fetched from the cache. Counts fetched in real time will perform an actual count of the database contents every time a page with this feature is requested, which will not scale. If you set the property key is set to cache ("true") you must run the following command periodically to update the count: |
...
Info |
---|
Starting from DSpace 3.0 you can configure which implementation use for the Browse DAOs both for create/update operations and for read operations. This allows you to customize which browse engine is utilized in your DSpace. Options Options include:
|
Property: |
|
Example Value: | browseDAO.class = org.dspace.browse.SolrBrowseDAO |
Informational Note: | This property configures the java Java class that is used for READ operations by the Browse System. You need to have Discovery enabled to use the SOLR Solr Browse DAOs |
Property: |
|
Example Value: |
|
Informational Note: | This property configures the java class that is used for WRITE operations by the Browse System. You need to have Discovery enabled to use the SOLR Solr Browse DAOs |
Note |
---|
If a DAOs configuration is not provided the system will use the out-of-box implementation available for your Database of choice (PostgreSQL or Oracle). |
...
Configure the browse engine to use SOLR
Warning |
---|
Use of the SOLR Solr backend for the Browse Engine requires that you have Discovery enabled. Please check the Discovery configuration section. |
This option enables the browse engine to store its indexes in Apache Solr. This essentially allows Discovery to be used for both search & browse within DSpace. The configuration is as follows:
Code Block |
---|
browseDAO.class = org.dspace.browse.SolrBrowseDAO browseCreateDAO.class = org.dspace.browse.SolrBrowseCreateDAO |
...
This option enables the browse engine to store its indexes in PostgreSQL database tables. All browsing is then performed via queries to those database tables. This is the traditional browsing option for users of PostgreSQL. The configuration is as follows:
Code Block |
---|
browseDAO.class = org.dspace.browse.BrowseDAOPostgres browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOPostgres |
...
This option enables the browse engine to store its indexes in Oracle database tables. All browsing is then performed via queries to those database tables. This is the traditional browsing option for users of Oracle. The configuration is as follows:
Code Block |
---|
browseDAO.class = org.dspace.browse.BrowseDAOOracle browseCreateDAO.class = org.dspace.browse.BrowseCreateDAOOracle |
Defining the Indexes
...
DSpace arrives comes with four default indexes already pre-defined: author, title, date issued, and subjects. Users may also define additional indexes or re-configure the current indexes for different levels of specificity. For example, the default entries that appear in the dspace.cfg as default installation:
...
Property: |
|
Example Value: |
|
Informational Note: |
|
...
Now that we know which field is our author or other multiple metadata value field we can provide the option to truncate the number of values displayed by default. We replace the remaining list of values with "et al" or the language pack specific alternative. Note that this is just for the default, and users will have the option of changing the number displayed when they browse the results. See the following table:
Property: |
| |
Example Value: |
| |
Informational Note: | |Where < n > is an integer number of values to be displayed. Use -1 for unlimited (the default value). |
Links to Other Browse Contexts
...
Property: |
|
Example Value: |
|
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 ( |
...
Submission License Substitution Variables
Property: |
(property key broken up for display purposes only) | ||
Example Value: |
| ||
Informational Note: | It is possible include contextual information in the submission license using substitution variables. The text substitution is driven by a plugin implementation. |
...
Property: |
|
Example Value: |
|
Informational Note: | Whether or not OpenSearch is enabled. By default, the feature is disabled. Change the property key to '"true' " to enable. |
Property: |
|
Example Value: |
|
Informational Note: | Context for HTML request URLs. Change only for non-standard servlet mapping. |
Property: |
|
Example Value: |
|
Informational Note: | Context for RSS/Atom request URLs. Change only for non-standard servlet mapping. |
Property: |
|
Example Value: |
|
Informational Note: | Present autodiscovery link in every page head. |
Property: |
|
Example Value: |
|
Informational Note: | Number of hours to retain results before recalculating. This applies to the Manakin interface only. |
Property: |
|
Example Value: |
|
Informational Note: | A short name used in browsers for search service. It should be sixteen (16) or fewer characters. |
Property: |
|
Example Value: |
|
Informational Note: | A longer name up to 48 characters. |
Property: |
|
Example Value: |
|
Informational Note: |
|
Property: |
|
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: |
|
Example Value: |
|
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: |
|
Example Value: |
|
Informational Note: | Tags used to describe search service. |
Property: |
|
Example Value: |
|
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: |
|
Example Value: |
|
Informational Note: | The directory where the generate sitemaps are stored. |
Property: |
|
Example Value: | _sitemap.engineurls = http://www.google.com/webmasters/sitemaps/ping?sitemap=_ |
Informational Note: | Comma-separated list of search engine URLs to '"ping' " when a new Sitemap has been created. Include everything except the Sitemap UL itself (which will be URL-encoded and appended to form the actual URL '"pinged'").Add the following to the above parameter if you have an application ID with Yahoo: http://search.yahooapis.com/SiteExplorererService/V1/updateNotification?appid=REPLACE_ME?url=_ . (Replace the component _REPLACE_ME with your application ID). There is no known '"ping' " URL for MSN/Live search. |
Authority Control Settings
...
Property: |
| ||
Example Value: |
| ||
Informational Note: |
| ||
Property: |
| ||
Example Value: |
| ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Location (URL) of the Library of Congress Name Service | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Location (URL) of the SHERPA/RoMEO authority plugin | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This sets the default lowest confidence level at which a metadata value is included in an authority-controlled browse (and search) index. It is a symbolic keyword, one of the following values (listed in descending order): accepted, uncertain, ambiguous, notfound, failed, rejected, novalue, unset. See | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This property sets the number of selectable choices in the Choices lookup popup |
...
Property: |
| ||
Example Value: |
| ||
Informational Note: | This is used to customize the DC metadata fields that display in the item display (the brief display) when pulling up a record. The format is: | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | When using "resolver" in webui.itemdisplay to render identifiers as resolvable links, the base URL is take taken from <code>webui.resolver.<n>.baseurl<code> where <code>webui.resolver.<n>.baseurl<code> matches the urn specified in the metadata value. The value is appended to the "baseurl" as is, so the baseurl needs to end with the forward slash almost in any case. If no urn is specified in the value it will be displayed as simple text. For the doi and hdl urn defaults values are provided, respectively http://dc.doi.org and http://hdl.handle.net are used. If a metadata value with style "doi", "handle" or "resolver" matches a URL already, it is simply rendered as a link with no other manipulation. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which strategy to use for select the style for an item. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which collections use which views by Handle. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Specify which metadata to use as name of the style | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Customize the DC fields to use in the item listing page. Elements will be displayed left to right in the order they are specified here. The form is <schema prefix>.<element>[.<qualifier> | .*][(date)], ... | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | You can customize the width of each column with the following line--you can have numbers (pixels) or percentages. For the 'thumbnail' column, a setting of '*' will use the max width specified for browse thumbnails (cf. | ||
Property: |
| ||
Example Value: | _}} | ||
Informational Note: | You can override the DC fields used on the listing page for a given browse index and/or sort option. As a sort option or index may be defined on a field that isn't normally included in the list, this allows you to display the fields that have been indexed/sorted on. There are a number of forms the configuration can take, and the order in which they are listed below is the priority in which they will be used (so a combination of an index name and sort name will take precedence over just the browse name).In the last case, a sort option name will always take precedence over a browse index name. Note also, that for any additional columns you list, you will need to ensure there is an itemlist.<field name> entry in the messages file. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | This would display the date of the accession in place of the issue date whenever the dateaccessioned browsed index or sort option is selected. Just like webui.itemlist.columns, you will need to include a 'thumbnail' entry to display the thumbnails in the item list. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | As in the aforementioned property key, you can customize the width of the columns for each configured column list, substituting '".widths' " for '".columns' " in the property name. See the setting for webui.itemlist.widths for more information. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | You can also set the overall size of the item list table with the following setting. It can lead to faster table rendering when used with the column widths above, but not generally recommended. | ||
Property: |
| ||
Example Value: |
| ||
Informational Note: | Enable or disable session invalidation upon login or logout. This feature is enabled by default to help prevent session hijacking but may cause problems for shibboleth, etc. If omitted, the default value is '"true'". [Only used for JSPUI authentication]. | ||
Property: |
| ||
Example Value: | jspui.google.analytics.key = UA-XXXXXX-X | ||
Informational Note: | If you would like to use Google Analytics to track general website statistics then use the following parameter to provide your Analytics key. |
JSPUI Configuring Multilingual Support
...
Example. For setting DOI in sfx.xml
Code Block | ||
---|---|---|
| ||
<query-pairs> <field> <querystring>rft_id=info:doi/</querystring> <dc-schema>dc</dc-schema> <dc-element>identifier</dc-element> <dc-qualifier>doi</dc-qualifier> </field> </query-pairs> |
If there is no DOI for that item, it will search next query-pair based on the [dspace]/config/sfx.xml
and then so on.
...
For parameter passing to the <querystring>
Code Block | ||
---|---|---|
| ||
<querystring>rft_id=info:doi/</querystring> |
Please refer to these:
[http://ocoins.info/cobgbook.html]
[http://ocoins.info/cobg.html]
Program assume won’t won't get empty string for the item, as there will at least author, title for the item to pass to the resolver.
For contributor author, program maintains original DSpace SFX function of extracting author‘s author's first and last name.
Code Block | ||
---|---|---|
| ||
<field> <querystring>rft.aulast=</querystring> <dc-schema>dc</dc-schema> <dc-element>contributor</dc-element> <dc-qualifier>author</dc-qualifier> </field> <field> <querystring>rft.aufirst=</querystring> <dc-schema>dc</dc-schema> <dc-element>contributor</dc-element> <dc-qualifier>author</dc-qualifier> </field> |
JSPUI Item Recommendation Setting
...
The taxonomies are described in XML following this (very simple) structure:
Code Block | ||
---|---|---|
| ||
<node id="acmccs98" label="ACMCCS98"> <isComposedBy> <node id="A." label="General Literature"> <isComposedBy> <node id="A.0" label="GENERAL"/> <node id="A.1" label="INTRODUCTORY AND SURVEY"/> </isComposedBy> </node> </isComposedBy> </node> |
...
Vocabularies need to be associated with the correspondent DC metadata fields. Edit the file [dspace]/config/input-forms.xml
and place a "vocabulary" tag under the "field" element that you want to control. Set value of the "vocabulary" element to the name of the file that contains the vocabulary, leaving out the extension (the add-on will only load files with extension "*.xml"). For example:
Code Block | ||
---|---|---|
| ||
<field> <dc-schema>dc</dc-schema> <dc-element>subject</dc-element> <dc-qualifier></dc-qualifier> <!-- An input-type of twobox MUST be marked as repeatable --> <repeatable>true</repeatable> <label>Subject Keywords</label> <input-type>twobox</input-type> <hint> Enter appropriate subject keywords or phrases below. </hint> <required></required> <vocabulary [closed="false"]>nsi</vocabulary> </field> |
The vocabulary element has an optional boolean attribute closed that can be used to force input only with the javascript JavaScript of controlled-vocabulary add-on. The default behavior (i.e. without this attribute) is as set closed="false". This allow the user also to enter the value in free way.
...
Property: |
|
Example Value: |
|
Informational Note: | A list of supported locales for Manakin. Manakin will look at a user's browser configuration for the first language that appears in this list to make available to in the interface. This parameter is a comma separated list of Locales. All types of Locales country, country_language, country_language_variant. Note that if the appropriate files are not present (i.e. Messages_XX_XX.xml) then Manakin will fall back through to a more general language. |
Property: |
|
Example Value: |
|
Informational Note: | Force all authenticated connections to use SSL, only non-authenticated connections are allowed over plain http. If set to true, then you need to ensure that the '"dspace.hostname' " parameter is set to the correctly. |
Property: |
|
Example Value: |
|
Informational Note: | Determine if new users should be allowed to register. This parameter is useful in conjunction with Shibboleth where you want to disallow registration because Shibboleth will automatically register the user. Default value is true. |
Property: |
|
Example Value: |
|
Informational Note: | Determines if users should be able to edit their own metadata. This parameter is useful in conjunction with Shibboleth where you want to disable the user's ability to edit their metadata because it came from Shibboleth. Default value is true. |
Property: |
|
Example Value: |
|
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: |
|
Example Value: |
|
Informational Note: | After a user has logged into the system, which url should they be directed? Leave this parameter blank or undefined to direct users to the homepage, or /profile for the user's profile, or another reasonable choice is /submissions to see if the user has any tasks awaiting their attention. The default is the repository home page. |
Property: |
|
Example Value: |
|
Informational Note: | Allow the user to override which theme is used to display a particular page. When submitting a request add the HTTP parameter "themepath" which corresponds to a particular theme, that specified theme will be used instead of the any other configured theme. Note that this is a potential security hole allowing execution of unintended code on the server, this option is only for development and debugging it should be turned off for any production repository. The default value unless otherwise specified is "false". |
Property: |
|
Example Value: |
|
Informational Note: | Determine which bundles administrators and collection administrators may upload into an existing item through the administrative interface. If the user does not have the appropriate privileges (add and write) on the bundle then that bundle will not be shown to the user as an option. |
Property: |
|
Example Value: |
|
Informational Note: | On the community-list page should all the metadata about a community/collection be available to the theme. This parameter defaults to true, but if you are experiencing performance problems on the community-list page you should experiment with turning this option off. |
Property: |
|
Example Value: |
|
Informational Note: | Normally, Manakin will fully verify any cache pages before using a cache copy. This means that when the community-list page is viewed the database is queried for each community/collection to see if their metadata has been modified. This can be expensive for repositories with a large community tree. To help solve this problem you can set the cache to be assumed valued for a specific set of time. The downside of this is that new or editing communities/collections may not show up the website for a period of time. |
Property: |
|
Example Value: |
|
Informational Note: | Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The MODS metadata file must be inside the "METADATA" bundle and named MODS.xml. If this option is set to 'true' and the bitstream is present then it is made available to the theme for display. |
Property: |
|
Example Value: |
|
Informational Note: | Optionally, you may configure Manakin to take advantage of metadata stored as a bitstream. The METS metadata file must be inside the "METADATA" bundle and named METS.xml. If this option is set to "true" and the bitstream is present then it is made available to the theme for display. |
Property: |
|
Example Value: |
|
Informational Note: | If you would like to use Google Analytics to track general website statistics then use the following parameter to provide your analytics key. First sign up for an account at http://analytics.google.com, then create an entry for your repositories website. Google Analytics will give you a snippet of javascript code to place on your site, inside that snip it is your Google Analytics key usually found in the line: _uacct = "UA-XXXXXXX-X" Take this key (just the UA-XXXXXX-X part) and place it here in this parameter. |
Property: |
|
Example Value: |
|
Informational Note: | Assign how many page views will be recorded and displayed in the control panel's activity viewer. The activity tab allows an administrator to debug problems in a running DSpace by understanding who and how their dspace is currently being used. The default value is 250. |
Property: |
|
Example Value: |
|
Informational Note: | Determine where the control panel's activity viewer receives an events IP address from. If your DSpace is in a load balanced environment or otherwise behind a context-switch then you will need to set the parameter to the HTTP parameter that records the original IP address. |
...
If you wish to add more metadata elements, you can do this in one of two ways. Via the DSpace admin UI you may define new metadata elements in the different available schemas. But you may also modify the XML file (or provide an additional one), and re-import the data as follows:
Code Block |
---|
[dspace]/bin/dspace dsrun org.dspace.administer.MetadataImporter -f [xml file] |
The XML file should be structured as follows:
Code Block | ||
---|---|---|
| ||
<dspace-dc-types> <dc-type> <schema>dc</schema> <element>contributor</element> <qualifier>advisor</qualifier> <scope_note>Use primarily for thesis advisor.</scope_note> </dc-type> </dspace-dc-types> |
...
The Tab File Logger plugin is provided as the class org.dspace.app.statistics.UsageEventTabFileLogger. It writes event records to a file in tab-separated column format. If left unconfigured, an error will be noted in the DSpace log and no file will be produced. To specify the file path, provide an absolute path as the value for usageEvent.tabFileLogger.file in dspace.cfg.
The XML Logger Plugin
The XML Logger plugin is provided as the class org.dspace.app.statistics.UsageEventXMLLogger. It writes event records to a file in a simple XML-like format. If left unconfigured, an error will be noted in the DSpace log and no file will be produced. To specify the file path, provide an absolute path as the value for usageEvent.xmlLogger.file in dspace.cfg.
webui.browse.metadata.show-freq.1 = false
# webui.browse.metadata.show-freq.2 = false