Configuring to synchronize with another CollectionSpace instance.

Owned by Tom Jones
Jul 22, 2016
1 min read

Starting with v4.4, CollectionSpace now supports limited functionality for synchronizing authorities and term lists with another CollectionSpace instance.  When configured correctly, a CollectionSpace instance's authorities and vocabularies can be synchronized (server to client synchronization only) with another CollectionSpace instance.  This allows limited sharing of authority and vocabulary terms between CollectionSpace instances.

Configuration

To mark as sync'able, add the following XML snippet to the Application layer's configuration file for a CollectionSpace authority or term list :

 <supportsReplicating>true</supportsReplicating>

If an authority/term-list's configuration record does not contain the "supportsReplicating" element, CollectionSpace assumes a value of 'false' meaning the authority/term-list cannot be synchronized.

 

To specify the "server" with which to synchronize, add the following XML snippet to an Application layer record's XML file:

 <remoteClientConfigName>default</remoteClientConfigName>

The value of the  "remoteClientConfigName" is a named configuration in the record's tenant configuration -i.e., the tenant's "settings.xml" file.  If a record does not contain a "remoteClientConfigName" element, CollectionSpace will use the default remote client configuration from the tenant's "settings.xml" file.

 

Here is an example definition for the <remoteclients> configuration element taken from the default "core" tenant's settings.xml file:

<remoteclients>
	<remoteclient>
		<name>default</name>
		<url>http://localhost:8180/cspace-services/</url>
		<user>admin@testsci.collectionspace.org</user>
		<password>Administrator</password>
		<ssl>false</ssl>
		<auth>true</auth>
		<tenantId>2</tenantId>
		<tenantName>testsci.collectionspace.org</tenantName>
	</remoteclient>
</remoteclients>

This snippet shows the configuration for the <remoteClientConfigName> named "default".  Any authority or term-list that is configured with 

<remoteClientConfigName>default</remoteClientConfigName> in its record configuration will try to sync with the server specified inside the <url> element using the credentials <user> and <password>.

 

Â