repository-deposit-dataverse/README.md

1.8 KiB

Using dataverse repository with Argos

The repository-deposit-dataverse module implements the https://code-repo.d4science.org/MaDgiK-CITE/repository-deposit-base interface for the dataverse repository.

Setup

After creating the jar from the project, environment variables should be set since they are used in the application.properties

  1. STORAGE_TMP_DATAVERSE - a temporary storage needed
  2. CONFIGURATION_DATAVERSE - path to json file which includes the configuration for the repository

JSON configuration file

The following fields should be set:
depositType - an integer representing how the dmp user can deposit in the repository,
a. 0 stands for system deposition meaning the dmp is deposited using argos credentials to the repository,
b. 1 stands for user deposition in which the argos user specifies his/her own credentials to the repository,
c. 2 stands for both ways deposition if the repository allows the deposits of dmps to be made from both argos and users accounts
note: depositType should be set to 0 since dataverse does not provide oauth2 protocol but, instead, uses api tokens
repositoryId - unique identifier for the repository
apiToken - api token provided for the depositions
repositoryUrl - repository's api url e.g. "https://demo.dataverse.org/api/"
repositoryRecordUrl - repository's record url, this url is used to index dmps that are created e.g. "https://demo.dataverse.org/dataset.xhtml?persistentId=doi:"
server - repository's server url e.g. "https://demo.dataverse.org"
parentDataverseAlias - dataverse alias in which all dmps that are deposited will be resided, note: the dataverse alias used should be published before making any dmp deposit
hasLogo - if the repository has a logo