-
Notifications
You must be signed in to change notification settings - Fork 17
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.
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
develop
Choose a base branch
from
task/RDMP-33-HDR-fix-deprecated
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
2c03c09
add basic command
JFriel 4be2764
workign create
JFriel 473929d
update working
JFriel eebab1b
working create
JFriel 45d8638
improved create
JFriel 96af888
working versioning
JFriel 16a19f9
working update
JFriel ff65ed6
working update
JFriel e3d8282
update ignore list
JFriel 147466a
add to correct ignore list
JFriel c62ee44
add docs
JFriel 2102fa4
tidy up
JFriel f78acfe
any
JFriel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 and 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"] | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.