Commit 3926b312 authored by Beatriz Sanchez's avatar Beatriz Sanchez
Browse files

Update B2SHARE-install.md

parent 4ba2a5ae
Installation/Configuration
===========================
The following describes the procedure to enable B2SAFE release-4.x.y with the
B2SHARE publication option.
The connection between B2SAFE and B2SHARE enables a B2SAFE user to trigger a set if IRods rules that call a python script (b2shareclientCLI) that connects to the HTTP API of b2share and performs the necesary acction to publis a document or collection.
The following describes the procedure to enable the B2SHARE publication option with B2SAFE release-4.x.y. The connection between B2SAFE and B2SHARE enables a B2SAFE user to trigger a set of IRods rules that call a python script (b2shareclientCLI) that connects to the HTTP API of b2share and performs the necesary acction to publis a document or collection.
INSTALLATION
......@@ -19,10 +16,7 @@ The B2SHARE connection component is an extension of the B2SAFE core package (htt
NOTE: B2HANDLE can be found at: https://github.eudat.eu/b2safe/B2HANDLE
NOTE: iRODS is running as a normal user process. NOT as root. The package can
be build by any user. During installation of the package it will use:
"/etc/irods/service_account.config" to set the ownership of the files.
NOTE: iRODS is running as a normal user process. NOT as root. The package can be build by any user. During installation of the package it will use: "/etc/irods/service_account.config" to set the ownership of the files.
To install the B2SHARE-connect component you have to do following steps:
......@@ -37,7 +31,6 @@ $ git clone https://gitlab.eudat.eu/b2safe/b2safe-b2share-connect.git
* configuration.py
* create_md_file.py
* irodsUtility.py
- add the rule “b2share.re” from B2SAFE-core/rulebase folder to the "rulebase" folder of your iRODS instance \<your path to B2SAFE\>/B2SAFE-core/rulebase
- add to your configuration folder \<your path to B2SAFE\>/B2SAFE-core/conf and modify the configuration file “b2share_client_example.json” according to your environment as described in "Configuration" section of this wiki page and rename it to “b2share_client.json”
- check for missing python libraries trying to run the major scripts with -d (dry run) option
......@@ -98,8 +91,11 @@ Following workflow was considered during the component development:
`imeta add -C \<collection_X\> EUDAT_B2SHARE_PUBLISH EUDAT` with community name as the value, to publish the collection unter
`imeta add -C \<collection_X\> EUDAT_B2SHARE_TITLE Some_Title` and the title of the publication.
```
The comand `imeta ls -C \<collection_X\>` will then deliver:
The comand
```
`imeta ls -C \<collection_X\>`
```
will then deliver:
```
AVUs defined for collection collection_X:
attribute: EUDAT_B2SHARE_PUBLISH
......@@ -110,9 +106,7 @@ The comand `imeta ls -C \<collection_X\>` will then deliver:
value: Some_Title
units:
```
3. As preparation the user can create a meta data file **b2share_metadata.json** in the collection. The helper script **create_md_file.py** creates a sceleton file according to th
e B2SHARE schema of the community.
3. As preparation the user can create a meta data file **b2share_metadata.json** in the collection. The helper script **create_md_file.py** creates a sceleton file according to the B2SHARE schema of the community.
4. The B2SAFE administrator executes a rule to scan the B2SAFE repository for that meta data tag or configure a cron job or a script to do so.
* The workflow the rule executes will then create a draft in B2SHARE with a list of files the collection contains. (see worflow diagram below)
......@@ -121,12 +115,10 @@ e B2SHARE schema of the community.
5. The user has then the possibility to fill out the meta data online in the B2SHARE in the published record. The record id will be add to the imeta (EUDAT_B2SHARE_PUBLISHED_ID) of the collection and the record in B2SHARE will be accessable to the user as it will be published with his access token.
Following assumptions were made:
Following assumptions had been made:
* there is just one owner for each collection.
* the drafts are registered in B2SHARE just one time, even if the rule to scan for draft is executed multiple times.
* the collections are copied and published just one time, even if the rule to publish them is executed multiple times.
DONE
Markdown is supported
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