Skip to main content

Research Data Portal

caution

@experimental This functionality is experimental and subject to change.

The Modern Research Data Portal is an example application, infrastructure, and design pattern used by many facilities, labs, and universities.

Abstractions provided by the Globus JavaScript ecosystem of packages expand on this original design pattern and allow the portal interface to be implemented as a static site – often referred to as the JAMstack approach.

Replacing the Example Data Portal with a Single HTML File​

The core workflow of the example Modern Research Data Portal (GitHub) for an end-user is:

  1. Log In to Globus
    1. Grant consent to required Globus Auth scopes.
  2. Select folders to Transfer.
  3. Follow a redirect to the Globus Web Application1 to select a Destination and set a Label for the transfer.
  4. Return to the MRDP interface for server-side Task submission and details.

The same workflow can be achieved using Globus UI in a single, static, HTML page with the following improvements:

  • No redirect to the Globus Web Application is required.
    • Globus UI provides components that allow users to select a destination, provide a label, and submit a transfer – all the while staying in your application context.
  • No server process is required.
    • Staying true to the JAMstack approach, the implementation is a browser-safe, PKCE-secured, integration into the Globus platform and service APIs.

Example Source​

<!DOCTYPE html>
<html dir="ltr" lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=5.0" />
    <title>Modern Resarch Data Portal</title>
    <script type="module" src="https://unpkg.com/@globus/ui/globus.esm.js"></script>
    <script nomodule src="https://unpkg.com/@globus/ui/globus.js"></script>
    <link rel="stylesheet" href="https://unpkg.com/@globus/ui/globus.css" />
  </head>
  <body>
    <div class="container">
      <globus-auth-context
        client-id="bb8b1927-8b64-4c68-a025-dd7daca20cbd"
        redirect-uri="https://my-data-portal-url/this-file.html"
        scopes="urn:globus:auth:scope:transfer.api.globus.org:all"
      >
        <gac-authenticated>
          <form id="transfer">
            <label for="label"> Label </label>
            <input type="text" name="label" />
            <hr />
            <label for="file"> Files </label>
            <globus-transfer-ls collection="a6f165fa-aee2-4fe5-95f3-97429c28bf82" path="/portal/catalog/"> </globus-transfer-ls>

            <label>Destination</label>
            <globus-collection></globus-collection>

            <hr />

            <globus-transfer-start>Transfer</globus-transfer-start>
          </form>
        </gac-authenticated>
      </globus-auth-context>
    </div>
  </body>
</html>

Migrating portal.conf​

portal.conf acts as the main configuration file for the example data portal.

Below is an annotated version of this file for how you might translate the values to Globus UI components.

#------------------------------------------------
# Default MRDP application configuration settings
#------------------------------------------------

# NOT REQUIRED
SERVER_NAME = 'localhost:5000'

# NOT REQURED
DEBUG = True

# NOT REQUIRED – PKCE does not require a client-side secret.
SECRET_KEY = '=.DKwWzDd}!3}6yeAY+WTF#W:zt5msTI7]2`o}Y!ziU!#CYD+;T9JpW$ud|5C_3'

# NOT REQUIRED
DATABASE = './portal/data/app.db'

# NOT REQUIRED
DATASETS= './portal/data/datasets.json'

# Use this value as an attribute value for `<globus-transfer-ls collection= ...>`
DATASET_ENDPOINT_ID = 'a6f165fa-aee2-4fe5-95f3-97429c28bf82'
# Use this value as an attribute value for `<globus-transfer-ls path= ...>`
DATASET_ENDPOINT_BASE = '/portal/catalog/'

# NOT REQUIRED / NOT SUPPORTED
GRAPH_ENDPOINT_ID = 'a6f165fa-aee2-4fe5-95f3-97429c28bf82'
# NOT REQUIRED / NOT SUPPORTED
GRAPH_ENDPOINT_BASE = '/portal/processed/'

# Use this value as an attribute value for `<globus-auth-context redirect-uri=...>`
SERVICE_URL_BASE = 'https://localhost:5100'

# Use this value as an attribute value for `<globus-auth-context client-id=...>`
PORTAL_CLIENT_ID = '82d3ab26-f8da-42fa-9f19-bcd5e7abb668'
# NOT REQUIRED – PKCE does not require a client-side secret.
PORTAL_CLIENT_SECRET = 'QmUvb1lZbzJ6W1UuS29aJHQ0UVYyPD0lOHtle0pSLUVDez5iZkIydUo9N3E8'

# NOT REQUIRED – use `<globus-auth-logout>`
GLOBUS_AUTH_LOGOUT_URI = 'https://auth.globus.org/v2/web/logout'

# Use this value (comma-seperated) as an attribute value for `<globus-auth-context scopes...>`
USER_SCOPES = (
    "openid",
    "profile",
    "email",
    "urn:globus:auth:scope:transfer.api.globus.org:all",
)
  1. The redirect to the Globus Web Application uses the Browse Endpoint Helper Page.↩