Skip to content

Commit 7e62ee1

Browse files
vpnuAndrewThien
andauthored
Add/tre guides (#8)
* add approve projects & memberships & outputs guides * update page links * change tab sequence * move sync info * add link to sync info * Update app/page.mdx Co-authored-by: Tri Thien Nguyen <119530400+AndrewThien@users.noreply.github.com> * Update app/page.mdx Co-authored-by: Tri Thien Nguyen <119530400+AndrewThien@users.noreply.github.com> * add links --------- Co-authored-by: Tri Thien Nguyen <119530400+AndrewThien@users.noreply.github.com>
1 parent e19383a commit 7e62ee1

11 files changed

Lines changed: 147 additions & 5 deletions

File tree

app/connect/_meta.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
export default {
22
"setup-tre": "Setup TRE Agent",
3-
approvals: "Approve Projects",
43
"connect-submission": "Connecting a TRE",
4+
approvals: "Approve Projects",
5+
"approve-outputs":"Review Outputs"
56
};

app/connect/approvals/page.mdx

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
readingTime: PT10M
3+
audiences: tre-operator
4+
---
5+
6+
import { Steps, Callout } from "nextra/components";
7+
import { DocMetadata } from "@/components/doc-metadata/DocMetadata";
8+
9+
<DocMetadata />
10+
11+
# Approving Project Access to a TRE
12+
13+
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.
14+
15+
## Prerequisites
16+
17+
### Knowledge
18+
19+
- Understand how the TRE Agent synchronises with the Submission Layer. [See Synchronisation](/connect/connect-submission#synchronisation)
20+
- Be familiar with the TRE Agent UI.
21+
22+
### Technical requirements
23+
24+
- A deployed TRE Layer.
25+
- A TRE Administrator user. A Keycloak administrator must create a TRE administrator account with the `dare-tre-admin` role. See **Add Keycloak User**.
26+
- A connected TRE Agent. See [Connect a TRE Agent to the Submission Layer](/connect/connect-submission).
27+
28+
## Approve Projects and Memberships
29+
30+
<Steps>
31+
32+
### Sign in
33+
34+
Sign in to the TRE Agent UI using a TRE administrator account.
35+
36+
### Locate the Project
37+
38+
Once the TRE Agent has synchronised with the Submission Layer, Projects assigned to the TRE appear in the TRE Agent UI.
39+
Select the Project you want to review.
40+
41+
![Unprocessed Projects](/images/tre-layer/tre-unprocessed-projects.png)
42+
43+
<Callout type="info">
44+
The TRE Agent synchronises Projects from the Submission Layer at a regular interval.
45+
46+
To change the synchronisation interval, a TRE operator can update the `syncSchedule` setting in the TRE Agent configuration.
47+
</Callout>
48+
49+
### Approve the Project
50+
51+
Navigate to the **Project Approval** section and choose whether to approve or reject the Project.
52+
![Review Project](/images/tre-layer/tre-project-review.png)
53+
54+
<Callout type="warning">
55+
A rejected Project cannot be changed back to **Undecided** or **Approved**.
56+
</Callout>
57+
58+
### Approve Project Memberships
59+
60+
Open the **Memberships** section.
61+
62+
Review each Project member and decide whether they are allowed to submit TES tasks to the Project.
63+
64+
Once you have finished reviewing all memberships, select **Save Changes**.
65+
![Review Project Members](/images/tre-layer/tre-project-review-members.png)
66+
67+
</Steps>
68+
69+
## What's next?
70+
71+
After approving the Project and its memberships, you can continue with:
72+
73+
- Controlling TRE data access.
74+
- [Review and approve outputs](/connect/approve-outputs).
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
readingTime: PT5M
3+
audiences: tre-operator
4+
---
5+
6+
import { Steps, Callout } from "nextra/components";
7+
import { DocMetadata } from "@/components/doc-metadata/DocMetadata";
8+
9+
<DocMetadata />
10+
11+
# Reviewing and Approving Outputs
12+
13+
This guide describes how an Output Checker reviews and approves data egress requests using the Egress Layer.
14+
15+
## Prerequisites
16+
17+
### Knowledge
18+
19+
- Understand your organisation's output checking procedures and Standard Operating Procedures (SOPs).
20+
- Know how to review outputs in accordance with the project's governance and disclosure control policies.
21+
- Be familiar with the Five Safes TES Egress application.
22+
23+
### Technical requirements
24+
25+
- A deployed Egress Layer.
26+
- An Egress administrator account. A Keycloak administrator must create a user with the `data-egress-admin` role. See **Add Keycloak User**.
27+
28+
## Review Output Requests
29+
30+
<Steps>
31+
32+
### Sign in
33+
34+
Sign in to the Egress Layer using an account with the `data-egress-admin` role.
35+
36+
### View Unprocessed Requests
37+
38+
Navigate to the **Requests** page and select the **Unprocessed Requests** tab.
39+
40+
All output requests that require review are displayed.
41+
42+
![View Unprocessed Requests](/images/tre-layer/egress-unprocessed.png)
43+
44+
### Review an Output Request
45+
46+
Select the output request you want to review by clicking **Review**.
47+
48+
Download the requested output files and review them according to your organisation's policies and procedures.
49+
50+
![Review Request](/images/tre-layer/egress-request-review.png)
51+
52+
### Approve or Reject Outputs
53+
54+
For each output within the request, choose either **Approved** or **Rejected**.
55+
56+
If you are not ready to complete the review, select **Save** to store your progress and continue reviewing later.
57+
58+
When the review is complete, select **Complete & Close Request**.
59+
60+
The request is returned to the **Requests** page and its status is updated (for example, **Fully Approved**).
61+
![Fully Approved Request](/images/tre-layer/egress-request-approved.png)
62+
<Callout type="info">
63+
Output requests can be reviewed over multiple sessions. Selecting **Save** preserves your decisions until you are ready to complete the review.
64+
</Callout>
65+
66+
</Steps>
67+

app/connect/connect-submission/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ Once any configuration or connectivity issues have been resolved, the Synchronis
146146

147147
### What’s next? :
148148

149-
- Approving Projects/Memberships
150-
- Checking and approving outputs
149+
- [Approving Projects/Memberships](/connect/approvals)
150+
- [Review & Approve Outputs](/connect/approve-outputs)

app/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ import CustomCard from "@/components/custom-card";
3333
href: "/5st-docs/connect/setup-tre/deployment-steps",
3434
},
3535
{ title: "Connecting a TRE", href: "/5st-docs/connect/connect-submission" },
36-
{ title: "Projects and users", href: "/link2" },
36+
{ title: "Projects and users", href: "/5s-tes-docs/connect/approvals" },
3737
{ title: "TRE data access", href: "/link1" },
38-
{ title: "Outputs approval", href: "/link2" },
38+
{ title: "Outputs approval", href: "/5s-tes-docs/connect/approve-outputs" },
3939
]}
4040
CTA={{ text: "Connect >", href: "/cta" }}
4141
icon={<Unplug size={24} />}
56.9 KB
Loading
125 KB
Loading
159 KB
Loading
117 KB
Loading
181 KB
Loading

0 commit comments

Comments
 (0)