Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 1 deletion app/connect/_meta.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export default {
"setup-tre": "Setup TRE Agent",
approvals: "Approve Projects",
"connect-submission": "Connecting a TRE",
approvals: "Approve Projects",
"approve-outputs":"Review Outputs"
};
74 changes: 74 additions & 0 deletions app/connect/approvals/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
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. [See Synchronisation](/connect/connect-submission#synchronisation)
- 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).

## 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.

![Unprocessed Projects](/images/tre-layer/tre-unprocessed-projects.png)

<Callout type="info">
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.
</Callout>

### Approve the Project

Navigate to the **Project Approval** section and choose whether to approve or reject the Project.
![Review Project](/images/tre-layer/tre-project-review.png)

<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**.
![Review Project Members](/images/tre-layer/tre-project-review-members.png)

</Steps>

## What's next?

After approving the Project and its memberships, you can continue with:

- Controlling TRE data access.
- [Review and approve outputs](/connect/approve-outputs).
67 changes: 67 additions & 0 deletions app/connect/approve-outputs/page.mdx
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.

![View Unprocessed Requests](/images/tre-layer/egress-unprocessed.png)

### 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.

![Review Request](/images/tre-layer/egress-request-review.png)

### 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**).
![Fully Approved Request](/images/tre-layer/egress-request-approved.png)
<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>

4 changes: 2 additions & 2 deletions app/connect/connect-submission/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,5 +146,5 @@ Once any configuration or connectivity issues have been resolved, the Synchronis

### What’s next? :

- Approving Projects/Memberships
- Checking and approving outputs
- [Approving Projects/Memberships](/connect/approvals)
- [Review & Approve Outputs](/connect/approve-outputs)
4 changes: 2 additions & 2 deletions app/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ import CustomCard from "@/components/custom-card";
href: "/5st-docs/connect/setup-tre/deployment-steps",
},
{ title: "Connecting a TRE", href: "/5st-docs/connect/connect-submission" },
{ title: "Projects and users", href: "/link2" },
{ title: "Projects and users", href: "/5s-tes-docs/connect/approvals" },
{ title: "TRE data access", href: "/link1" },
{ title: "Outputs approval", href: "/link2" },
{ title: "Outputs approval", href: "/5s-tes-docs/connect/approve-outputs" },
]}
CTA={{ text: "Connect >", href: "/cta" }}
icon={<Unplug size={24} />}
Expand Down
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.
Binary file added public/images/tre-layer/egress-unprocessed.png
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.
Binary file added public/images/tre-layer/tre-project-review.png
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.