Skip to content

To demo server, add external tool for Open OnDemand #390

@pdurbin

Description

@pdurbin

We want to add a dataset-level tool that says "Explore in OpenOnDemand" to https://demo.dataverse.org

The manifest will be a variation of the one at https://iqss.github.io/ondemand-loop/development_guide/dataverse_integration/#registering-the-external-tool . I'm putting a version below that I think we'll use, but I'll confirm with @abujeda.

Here's a direct link to the interstitial page that users will see (from the toolUrl): https://hmdc.github.io/fasrc-ondemand-loop/dv_external_tools/demo_landing.html

The reason we have an interstitial page is that installation of Open OnDemand we're integrating with is only for Harvard affiliates. And they have to have a FASRC account be be connected to the FASRC VPN. See also the following issue.

curl --location 'http://localhost:8080/api/admin/externalTools' \
--header 'Content-Type: application/json' \
--data '{
  "displayName": "Explore in Open OnDemand",
  "description": "Download dataset files into Open OnDemand and publish back to Dataverse",
  "toolName": "ondemand_loop_dataset_tool",
  "scope": "dataset",
  "types": ["explore"],
  "toolUrl": "https://hmdc.github.io/fasrc-ondemand-loop/dv_external_tools/demo_landing.html",
  "httpMethod": "GET",
  "toolParameters": {
    "queryParameters": [
      {"dataverse_url": "{siteUrl}"},
      {"dataset_id": "{datasetPid}"},
      {"version": "{datasetVersion}"},
      {"locale": "{localeCode}"},
      {"env_cannon_prod": "{localeCode}"}
    ]
  }
}'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions