Page History

...

The full table of contents follows:

General Configuration

In the following sections you will learn about the different configuration files that you will need to edit so that you may make your DSpace installation work. Of the several configuration files which you will work with, it is the dspace.cfg file you need to learn to configure first and foremost.

...

The property value may contain references to other configuration properties, in the form ${property.name}. This follows the ant convention of allowing references in property files. A property may not refer to itself. Examples:

property.name = word1 ${other.property.name} more words
property2.name = ${dspace.dir}/rest/of/path

Property values can include other, previously defined values, by enclosing the property name in ${...}. For example, if your dspace.cfg contains:

dspace.dir = /dspace
dspace.history = ${dspace.dir}/history

...

Things you should know about editing dspace.cfg files.
It is important to remember that there are * two dspace.cfg files after an installation of DSpace.*

1. Wiki MarkupThe "source" file that is found in {{\[dspace-source\]/dspace/config/dspace.cfg}}
2. Wiki MarkupThe "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 of {{dspace.cfg}} in addition to the runtime file. The two files should always be identical, since the source {{dspace.cfg}} will be the basis of your next upgrade.

...

To keep the two files in synchronization, you can edit your files in {{\[dspace-source\]/dspace/config/}} and then you would run the following commands:

cd [dspace-source]/dspace/target/dspace-<version>-
mvn package
cd [dspace-source]/dspace/target/dspace-<version>-build.dir 
ant update_configs

Wiki MarkupThis will copy the source {{dspace.cfg}} (along with other configuration files) into the runtime ({{\[dspace\]/config}}) directory.

You should remember that after editing your configuration file(s), and you are done and wish to implement the changes, you will need to:

...

• Run {{ant \ -Dconfig=\[dspace\]/config/dspace.cfg update}} if you are updating your {{dspace.cfg}} file and wish to see the changes appear. Follow the usual sequence with copying your webapps.unmigrated-wiki-markup
• If you edit _dspace.cfg_ in _\[dspace-source\]/dspace/config/_, you should then run '_ant init_configs_' in the directory _\[dspace-source\]/dspace/target/dspace-1.5.2-build.dir_ so that any changes you may have made are reflected in the configuration files of other applications, for example Apache. You may then need to restart those applications, depending on what you changed.

The dspace.cfg Configuration Properties File

...

Wording of E-mail Messages

...

Sometimes DSpace automatically sends e-mail messages to users, for example, to inform them of a new work flow task, or as a subscription e-mail alert. The wording of emails can be changed by editing the relevant file in {{\[[dspace\]/config/emails}} . Each file is commented. Be careful to keep the right number 'placeholders' (e.g._\{2\}_).

Note: You should replace the contact-information "dspace-help@myu.edu or call us at xxx-555-xxxx" with your own contact details in:
config/emails/change_password
config/emails/register

...

Property:	assetstore.dir
Example Value:	assetstore.dir = ${dspace.dir}/assetstore
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: assetstore.dir = /storevgm/assestore .
Property:	Code Block assetstore.dir.1 assetstore.dir.2
Example Value:	Code Block assetstore.dir.1 = /second/assetstore assetstore.dir.2 = /third/assetstore
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:	assetstore.incoming
Example Value:	assetstore.incoming = 1
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="837167f1-f287-4b3a-837e-2a35a9928334"><ac:plain-text-body><![CDATA[	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.]]></ac:plain-text-body></ac:structured-macro>

Info
title Be Careful
In the examples above, you can see that your storage does not have to be under the /dspace directory. For the default installation it needs to reside on the same server (unless you plan to configure SRB (see below)). So, if you added storage space to your server, and it has a different logical volume/name/directory, you could have the following as an example:

...

Property:	log.init.config
Example Value:	log.init.config = ${dspace.dir}/config/log4j.properties
Informational Note:	This is where your logging configuration file is located. You may override the default log4j configuration by providing your own. Existing alternatives are: Code Block log.init.config = ${dspace.dir}/config/log4j.properties log.init.config = ${dspace.dir}/config/log4j-console.properties
Property:	log.dir
Example value:	log.dir = ${dspace.dir}/log
Informational Note:	This is where to put the logs. (This is used for initial configuration only)
Property:	useProxies
Example Value:	useProxies = true
Informational Note:	If your DSpace instance is protected by a proxy server, in order for log4j  to log the correct IP address of the user rather than of the proxy, it must be configured to look for the X-Forwarded-For header.  This feature can be enabled by ensuring this setting is set to true.  This also affects IPAuthentication, and should be enabled for that to work properly if your installation uses a proxy server.

...

In the example above, search.index.1 and search.index.2 and search.index.3 are configured as the author search field. The author index is created by Lucene indexing all dc.contributor.*,dc.creator.* and description.statementofresponsibility metadata fields.unmigrated-wiki-markup

After changing the configuration run {{/\[dspace\]/bin/dspace index-init}} to regenerate the indexes.

While the indexes are created, this only affects the search results and has no effect on the search components of the user interface. One will need to customize the user interface to reflect the changes, for example, to add the a new search category to the Advanced Search.

...

You can also implement more dynamic or configurable Media/Format Filters which extend SelfNamedPlugin .

Info
title More Information on MediaFilters
For more information on Media/Format Filters, see the section on Transforming DSpace Content (MediaFilters).

Crosswalk and Packager Plugin Settings

The subsections below give configuration details based on the types of crosswalks and packager plugins you need to implement.

Configurable MODS Dissemination Crosswalk

...

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:

...

crosswalk.submissionPluginName.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\
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}}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).

You can make two different plugin names point to the same crosswalk, by adding two configuration entries with the same path:

crosswalk.submission.MyFormat.stylesheet = crosswalks/myformat.xslt
     crosswalk.submission.almost_DC.stylesheet = crosswalks/myformat.xslt

The dissemination crosswalk must also be configured with an XML Namespace (including prefix and URI) and an XML schema for its output format. This is configured on additional properties in the DSpace configuration:

crosswalk.dissemination.PluginName.namespace.Prefix = namespace-URI
     crosswalk.dissemination.PluginName.schemaLocation = schemaLocation value

For example:

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 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:

[dspace]/bin/dspace dsrun
     org.dspace.content.crosswalk.XSLTIngestionCrosswalk [-l] plugin input-file

...

crosswalk.qdc.schemaLocation.QDC = http://www.purl.org/dc/terms \
      http://dublincore.org/schemas/xmls/qdc/2006/01/06/dcterms.xsd \
      http://purl.org/dc/elements/1.1 \
      http://dublincore.org/schemas/xmls/qdc/2006/01/06/dc.xsd

Wiki MarkupIn the property key "{{crosswalk.qdc.properties.QDC}}" the value of this property is a path to a separate properties file containing the configuration for this crosswalk. The pathname is relative to the DSpace configuration directory {{/\[dspace\]/config}} . Referring back to the "Example Value" for this property key, one has {{crosswalks/qdc.properties}} which defines a crosswalk named {{QDC}} whose configuration comes from the file {{\[dspace\]/config/crosswalks/qdc.properties}} .

You will also need to configure the namespaces and schema location strings for the XML output generated by this crosswalk. The namespaces properties names are formatted:

...

You can add names for the existing plugins, and add new plugins, by altering these configuration properties. See the Plugin Manager architecture for more information about plugins.

...

Checksum Checker Settings

...

DSpace now comes with a Checksum Checker script ({{\[dspace\]/bin/dspace checker}}) which can be scheduled to verify the checksum of every item within DSpace. Since DSpace calculates and records the checksum of every file submitted to it, this script is able to determine whether or not a file has been changed (either manually or by some sort of corruption or virus). The idea being that the earlier you can identify a file has changed, the more likely you'd be able to recover it (assuming it was not a wanted change).

Property:	plugin.single.org.dspace.checker.BitstreamDispatcher
Example Value:	plugin.single.org.dspace.checker.BitstreamDispatcher = org.dspace.checker.SimpleDispatcher
Informational Note:	The Default dispatcher is case non is specified.
Property:	checker.retention.default
Example Value:	checker.retention.default = 10y
Informational Note:	This option specifies the default time frame after which all checksum checks are removed from the database (defaults to 10 years). This means that after 10 years, all successful or unsuccessful matches are removed from the database.
Property:	checker.retention.CHECKSUM_MATCH
Example Value:	checker.retention.CHECKSUM_MATCH = 8w
Informational Note:	This option specifies the time frame after which a successful match will be removed from your DSpace database (defaults to 8 weeks). This means that after 8 weeks, all successful matches are automatically deleted from your database (in order to keep that database table from growing too large).

Info
title More Checksum Checking Details
For more information on using DSpace's built-in Checksum verification system, see the section on Validating CheckSums of Bitstreams.

Item Export and Download Settings

...

Configuring Creative Commons License

...

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|http://creativecommons.org|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 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:	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 data
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)

...

