Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.69 KB

README.md

File metadata and controls

59 lines (44 loc) · 2.69 KB
Raw

dvwebloader

A web tool for uploading folders of files to a Dataverse dataset. See the wiki for further details.

Hosted at https://gdcc.github.io/dvwebloader

Current integration mechanism (v5.13+):

Configure dvwebloader as an integrated UploadMethod:

curl -X PUT -d 'native/http,dvwebloader' http://localhost:8080/api/admin/settings/:UploadMethods

Point Dataverse at the appropriate dvwebloader URL (the GDCC GitHub copy is used here):

curl -X PUT -d 'https://gdcc.github.io/dvwebloader/src/dvwebloader.html' http://localhost:8080/api/admin/settings/:WebloaderUrl

Once these settings are in place, an "Upload a Folder" button should appear on a given dataset's file upload page, provided that the dataset lives in S3 storage with direct-upload enabled.

Note that dvwebloader does not currently detect whether a user's API token is expired or even extant. If the page appears to hang while Getting Dataset Information... check your API token.

External Tool Setup for Dataverse 5.12 and below:

Install as a dataset-level Explore Tool. The tool will appear in the Dataset Access menu: image

Note that dataset-level tools only appear once there is at least one file in the dataset, so with this launch mechanism, you must add one file to the dataset by other means in order to launch this tool. Also note that the tool is displayed in the menu and will launch when you are not logged in (and therefore don't have permission to upload, causing a failure) and on datasets where direct upload is not enabled, which will also fail.

As of now, the best way to debug issues/failures is to open the browser develop console and look at the messages there. If the issue isn't obvious from that, including the console log in an issue should help others in figuring out what is going wrong.

To install, copy/paste the curl command below and run it on your Dataverse machine:

curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
'{
  "displayName": "Dataverse WebLoader",
  "description": "Upload all  the files in a local directory!",
  "toolName": "dvwebloader",
  "scope": "dataset",
  "contentType":"text/plain",
  "types": [
    "explore"
  ],
  "toolUrl": "https://gdcc.github.io/dvwebloader/src/dvwebloader.html",
  "toolParameters": {
    "queryParameters": [
      {
        "siteUrl": "{siteUrl}"
      },
      {
        "datasetPid": "{datasetPid}"
      },
      {
        "key": "{apiToken}"
      }
    ]
  }
}'

Sponsored by UiT/DataverseNO