Skip to content
Snippets Groups Projects
Commit 731513d6 authored by Marco Del Tufo's avatar Marco Del Tufo
Browse files

Update openbis-sync.md

parent dbbafdda
No related branches found
No related tags found
1 merge request!40SSDM-13578 : 2PT : Database and V3 Implementation - include the new AFS "free"...
Hide whitespace changes
Inline Side-by-side
docs/system-admin-documentation/advanced-features/openbis-sync.md
+ 69
− 51
View file @ 731513d6
...@@ -27,41 +27,47 @@ property in AS service.properties. Example: ...@@ -27,41 +27,47 @@ property in AS service.properties. Example:
**servers/openBIS-server/jetty/etc/plugin.properties** **servers/openBIS-server/jetty/etc/plugin.properties**
... ```html
database.kind = production ...
... database.kind = production
...
**servers/datastore\_server/etc/plugin.properties** **servers/datastore\_server/etc/plugin.properties**
... ...
database.kind = production database.kind = production
... ...
The URL of the service is `<DSS base URL>/datastore_server/re-sync`. The The URL of the service is `<DSS base URL>/datastore_server/re-sync`. The
returned XML document looks like the following: returned XML document looks like the following:
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:rs="http://www.openarchives.org/rs/terms/"> ```xml
<rs:ln href="https://localhost:8444/datastore_server/re-sync/?verb=about.xml" rel="describedby"/> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:rs="http://www.openarchives.org/rs/terms/">
<rs:md capability="description"/> <rs:ln href="https://localhost:8444/datastore_server/re-sync/?verb=about.xml" rel="describedby"/>
<url> <rs:md capability="description"/>
<loc>https://localhost:8444/datastore_server/re-sync/?verb=capabilitylist.xml</loc> <url>
<rs:md capability="capabilitylist"/> <loc>https://localhost:8444/datastore_server/re-sync/?verb=capabilitylist.xml</loc>
</url> <rs:md capability="capabilitylist"/>
</urlset> </url>
</urlset>
```
The loc element contains the URL which delivers a list of all The loc element contains the URL which delivers a list of all
capabilities: capabilities:
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:rs="http://www.openarchives.org/rs/terms/"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:rs="http://www.openarchives.org/rs/terms/">
<rs:ln href="https://localhost:8444/datastore_server/re-sync/?verb=about.xml" rel="up"/> <rs:ln href="https://localhost:8444/datastore_server/re-sync/?verb=about.xml" rel="up"/>
<rs:md capability="capabilitylist" from="2013-02-07T22:39:00"/> <rs:md capability="capabilitylist" from="2013-02-07T22:39:00"/>
<url> <url>
<loc>https://localhost:8444/datastore_server/re-sync/?verb=resourcelist.xml</loc> <loc>https://localhost:8444/datastore_server/re-sync/?verb=resourcelist.xml</loc>
<rs:md capability="resourcelist"/> <rs:md capability="resourcelist"/>
</url> </url>
</urlset> </urlset>
```
From capabilities described in the ResourceSync Framework Specification From capabilities described in the ResourceSync Framework Specification
only `resourcelist` is supported. The resourcelist returns an XML with only `resourcelist` is supported. The resourcelist returns an XML with
...@@ -94,9 +100,12 @@ configuration file each time the task is executed. ...@@ -94,9 +100,12 @@ configuration file each time the task is executed.
**plugin.properties** **plugin.properties**
class = ch.ethz.sis.openbis.generic.server.dss.plugins.sync.harvester.HarvesterMaintenanceTask ```
interval = 1 d class = ch.ethz.sis.openbis.generic.server.dss.plugins.sync.harvester.HarvesterMaintenanceTask
harvester-config-file = ../../data/harvester-config.txt interval = 1 d
harvester-config-file = ../../data/harvester-config.txt
```
The only specific property of `HarvesterMaintenanceTask` is The only specific property of `HarvesterMaintenanceTask` is
`harvester-config-file` which is absolute or relative path to the actual `harvester-config-file` which is absolute or relative path to the actual
...@@ -113,15 +122,21 @@ service.properties. Example: ...@@ -113,15 +122,21 @@ service.properties. Example:
**servers/openBIS-server/jetty/etc/plugin.properties** **servers/openBIS-server/jetty/etc/plugin.properties**
... ```
database.kind = production ...
... database.kind = production
...
```
**servers/datastore\_server/etc/plugin.properties** **servers/datastore\_server/etc/plugin.properties**
... ```
database.kind = production ...
... database.kind = production
...
```
### Harvester Config File ### Harvester Config File
...@@ -129,31 +144,34 @@ Here is an example of a typical configuration: ...@@ -129,31 +144,34 @@ Here is an example of a typical configuration:
**harvester-config.txt** **harvester-config.txt**
[DS1] ```
[DS1]
resource-list-url = https://<data source host>:<DSS port>/datastore_server/re-sync
resource-list-url = https://<data source host>:<DSS port>/datastore_server/re-sync data-source-openbis-url = https://<data source host>:<AS port>/openbis/openbis
data-source-dss-url = https://<data source host>:<DSS port>/datastore_server
data-source-auth-realm = OAI-PMH
data-source-auth-user = <data source user id>
data-source-auth-pass = <data source password>
space-black-list = SYSTEM
space-white-list = ABC_.*
data-source-openbis-url = https://<data source host>:<AS port>/openbis/openbis harvester-user = <harvester user id>
data-source-dss-url = https://<data source host>:<DSS port>/datastore_server harvester-pass = <harvester user password>
data-source-auth-realm = OAI-PMH
data-source-auth-user = <data source user id>
data-source-auth-pass = <data source password>
space-black-list = SYSTEM
space-white-list = ABC_.*
harvester-user = <harvester user id> keep-original-timestamps-and-users = false
harvester-pass = <harvester user password> harvester-tmp-dir = temp
last-sync-timestamp-file = ../../data/last-sync-timestamp-file_HRVSTR.txt
log-file = log/synchronization.log
keep-original-timestamps-and-users = false email-addresses = <e-mail 1>, <e-mail 2>, ...
harvester-tmp-dir = temp
last-sync-timestamp-file = ../../data/last-sync-timestamp-file_HRVSTR.txt
log-file = log/synchronization.log
email-addresses = <e-mail 1>, <e-mail 2>, ... translate-using-data-source-alias = true
verbose = true
#dry-run = true
```
translate-using-data-source-alias = true
verbose = true
#dry-run = true
- The configuration file can have one or many section for each openBIS - The configuration file can have one or many section for each openBIS
instance. Each section start with an arbitrary name in square instance. Each section start with an arbitrary name in square
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment