HOWTO: Configure the Data Capture Module (DCM)

1. Dataverse (big D)

DataCaptureModuleUrl

Using the admin API, you will need to set the DCM base URL for the service that responds to upload/download requests.

Example:

curl 'http://localhost:8080/api/admin/settings/:DataCaptureModuleUrl?key=mykey' -X PUT -d 'https://datacapture.example.org' -H 'Content-Type: application/json'

Response:

{
    "status": "OK",
    "data": {
        ":DataCaptureModuleUrl": "https://datacapture.example.org"
    }
}

Note:

Set the DataCaptureModuleUrl to “mock” to test the APIs without an implementation.

TODO:

The following configurations are hardcoded (see: DataCaptureModuleServiceBean) and should be made configurable:

• UploadRequestPath (e.g., “/ur.py”)
• ScriptRequestPath (e.g., “/sr.py?datasetIdentifier=” + dataset ID)

2. dataverse (small d)

FileUploadMechanisms

Using the API, you will need to set the list of supported upload protocols by specifying a colon separated list.

Enumerated mechanisms:

• GUI (default)
• SWORD
• DROPBOX
• RSYNC
• GLOBUS
• ASPERA

Example:

curl 'http://localhost:8080/api/dataverses/test1/uploadmechanisms' -X POST -d 'GUI:RSYNC' -H 'Content-type: application/json' -H 'X-Dataverse-key: mykey'

Response:

{ 
    "status": "OK", 
    "data": ["GUI","RSYNC"] 
}