Skip to content

Task/rdmp 33 Export Catalogues to HDR #2289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JFriel wants to merge 13 commits into
base: develop
Choose a base branch
from
Open

Task/rdmp 33 Export Catalogues to HDR #2289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2c03c09
add basic command
JFriel Dec 9, 2025
4be2764
workign create
JFriel Dec 10, 2025
473929d
update working
JFriel Dec 12, 2025
eebab1b
working create
JFriel Dec 15, 2025
45d8638
improved create
JFriel Dec 16, 2025
96af888
working versioning
JFriel Dec 16, 2025
16a19f9
working update
JFriel Dec 16, 2025
ff65ed6
working update
JFriel Dec 16, 2025
e3d8282
update ignore list
JFriel Dec 16, 2025
147466a
add to correct ignore list
JFriel Dec 16, 2025
c62ee44
add docs
JFriel Dec 16, 2025
2102fa4
tidy up
JFriel Dec 17, 2025
f78acfe
any
JFriel Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [9.1.2] - Unreleased
- Add CLI Command to export Catalogue Info to HDR Gateway (see [Documentation\Catalogues\ExportCataloguesToHDR.md])

## [9.1.1] - 2025-12-02
- Allow Atlassian service workers to write to Confluence from RDMP

Expand Down
30 changes: 30 additions & 0 deletions Documentation/Catalogues/ExportCataloguesToHDR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Export Catalogues to HDR

The [HDR Gateway](https://healthdatagateway.org/en) is a metadata catalogue for all things health data.
RDMP has the ability to upload all non-internal, non-depricated, non-project specific catalogues to it using the following command
```
rdmp.exe exportcataloguestohdrgateway https://api.hdruk.cloud/api {teamID} {AppID} {ClientID} {additional config file}

```

Running this command will create new dataets on the HDR Gateway, as well as update any existing datasets with the same name as the catalogue.

### Command Variables
* teamId - the TeamID that you and the dataset(s) you want to create belong to
* AppID - This integration requires the use of a custom integration, the AppID is provided by this integration
* ClientID- This integration requires the use of a custom integration, the clientID is provided by this integration
* Additional config file - some details are not stored within RDMP, but are typically the same for all datasets that belong to a single owner. This file is used to populate these fields. Use the example below as a starting point

### Example Config File
{
"accessRights":"https://www.dundee.ac.uk/hic/governance-service",
"accessService":"HIC has implemented a remote-access Trusted Research Environment to protect data confidentiality, satisfy public concerns about data loss and reassure Data Controllers about HIC’s secure management and processing of their data.\r\nData is not released externally to data users for analysis on their own computers but placed on a server at HIC, within a restricted, secure IT environment, where the data user is given secure remote access to carry out their analysis.\r\nFull details are available via the following link: https://www.dundee.ac.uk/hic/safe-haven",
"accessServiceCategory":"TRE/SDE",
"conformsTo":["LOCAL"],
"vocabularyEncodingScheme":["LOCAL"],
"language":["en"],
"format":["CSV","Database"]
"dataUseLimitation":["General research use"],
"resourceCreator":"Please cite us!",
"dataUseRequirements":["Disclosure control"]
}
Loading
Loading