Configuring External Metadata

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Configuring External Metadata: SRU/SRW

External metadata about content objects in Rosetta is stored in external systems such as collection management systems. To enable Rosetta to communicate with external systems, Administrators can edit the configuration files from the Administration page by clicking Repository Configuration > External Interfaces > SRU/SRW sources and definitions.The Configuration Files page opens to the SRU/SRW sub-group (below).

SRU/SRW Configuration Files

The fields are described in the following table:

External Metadata Configuration Files
File	Defines...
explain.properties	Parameters of the Rosetta system server
external_resource_explorer_configuration.xml	Parameters of an external system server

The following tasks must be performed in the configuration of SRU:

Configure Rosetta Parameters - External Resource File
Configure Rosetta Parameters - Explain File
Adaptation Needed in the SRU Server

Configure Rosetta Parameters - External Resource File

Use the following procedure to configure Rosetta parameters for external files:

With the File Group field set to External Interface and the Sub-Group set to SRU/SRW, click Edit for the file named external_resource_explorer_configuration.xml.
The file opens on the page. It contains all SRU configurations that are delivered with Rosetta.
Add your configuration to the file. The parameters that should be modified are:

baseUrl - the URL of the system that acts as an SRU server (CMS)
version - SRU version (currently 1.1 is supported by Rosetta)
operation - since Rosetta is the client, "searchRetrieve" is the only option
recordSchema - should be "dps"
indexName - should be "rec.id"
recordPacking - should be xml
updateUrl - in cases where the server can get a response for updating the exists-in-Rosetta flag, the url should be added here (currently available only for Voyager and Aleph. For other systems - leave it empty.

The following is an example of an SRU configuration for Aleph and Voyager:

<?xml version="1.0" encoding="UTF-8"?>

<parm name="baseUrl">http://10.100.2.36:17191/voyager</parm>

<parm name="operation">searchRetrieve</parm>

<parm name="updateUrl">http://10.100.2.36:17114/vxws/updateDPSFlag</parm>

</protocol>

</RepositoryName>

<parm name="baseUrl">http://il-aleph07:5667/usm01</parm>

<parm name="operation">searchRetrieve</parm>

<parm name="updateUrl">http://il-aleph07:8997/X?op=ros_doc&library=USM01</parm>

<parm name="detachUrl">http://il-aleph07:8997/X?op=ros_doc_del&library=USM01</parm>

</protocol>

</RepositoryName>

</ExternalResourceExplorer>

It should be noted that RepositoryName must equal the name that is returned in the SRU/SRW response. For example, if
<identifier>DPS:10.100.2.36:ALEPH01:9611</identifier>
then the name attribute of RepositoryName must be ALEPH01, as in
<RepositoryName name="ALEPH01" type="ALEPH">

To get the parameters from the SRU server, call the explain URL.

The following is an example of the explain URL from the Aleph system:

<zs:explainResponse>

<zs:version>1.1</zs:version>

<zs:record>

<zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>

<zs:recordPacking>xml</zs:recordPacking>

<zs:recordData>

<host>il-aleph07</host>

</serverInfo>

<title>title</title>

<map>

<name set="dc">dc.title</name>

</map>

</index>

<title>identifier</title>

<map>

<name set="dc">dc.identifier</name>

</map>

</index>

<map>

</map>

</index>

</indexInfo>

</explain>

</zs:recordData>

</zs:record>

<zs:diagnostics>

<uri>info:srw/diagnostic/1/7</uri>

<message>Mandatory parameter not supplied</message>

<details>version</details>

</diagnostic>

<uri>info:srw/diagnostic/1/7</uri>

<message>Mandatory parameter not supplied</message>

<details>operation</details>

</diagnostic>

</zs:diagnostics>

</zs:explainResponse>

Configure Rosetta Parameters - Explain File

Use the following procedure to configure the dbInfo parameter in the explain file:

With the File Group field set to External Interface and the Sub-Group set to SRU/SRW, click Edit for the file named explain.properties and enter your SRU (Rosetta) details for dbInfo={DPS SRU Database}

For example,:

dbInfo=DPS SRU Database

Adaptation Needed in the SRU Server

Rosetta should store the CMS ID and metadata in the repository and link it to an IE. In order for Rosetta to perform the link, the following metadata should be returned as part of the response:

where:

{DPS} = constant text
{IP} = the IP of the server
{NAME} = the name of the repository
{CMD-ID} = the CMS ID

For example:

Note: The response should be in DC format only.

The query:

http://10.100.2.36:17191/voyager?version=1.1&operation=searchRetrieve&query=title=boy&maximumRecords=10&recordSchema=dps