General Web User Interface Configurations
In this section of Configuration, we address the agnostic WEB User Interface that is used for JSP UI and XML UI. Some of the configurations will give information towards customization or refer you to the appropriate documentation.

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:	webui.browse.thubnail.show
Example Value:	webui.browse.thubnail.show = true
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:	webui.browse.thumbnail.maxheight
Example Value:	webui.browse.thumbnail.maxheight = 80
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:	webui.browse.thumbnail.maxwidth
Example Value:	webui.browse.thumbnail.maxwidth = 80
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:	webui.item.thumbnail.show
Example Value:	webui.item.thumbnail.show = true
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:	webui.browse.thumbnail.linkbehavior
Example Value:	webui.browse.thumbnail.linkbehavior = item
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:	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.enabled
Example Value:	webui.preview.enabled = false
Informational Note:	Whether or not the user can "preview" the image.
Property:	webui.preview.maxwidth
Example Value:	webui.preview.maxwidth = 600
Informational Note:	This property sets the maximum width for the preview image.
Property:	webui.preview.maxheight
Example Value:	webui.preview.maxheight = 600
Informational Note:	This property sets the maximum height for the preview image.
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.
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.
Property:	webui.preview.brand.height
Example Value:	webui.preview.brand.height = 20
Informational Note:	The height (in px) of the brand.
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.
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.
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.
Property:	webui.strengths.show
Example Value:	webui.strengths.show = false
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 using XMLUI, you need to create a theme which displays them).
Property:	webui.strengths.cache
Example Value:	webui.strengths.cache = false	<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2cbd5d42-64f1-49c6-9ca4-a742ed7531a8"><ac:plain-text-body><![CDATA[	Informational Note:
Informational Note:	When showing the strengths, should they be counted in real time, or fetched from the cache. Counts fetched in real time 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: /[dspace]/bin/dspace itemcounter. The default is to count in real time (set to "false").]]></ac:plain-text-body></ac:structured-macro>

Browse Index Configuration

...

Submission License Substitution Variables

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

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

...

Authority Control Settings

Two new features of DSpace 1.6 fall under the header of Authority Control: Choice Management and Authority Control of Item ("DC") metadata values. Authority control is a fully optional feature in DSpace 1.6. Implemented out of the box are the Library of Congress Names service, and the Sherpa Romeo authority plugin.

For an in-depth description of this feature, please consult: http: //wiki.dspace.org/index.php/Authority _ Control _ of _ Metadata _ Values

plugin.named.org.dspace.content.authority.ChoiceAuthority = \
	org.dspace.content.authority.SampleAuthority = Sample, \
 	org.dspace.content.authority.LCNameAuthority = LCNameAuthority, \
 	org.dspace.content.authority.SHERPARoMEOPublisher = SRPublisher, \
 	org.dspace.content.authority.SHERPARoMEOJournalTitle = SRJournalTitle

plugin.selfnamed.org.dspace.content.authority.ChoiceAuthority = \
	org.dspace.content.authority.DCInputAuthority

...

webui.itemdisplay.default = dc.title, dc.title.alternative, \
           dc.contributor.*, dc.subject, dc.data.issued(date), \
           dc.publisher, dc.identifier.citation, \
           dc.relation.ispartofseries, dc.description.abstract, \
           dc.description, dc.identifier.govdoc, \
           dc.identifier.uri(link), dc.identifier.isbn, \
           dc.identifier.issn, dc.identifier.ismn, dc.identifier

webui.resolver.1.urn
webui.resolver.1.baseurl
webui.resolver.2.urn
webui.resolver.2.baseurl

webui.resolver.1.urn = doi
webui.resolver.1.baseurl = http://dx.doi.org/
webui.resolver.2.urn = hdl
webui.resolver.2.baseurl = http://hdl.handle.net/

plugin.single.org.dspace.app.webui.util.StyleSelection = \
  org.dspace.app.web.util.CollectionStyleSelection
  #org.dspace.app.web.util.MetadataStyleSelection

webui.itemdisplay.metadata-style
webui.itemdisplay.metadata-style

webui.itemdisplay.metadata-style = schema.element[.qualifier|.*]
webui.itemdisplay.metadata-style = dc.type

webui.itemlist.columns = thumbnail, dc.date.issued(date), dc.title, \
          dc.contributor.*

webui.itemlist.browse.<index name>.sort.<sort name>.columns
webui.itemlist.sort.<sort name>.columns
webui.itemlist.browse.<browse name>.columns
webui.itemlist.<sort or index name>.columns

JSPUI Configuring Multilingual Support

...

\[i18n -- – Locales\]

Setting the Default Language for the Application

...

If you set webui.supported.locales make sure that all the related additional files for each language are available. LOCALE should correspond to the locale set in webui.supported.locales, e. g.: for webui.supported.locales = en, de, fr, there should be:

...

• {{\[dspace-source\]/dspace/modules/jspui/src/main/resources/Messages.properties}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/modules/jspui/src/main/resources/Messages_en.properties}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/modules/jspui/src/main/resources/Messages_de.properties}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/modules/jspui/src/main/resources/Messages_fr.properties}} \\ Files to be localized:
  Files to be localized:

