Page History
...
For ease of use, the Configuration documentation is broken into several parts:
- DSDOC:General Configuration - addresses general conventions used with configuring not only the dspace.cfg file, but other configuration files which use similar conventions.
- DSDOC:The dspace.cfg Configuration Properties File - specifies the basic
dspace.cfg
file settings - DSDOC:Optional or Advanced Configuration Settings - contain other more advanced settings that are optional in the dspace.cfg configuration file.
...
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.*
...
- The "source" file that is found in {{\
[
DSDOC:dspace-source
\]/dspace/config/dspace.cfg
}}unmigrated-wiki-markup - The "runtime" file that is found in {{\
[
DSDOC: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 {{\[
DSDOC:dspace-source
\]/dspace/config/
}} and then you would run the following commands:
Code Block |
---|
cd [dspace-source]/dspace/target/dspace-<version>-build.dir ant update_configs |
This will copy the source {{ Wiki Markup dspace.cfg
}} (along with other configuration files) into the runtime ({{\[
DSDOC: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 {{Wiki Markup ant
\-Dconfig=
\[
DSDOC: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 _\[DSDOC:dspace-source\]/dspace/config/_, you should then run '_ant init_configs_' in the directory _\[DSDOC: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
...
Property: | | |
Example Value: | | |
Informational Note: | Root directory of DSpace installation. Omit the trailing '/'. Note that if you change this, there are several other parameters you will probably want to change to match, e.g. | |
Property: | | |
Example Value: | | |
Informational Note: | Fully qualified hostname; do not include port number. | |
Property: |
| |
Example Value: | | ]]></ac:plain-text-body></ac:structured-macro> |
Informational Note: | Main URL at which DSpace Web UI webapp is deployed. Include any port number, but do not include the trailing ' | |
Property: | | |
Example Value: | | |
Informational note | DSpace base URL. URL that determines whether JSPUI or XMLUI will be loaded by default. Include port number etc., but NOT trailing slash. Change to | |
Property: | | |
Example Value: | | |
Informational note: | The base URL of the OAI webapp (do not include /request). | |
Property: | | |
Example Value: | | |
Informational Note: | Short and sweet site name, used throughout Web UI, e-mails and elsewhere (such as OAI protocol) |
...
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 {{\[
DSDOC: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
...
DSpace supports two distinct options for storing your repository bitstreams (uploaded files). The files are not stored in the database in which Metadata, user information, ... are stored. An assetstore is a directory on your server, on which the bitstreams are stored and consulted afterwards. The usage of different assetstore directories is the default "technique" in DSpace. The parameters below define which assetstores are present, and which one should be used for newly incoming items. As an alternative, DSpace can also use SRB (Storage Resource Brokerage) as an alternative. See DSDOC:SRB File Storage for details regarding SRB.
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 [DSDOC:(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 | ||
---|---|---|
| ||
In the examples above, you can see that your storage does not have to be under the |
...
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 {{/
\[
DSDOC: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.
...
Code Block |
---|
plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.authenticate.IPAuthentication |
...
You are then able to map DSpace groups to IP addresses in dspace.cfg by setting {{authentication.ip.GROUPNAME
=
iprange
\[
DSDOC:,
iprange
...
\]
}}, e.g:
Code Block |
---|
authentication.ip.MY_UNIVERSITY = 10.1.2.3, \ # Full IP 13.5, \ # Partial IP 11.3.4.5/24, \ # with CIDR 12.7.8.9/255.255.128.0, # with netmask 2001:18e8::/32 # IPv6 too |
...
Standard LDAP Configuration | |||
Property: | | ||
Example Value: | | ||
Informational Note: | This setting will enable or disable LDAP authentication in DSpace. With the setting off, users will be required to register and login with their email address. With this setting on, users will be able to login and register with their LDAP user ids and passwords. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the url to your institution's LDAP server. You may or may not need the /o=myu.edu part at the end. Your server may also require the ldaps:// protocol. | ||
Property: | | ||
Example Value: | | ||
Explanation: | This is the unique identifier field in the LDAP directory where the username is stored. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the object context used when authenticating the user. It is appended to the ldap.id_field and username. For example | ||
Property: | | ||
Example Value: | | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8825bcd4-e08a-4539-9085-5f1036500b3e"><ac:plain-text-body><![CDATA[ | Informational Note: |
Informational Note: | This is the search context used when looking up a user's LDAP object to retrieve their data for autoregistering. With ldap This is the search context used when looking up a user's LDAP object to retrieve their data for autoregistering. With ldap.autoregister turned on, when a user authenticates without an EPerson object we search the LDAP directory to get their name and email address so that we can create one for them. So after we have authenticated against uid=username,ou=people,o=byu.edu we now search in ou=people for filtering on [DSDOC:uid=username]. Often the | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's email address is stored. "mail" is the default and the most common for LDAP servers. If the mail field is not found the username will be used as the email address when creating the eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's last name is stored. "sn" is the default and is the most common for LDAP servers. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the LDAP object field where the user's given names are stored. I'm not sure how common the givenName field is in different LDAP instances. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This is the field where the user's phone number is stored in the LDAP directory. If the field is not found the field will be left blank in the new eperson object. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | This will turn LDAP autoregistration on or off. With this on, a new EPerson object will be created for any user who successfully authenticates against the LDAP server when they first login. With this setting off, the user must first register to get an EPerson object by entering their ldap username and password and filling out the forms. | ||
LDAP Users Group | |||
Property: | | ||
Example Value: | | ||
Informational Note: | If required, a group name can be given here, and all users who log into LDAP will automatically become members of this group. This is useful if you want a group made up of all internal authenticated users. (Remember to log on as the administrator, add this to the "Groups" with read rights). |
...
Properties: | | |
Example Values: | | |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0a78d2a2-b30b-4149-88ff-e7421c4542b2"><ac:plain-text-body><![CDATA[ | Informational Note: | This defines a crosswalk named MODS whose configuration comes from the file |
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 |
---|
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 {{/\[DSDOC:dspace\]/config}}).
Here is an example that configures a crosswalk named "LOM" using a stylesheet in {{\[DSDOC: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 {{/
\[
DSDOC:dspace
\]/config
}}).
You can make two different plugin names point to the same crosswalk, by adding two configuration entries with the same path:
...
Properties: | | ||
Example Value: | | ||
Properties: | | ||
Example Value: | | ||
Properties: | | ||
Example Value: |
| ||
Properties: | | ||
Example Value: | | ||
Informational Note: | Configuration of the QDC Crosswalk dissemination plugin for Qualified DC. (Add lower-case name for OAI-PMH. That is, change QDC to qdc.)}} |
...
In 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 {{/
\[
DSDOC: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 {{\[
DSDOC: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:
...
- Simple Dates.If you want to enter simple calendar dates for when an embargo will expire, follow these steps.
- Select a metadata field. Let's use dc.description.embargo. This field does not exist in in the default DSpace metadata directory, so login as an administrator, go the metadata registry page, select the 'dc' schema, then add the metadata field.unmigrated-wiki-markup
- Expose the metadata field. Edit _\[DSDOC:dspace\]/config/input-forms.xml_ . If you have only one form‚ usually 'traditional', add it there. If you have multiple forms, add it only to the forms linked to collections for which embargo applies:
Note: if you want to require embargo terms for every item, put a phrase in the <required> element. Example:<required>You must enter an embargo date</required>unmigrated-wiki-markupCode Block <form name="traditional"> <page number="1"> ... <field> <dc-schema>dc</dc-schema> <dc-element>description</dc-element> <dc-qualifier>embargo</dc-qualifier> <repeatable>false</repeatable> <label>Embargo Date</label> <input-type>onebox</input-type> <hint>If required, enter date 'yyyy-mm-dd' when embargo expires or 'forever'.</hint> <required></required> </field>
- Configure Embargo. Edit _\[DSDOC:dspace\]/config/dspace.cfg_. Find the Embargo properties and set these two:
Code Block # DC metadata field to hold the user-supplied embargo terms embargo.field.terms = dc.description.embargo # DC metadata field to hold computed "lift date" of embargo embargo.field.lift = dc.description.embargo
- Restart DSpace application. This will pick up these changes. Now just enter future dates (if applicable) in web submission and the items will be placed under embargo. You can enter years ('2020'), years and months ('2020-12'), or also days ('2020-12-15').unmigrated-wiki-markup
- Periodically run the lifter. Run the task:_\[DSDOC:dspace\]/bin/dspace embargo-lifter_You will want to run this task in a cron-scheduled or other repeating way. Item embargoes will be lifted as their dates pass.
- Period Sets. If you wish to use a fixed set of time periods (e.g. 90 days, 6 months and 1 year) as embargo terms, follow these steps, which involve using a custom 'setter'.
- Select two metadata fields. Let's use 'dc.embargo.terms' and 'dc.embargo.lift'. These fields do not exist in the default DSpace metadata registry. Login as an administrator, go the metadata registry page, select the 'dc' schema, then add the metadata fields.unmigrated-wiki-markup
- Expose the 'term' metadata field. The lift field will be assigned by the embargo system, so it should not be exposed directly. Edit _\[DSDOC:dspace\]/config/input-forms.xml_ . If you have only one form (usually 'traditional') add it there. If you have multiple forms, add it only to the form(s) linked to collection(s) for which embargo applies. First, add the new field to the 'form definition':
Note: If you want to require embargo terms for every item, put a phrase in the <required> element, e.g._<required>You must select embargo terms</required>_Observe that we have referenced a new value-pair list: "embargo_terms'. We must now define that as well (only once even if references by multiple forms):Code Block <form name="traditional"> <page number="1"> ... <field> <dc-schema>dc</dc-schema> <dc-element>embargo</dc-element> <dc-qualifier>terms</dc-qualifier> <repeatable>false</repeatable> <label>Embargo Terms</label> <input-type value-pairs-name="embargo_terms">dropdown</input-type> <hint>If required, select embargo terms.</hint> <required></required> </field>
Note: if desired, you could localize the language of the displayed value.Code Block <form-value-pairs> ... <value-pairs value-pairs-name="embargo_terms" dc-term="embargo.terms"> <pair> <displayed-value>90 days</displayed-value> <stored-value>90 days</stored-value> </pair> <pair> <displayed-value>6 months</displayed-value> <stored-value>6 months</stored-value> </pair> <pair> <displayed-value>1 year</displayed-value> <stored-value>1 year</stored-value> </pair> </value-pairs>
- Configure Embargo. Edit /dspace/config/dspace.cfg. Find the Embargo properties and set the following properties:
Code Block # DC metadata field to hold the user-supplied embargo terms embargo.field.terms = dc.embargo.terms # DC metadata field to hold computed "lift date" of embargo embargo.field.lift = dc.embargo.lift # implementation of embargo setter plugin - replace with local implementation if applicable plugin.single.org.dspace.embargo.EmbargoSetter = org.dspace.embargo.DayTableEmbargoSetter
...
- This step is the same as Step A.4 above, except that instead of entering a date, the submitter will select a value form a drop-down list.unmigrated-wiki-markup
- Periodically run the lifter. Run the task:
{{\[DSDOC:dspace\
[dspace]/bin/dspace
embargo-lifter
}} .
You will want to run this task in a cron-scheduled or other repeating way. Item embargoes will be lifted as their dates pass.
- Periodically run the lifter. Run the task:
{{\[DSDOC:dspace\
Checksum Checker Settings
DSpace now comes with a Checksum Checker script ({{\ Wiki Markup [
DSDOC: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: | |
Example Value: | |
Informational Note: | The Default dispatcher is case non is specified. |
Property: | |
Example Value: | |
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: | |
Example Value: | |
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). |
...
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 using XMLUI, you need to create a theme which displays them). | |
Property: | | |
Example Value: | | |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="bcf167ce-b846-4782-ace6-a48a9d50bff1"><ac:plain-text-body><![CDATA[ | 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: |
Browse Index Configuration
...
webui.browse.index.3 = title:metadata:dc.title,dc.relation.ispartofseries:title:
full
webui.browse.index.3 = title:metadata:dc.title,dc.relation.ispartofseries:title:full
Defining Sort Options
Sort options will be available when browsing a list of items (i.e. only in "full" mode, not "single" mode). You can define an arbitrary number of fields to sort on, irrespective of which fields you display using web.itemlist.columns. For example, the default entries that appear in the dspace.cfg as default installation:
...
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 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: |
| ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6781eb5f-d850-4a85-bc83-df3d6df7f176"><ac:plain-text-body><![CDATA[ | 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> | DSDOC: .*][DSDOC:(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: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="8b348fa8-606c-4d4a-8a15-d3badb6912b4"><ac:plain-text-body><![CDATA[ | Informational 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'. [DSDOC:Only used for JSPUI authentication]. | ]]></ac:plain-text-body></ac:structured-macro> |
JSPUI Configuring Multilingual Support
...
\[DSDOC:i18n -- Locales\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:
...
- {{\
[
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages.properties
}} {Wiki Markup - {\
[
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_en.properties
}}Wiki Markup - {{\
[
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_de.properties
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_fr.properties
}} \\ Files to be
Files to be localized:
{{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/resources/Messages_LOCALE.properties
}}unmigrated-wiki-markup- {{\
[
DSDOC:dspace-source
\]/dspace/config/input-forms_LOCALE.xml
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/default_LOCALE.license
-
should
be
pure
ASCII
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/news-top_LOCALE.html
}}Wiki Markup - {{\
[
DSDOC:dspace-source
\]/dspace/config/news-side_LOCALE.html
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/emails/change_password_LOCALE
}}unmigrated-wiki-markup- {{\
[
DSDOC:dspace-source
\]/dspace/config/emails/feedback_LOCALE
}}Wiki Markup - {{\
[
DSDOC:dspace-source
\]/dspace/config/emails/internal_error_LOCALE
}}unmigrated-wiki-markup{ - {\
[
DSDOC:dspace-source
\]/dspace/config/emails/register_LOCALE
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/emails/submit_archive_LOCALE
}}Wiki Markup - {{\
[
DSDOC:dspace-source
\]/dspace/config/emails/submit_reject_LOCALE
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/emails/submit_task_LOCALE
}}unmigrated-wiki-markup- {{\
[
DSDOC:dspace-source
\]/dspace/config/emails/subscription_LOCALE
}} {{\Wiki Markup [
DSDOC:dspace-source
\]/dspace/config/emails/suggest_LOCALE
}} {{\Wiki Markup [
DSDOC:dspace
\]/webapps/jspui/help/collection-admin_LOCALE.html
-
in
html
keep
the
jump
link
as
original;
must
be
copied
to
\[
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/webapp/help
}}Wiki Markup - {{\
[
DSDOC:dspace
\]/webapps/jspui/help/index_LOCALE.html
-
must
be
copied
to
\[
DSDOC:dspace-source
\]/dspace/modules/jspui/src/main/webapp/help
}}unmigrated-wiki-markup{{\ [
DSDOC:dspace
\]/webapps/jspui/help/site-admin_LOCALE.html
-
must
be
copied
to
\[
DSDOC: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
...
Property: | |
Example Value: | |
 | |
Informational Note: | SFX query is appended to this URL. If this property is commented out or omitted, SFX support is switched off. |
...
All the parameters mapping are defined in {{\[
DSDOC: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
...
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 {{\ Wiki Markup [
DSDOC: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>
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> |
...
webui.controlledvocabulary.enable = true
unmigrated-wiki-markup
New vocabularies should be placed in {{\[
DSDOC:dspace
\]/config/controlled-vocabularies/
}} and must be according to the structure described. A validation XML Schema (controlledvocabulary.xsd) can be downloaded [here|DSDOC:controlledvocabulary.xsd|here].be found in that directory.
Vocabularies need to be associated with the correspondent DC metadata fields. Edit the file [dspace
Vocabularies need to be associated with the correspondent DC metadata fields. Edit the file {{\[DSDOC:dspace\ Wiki Markup ]/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> |
...
Property: | | |
Example Value: | | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b8e236b2-dc66-482a-85d8-fa2cbb34b3f9"><ac:plain-text-body><![CDATA[ |
Informational Note: | Max response size for DIDL. This is the maximum size in bytes of the files you wish to enclose Base64 encoded in your responses, remember that the base64 encoding process uses a lot of memory. We recommend at most 200000 for answers of 30 records each on a 1 Gigabyte machine. Ultimately this will change to a streaming model and remove this restriction. Also please remember to allocate plenty of memory, at least 512 MB to your Tomcat. Optional: DSpace uses 100 records as the limit for the oai responses. You can alter this by changing /[DSDOC:dspace-source]/dspace-oai/dspace-oai-api/src/main/java/org/dspace/app/oai/DSpaceOAICatalog.java to codify the declaration: private final int MAX_RECORDS = 100 to private final int MAX_RECORDS = 30 ]]></ac:plain-text-body></ac:structured-macro> |
Activating Additional OAI-PMH Crosswalks
...
- mets - The manifest document from a DSpace METS SIP.
- mods - MODS metadata, produced by the table-driven MODS dissemination crosswalk.
- qdc - Qualified Dublin Core, produced by the configurable QDC crosswalk. Note that this QDC does not include all of the DSpace "dublin core" metadata fields, since the XML standard for QDC is defined for a different set of elements and qualifiers.
OAI-PMH crosswalks based on Crosswalk Plugins are activated as follows:
Uncomment the appropriate {{\Wiki Markup [
DSDOC:dspace
\]/config/oaicat.properties
}} of the form: {{Crosswalks.plugin_name=org.dspace.app.oai.PluginCrosswalk
}} (where {{plugin_name
}} is the actual plugin's name, e.g. "mets" or "qdc"). These lines are all near the bottom of the file.- You can also add a brand new custom crosswalk plugin. Just make sure that the crosswalk plugin has a lower-case name (possibly in addition to its upper-case name) in the plugin configuration in
dspace.cfg
. Then add a line similar to above to theoaicat.properties
file.
- You can also add a brand new custom crosswalk plugin. Just make sure that the crosswalk plugin has a lower-case name (possibly in addition to its upper-case name) in the plugin configuration in
- Restart your servlet container, e.g. Tomcat, for the change to take effect.
- Verify the Crosswalk is activated by accessing a URL such as
http://mydspace/oai/request?verb=ListRecords&metadataPrefix=mets
...
- Uncomment the
oai.didl.maxresponse
configuration indspace.cfg
Uncomment the DIDL Crosswalk entry from the {{\Wiki Markup [
DSDOC:dspace
\]/config/oaicat.properties
}} file- Restart your servlet container, e.g. Tomcat, for the change to take effect.
- Verify the Crosswalk is activated by accessing a URL such as
http://mydspace/oai/request?verb=ListRecords&metadataPrefix=didl
...
Property: | | ||
Example Value: | | ||
Informational Note: | The EPerson under whose authorization automatic harvesting will be performed. This field does not have a default value and must be specified in order to use the harvest scheduling system. This will most likely be the DSpace admin account created during installation. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The base url of the OAI-PMH disseminator webapp (i.e. do not include the /request on the end). This is necessary in order to mint URIs for ORE Resource Maps. The default value of | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The webapp responsible for minting the URIs for ORE Resource Maps. If using oai, the dspace.oai.uri config value must be set. The URIs generated for ORE ReMs follow the following convention for both cases._baseURI/metadata/handle/theHandle/ore.xml}} | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Determines whether the harvest scheduler process starts up automatically when the XMLUI webapp is redeployed. | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | This field can be repeated and serves as a link between the metadata formats supported by the local repository and those supported by the remote OAI-PMH provider. It follows the form | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | This field works in much the same way as | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Amount of time subtracted from the from argument of the PMH request to account for the time taken to negotiate a connection. Measured in seconds. Default value is 120. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | How frequently the harvest scheduler checks the remote provider for updates. Should always be longer than _timePadding _. Measured in minutes. Default value is 720. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The heartbeat is the frequency at which the harvest scheduler queries the local database to determine if any collections are due for a harvest cycle (based on the harvestFrequency) value. The scheduler is optimized to then sleep until the next collection is actually ready to be harvested. The minHeartbeat and maxHeartbeat are the lower and upper bounds on this timeframe. Measured in seconds. Default value is 30. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | The heartbeat is the frequency at which the harvest scheduler queries the local database to determine if any collections are due for a harvest cycle (based on the harvestFrequency) value. The scheduler is optimized to then sleep until the next collection is actually ready to be harvested. The minHeartbeat and maxHeartbeat are the lower and upper bounds on this timeframe. Measured in seconds. Default value is 3600 (1 hour). | ||
Property: | | ||
Example Value: | | ||
Informational Note: | How many harvest process threads the scheduler can spool up at once. Default value is 3. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | How much time passes before a harvest thread is terminated. The termination process waits for the current item to complete ingest and saves progress made up to that point. Measured in hours. Default value is 24. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | You have three (3) choices. When a harvest process completes for a single item and it has been passed through ingestion crosswalks for ORE and its chosen descriptive metadata format, it might end up with DIM values that have not been defined in the local repository. This setting determines what should be done in the case where those DIM values belong to an already declared schema. Fail will terminate the harvesting task and generate an error. Ignore will quietly omit the unknown fields. Add will add the missing field to the local repository's metadata registry. Default value: fail. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | When a harvest process completes for a single item and it has been passed through ingestion crosswalks for ORE and its chosen descriptive metadata format, it might end up with DIM values that have not been defined in the local repository. This setting determines what should be done in the case where those DIM values belong to an unknown schema. Fail will terminate the harvesting task and generate an error. Ignore will quietly omit the unknown fields. Add will add the missing schema to the local repository's metadata registry, using the schema name as the prefix and "unknown" as the namespace. Default value: fail. | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | A harvest process will attempt to scan the metadata of the incoming items (identifier.uri field, to be exact) to see if it looks like a handle. If so, it matches the pattern against the values of this parameter. If there is a match the new item is assigned the handle from the metadata value instead of minting a new one. Default value: hdl.handle.net. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Pattern to reject as an invalid handle prefix (known test string, for example) when attempting to find the handle of harvested items. If there is a match with this config parameter, a new handle will be minted instead. Default value: 123456789. |
...
Property: | | ||
Example Value: | | ||
Informational Note: | Is used by the SolrLogger Client class to connect to the SOLR server over http and perform updates and queries. | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Spiders file is utilized by the SolrLogger, this will be populated by running the following command: | ||
Property: | | ||
Example Value: | | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="edaea065-d5fc-4247-9182-391a08f6a610"><ac:plain-text-body><![CDATA[ | Informational Note: | The following refers to the GeoLiteCity database file utilized by the LocationUtils to calculate the location of client requests based on IP address. During the Ant build process (both fresh_install and update) this file will be downloaded from [http://www.maxmind.com/app/geolitecity] if a new version has been published or it is absent from your | |
Property: | | ||
Example Value: | | ||
Informational Note: | Timeout for the resolver in the DNS lookup time in milliseconds, defaults to 200 for backward compatibility; your system's default is usually set in | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Enables access control restriction on DSpace Statistics pages, Restrictions are based on access rights to Community, Collection and Item Pages. This will require the user to sign on to see that statistics. Setting the statistics to "false" will make them publicly available. | ||
Property: | | ||
Example Value: | {{solr.statistics.logBots = true }} | ||
Informational Note: | Enable/disable logging of spiders in solr statistics. If false, and IP matches an address in solr.spiderips.urls, event is not logged. If true, event will be logged with the 'isBot' field set to true (see | ||
Property: | | ||
Example Value: | | ||
Informational Note: | Controls solr statistics querying to filter out spider IPs. False by default. | ||
Property: | {{solr.statistics.query.filter.isBot }} | ||
Example Value: | | ||
Informational Note: | Controls solr statistics querying to look at "isBot" field to determine if record is a bot. True by default. | ||
Property: | | ||
Example Value: |
| ||
Informational Note: | URLs to download IP addresses of search engine spiders from |
...
The Metadata Format and Bitstream Format Registries
...
The _\[DSDOC: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.
...
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 _\[DSDOC: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.
...
Properties: | | |||
Example Value: | | |||
Informational Note: | The property key tell the SWORD METS implementation which package ingester to use to install deposited content. This should refer to one of the classes configured for:
The value of sword.mets-ingester.package-ingester tells the system which named plugin for this interface should be used to ingest SWORD METS packages. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Define the metadata type EPDCX (EPrints DC XML)to be handled by the SWORD crosswalk configuration. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Define the stylesheet which will be used by the self-named XSLTIngestionCrosswalk class when asked to load the SWORD configuration (as specified above). This will use the specified stylesheet to crosswalk the incoming SWAP metadata to the DIM format for ingestion. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | The base URL of the SWORD deposit. This is the URL from which DSpace will construct the deposit location URLs for collections. The default is {dspace.baseUrl}/sword/deposit. In the event that you are not deploying DSpace as the ROOT application in the servlet container, this will generate incorrect URLs, and you should override the functionality by specifying in full as shown in the example value. | |||
Properties: | {{sword.servicedocument.url }} | |||
Example Value: | {{sword.servicedocument.url = http://www.myu.ac.uk/sword/servicedocument_ | |||
Informational Note: | The base URL of the SWORD service document. This is the URL from which DSpace will construct the service document location URLs for the site, and for individual collections. The default is {dspace.baseUrl}/sword/servicedocument . In the event that you are not deploying DSpace as the ROOT application in the servlet container, this will generate incorrect URLs, and you should override the functionality by specifying in full as shown in the example value. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | The base URL of the SWORD media links. This is the URL which DSpace will use to construct the media link URLs for items which are deposited via sword. The default is { | |||
Properties: | | |||
Example Value: | | <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d5fddd73-1867-4829-9670-a0709c7adc24"><ac:plain-text-body><![CDATA[ | ||
Informational Note: | The URL which identifies the sword software which provides the sword interface. This is the URL which DSpace will use to fill out the atom:generator element of its atom documents. The default is: {{[http://www.dspace.org/ns/sword/1.3.1_ | [http://www.dspace.org/ns/sword/1.3.1_]]}}. If you have modified your sword software, you should change this URI to identify your own version. If you are using the standard dspace-sword module you will not, in general, need to change this setting. ]]></ac:plain-text-body></ac:structured-macro> | ||
Properties: | | |||
Example Value: | | |||
Informational Note: | The metadata field in which to store the updated date for items deposited via SWORD. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | The metadata field in which to store the value of the slug header if it is supplied. | |||
Properties: |
| |||
Example Value: |
| |||
Informational Note: | The accept packaging properties, along with their associated quality values where appropriate. This is a Global Setting; these will be used on all DSpace collections | |||
Properties: |
| |||
Example Value: |
| |||
Informational Note: | Collection Specific settings: these will be used on the collections with the given handles. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Should the server offer up items in collections as sword deposit targets. This will be effected by placing a URI in the collection description which will list all the allowed items for the depositing user in that collection on request. NOTE: this will require an implementation of deposit onto items, which will not be forthcoming for a short while. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Should the server offer as the default the list of all Communities to a Service Document request. If false, the server will offer the list of all collections, which is the default and recommended behavior at this stage. NOTE: a service document for Communities will not offer any viable deposit targets, and the client will need to request the list of Collections in the target before deposit can continue. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | The maximum upload size of a package through the sword interface, in bytes. This will be the combined size of all the files, the metadata and any manifest data. It is NOT the same as the maximum size set for an individual file upload through the user interface. If not set, or set to 0, the sword service will default to no limit. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Whether or not DSpace should store a copy of the original sword deposit package. NOTE: this will cause the deposit process to run slightly slower, and will accelerate the rate at which the repository consumes disk space. BUT, it will also mean that the deposited packages are recoverable in their original form. It is strongly recommended, therefore, to leave this option turned on. When set to "true", this requires that the configuration option upload.temp.dir above is set to a valid location. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | The bundle name that SWORD should store incoming packages under if sword.keep-original-package is set to true. The default is "SWORD" if not value is set | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Should the server identify the sword version in a deposit response. It is recommended to leave this unchanged. | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | Should mediated deposit via sword be supported. If enabled, this will allow users to deposit content packages on behalf of other users. | |||
Properties: |
| |||
Example Value: |
| <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b3b1f4a2-546f-46e6-97c1-c6f3fdbee44d"><ac:plain-text-body><![CDATA[ | ||
Informational Note: | Configure the plugins to process incoming packages. The form of this configuration is as per the Plugin Manager's Named Plugin documentation: {{plugin.named.[DSDOC:interface] = [DSDOC:implementation] = [DSDOC:package format identifier] }}. Package ingesters should implement the SWORDIngester interface, and will be loaded when a package of the format specified above in: {{sword.accept-packaging.[DSDOC:package format].identifier = [DSDOC:package format identifier]}}is received. In the event that this is a simple file deposit, with no package format, then the class named by "SimpleFileIngester" will be loaded and executed where appropriate. This case will only occur when a single file is being deposited into an existing DSpace Item. ]]></ac:plain-text-body></ac:structured-macro> | |||
Properties: | | |||
Example Value: | | |||
Informational Note: | A comma separated list of MIME types that SWORD will accept. |