Prepare Dataverse Manifest File

[raprasad]

See http://guides.dataverse.org/en/latest/api/external-tools.html

queryParameters to include

1. fileId: {fileId}
2. apiSensitiveDataReadToken: {apiToken}
   • Used to retrieve the DDI XML file and the raw data file.
   • Should be time-bound or in some other way limited.
   • Each of these two files should only need to be retrieved once.
3. apiGeneralToken: {apiToken}
   • Used for retrieving user information and citation metadata, including schema.org JSON-LD information
   • Allows the depositing of DP release data related to the specific DV file.
     • Currently the release consists of 3 files:
       • Full release (JSON)
       • DP DDI (XML)
       • Human-readable report (PDF)
4. siteUrl: {siteUrl}
   • To distinguish for multiple DV installations using the tool
5. filePid: {filePid}
   • If available, else null is ok, e.g. the DOI such as "10.7910/DVN/3E6ZRT/HYM6TD"
6. datasetPid: {datasetPid}
   • To retrieve schema.org JSON-LD information
7. datasetVersion: {datasetVersion}
   • Extra metadata for tracking the DP releases.

• Related to: API development: read sensitive data and write privacy preserving metadata for OpenDP privacy tools IQSS/dataverse#7158

[raprasad]

• Example

{
  "displayName":"Open Differential Privacy Application",
  "description":"Create differentially private (DP) statistics on sensitive data using the OpenDP programming framework created as part of the Harvard University Privacy Tools Project. https://privacytools.seas.harvard.edu/opendp",
  "toolName":"OpenDP App",
  "scope":"file",
  "type":"configure",
  "toolUrl":"https://app.opendp.io",
  "contentType":"text/tab-separated-values",
  "toolParameters":{
    "queryParameters":[
      {
        "fileId":"{fileId}"
      },
      {
        "apiSensitiveDataReadToken":"{apiToken}"
      },
      {
        "apiGeneralToken":"{apiToken}"
      },
      {
        "siteUrl":"{siteUrl}"
      },
      {
        "filePid":"{filePid}"
      },
      {
        "datasetPid":"{datasetPid}"
      },
      {
        "datasetVersion":"{datasetVersion}"
      }
    ]
  }
}