• Wiki Markup{{\[dspace-source\]/dspace/modules/jspui/src/main/resources/Messages_LOCALE.properties}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/input-forms_LOCALE.xml}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/default_LOCALE.license - should be pure ASCII}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/news-top_LOCALE.html}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/news-side_LOCALE.html}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/change_password_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/feedback_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/internal_error_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/register_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/submit_archive_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/submit_reject_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/submit_task_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/subscription_LOCALE}}unmigrated-wiki-markup
• {{\[dspace-source\]/dspace/config/emails/suggest_LOCALE}}_LOCALE
• Wiki Markup{{\[dspace\]/webapps/jspui/help/collection-admin_LOCALE.html - in html keep the jump link as original; must be copied to \ [dspace-source\]/dspace/modules/jspui/src/main/webapp/help}}unmigrated-wiki-markup
• {{\[dspace\]/webapps/jspui/help/index_LOCALE.html - must be copied to \ [dspace-source\]/dspace/modules/jspui/src/main/webapp/help}} Wiki Markup{{\
• [dspace\]/webapps/jspui/help/site-admin_LOCALE.html - must be copied to \ [dspace-source\]/dspace/modules/jspui/src/main/webapp/help}}

JSPUI Item Mapper

Because the item mapper requires a primitive implementation of the browse system to be present, we simply need to tell that system which of our indexes defines the author browse (or equivalent) so that the mapper can list authors' items for mapping

...

...

All the parameters mapping are defined in {{\[dspace\]/config/sfx.xml}} file. The program will check the parameters in {{sfx.xml}} and retrieve the correct metadata of the item. It will then parse the string to your resolver.

For the following example, the program will search the first query-pair which is DOI of the item. If there is a DOI for that item, your retrieval results will be, for example:
http://researchspace.auckland.ac.nz/handle/2292/5763

...

<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.unmigrated-wiki-markup

Example of using ISSN, volume, issue for item without DOI {{\
[http://researchspace.auckland.ac.nz/handle/2292/4947\]}}

For parameter passing to the <querystring>

<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.

<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>

...

The taxonomies are described in XML following this (very simple) structure:

<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>

...

webui.controlledvocabulary.enable = true

Wiki MarkupNew vocabularies should be placed in {{\[dspace\]/config/controlled-vocabularies/}} and must be according to the structure described. A validation XML Schema (named {{controlledvocabulary.xsd}}) is also available in that directory.unmigrated-wiki-markup

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:

<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>

...

solr.spiderips.urls = http://iplists.com/google.txt, \
                      http://iplists.com/inktomi.txt, \
                      http://iplists.com/lycos.txt, \
                      http://iplists.com/infoseek.txt, \
                      http://iplists.com/altavista.txt,\
                      http://iplists.com/excite.txt, \
                      http://iplists.com/misc.txt, \
                      http://iplists.com/excite.txt, \
                      http://iplists.com/misc.txt, \
                      http://iplists.com/non_engines.txt

...

The Metadata Format and Bitstream Format Registries

...

The _\[dspace\]/config/registries_ directory contains three XML files. These are used to load the _initial_ contents of the Dublin Core Metadata registry and Bitstream Format registry and SWORD metadata registry. After the initial loading (performed by _ant fresh_install_ above), the registries reside in the database; the XML files are not updated.

In order to change the registries, you may adjust the XML files before the first installation of DSpace. On an already running instance it is recommended to change bitstream registries via DSpace admin UI, but the metadata registries can be loaded again at any time from the XML files without difficult. The changes made via admin UI are not reflected in the XML files.

...

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]

...

Bitstream Format Registry

...

The bitstream formats recognized by the system and levels of support are similarly stored in the bitstream format registry. This can also be edited at install-time via _\[dspace\]/config/registries/bitstream-formats.xml_ or by the administration Web UI. The contents of the bitstream format registry are entirely up to you, though the system requires that the following two formats are present:

• Unknown
• License
  Deleting a format will cause any existing bitstreams of this format to be reverted to the unknown bitstream format.

...

Download the jai_imageio library version 1.0_01 or 1.1 found at: https://jai-imageio.dev.java.net/binary-builds.html#Stable_builds .

For these filters you do NOT have to worry about the native code, just the JAR, so choose a download for any platform.

Code Block
curl -O http://download.java.net/media/jai-imageio/builds/release/1.1/jai_imageio-1_1-lib-linux-i586.tar.gz tar xzf jai_imageio-1_1-lib-linux-i586.tar.gz

The preceding example leaves the JAR in jai_imageio-1_1/lib/jai_imageio.jar . Now install it in your local Maven repository, e.g.: (changing the path after file= if necessary)

Code Block
mvn install:install-file \ -Dfile=jai_imageio-1_1/lib/jai_imageio.jar \ -DgroupId=com.sun.media \ -DartifactId=jai_imageio \ -Dversion=1.0_01 \ -Dpackaging=jar \ -DgeneratePom=true

...