Skip to content
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

chore - GAT-4470 : Rename FMA #9

Merged
merged 2 commits into from
Oct 16, 2024
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
File renamed without changes.
16 changes: 8 additions & 8 deletions docs/integrations-hdruk-datasets.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
## Introduction

The Federated Metadata Automation (FMA) service enables data custodians to automate metadata transfer to the Gateway by configuring specific API endpoints. This technical guide provides instructions on how to set up and manage the FMA self-service on the Gateway. It also covers common pitfalls and error codes encountered during the integration testing process.
The Gateway Metadata Integration (GMI) service enables data custodians to automate metadata transfer to the Gateway by configuring specific API endpoints. This technical guide provides instructions on how to set up and manage the GMI self-service on the Gateway. It also covers common pitfalls and error codes encountered during the integration testing process.

## How to set up a FMA process
## How to set up a GMI process

The following diagram (Fig 1) illustrates the steps involved in setting up a Federated Metadata Automation process on the Gateway:
The following diagram (Fig 1) illustrates the steps involved in setting up a Gateway Metadata Integration process on the Gateway:

![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/e0f42677-7e97-4795-90c8-1a6f4c088a42)
**Fig 1: Federated Metadata Automation process**
**Fig 1: Gateway Metadata Integration process**

### Step 1: Sign in to the Gateway

Sign in to the Gateway with your preferred route. Make sure you have a Team set up on the Gateway. If you need assistance with this step, contact the HDR UK technology team using the link below.

[https://www.healthdatagateway.org/about/contact-us](https://www.healthdatagateway.org/about/contact-us)

### Step 2: Access to the Gateway FMA service
### Step 2: Access to the Gateway GMI service

The FMA service is designed to enable data custodians to maintain datasets and integration independently. If you have the necessary permissions (Team Admininistrator or Developer), you can access the service by following these steps:
The GMI service is designed to enable data custodians to maintain datasets and integration independently. If you have the necessary permissions (Team Admininistrator or Developer), you can access the service by following these steps:

- Go to Team Management > Integrations > Integration.
- Click on “Create new Integration” to initiate the configuration (Fig 2).
Expand Down Expand Up @@ -62,11 +62,11 @@ If any of the above tests fail, an error message will be returned. If there are
![image](https://github.com/HDRUK/gateway-2-integrations-testing/assets/69473770/c674ca37-0b66-4826-a538-2557595657bb)
**Fig 4: Integration testing**

If during normal operation the server changes or datasets are moved elsewhere, the integration may become invalid and FMA will disable it. In such cases, the synchronisation of datasets will cease, and you will receive a notification. To re-enable the integration, you will need to follow the configuration process again.
If during normal operation the server changes or datasets are moved elsewhere, the integration may become invalid and GMI will disable it. In such cases, the synchronisation of datasets will cease, and you will receive a notification. To re-enable the integration, you will need to follow the configuration process again.

#### Error Codes

The FMA service utilises a list of error codes (Table 1). These error codes help in identifying and handling specific issues encountered during the integration testing process.
The GMI service utilises a list of error codes (Table 1). These error codes help in identifying and handling specific issues encountered during the integration testing process.

<center>

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ nav:
- Update: updating-a-dataset.md
- Delete: deleting-a-dataset.md
- Using HDR UK Datasets Federation:
- Test Server Example: fma-test-server.md
- Test Server Example: gmi-test-server.md
plugins:
- search

Expand Down
Loading