-
Notifications
You must be signed in to change notification settings - Fork 0
Add/tre guides #8
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
42c1242
add approve projects & memberships & outputs guides
vpnu 59fd97a
update page links
vpnu 4858600
change tab sequence
vpnu 36128b9
move sync info
vpnu ffc4c8f
add link to sync info
vpnu 61bf013
Merge branch 'main' into add/tre-guides
vpnu 1a60e0a
Update app/page.mdx
vpnu bb38334
Update app/page.mdx
vpnu cbd8425
add links
vpnu c84373d
Merge branch 'add/tre-guides' of github.com:Health-Informatics-UoN/5s…
vpnu 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| export default { | ||
| "setup-tre": "Setup TRE Agent", | ||
| "connect-submission": "Connecting a TRE", | ||
| approvals: "Approve Projects", | ||
| "connect-submission": "Connecting a TRE" | ||
| "approve-outputs":"Review Outputs" | ||
| }; |
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,73 @@ | ||
| --- | ||
| readingTime: PT10M | ||
| audiences: tre-operator | ||
| --- | ||
|
|
||
| import { Steps, Callout } from "nextra/components"; | ||
| import { DocMetadata } from "@/components/doc-metadata/DocMetadata"; | ||
|
|
||
| <DocMetadata /> | ||
|
|
||
| # Approving Project Access to a TRE | ||
|
|
||
| This guide describes how a TRE Operator approves Projects and Project memberships after they have been synchronised from the Submission Layer to the TRE Agent. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Knowledge | ||
|
|
||
| - Understand how the TRE Agent synchronises with the Submission Layer. | ||
| - Be familiar with the TRE Agent UI. | ||
|
|
||
| ### Technical requirements | ||
|
|
||
| - A deployed TRE Layer. | ||
| - A TRE Administrator user. A Keycloak administrator must create a TRE administrator account with the `dare-tre-admin` role. See **Add Keycloak User**. | ||
| - A connected TRE Agent. See [Connect a TRE Agent to the Submission Layer](/connect/connect-submission). | ||
|
|
||
| ## Synchronisation | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why is this here?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. moved it down in a callout where it was meant to be 👍 |
||
|
|
||
| The TRE Agent synchronises Projects from the Submission Layer at a regular interval. | ||
|
|
||
| To change the synchronisation interval, a TRE operator can update the `syncSchedule` setting in the TRE Agent configuration. | ||
|
|
||
| ## Approve Projects and Memberships | ||
|
|
||
| <Steps> | ||
|
|
||
| ### Sign in | ||
|
|
||
| Sign in to the TRE Agent UI using a TRE administrator account. | ||
|
|
||
| ### Locate the Project | ||
|
|
||
| Once the TRE Agent has synchronised with the Submission Layer, Projects assigned to the TRE appear in the TRE Agent UI. | ||
| Select the Project you want to review. | ||
|
|
||
|  | ||
| ### Approve the Project | ||
|
|
||
| Navigate to the **Project Approval** section and choose whether to approve or reject the Project. | ||
|  | ||
|
|
||
| <Callout type="warning"> | ||
| A rejected Project cannot be changed back to **Undecided** or **Approved**. | ||
| </Callout> | ||
|
|
||
| ### Approve Project Memberships | ||
|
|
||
| Open the **Memberships** section. | ||
|
|
||
| Review each Project member and decide whether they are allowed to submit TES tasks to the Project. | ||
|
|
||
| Once you have finished reviewing all memberships, select **Save Changes**. | ||
|  | ||
|
|
||
| </Steps> | ||
|
|
||
| ## What's next? | ||
|
|
||
| After approving the Project and its memberships, you can continue with: | ||
|
|
||
| - Controlling TRE data access. | ||
| - [Reviewing and approving outputs](/connect/approve-outputs). | ||
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,67 @@ | ||
| --- | ||
| readingTime: PT5M | ||
| audiences: tre-operator | ||
| --- | ||
|
|
||
| import { Steps, Callout } from "nextra/components"; | ||
| import { DocMetadata } from "@/components/doc-metadata/DocMetadata"; | ||
|
|
||
| <DocMetadata /> | ||
|
|
||
| # Reviewing and Approving Outputs | ||
|
|
||
| This guide describes how an Output Checker reviews and approves data egress requests using the Egress Layer. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Knowledge | ||
|
|
||
| - Understand your organisation's output checking procedures and Standard Operating Procedures (SOPs). | ||
| - Know how to review outputs in accordance with the project's governance and disclosure control policies. | ||
| - Be familiar with the Five Safes TES Egress application. | ||
|
|
||
| ### Technical requirements | ||
|
|
||
| - A deployed Egress Layer. | ||
| - An Egress administrator account. A Keycloak administrator must create a user with the `data-egress-admin` role. See **Add Keycloak User**. | ||
|
|
||
| ## Review Output Requests | ||
|
|
||
| <Steps> | ||
|
|
||
| ### Sign in | ||
|
|
||
| Sign in to the Egress Layer using an account with the `data-egress-admin` role. | ||
|
|
||
| ### View Unprocessed Requests | ||
|
|
||
| Navigate to the **Requests** page and select the **Unprocessed Requests** tab. | ||
|
|
||
| All output requests that require review are displayed. | ||
|
|
||
|  | ||
|
|
||
| ### Review an Output Request | ||
|
|
||
| Select the output request you want to review by clicking **Review**. | ||
|
|
||
| Download the requested output files and review them according to your organisation's policies and procedures. | ||
|
|
||
|  | ||
|
|
||
| ### Approve or Reject Outputs | ||
|
|
||
| For each output within the request, choose either **Approved** or **Rejected**. | ||
|
|
||
| If you are not ready to complete the review, select **Save** to store your progress and continue reviewing later. | ||
|
|
||
| When the review is complete, select **Complete & Close Request**. | ||
|
|
||
| The request is returned to the **Requests** page and its status is updated (for example, **Fully Approved**). | ||
|  | ||
| <Callout type="info"> | ||
| Output requests can be reviewed over multiple sessions. Selecting **Save** preserves your decisions until you are ready to complete the review. | ||
| </Callout> | ||
|
|
||
| </Steps> | ||
|
|
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe a link back to
app/connect/connect-submission/page.mdxor a subsection of it?