{"id":41980200,"url":"https://github.com/globus/example-search-portal-with-transfer","last_synced_at":"2026-01-25T23:41:02.769Z","repository":{"id":260522013,"uuid":"881535036","full_name":"globus/example-search-portal-with-transfer","owner":"globus","description":"An example search portal that includes Globus Transfer functionality.","archived":false,"fork":false,"pushed_at":"2025-01-22T17:52:49.000Z","size":156,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T18:37:21.231Z","etag":null,"topics":["example","portal","serverless"],"latest_commit_sha":null,"homepage":"https://globus.github.io/example-search-portal-with-transfer/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/globus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-31T19:08:40.000Z","updated_at":"2025-01-22T17:52:46.000Z","dependencies_parsed_at":"2025-01-22T18:38:45.723Z","dependency_job_id":null,"html_url":"https://github.com/globus/example-search-portal-with-transfer","commit_stats":null,"previous_names":["globus/example-search-portal-with-transfer"],"tags_count":0,"template":false,"template_full_name":"globus/template-search-portal","purl":"pkg:github/globus/example-search-portal-with-transfer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Fexample-search-portal-with-transfer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Fexample-search-portal-with-transfer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Fexample-search-portal-with-transfer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Fexample-search-portal-with-transfer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/globus","download_url":"https://codeload.github.com/globus/example-search-portal-with-transfer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/globus%2Fexample-search-portal-with-transfer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28761816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T23:06:19.311Z","status":"ssl_error","status_checked_at":"2026-01-25T23:03:50.555Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["example","portal","serverless"],"created_at":"2026-01-25T23:40:59.433Z","updated_at":"2026-01-25T23:41:02.764Z","avatar_url":"https://github.com/globus.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Example: Serverless Search Portal with Transfer Integration\n\nThis repository is an example of the [@globus/template-search-portal](https://github.com/globus/template-search-portal)\n\nYou can create your own portal with similar functionality by following the [**Creating Your Own Research Search Portal**](https://github.com/globus/template-search-portal?tab=readme-ov-file#creating-your-own-static-research-search-portal) section in the template repository and then referencing the sections below.\n\n## Background\n\nGlobus Search is often used to provide metadata to datasets available via Globus Transfer. To support this use case, our serverless search portal includes the ability to enable Transfer-related features for users browsing your index.\n\n## Pre-Requisites\n\n- A [Globus Search Index](https://docs.globus.org/api/search/) you administer.\n- A Globus Collection that hosts data relevant to the documents in your Globus Search Index.\n- A Search Portal, created following: [**Creating Your Own Research Search Portal**](https://github.com/globus/template-search-portal?tab=readme-ov-file#creating-your-own-static-research-search-portal) in our template repository, **with Authentication enabled.**\n\n\n## Globus Transfer Integration\n\nThe simplest way to enable Transfer functionality in your Search Portal is to [add authentication to your portal](https://github.com/globus/template-search-portal?tab=readme-ov-file#private-globus-search-indexes-authentication)[^1] and include Transfer properties in your search entries.\n\n[^1]: Even if your search data is public, authentication is required to use Globus Transfer.\n\n### Adding Transfer Properties\n\nWhen a `globus.transfer` object is present on your `GMetaResult.entries.content[n]`, and you've configured authentication, Transfer functionality will be automatically enabled[^2].\n\n[^2]: You can opt-out of the Transfer functionality by setting `data.attributes.features.transfer` to `false` in your `static.json` file.\n\n\n```jsonc\n\"globus\": {\n  \"transfer\": {\n    /**\n     * The UUID of the Globus Collection where the data resides.\n     * @type string\n     */\n    \"collection\": \"a6f165fa-aee2-4fe5-95f3-97429c28bf82\",\n    /**\n     * The path to the data the entry represents on the Collection.\n     * @type string\n     */\n    \"path\": \"/portal/catalog/dataset_atl\",\n    /**\n     * The type of inode the path represents.\n     * @default \"file\" If no value is provided, the path is assumed to be a file.\n     * @type \"directory\" | \"file\"\n     */\n    \"type\": \"directory\"\n  }\n}\n```\n\n\u003cdetails\u003e\n\n  \u003csummary\u003eView a more comprehensive example of a \u003ccode\u003eGMetaEntry\u003c/code\u003e\u003c/summary\u003e\n\n```json\n  {\n    \"subject\": \"5352507d-1293-4827-8ba9-c2d4a0eb78d1\",\n    \"visible_to\": [\n      \"public\"\n    ],\n    \"content\": {\n      \"name\": \"Atlanta International Airport Climate Data (ATL)\",\n      \"id\": \"5352507d-1293-4827-8ba9-c2d4a0eb78d1\",\n      \"path\": \"/portal/catalog/dataset_atl\",\n      \"region\": \"south\",\n      \"tags\": [\n        \"airport\"\n      ],\n      \"globus\": {\n        \"transfer\": {\n          \"collection\": \"a6f165fa-aee2-4fe5-95f3-97429c28bf82\",\n          \"path\": \"/portal/catalog/dataset_atl\",\n          \"type\": \"directory\"\n        }\n      }\n    }\n  }\n```\n\n\u003c/details\u003e\n\n### Advanced Integrations\n\n#### Using Dynamic Transfer Property References\n\n**🧪 This feature is experimental, feel free to provide feedback if you encounter issues.**\n\nAs an alternative to adding the `globus.transfer` property to entries [JSONata](https://jsonata.org/) can be used to allow dynamic references to existing properties.\n\n1. Enable JSONata support in your portal by setting `data.attributes.features.jsonata` to `true`\n\n```jsonc\n  \"data\": {\n    \"attributes\": {\n      \"features\": {\n        \"jsonata\": true\n      }\n      // ...\n    }\n  }\n```\n\n2. You'll customize the `Result` component to include the `globus.transfer` configuration.\n\n  - A `property` member can be used to signal JSONata should be used (against the `GMetaResult`) for sourcing.\n  - For static values, a `string` can be used. \n\n```jsonc\n  \"data\": {\n    \"attributes\": {\n      \"components\": {\n        \"Result\": {\n          \"globus\": {\n            \"transfer\": {\n              // The `collection` property will be sourced from the `subject` on the `GMetaResult`.\n              \"collection\": {\n                \"property\": \"$split($split(subject, 'globus://')[1], '/')[0]\"\n              },\n              // The `path` will be sourced from the `subject`, similar to the `collection`.\n              \"path\": {\n                \"property\": \"$replace(subject, 'globus://' \u0026 $split($split(subject, 'globus://')[1], '/')[0], '')\"\n              },\n              // Setting the `type` to a static value.\n              \"type\": \"directory\"\n            }\n          }\n        }\n      }\n      // ...\n    }\n  }\n```\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobus%2Fexample-search-portal-with-transfer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglobus%2Fexample-search-portal-with-transfer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglobus%2Fexample-search-portal-with-transfer/lists"}