From 5b32ab22d96b775f6ca5df0dbeb358b36050139f Mon Sep 17 00:00:00 2001 From: Cesare Concordia Date: Wed, 27 Jan 2021 10:38:01 +0100 Subject: [PATCH 1/5] Update 'README.md' --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 959472d..994377f 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,14 @@ This repository contains a collection of files that are built according to the [ #### Installation -The files can be installed on a Dataverse instance by executing the curl command(s) below to register them with the local Dataverse instance. In alternative the code can be downloaded and used locally. +The files can be installed on a Dataverse instance by executing the curl command(s) below to register them with the local Dataverse instance. In alternative the code can be downloaded and used locally. Detailed instructions for a local installation can be found at the [Dataverse Projcet site](https://guides.dataverse.org/en/latest/admin/external-tools.html#). -In the current release there is one file for each mime type. +In the current release there is one file for each mime type, each file can be installed independently from others. #### Known limitations -To send a protected file to the Switchboard or to preview it, the permission to access the dataset version containing the file is required, this means that a valid API Token must be used. Instead sending/viewing public content does not require an API Token. Files in the current release *do not allow* to send to LRS or to preview protected files, this feature will be implemented in next releases. +Files in the current release *do not allow* to send to LRS or to preview restricted content (i.e. non public files). To send a non public file to the Switchboard or to preview it, the permission to access the dataset version containing the file is required, this means that a valid API Token must be used. Instead sending/viewing public content does not require an API Token. +The decision to implement the processing of restricted content depends on the security policy that will be adopted. The current release has been tested with Dataverse v5.11+, however it should work also with Dataverse releases v4.12+. From 37041aa753c32c192c7fae9ec57871ff32d0ac31 Mon Sep 17 00:00:00 2001 From: Cesare Concordia Date: Wed, 27 Jan 2021 10:41:22 +0100 Subject: [PATCH 2/5] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 994377f..8a109ac 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ In the current release there is one file for each mime type, each file can be in #### Known limitations -Files in the current release *do not allow* to send to LRS or to preview restricted content (i.e. non public files). To send a non public file to the Switchboard or to preview it, the permission to access the dataset version containing the file is required, this means that a valid API Token must be used. Instead sending/viewing public content does not require an API Token. +Files in the current release *do not allow* to send to LRS or to preview restricted content (i.e. non public files). To send a non public file to the Switchboard or to preview it, the permission to access the dataset version containing the file would be required, technically speaking this means that a valid API Token should be used. Instead sending/viewing public content does not require an API Token. The decision to implement the processing of restricted content depends on the security policy that will be adopted. The current release has been tested with Dataverse v5.11+, however it should work also with Dataverse releases v4.12+. From aa4141584890dd73087ae4a1a0b9fa1000f75bd6 Mon Sep 17 00:00:00 2001 From: Cesare Concordia Date: Wed, 27 Jan 2021 10:44:33 +0100 Subject: [PATCH 3/5] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a109ac..a85ac30 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # dataverse-lrs -### Integrating Dataverse with Language Resource Switchboard. +### Integrating Dataverse with the Language Resource Switchboard. This repository contains a collection of files that are built according to the [Dataverse external tools interface](https://guides.dataverse.org/en/latest/admin/external-tools.html) in order to make the Clarin [Language Resource Switchboard](https://switchboard.clarin.eu) available through the external tools button on Dataset pages (left). Some of these files also implements data previewer apps for embedded display on Datafile pages (right), these previewers are based on those originally developed by the [Qualitative Data Repository](https://qdr.syr.edu). From 9f893f85ff7aac2c890cdd486f9a4e3c96db02a8 Mon Sep 17 00:00:00 2001 From: Cesare Concordia Date: Wed, 27 Jan 2021 10:48:17 +0100 Subject: [PATCH 4/5] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a85ac30..21fb36a 100644 --- a/README.md +++ b/README.md @@ -41,5 +41,5 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin -- send PDF directly to LRS -curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \ "{ \"displayName\":\"Process PDF file with LRS\", \"description\":\"Process the file using LRS.\", \"scope\":\"file\", \"type\":\"explore\", \"hasPreviewMode\":\"false\", \"toolUrl\":\"https://v4e-dock.isti.cnr.it/previewers/SendPDF.html\", \"toolParameters\": { \"queryParameters\":[ {\"fileid\":\"{fileId}\"}, {\"siteUrl\":\"{siteUrl}\"}, {\"key\":\"{apiToken}\"}, {\"datasetid\":\"{datasetId}\"}, {\"datasetversion\":\"{datasetVersion}\"}, {\"locale\":\"{localeCode}\"} ]}, \"contentType\":\"application/pdf\" }" +curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \ "{ \"displayName\":\"Process PDF file with LRS\", \"description\":\"Process a PDF file using LRS.\", \"scope\":\"file\", \"type\":\"explore\", \"hasPreviewMode\":\"false\", \"toolUrl\":\"https://v4e-dock.isti.cnr.it/previewers/SendPDF.html\", \"toolParameters\": { \"queryParameters\":[ {\"fileid\":\"{fileId}\"}, {\"siteUrl\":\"{siteUrl}\"}, {\"key\":\"{apiToken}\"}, {\"datasetid\":\"{datasetId}\"}, {\"datasetversion\":\"{datasetVersion}\"}, {\"locale\":\"{localeCode}\"} ]}, \"contentType\":\"application/pdf\" }" From e9272ed4dfbd0fe19a2313860e1f651ffbbb15e7 Mon Sep 17 00:00:00 2001 From: Cesare Concordia Date: Wed, 27 Jan 2021 10:51:18 +0100 Subject: [PATCH 5/5] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 21fb36a..37985e8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ The decision to implement the processing of restricted content depends on the se The current release has been tested with Dataverse v5.11+, however it should work also with Dataverse releases v4.12+. -*This is an in progress activity, code may change and may be not stable all the time.* +*This is an in progress activity, code may change and may not be stable all the time.* #### Curl commands to configure and run web applications with a Dataverse instance: